Readonly
chainIDReadonly
contractReadonly
envReadonly
imageReadonly
networkCreates a burn
transaction
the address of the user
the nonce of the DataNFT-FT
the quantity to burn
the DataNFT-FT token identifier (default = DATA-NFT-FT
token identifier based on the EnvironmentsEnum)
The address of the sender, must be the admin or owner of the contract
The nonce of the token to freeze for freezeAddress
The address to freeze
Creates an initialize contract transaction for the contract
The address of the sender, must be the admin of the contract
The name of the NFT collection
The ticker of the NFT collection
The token identifier of the anti spam token
The amount of anti spam token to be used for minting as tax
The address of the treasury to collect the anti spam tax
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.
the address of the user
the name of the DataNFT-FT. Between 3 and 20 alphanumeric characters, no spaces.
the url of the data marshal. A live HTTPS URL that returns a 200 OK HTTP code.
the url of the data stream to be encrypted. A live HTTPS URL that returns a 200 OK HTTP code.
the url of the data preview. A live HTTPS URL that returns a 200 OK HTTP code.
the royalties to be set for the Data NFT-FT. A number between 0 and 50. This equates to a % value. e.g. 10%
the supply of the Data NFT-FT. A number between 1 and 1000.
the title of the dataset. Between 10 and 60 alphanumeric characters.
the description of the dataset. Between 10 and 400 alphanumeric characters.
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: { [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
antiOptional
imageOptional
nftOptional
traitsCreates a remove whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to remove from the whitelist
Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
The token identifier of the token to set the mint tax
The tax to set for the token
The address of the sender, must be the admin of the contract
The minimum royalties to set for minting
The maximum royalties to set for minting
Remarks: The royalties are set in percentage (e.g. 100% = 10000)
Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
A boolean value to set if whitelist is enabled or not
The address of the sender, must be the admin or owner of the contract
The nonce of the token to unfreeze for unfreezeAddress
The address to unfreeze
Retrieves the minter smart contract requirements for the given user
the address of the user
the tax token to be used for the minting (default = ITHEUM
token identifier based on the EnvironmentsEnum)
The address of the sender, must be the admin or owner of the contract
The nonce of the token to wipe for wipeAddress
The address to wipe from Important: This will wipe all NFTs from the address Note: The nonce must be freezed before wiping
Generated using TypeDoc
Creates a new instance of the
SftMinter
class, which can be used to interact with the Data NFT-FT minter smart contract