Usage
This is a detailed explanation of the features provided by the NFT module.
Contents
Name | Description |
---|---|
Issue NFT. | |
Transfer the ownership right of the issued NFT. | |
Burn the issued NFT. | |
Parameters required to call API. |
1. mint
Issue NFT and record the result on the chain network.
Parameters
Name | Type | Example |
---|---|---|
wallet | Object (FirmaWalletService) | You can check how to use your wallet in the "firma-js of the Github repository". |
tokenURI | String | "https://firmachain.org/nft/metadata/bcf5cdajs-ff12...-d2han89nnha1" |
txMisc (Not required) | Object (TxMisc) | {fee:200000,gas:163821,memo:"custom message"} |
Return value
2. transfer
Transfer the ownership right of the issued NFT and record the result of the transfer on the chain network.
Parameters
Name | Type | Example |
---|---|---|
wallet | Object (FirmaWalletService) | You can check how to use your wallet in the "firma-js of the Github repository". |
toAddress | String | "firma1nssuz67am2uwc2hjgvphg0fmj3k9l6cx65ux9u" |
nftID | String | "16" |
txMisc (Not required) | Object (TxMisc) | {fee:200000,gas:163821,memo:"custom message"} |
Return value
3. burn
Following are the features offered in order to search the issued NFTs.
Parameters
Name | Type | Example |
---|---|---|
wallet | Object (FirmaWalletService) | You can check how to use your wallet in the "firma-js of the Github repository". |
nftID | String | "16" |
txMisc (Not required) | Object (TxMisc) | {fee:200000,gas:163821,memo:"custom message"} |
Return value
4. Parameter Description
Name | Description |
---|---|
wallet | Unique wallet parameter created from the user’s Mnemonic. This parameter can be called by using the Wallet.fromMnemonic function from the FirmaSDK module. |
toAddress | For this parameter, please enter your FirmaChain wallet address. |
nftID | For this parameter, Unique ID of the issued NFT. |
txMisc | This object contains the gas fee that is deducted when a transaction is called upon. * The default gas fee is set at 0.02fct. |
tokenURI | Metadata address describing the NFT. |
Last updated