Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Class TokenBurnTransactionBody

java.lang.Object
com.google.protobuf.AbstractMessageLite<TokenBurnTransactionBody,TokenBurnTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite<TokenBurnTransactionBody,TokenBurnTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.TokenBurnTransactionBody
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, TokenBurnTransactionBodyOrBuilder
@Generated public final class TokenBurnTransactionBody extends com.google.protobuf.GeneratedMessageLite<TokenBurnTransactionBody,TokenBurnTransactionBody.Builder> implements TokenBurnTransactionBodyOrBuilder
 *
 Burns tokens from the Token's treasury Account.

 The token MUST have a `supply_key` set and that key MUST NOT
 be an empty `KeyList`.<br/>
 The token `supply_key` MUST sign this transaction.<br/>
 This operation SHALL decrease the total supply for the token type by
 the number of tokens "burned".<br/>
 The total supply for the token type MUST NOT be reduced below zero (`0`)
 by this transaction.<br/>
 The tokens to burn SHALL be deducted from the token treasury account.<br/>
 If the token is a fungible/common type, the amount MUST be specified.<br/>
 If the token is a non-fungible/unique type, the specific serial numbers
 MUST be specified.<br/>
 The global batch size limit (`tokens.nfts.maxBatchSizeBurn`) SHALL set
 the maximum number of individual NFT serial numbers permitted in a single
 `tokenBurn` transaction.

 ### Block Stream Effects
 None
Protobuf type proto.TokenBurnTransactionBody

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TokenBurnTransactionBody.Builder
    * Burns tokens from the Token's treasury Account.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AMOUNT_FIELD_NUMBER
     
    static final int
    SERIALNUMBERS_FIELD_NUMBER
     
    static final int
    TOKEN_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    long
    getAmount()
    * An amount to burn from the Treasury Account.
    static TokenBurnTransactionBody
    getDefaultInstance()
     
    long
    getSerialNumbers(int index)
    * A list of serial numbers to burn from the Treasury Account.
    int
    getSerialNumbersCount()
    * A list of serial numbers to burn from the Treasury Account.
    List<Long>
    getSerialNumbersList()
    * A list of serial numbers to burn from the Treasury Account.
    TokenID
    getToken()
    * A token identifier.
    boolean
    hasToken()
    * A token identifier.
    static TokenBurnTransactionBody.Builder
    newBuilder()
     
    static TokenBurnTransactionBody.Builder
    newBuilder(TokenBurnTransactionBody prototype)
     
    static TokenBurnTransactionBody
    parseDelimitedFrom(InputStream input)
     
    static TokenBurnTransactionBody
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenBurnTransactionBody
    parseFrom(byte[] data)
     
    static TokenBurnTransactionBody
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenBurnTransactionBody
    parseFrom(com.google.protobuf.ByteString data)
     
    static TokenBurnTransactionBody
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenBurnTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TokenBurnTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenBurnTransactionBody
    parseFrom(InputStream input)
     
    static TokenBurnTransactionBody
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenBurnTransactionBody
    parseFrom(ByteBuffer data)
     
    static TokenBurnTransactionBody
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TokenBurnTransactionBody>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • hasToken

      public boolean hasToken()
       *
 A token identifier.
 <p>
 This SHALL identify the token type to "burn".<br/>
 The identified token MUST exist, and MUST NOT be deleted.
      .proto.TokenID token = 1;
      Specified by:
      hasToken in interface TokenBurnTransactionBodyOrBuilder
      Returns:
      Whether the token field is set.

    • getToken

      public TokenID getToken()
       *
 A token identifier.
 <p>
 This SHALL identify the token type to "burn".<br/>
 The identified token MUST exist, and MUST NOT be deleted.
      .proto.TokenID token = 1;
      Specified by:
      getToken in interface TokenBurnTransactionBodyOrBuilder
      Returns:
      The token.

    • getAmount

      public long getAmount()
       *
 An amount to burn from the Treasury Account.
 <p>
 This is interpreted as an amount in the smallest possible denomination
 for the token (10<sup>-decimals</sup> whole tokens).<br/>
 The balance for the token treasury account MUST contain sufficient
 tokens to complete this transaction with a non-negative balance.<br/>
 If this value is equal to zero (`0`), the token SHOULD be a
 non-fungible/unique type.<br/>
 If this value is non-zero, the token MUST be a fungible/common type.
      uint64 amount = 2;
      Specified by:
      getAmount in interface TokenBurnTransactionBodyOrBuilder
      Returns:
      The amount.

    • getSerialNumbersList

      public List<Long> getSerialNumbersList()
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Specified by:
      getSerialNumbersList in interface TokenBurnTransactionBodyOrBuilder
      Returns:
      A list containing the serialNumbers.

    • getSerialNumbersCount

      public int getSerialNumbersCount()
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Specified by:
      getSerialNumbersCount in interface TokenBurnTransactionBodyOrBuilder
      Returns:
      The count of serialNumbers.

    • getSerialNumbers

      public long getSerialNumbers(int index)
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Specified by:
      getSerialNumbers in interface TokenBurnTransactionBodyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The serialNumbers at the given index.

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TokenBurnTransactionBody parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TokenBurnTransactionBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenBurnTransactionBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static TokenBurnTransactionBody.Builder newBuilder()

    • newBuilder

      public static TokenBurnTransactionBody.Builder newBuilder(TokenBurnTransactionBody prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<TokenBurnTransactionBody,TokenBurnTransactionBody.Builder>

    • getDefaultInstance

      public static TokenBurnTransactionBody getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TokenBurnTransactionBody> parser()