Class SftMinter

Hierarchy (view full)

Minter
- SftMinter

Constructors

constructor

new SftMinter(env, timeout?): SftMinter
Creates a new instance of the SftMinter class, which can be used to interact with the Data NFT-FT minter smart contract
Parameters
- env: string
  'devnet' | 'mainnet' | 'testnet'
- timeout: number = 10000
  Timeout for the network provider (DEFAULT = 10000ms)
Returns SftMinter
Overrides Minter.constructor
- Defined in sft-minter.ts:42

Properties

`Readonly` chainID

chainID: string

`Readonly` contract

contract: SmartContract

`Readonly` env

env: string

`Readonly` imageServiceUrl

imageServiceUrl: string

`Readonly` networkProvider

networkProvider: ApiNetworkProvider

Methods

burn

burn(senderAddress, dataNftNonce, quantityToBurn, dataNftIdentifier?): Transaction
Creates a burn transaction
Parameters
- senderAddress: IAddress
  the address of the user
- dataNftNonce: number
  the nonce of the DataNFT-FT
- quantityToBurn: Value
  the quantity to burn
- dataNftIdentifier: string = ...
  the DataNFT-FT token identifier (default = DATA-NFT-FT token identifier based on the EnvironmentsEnum)
Returns Transaction
Inherited from Minter.burn
- Defined in minter.ts:127

freeze

freeze(senderAddress, freezeAddress): Transaction
Freeze transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
- freezeAddress: IAddress
Returns Transaction
Inherited from Minter.freeze
- Defined in minter.ts:394

freezeSingleNFT

freezeSingleNFT(senderAddress, nonce, freezeAddress): Transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
- nonce: number
  The nonce of the token to freeze for freezeAddress
- freezeAddress: IAddress
  The address to freeze
Returns Transaction
Inherited from Minter.freezeSingleNFT
- Defined in minter.ts:436

getContractAddress

getContractAddress(): IAddress
Retrieves the address of the minter smart contract based on the environment

Returns IAddress
Inherited from Minter.getContractAddress
- Defined in minter.ts:44

initializeContract

initializeContract(senderAddress, collectionName, tokenTicker, antiSpamTaxTokenIdentifier, antiSpamTaxTokenAmount, mintLimit, treasury_address): Transaction
Creates an initialize contract transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- collectionName: string
  The name of the NFT collection
- tokenTicker: string
  The ticker of the NFT collection
- antiSpamTaxTokenIdentifier: string
  The token identifier of the anti spam token
- antiSpamTaxTokenAmount: Value
  The amount of anti spam token to be used for minting as tax
- mintLimit: number
- treasury_address: IAddress
  The address of the treasury to collect the anti spam tax
Returns Transaction
- Defined in sft-minter.ts:137

mint

mint(senderAddress, tokenName, dataMarshalUrl, dataStreamUrl, dataPreviewUrl, royalties, supply, datasetTitle, datasetDescription, amountToSend, lockPeriod?, donationPercentage?, options?): Promise<Transaction>
Creates a mint transaction

NOTE: The dataStreamUrl is being encrypted and the media and metadata urls are build and uploaded to IPFS

NOTE: The options.nftStorageToken is required when not using custom image and traits, when using custom image and traits the traits should be compliant with the traits structure

For more information, see the README documentation.
Parameters
- senderAddress: IAddress
  the address of the user
- tokenName: string
  the name of the DataNFT-FT. Between 3 and 20 alphanumeric characters, no spaces.
- dataMarshalUrl: string
  the url of the data marshal. A live HTTPS URL that returns a 200 OK HTTP code.
- dataStreamUrl: string
  the url of the data stream to be encrypted. A live HTTPS URL that returns a 200 OK HTTP code.
- dataPreviewUrl: string
  the url of the data preview. A live HTTPS URL that returns a 200 OK HTTP code.
- royalties: number
  the royalties to be set for the Data NFT-FT. A number between 0 and 50. This equates to a % value. e.g. 10%
- supply: number
  the supply of the Data NFT-FT. A number between 1 and 1000.
- datasetTitle: string
  the title of the dataset. Between 10 and 60 alphanumeric characters.
- datasetDescription: string
  the description of the dataset. Between 10 and 400 alphanumeric characters.
- amountToSend: number
  the amount of the bond + anti spam tax (if anti spam tax > 0) to be sent
- Optional lockPeriod: number
  the lock period for the bond in days
