Class NFTMethod

Adds dependencies from other module methods.

Mints a new NFT. The NFT will always be native to the chain creating it.

Example

 create(methodContext,address,collectionID,attributesArray);

Destroys the specified NFT. The NFT will be removed from the NFT substore and cannot be retrieved, except in the case of destroying NFT on a foreign chain: the information about the NFT (e.g., the attributes) will still be available in the corresponding escrow entry of the NFT substore in the native chain.

Example

 destroy(methodContext,address,nftID);

Gets the chain ID of an NFT.

Example

 getChainID(nftID);

Returns

The ID of the chain the NFT belongs to.

Gets the ID of the collection of an NFT.

Example

 getCollectionID(nftID);

Returns

The collection ID of the NFT.

Gets a specific NFT.

Example

 getNFT(methodContext,nftID);

Returns

The requested NFT.

Returns the next free index inside an NFT collection.

Example

 getNextAvailableIndex(methodContext,collectionID);

Returns

Index of the next free slot inside an NFT collection.

Checks whether a provided NFT is escrowed, e.g. the NFT is a native NFT that has been sent cross-chain to a foreign chain.

Example

 isNFTEscrowed(nft);

Returns

true, if the NFT is escrowed, false if not.

Checks whether a provided NFT is locked or not.

Example

 isNFTLocked(nft);

Returns

true if the NFT is locked, false if not.

Checks whether the NFT is supported by the network, or not.

Example

 isNFTSupported(methodContext,nftID);

Returns

true if the NFT is supported, false if not.

This function locks an NFT to a given module. A locked NFT cannot be transferred (within the chain or across chains). This can be useful, for example, when the NFT is used as a deposit for a service. Module is specified both when locking and unlocking the NFT, thus preventing NFTs being accidentally locked and unlocked by different modules. Note that an NFT can not be locked to the NFT module.

Example

 lock(methodContext,module,nftID);

This function recovers an NFT escrowed to a terminated chain. It should only be called by the module to trigger the recovery of NFTs escrowed to terminated chains.

Example

 recover(methodContext,terminatedChainID,substorePrefix,nftID,nft);

This function removes support for all non-native NFTs.

Example

 removeSupportAllNFTs(methodContext);

This function removes support for all non-native NFTs of a specified foreign chain.

Example

 removeSupportAllNFTsFromChain(methodContext,chainID);

This function removes support for all non-native NFTs of a specified collection.

Example

 removeSupportAllNFTsFromCollection(methodContext,chainID,collectionID);

This function is used to modify the attributes of NFTs. Each custom module can define the rules surrounding modifying NFT attributes and should call this function. This function will be executed even if the NFT is locked.

Example

 setAttributes(methodContext,module,nftID,attributes);

This function updates the supported NFTs substore to support all NFTs of the Lisk ecosystem.

Example

 supportAllNFTs(methodContext);

This function updates the supported NFTs substore to support all non-native NFTs of a specified foreign chain.

Example

 supportAllNFTsFromChain(methodContext,chainID);

This function updates the supported NFTs substore to support all non-native NFTs of a specified collection.

Example

 supportAllNFTsFromCollection(methodContext,chainID,collectionID);

This function is used to transfer ownership of NFTs within one chain.

Example

 transfer(methodContext,senderAddress,recipientAddress,nftID);

This function is used to transfer ownership of NFTs across chains in the Lisk ecosystem.

Example

 transferCrossChain(methodContext,senderAddress,recipientAddress,nftID,receivingChainID,messageFee,data,includeAttributes);

This function is used to unlock an NFT that was locked to a module.

Example

 unlock(methodContext,module,nftID);