SecretNET.NFT Namespace

Snip721Tx..::..BurnNft Method

BurnNft is used to burn a single token, providing an optional memo to include in the burn's transaction history if desired. If the contract has not enabled burn functionality using the init configuration enable_burn, BurnNft will result in an error, unless the token being burned is a SNIP-722 non-transferable token. This is because an owner should always be able to dispose of an unwanted, non-transferable token. Only the token owner and anyone else with valid transfer approval may burn this token.

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

Syntax


public Task<SingleSecretTx<BurnNftResponse>> BurnNft(
	MsgBurnNft msg,
	Nullable<TxOptions> txOptions
)
Public Function BurnNft ( _
	msg As MsgBurnNft, _
	txOptions As Nullable(Of TxOptions) _
) As Task(Of SingleSecretTx(Of BurnNftResponse))
public:
Task<SingleSecretTx<BurnNftResponse^>^>^ BurnNft(
	MsgBurnNft^ msg, 
	Nullable<TxOptions^> txOptions
)

Parameters

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

Return Value

SingleSecretTx<BurnNftResponse>.