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

Class TokenWipeAccountTransactionBody

java.lang.Object
com.google.protobuf.AbstractMessageLite<TokenWipeAccountTransactionBody,TokenWipeAccountTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite<TokenWipeAccountTransactionBody,TokenWipeAccountTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.TokenWipeAccountTransactionBody
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, TokenWipeAccountTransactionBodyOrBuilder
@Generated public final class TokenWipeAccountTransactionBody extends com.google.protobuf.GeneratedMessageLite<TokenWipeAccountTransactionBody,TokenWipeAccountTransactionBody.Builder> implements TokenWipeAccountTransactionBodyOrBuilder
 *
 Wipe (administratively burn) tokens held by a non-treasury account.<br/>
 On success, the requested tokens will be removed from the identified account
 and the token supply will be reduced by the amount "wiped".

 This transaction MUST be signed by the token `wipe_key`.<br/>
 The identified token MUST exist, MUST NOT be deleted,
 and MUST NOT be paused.<br/>
 The identified token MUST have a valid `Key` set for the `wipe_key` field,
 and that key MUST NOT be an empty `KeyList`.<br/>
 The identified account MUST exist, MUST NOT be deleted, MUST be
 associated to the identified token, MUST NOT be frozen for the identified
 token, MUST NOT be the token `treasury`, and MUST hold a balance for the
 token or the specific serial numbers provided.<br/>
 This transaction SHOULD provide a value for `amount` or `serialNumbers`,
 but MUST NOT set both fields.

 ### Block Stream Effects
 The new total supply for the wiped token type SHALL be recorded.
Protobuf type proto.TokenWipeAccountTransactionBody

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TokenWipeAccountTransactionBody.Builder
    * Wipe (administratively burn) tokens held by a non-treasury account.<br/> On success, the requested tokens will be removed from the identified account and the token supply will be reduced by the amount "wiped".

    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
    ACCOUNT_FIELD_NUMBER
     
    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)
     
    AccountID
    getAccount()
    * An account identifier.<br/> This identifies the account from which tokens will be wiped.
    long
    getAmount()
    * An amount of fungible/common tokens to wipe.
    static TokenWipeAccountTransactionBody
    getDefaultInstance()
     
    long
    getSerialNumbers(int index)
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    int
    getSerialNumbersCount()
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    List<Long>
    getSerialNumbersList()
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    TokenID
    getToken()
    * A token identifier.
    boolean
    hasAccount()
    * An account identifier.<br/> This identifies the account from which tokens will be wiped.
    boolean
    hasToken()
    * A token identifier.
    static TokenWipeAccountTransactionBody.Builder
    newBuilder()
     
    static TokenWipeAccountTransactionBody.Builder
    newBuilder(TokenWipeAccountTransactionBody prototype)
     
    static TokenWipeAccountTransactionBody
    parseDelimitedFrom(InputStream input)
     
    static TokenWipeAccountTransactionBody
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenWipeAccountTransactionBody
    parseFrom(byte[] data)
     
    static TokenWipeAccountTransactionBody
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenWipeAccountTransactionBody
    parseFrom(com.google.protobuf.ByteString data)
     
    static TokenWipeAccountTransactionBody
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenWipeAccountTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TokenWipeAccountTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenWipeAccountTransactionBody
    parseFrom(InputStream input)
     
    static TokenWipeAccountTransactionBody
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TokenWipeAccountTransactionBody
    parseFrom(ByteBuffer data)
     
    static TokenWipeAccountTransactionBody
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TokenWipeAccountTransactionBody>
    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 field is REQUIRED.<br/>
 The identified token MUST exist, MUST NOT be paused, MUST NOT be
 deleted, and MUST NOT be expired.
      .proto.TokenID token = 1;
      Specified by:
      hasToken in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      Whether the token field is set.

    • getToken

      public TokenID getToken()
       *
 A token identifier.
 <p>
 This field is REQUIRED.<br/>
 The identified token MUST exist, MUST NOT be paused, MUST NOT be
 deleted, and MUST NOT be expired.
      .proto.TokenID token = 1;
      Specified by:
      getToken in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      The token.

    • hasAccount

      public boolean hasAccount()
       *
 An account identifier.<br/>
 This identifies the account from which tokens will be wiped.
 <p>
 This field is REQUIRED.<br/>
 The identified account MUST NOT be deleted or expired.<br/>
 If the identified token `kyc_key` is set to a valid key, the
 identified account MUST have "KYC" granted.<br/>
 The identified account MUST NOT be the `treasury` account for the
 identified token.
      .proto.AccountID account = 2;
      Specified by:
      hasAccount in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      Whether the account field is set.

    • getAccount

      public AccountID getAccount()
       *
 An account identifier.<br/>
 This identifies the account from which tokens will be wiped.
 <p>
 This field is REQUIRED.<br/>
 The identified account MUST NOT be deleted or expired.<br/>
 If the identified token `kyc_key` is set to a valid key, the
 identified account MUST have "KYC" granted.<br/>
 The identified account MUST NOT be the `treasury` account for the
 identified token.
      .proto.AccountID account = 2;
      Specified by:
      getAccount in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      The account.

    • getAmount

      public long getAmount()
       *
 An amount of fungible/common tokens to wipe.
 <p>
 If the identified token is a non-fungible/unique token type,
 this value MUST be exactly zero(`0`).<br/>
 If the identified token type is fungible/common:
 <ul>
 <li>This value SHALL be specified in units of the smallest
 denomination possible for the identified token
 (<tt>10<sup>-decimals</sup></tt> whole tokens).</li>
 <li>This value MUST be strictly less than `Long.MAX_VALUE`.</li>
 <li>This value MUST be less than or equal to the current total
 supply for the identified token.</li>
 <li>This value MUST be less than or equal to the current balance
 held by the identified account.</li>
 <li>This value MAY be zero(`0`).</li>
 </ul>
      uint64 amount = 3;
      Specified by:
      getAmount in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      The amount.

    • getSerialNumbersList

      public List<Long> getSerialNumbersList()
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Specified by:
      getSerialNumbersList in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      A list containing the serialNumbers.

    • getSerialNumbersCount

      public int getSerialNumbersCount()
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Specified by:
      getSerialNumbersCount in interface TokenWipeAccountTransactionBodyOrBuilder
      Returns:
      The count of serialNumbers.

    • getSerialNumbers

      public long getSerialNumbers(int index)
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Specified by:
      getSerialNumbers in interface TokenWipeAccountTransactionBodyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The serialNumbers at the given index.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static TokenWipeAccountTransactionBody.Builder newBuilder()

    • newBuilder

      public static TokenWipeAccountTransactionBody.Builder newBuilder(TokenWipeAccountTransactionBody 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<TokenWipeAccountTransactionBody,TokenWipeAccountTransactionBody.Builder>

    • getDefaultInstance

      public static TokenWipeAccountTransactionBody getDefaultInstance()

    • parser

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