- donationPercentage: number = 0
- Optional options: {
      extraAssets?: string[];
      imageUrl?: string;
      nftStorageToken?: string;
      traitsUrl?: string;
  }
  [optional] below parameters are optional or required based on use case - imageUrl: the URL of the image for the Data NFT - traitsUrl: the URL of the traits for the Data NFT - nftStorageToken: the nft storage token to be used to upload the image and metadata to IPFS - extraAssets: [optional] extra URIs to attached to the NFT. Can be media files, documents, etc. These URIs are public - donationPercentage: [optional] the donation percentage to be set for the Data NFT-FT supply to be sent to the donation
  - Optional extraAssets?: string[]
  - Optional imageUrl?: string
  - Optional nftStorageToken?: string
  - Optional traitsUrl?: string
Returns Promise<Transaction>
- Defined in sft-minter.ts:285

pauseCollection

pauseCollection(senderAddress): Transaction
Pause collection transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
Returns Transaction
Inherited from Minter.pauseCollection
- Defined in minter.ts:357

pauseContract

pauseContract(senderAddress): Transaction
Creates a pause transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
Returns Transaction
Inherited from Minter.pauseContract
- Defined in minter.ts:172

removeWhitelist

removeWhitelist(senderAddress, addresses, extraGas?): Transaction
Creates a remove whitelist transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- addresses: string[]
  The addresses to remove from the whitelist
- extraGas: number = 0
  The extra gas to add to the transaction
Returns Transaction
Inherited from Minter.removeWhitelist
- Defined in minter.ts:289

setAdministrator

setAdministrator(senderAddress, newAdministrator): Transaction
Sets a new administrator for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- newAdministrator: IAddress
  The address of the new administrator
Returns Transaction
Inherited from Minter.setAdministrator
- Defined in minter.ts:333

setDonationTreasuryAddress

setDonationTreasuryAddress(senderAddress, donationTreasuryAddress): Transaction
Creates a setDonationTreasuryAddress transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- donationTreasuryAddress: IAddress
  The address of the donation treasury to collect the donation tax
Returns Transaction
- Defined in sft-minter.ts:193

setLocalRoles

setLocalRoles(senderAddress): Transaction
Creates a setLocalRoles transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
Returns Transaction
Inherited from Minter.setLocalRoles
- Defined in minter.ts:155

setMaxDonationPercentage

setMaxDonationPercentage(senderAddress, maxDonationPercentage): Transaction
Creates a setMaxDonationPercentage transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- maxDonationPercentage: Value
  The maximum donation percentage that can be set
Returns Transaction
- Defined in sft-minter.ts:216

setMaxSupply

setMaxSupply(senderAddress, maxSupply): Transaction
Creates a setAntiSpamTax transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- maxSupply: Value
  The maximum supply that can be minted
Returns Transaction
- Defined in sft-minter.ts:239

setMintTimeLimit

setMintTimeLimit(senderAddress, timeLimit): Transaction
Creates a set mint time limit transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- timeLimit: number
Returns Transaction
Inherited from Minter.setMintTimeLimit
- Defined in minter.ts:314

setRoyaltiesLimits

setRoyaltiesLimits(senderAddress, minRoyalties, maxRoyalties): Transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- minRoyalties: Value
  The minimum royalties to set for minting
- maxRoyalties: Value
  The maximum royalties to set for minting
  
  Remarks: The royalties are set in percentage (e.g. 100% = 10000)
Returns Transaction
Inherited from Minter.setRoyaltiesLimits
- Defined in minter.ts:215

setTreasuryAddress

setTreasuryAddress(senderAddress, treasuryAddress): Transaction
Creates a setTreasuryAddress transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- treasuryAddress: IAddress
  The address of the treasury to collect the anti spam tax
Returns Transaction
- Defined in sft-minter.ts:170

setWhitelistIsEnabled

setWhitelistIsEnabled(senderAddress, is_enabled): Transaction
Creates a set mint tax transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- is_enabled: boolean
  A boolean value to set if whitelist is enabled or not
Returns Transaction
Inherited from Minter.setWhitelistIsEnabled
- Defined in minter.ts:239

unFreezeSingleNFT

unFreezeSingleNFT(senderAddress, nonce, unfreezeAddress): Transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
- nonce: number
  The nonce of the token to unfreeze for unfreezeAddress
- unfreezeAddress: IAddress
  The address to unfreeze
Returns Transaction
Inherited from Minter.unFreezeSingleNFT
- Defined in minter.ts:462

unfreeze

unfreeze(senderAddress, unfreezeAddress): Transaction
Unfreeze transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
- unfreezeAddress: IAddress
Returns Transaction
Inherited from Minter.unfreeze
- Defined in minter.ts:414

unpauseCollection

unpauseCollection(senderAddress): Transaction
Unpause collection transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
Returns Transaction
Inherited from Minter.unpauseCollection
- Defined in minter.ts:375

