Class SftMinter

Hierarchy

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' | 'devnet2' | 'mainnet' | 'testnet'
- timeout: number = 10000
  
  Timeout for the network provider (DEFAULT = 10000ms)
Returns SftMinter
Overrides Minter.constructor
- Defined in sft-minter.ts:40

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: number
  
  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:177

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:467

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:509

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:65

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: number
  
  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:105

mint

mint(senderAddress, tokenName, dataMarshalUrl, dataStreamUrl, dataPreviewUrl, royalties, supply, datasetTitle, datasetDescription, antiSpamTax, 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.
- antiSpamTax: number
  
  the anti spam tax to be set for the Data NFT-FT with decimals. Needs to be greater than 0 and should be obtained in real time via viewMinterRequirements prior to calling mint.
- Optional options: {
      antiSpamTokenIdentifier?: 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 - antiSpamTokenIdentifier: the anti spam token identifier to be used for the minting (default = ITHEUM token identifier based on the EnvironmentsEnum)
  - Optional antiSpamTokenIdentifier?: string
  - Optional imageUrl?: string
  - Optional nftStorageToken?: string
  - Optional traitsUrl?: string
Returns Promise<Transaction>
- Defined in sft-minter.ts:202

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:430

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:222

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
Returns Transaction
Inherited from Minter.removeWhitelist
- Defined in minter.ts:362

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:406

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:205

setMaxSupply

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

setMintTax

setMintTax(senderAddress, tokenIdentifier, tax): 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
- tokenIdentifier: string
  
  The token identifier of the token to set the mint tax
- tax: number
  
  The tax to set for the token
Returns Transaction
Inherited from Minter.setMintTax
- Defined in minter.ts:262

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:387

setRoyaltiesLimits

setRoyaltiesLimits(senderAddress, minRoyalties, maxRoyalties): Transaction
Parameters
- senderAddress: IAddress
  
  The address of the sender, must be the admin of the contract
- minRoyalties: number
  
  The minimum royalties to set for minting
- maxRoyalties: number
  
  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:290

setTreasuryAddress

setTreasuryAddress(senderAddress, treasuryAddress): 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:138

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:314

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:535

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:487

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:448

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:241

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[]>
Inherited from Minter.viewAddressFrozenNonces
- Defined in minter.ts:145

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:118

viewContractPauseState

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

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

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:54

viewWhitelist

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

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

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
Returns Transaction
Inherited from Minter.whitelist
- Defined in minter.ts:337

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:563

Class SftMinter

Hierarchy

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: number

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: number

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

antiSpamTax: number

Optional options: { antiSpamTokenIdentifier?: string; imageUrl?: string; nftStorageToken?: string; traitsUrl?: string; }

Optional antiSpamTokenIdentifier?: 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

addresses: string[]

extraGas: number = 0

`Readonly` chainID

`Readonly` contract

`Readonly` env

`Readonly` imageServiceUrl

`Readonly` networkProvider

`Optional` options: {
antiSpamTokenIdentifier?: string;
imageUrl?: string;
nftStorageToken?: string;
traitsUrl?: string;
}

`Optional` antiSpamTokenIdentifier?: string

`Optional` imageUrl?: string

`Optional` nftStorageToken?: string

`Optional` traitsUrl?: string