SecretNET.NFT Namespace

Snip721Tx..::..BatchBurnNft Method

BatchBurnNft is used to burn multiple tokens. The message sender may specify a list of tokens to burn in each Burn object, and any memo provided will be applied to every token burned in that one Burn object. The message sender will usually list every token to be burned in one Burn object, but if a different memo is needed for different tokens being burned, multiple Burn objects may be listed. Each individual burning of a token will show separately in transaction histories. The message sender must have permission to transfer/burn all the tokens listed (either by being the owner or being granted transfer approval). A contract may use the VerifyTransferApproval query to verify that it has permission to transfer/burn all the tokens. If the message sender does not have permission to transfer/burn any one of the listed tokens, the entire message will fail (no tokens will be burned) and the error will provide the ID of the first token encountered in which the sender does not have the required permission. A SNIP-722 non-transferable token can always be burned even if burn functionality has been disabled using the init configuration. This is because an owner should always be able to dispose of an unwanted, non-transferable token.

Namespace:  SecretNET.NFT
Assembly:  SecretNET.NFT (in SecretNET.NFT.dll)

Syntax


public Task<SingleSecretTx<BatchBurnNftResponse>> BatchBurnNft(
	MsgBatchBurnNft msg,
	Nullable<TxOptions> txOptions
)
Public Function BatchBurnNft ( _
	msg As MsgBatchBurnNft, _
	txOptions As Nullable(Of TxOptions) _
) As Task(Of SingleSecretTx(Of BatchBurnNftResponse))
public:
Task<SingleSecretTx<BatchBurnNftResponse^>^>^ BatchBurnNft(
	MsgBatchBurnNft^ msg, 
	Nullable<TxOptions^> txOptions
)

Parameters

msg
Type: SecretNET.NFT..::..MsgBatchBurnNft
The MSG.
txOptions
Type: Nullable<(Of <(<'TxOptions>)>)>
The tx options.

Return Value

SingleSecretTx<BatchBurnNftResponse>.