unpauseContract

unpauseContract(senderAddress): Transaction
Creates a unpause transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
Returns Transaction
Inherited from Minter.unpauseContract
- Defined in minter.ts:191

viewAddressFrozenNonces

viewAddressFrozenNonces(address): Promise<number[]>
Retrieves a list of nonces that are frozen for address
Parameters
- address: IAddress
  The address to check
Returns Promise<number[]>
- Defined in sft-minter.ts:102

viewCollectionFrozenAddresses

viewCollectionFrozenAddresses(): Promise<string[]>
Retrieves a list of addresses that are frozen for collection

Returns Promise<string[]>
Inherited from Minter.viewCollectionFrozenAddresses
- Defined in minter.ts:97

viewContractPauseState

viewContractPauseState(): Promise<boolean>
Retrieves the smart contract pause state

Returns Promise<boolean>
Inherited from Minter.viewContractPauseState
- Defined in minter.ts:51

viewMinterRequirements

viewMinterRequirements(address, taxToken?): Promise<SftMinterRequirements>
Retrieves the minter smart contract requirements for the given user
Parameters
- address: IAddress
  the address of the user
- taxToken: string = ...
  the tax token to be used for the minting (default = ITHEUM token identifier based on the EnvironmentsEnum)
Returns Promise<SftMinterRequirements>
- Defined in sft-minter.ts:56

viewWhitelist

viewWhitelist(): Promise<string[]>
Retrieves the minter whitelist

Returns Promise<string[]>
Inherited from Minter.viewWhitelist
- Defined in minter.ts:74

whitelist

whitelist(senderAddress, addresses, extraGas?): Transaction
Creates a whitelist transaction for the contract
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin of the contract
- addresses: string[]
  The addresses to whitelist
- extraGas: number = 0
  The extra gas to add to the transaction
Returns Transaction
Inherited from Minter.whitelist
- Defined in minter.ts:263

wipeSingleNFT

wipeSingleNFT(senderAddress, nonce, wipeAddress): Transaction
Parameters
- senderAddress: IAddress
  The address of the sender, must be the admin or owner of the contract
- nonce: number
  The nonce of the token to wipe for wipeAddress
- wipeAddress: IAddress
  The address to wipe from Important: This will wipe all NFTs from the address Note: The nonce must be freezed before wiping
Returns Transaction
Inherited from Minter.wipeSingleNFT
- Defined in minter.ts:490

Class SftMinter

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

env: string

timeout: number = 10000

Returns SftMinter

Properties

Readonly chainID

Readonly contract

Readonly env

Readonly imageServiceUrl

Readonly networkProvider

Methods

burn

Parameters

senderAddress: IAddress

dataNftNonce: number

quantityToBurn: Value

dataNftIdentifier: string = ...

Returns Transaction

freeze

Parameters

senderAddress: IAddress

freezeAddress: IAddress

Returns Transaction

freezeSingleNFT

Parameters

senderAddress: IAddress

nonce: number

freezeAddress: IAddress

Returns Transaction

getContractAddress

Returns IAddress

initializeContract

Parameters

senderAddress: IAddress

collectionName: string

tokenTicker: string

antiSpamTaxTokenIdentifier: string

antiSpamTaxTokenAmount: Value

mintLimit: number

treasury_address: IAddress

Returns Transaction

mint

Parameters

senderAddress: IAddress

tokenName: string

dataMarshalUrl: string

dataStreamUrl: string

dataPreviewUrl: string

royalties: number

supply: number

datasetTitle: string

datasetDescription: string

amountToSend: number

Optional lockPeriod: number

donationPercentage: number = 0

Optional options: { extraAssets?: string[]; imageUrl?: string; nftStorageToken?: string; traitsUrl?: string; }

Optional extraAssets?: string[]

Optional imageUrl?: string

Optional nftStorageToken?: string

Optional traitsUrl?: string

Returns Promise<Transaction>

pauseCollection

Parameters

senderAddress: IAddress

Returns Transaction

pauseContract

Parameters

senderAddress: IAddress

Returns Transaction

removeWhitelist

Parameters

senderAddress: IAddress

`Readonly` chainID

`Readonly` contract

`Readonly` env

`Readonly` imageServiceUrl

`Readonly` networkProvider

`Optional` lockPeriod: number

`Optional` options: {
extraAssets?: string[];
imageUrl?: string;
nftStorageToken?: string;
traitsUrl?: string;
}

`Optional` extraAssets?: string[]

`Optional` imageUrl?: string

`Optional` nftStorageToken?: string

`Optional` traitsUrl?: string