Interface NfTokenBurn
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableNfTokenBurn
The
NfTokenBurn transaction is used to remove an NfToken object from the
NfTokenPage in which it is being held, effectively removing the token from
the ledger ("burning" it).
If this operation succeeds, the corresponding NfToken is removed. If this operation empties the NfTokenPage holding the NfToken or results in the consolidation, thus removing an NfTokenPage, the owner’s reserve requirement is reduced by one.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionaccount()Indicates theAddressof the account that submitted this transaction.static ImmutableNfTokenBurn.Builderbuilder()Construct a builder for this class.default TransactionFlagsflags()Set ofTransactionFlagss for thisNfTokenBurn, which only allows thetfFullyCanonicalSigflag, which is deprecated.Identifies the NfToken object to be removed by the transaction.owner()Indicates theAddressof the account that owns the NFToken if it is different than the Account field.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableNfTokenBurn.Builder.
-
account
Address account()Indicates theAddressof the account that submitted this transaction. The account MUST be either the present owner of the token or, if the lsfBurnable flag is set in the NfToken, either the issuer account or an account authorized by the issuer, i.e. Minter field inAccountSetset as the address of the issuer.- Specified by:
accountin interfaceTransaction- Returns:
- An
Addressof the account initiating the burning of the NfToken.
-
nfTokenId
NfTokenId nfTokenId()Identifies the NfToken object to be removed by the transaction.- Returns:
- The TokenID of the NfToken to be burned.
-
owner
Indicates theAddressof the account that owns the NFToken if it is different than the Account field. Only used to burn tokens which have the lsfBurnable flag enabled and are not owned by the signing account.- Returns:
- An
Addressof the account that owns the NFToken specified by TokenID.
-
flags
Set ofTransactionFlagss for thisNfTokenBurn, which only allows thetfFullyCanonicalSigflag, which is deprecated.The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.
- Returns:
- Always
TransactionFlags.EMPTY.
-