Interface NfTokenBurn

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableNfTokenBurn

@Immutable public interface NfTokenBurn extends Transaction
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.

  • Method Details

    • builder

      static ImmutableNfTokenBurn.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableNfTokenBurn.Builder.
    • account

      Address account()
      Indicates the Address of 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 in AccountSet set as the address of the issuer.
      Specified by:
      account in interface Transaction
      Returns:
      An Address of 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

      Optional<Address> owner()
      Indicates the Address of 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 Address of the account that owns the NFToken specified by TokenID.
    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this NfTokenBurn, which only allows the tfFullyCanonicalSig flag, 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.