Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto
Class TokenCreateTransactionBody
java.lang.Object
com.google.protobuf.AbstractMessageLite<TokenCreateTransactionBody,TokenCreateTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite<TokenCreateTransactionBody,TokenCreateTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.TokenCreateTransactionBody
- All Implemented Interfaces:
com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,TokenCreateTransactionBodyOrBuilder
@Generated
public final class TokenCreateTransactionBody
extends com.google.protobuf.GeneratedMessageLite<TokenCreateTransactionBody,TokenCreateTransactionBody.Builder>
implements TokenCreateTransactionBodyOrBuilder
* Create an HTS token. #### Keys Each token has several keys that, separately, control different functions for that token. It is *_strongly_* recommended that each key assigned to a token be unique, or disabled by assigning an empty `KeyList`. Keys and purpose - `adminKey` is a general access and may authorize a token update transaction as well as _update the other keys_. Even the admin key cannot authorize _adding_ a key that is not present, however.<br/> The admin key may also delete the token entirely. - `fee_schedule` may authorize updating the token custom fees. If this key is not present, the custom fees for the token are fixed and immutable. - `freeze` may authorize a token freeze or unfreeze transaction. If this key is not present, accounts holding this token cannot have their tokens frozen or unfrozen. - `kyc` may authorize a token grant KYC or revoke KYC transaction. If this key is not present, accounts holding this token cannot have KYC status granted or revoked. - `metadata` may authorize token update nfts transactions. If this key is not present, the token metadata values for that non-fungible/unique token _type_ will be immutable. - `pause` may authorize a token pause or token unpause transaction. If this key is not present, the token cannot be paused (preventing any account from transacting in that token) or resumed. - `supply` may authorize a token mint or burn transaction. If this key is not present, the token cannot mint additional supply and existing tokens cannot be "burned" from the treasury (but _might_ still be "burned" from individual accounts, c.f. `wipeKey` and `tokenWipe`). - `wipe` may authorize a token wipe account transaction. If this key is not present, accounts holding this token cannot have their balance or NFTs wiped (effectively burned). #### Requirements If `tokenType` is fungible/common, the `initialSupply` MUST be strictly greater than zero(`0`).<br/> If `tokenType` is non-fungible/unique, the `initialSupply` MUST be zero(`0`).<br/> If `tokenSupplyType` is "infinite", the `maxSupply` MUST be zero(`0`).<br/> If `tokenSupplyType` is "finite", the `maxSupply` MUST be strictly greater than zero(`0`).<br/> ### Block Stream Effects If the token is created, the Token Identifier SHALL be in the receipt.<br/>Protobuf type
proto.TokenCreateTransactionBody-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class* Create an HTS token.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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFieldsFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionprotected final ObjectdynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) * An Hedera key for token administration.* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token.* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.getCustomFees(int index) * A list of custom fees representing a fee schedule.int* A list of custom fees representing a fee schedule.* A list of custom fees representing a fee schedule.getCustomFeesOrBuilder(int index) * A list of custom fees representing a fee schedule.List<? extends CustomFeeOrBuilder> * A list of custom fees representing a fee schedule.int* A decimal precision of the token's smallest denomination.<br/> Most values are described in terms of this smallest denomination, so the token initial supply, for instance, must be divided by <tt>10<sup>decimals</sup></tt> to get whole tokens.static TokenCreateTransactionBody* An expiration timestamp.* An Hedera key for managing the token custom fee schedule.boolean* An initial Freeze status for accounts associated to this token.* An Hedera key for managing asset "freeze".long* An initial supply, in the smallest denomination for the token.* An Hedera key for managing account KYC.long* A maximum supply for this token.getMemo()* A short description for this token.com.google.protobuf.ByteString* A short description for this token.com.google.protobuf.ByteString* Token "Metadata".* An Hedera key for managing the token `metadata`.getName()* A name for the token.<br/> This is generally the "full name" displayed in wallet software.com.google.protobuf.ByteString* A name for the token.<br/> This is generally the "full name" displayed in wallet software.* An Hedera key for managing token "pause".* An Hedera key for "minting" and "burning" tokens.* A supply type for this token, according to IWA classification.int* A supply type for this token, according to IWA classification.* A symbol to use for the token.com.google.protobuf.ByteString* A symbol to use for the token.* A type for this token, according to IWA classification.int* A type for this token, according to IWA classification.* A treasury account identifier.* An Hedera key for wiping tokens from accounts.boolean* An Hedera key for token administration.boolean* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token.boolean* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.boolean* An expiration timestamp.boolean* An Hedera key for managing the token custom fee schedule.boolean* An Hedera key for managing asset "freeze".boolean* An Hedera key for managing account KYC.boolean* An Hedera key for managing the token `metadata`.boolean* An Hedera key for managing token "pause".boolean* An Hedera key for "minting" and "burning" tokens.boolean* A treasury account identifier.boolean* An Hedera key for wiping tokens from accounts.newBuilder(TokenCreateTransactionBody prototype) static TokenCreateTransactionBodyparseDelimitedFrom(InputStream input) static TokenCreateTransactionBodyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenCreateTransactionBodyparseFrom(byte[] data) static TokenCreateTransactionBodyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenCreateTransactionBodyparseFrom(com.google.protobuf.ByteString data) static TokenCreateTransactionBodyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenCreateTransactionBodyparseFrom(com.google.protobuf.CodedInputStream input) static TokenCreateTransactionBodyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenCreateTransactionBodyparseFrom(InputStream input) static TokenCreateTransactionBodyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenCreateTransactionBodyparseFrom(ByteBuffer data) static TokenCreateTransactionBodyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TokenCreateTransactionBody> 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, writeToMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
SYMBOL_FIELD_NUMBER
public static final int SYMBOL_FIELD_NUMBER- See Also:
-
DECIMALS_FIELD_NUMBER
public static final int DECIMALS_FIELD_NUMBER- See Also:
-
INITIALSUPPLY_FIELD_NUMBER
public static final int INITIALSUPPLY_FIELD_NUMBER- See Also:
-
TREASURY_FIELD_NUMBER
public static final int TREASURY_FIELD_NUMBER- See Also:
-
ADMINKEY_FIELD_NUMBER
public static final int ADMINKEY_FIELD_NUMBER- See Also:
-
KYCKEY_FIELD_NUMBER
public static final int KYCKEY_FIELD_NUMBER- See Also:
-
FREEZEKEY_FIELD_NUMBER
public static final int FREEZEKEY_FIELD_NUMBER- See Also:
-
WIPEKEY_FIELD_NUMBER
public static final int WIPEKEY_FIELD_NUMBER- See Also:
-
SUPPLYKEY_FIELD_NUMBER
public static final int SUPPLYKEY_FIELD_NUMBER- See Also:
-
FREEZEDEFAULT_FIELD_NUMBER
public static final int FREEZEDEFAULT_FIELD_NUMBER- See Also:
-
EXPIRY_FIELD_NUMBER
public static final int EXPIRY_FIELD_NUMBER- See Also:
-
AUTORENEWACCOUNT_FIELD_NUMBER
public static final int AUTORENEWACCOUNT_FIELD_NUMBER- See Also:
-
AUTORENEWPERIOD_FIELD_NUMBER
public static final int AUTORENEWPERIOD_FIELD_NUMBER- See Also:
-
MEMO_FIELD_NUMBER
public static final int MEMO_FIELD_NUMBER- See Also:
-
TOKENTYPE_FIELD_NUMBER
public static final int TOKENTYPE_FIELD_NUMBER- See Also:
-
SUPPLYTYPE_FIELD_NUMBER
public static final int SUPPLYTYPE_FIELD_NUMBER- See Also:
-
MAXSUPPLY_FIELD_NUMBER
public static final int MAXSUPPLY_FIELD_NUMBER- See Also:
-
FEE_SCHEDULE_KEY_FIELD_NUMBER
public static final int FEE_SCHEDULE_KEY_FIELD_NUMBER- See Also:
-
CUSTOM_FEES_FIELD_NUMBER
public static final int CUSTOM_FEES_FIELD_NUMBER- See Also:
-
PAUSE_KEY_FIELD_NUMBER
public static final int PAUSE_KEY_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
METADATA_KEY_FIELD_NUMBER
public static final int METADATA_KEY_FIELD_NUMBER- See Also:
-
-
Method Details
-
getName
* A name for the token.<br/> This is generally the "full name" displayed in wallet software. <p> This field is REQUIRED.<br/> This value MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value MUST NOT contain the Unicode NUL codepoint.
string name = 1;- Specified by:
getNamein interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()* A name for the token.<br/> This is generally the "full name" displayed in wallet software. <p> This field is REQUIRED.<br/> This value MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value MUST NOT contain the Unicode NUL codepoint.
string name = 1;- Specified by:
getNameBytesin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The bytes for name.
-
getSymbol
* A symbol to use for the token. <p> This field is REQUIRED.<br/> This value MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value MUST NOT contain the Unicode NUL codepoint.
string symbol = 2;- Specified by:
getSymbolin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The symbol.
-
getSymbolBytes
public com.google.protobuf.ByteString getSymbolBytes()* A symbol to use for the token. <p> This field is REQUIRED.<br/> This value MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value MUST NOT contain the Unicode NUL codepoint.
string symbol = 2;- Specified by:
getSymbolBytesin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The bytes for symbol.
-
getDecimals
public int getDecimals()* A decimal precision of the token's smallest denomination.<br/> Most values are described in terms of this smallest denomination, so the token initial supply, for instance, must be divided by <tt>10<sup>decimals</sup></tt> to get whole tokens. <p> This MUST be zero(`0`) for non-fungible/unique tokens.
uint32 decimals = 3;- Specified by:
getDecimalsin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The decimals.
-
getInitialSupply
public long getInitialSupply()* An initial supply, in the smallest denomination for the token. <p> This amount SHALL be transferred to the treasury account as part of this transaction.<br/> This amount MUST be specified in the smallest denomination for the token (i.e. <tt>10<sup>-decimals</sup></tt> whole tokens).<br/> This MUST be zero(`0`) for a non-fungible/unique token.
uint64 initialSupply = 4;- Specified by:
getInitialSupplyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The initialSupply.
-
hasTreasury
public boolean hasTreasury()* A treasury account identifier. <p> This field is REQUIRED.<br/> The identified account SHALL be designated the "treasury" for the new token, and all tokens "minted" SHALL be delivered to that account, including the initial supply, if any.<br/> The identified account MUST exist, MUST NOT be expired, and SHOULD have a non-zero HBAR balance.<br/> The identified account SHALL be associated to the new token.
.proto.AccountID treasury = 5;- Specified by:
hasTreasuryin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the treasury field is set.
-
getTreasury
* A treasury account identifier. <p> This field is REQUIRED.<br/> The identified account SHALL be designated the "treasury" for the new token, and all tokens "minted" SHALL be delivered to that account, including the initial supply, if any.<br/> The identified account MUST exist, MUST NOT be expired, and SHOULD have a non-zero HBAR balance.<br/> The identified account SHALL be associated to the new token.
.proto.AccountID treasury = 5;- Specified by:
getTreasuryin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The treasury.
-
hasAdminKey
public boolean hasAdminKey()* An Hedera key for token administration. <p> This key, if set, SHALL have administrative authority for this token and MAY authorize token update and/or token delete transactions.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL be immutable, except for expiration and renewal.
.proto.Key adminKey = 6;- Specified by:
hasAdminKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the adminKey field is set.
-
getAdminKey
* An Hedera key for token administration. <p> This key, if set, SHALL have administrative authority for this token and MAY authorize token update and/or token delete transactions.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL be immutable, except for expiration and renewal.
.proto.Key adminKey = 6;- Specified by:
getAdminKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The adminKey.
-
hasKycKey
public boolean hasKycKey()* An Hedera key for managing account KYC. <p> This key, if set, SHALL have KYC authority for this token and MAY authorize transactions to grant or revoke KYC for accounts.<br/> If this key is not set, or is an empty `KeyList`, KYC status for this token SHALL NOT be granted or revoked for any account.<br/> If this key is removed after granting KYC, those grants SHALL remain and cannot be revoked.
.proto.Key kycKey = 7;- Specified by:
hasKycKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the kycKey field is set.
-
getKycKey
* An Hedera key for managing account KYC. <p> This key, if set, SHALL have KYC authority for this token and MAY authorize transactions to grant or revoke KYC for accounts.<br/> If this key is not set, or is an empty `KeyList`, KYC status for this token SHALL NOT be granted or revoked for any account.<br/> If this key is removed after granting KYC, those grants SHALL remain and cannot be revoked.
.proto.Key kycKey = 7;- Specified by:
getKycKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The kycKey.
-
hasFreezeKey
public boolean hasFreezeKey()* An Hedera key for managing asset "freeze". <p> This key, if set, SHALL have "freeze" authority for this token and MAY authorize transactions to freeze or unfreeze accounts with respect to this token.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL NOT be frozen or unfrozen for any account.<br/> If this key is removed after freezing accounts, those accounts SHALL remain frozen and cannot be unfrozen.
.proto.Key freezeKey = 8;- Specified by:
hasFreezeKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the freezeKey field is set.
-
getFreezeKey
* An Hedera key for managing asset "freeze". <p> This key, if set, SHALL have "freeze" authority for this token and MAY authorize transactions to freeze or unfreeze accounts with respect to this token.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL NOT be frozen or unfrozen for any account.<br/> If this key is removed after freezing accounts, those accounts SHALL remain frozen and cannot be unfrozen.
.proto.Key freezeKey = 8;- Specified by:
getFreezeKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The freezeKey.
-
hasWipeKey
public boolean hasWipeKey()* An Hedera key for wiping tokens from accounts. <p> This key, if set, SHALL have "wipe" authority for this token and MAY authorize transactions to "wipe" any amount of this token from any account, effectively burning the tokens "wiped".<br/> If this key is not set, or is an empty `KeyList`, it SHALL NOT be possible to "wipe" this token from an account.
.proto.Key wipeKey = 9;- Specified by:
hasWipeKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the wipeKey field is set.
-
getWipeKey
* An Hedera key for wiping tokens from accounts. <p> This key, if set, SHALL have "wipe" authority for this token and MAY authorize transactions to "wipe" any amount of this token from any account, effectively burning the tokens "wiped".<br/> If this key is not set, or is an empty `KeyList`, it SHALL NOT be possible to "wipe" this token from an account.
.proto.Key wipeKey = 9;- Specified by:
getWipeKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The wipeKey.
-
hasSupplyKey
public boolean hasSupplyKey()* An Hedera key for "minting" and "burning" tokens. <p> This key, if set, MAY authorize transactions to "mint" new tokens to be delivered to the token treasury or "burn" tokens held by the token treasury.<br/> If this key is not set, or is an empty `KeyList`, it SHALL NOT be possible to change the supply of tokens and neither "mint" nor "burn" transactions SHALL be permitted.
.proto.Key supplyKey = 10;- Specified by:
hasSupplyKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the supplyKey field is set.
-
getSupplyKey
* An Hedera key for "minting" and "burning" tokens. <p> This key, if set, MAY authorize transactions to "mint" new tokens to be delivered to the token treasury or "burn" tokens held by the token treasury.<br/> If this key is not set, or is an empty `KeyList`, it SHALL NOT be possible to change the supply of tokens and neither "mint" nor "burn" transactions SHALL be permitted.
.proto.Key supplyKey = 10;- Specified by:
getSupplyKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The supplyKey.
-
getFreezeDefault
public boolean getFreezeDefault()* An initial Freeze status for accounts associated to this token. <p> If this value is set, an account MUST be the subject of a `tokenUnfreeze` transaction after associating to the token before that account can send or receive this token.<br/> If this value is set, the `freezeKey` SHOULD be set.<br/> If the `freezeKey` is not set, any account associated to this token while this value is set SHALL be permanently frozen. <p> <blockquote>REVIEW NOTE<blockquote> Should we prevent setting this value true for tokens with no freeze key?<br/> Should we set this value to false if a freeze key is removed? </blockquote></blockquote>
bool freezeDefault = 11;- Specified by:
getFreezeDefaultin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The freezeDefault.
-
hasExpiry
public boolean hasExpiry()* An expiration timestamp. <p> If the `autoRenewAccount` and `autoRenewPeriod` fields are set, this value SHALL be replaced with the current consensus time extended by the `autoRenewPeriod` duration.<br/> If this value is set and token expiration is enabled in network configuration, this token SHALL expire when consensus time exceeds this value, and MAY be subsequently removed from the network state.<br/> If this value is not set, and the automatic renewal account is also not set, then this value SHALL default to the current consensus time extended by the "default" expiration period from network configuration.
.proto.Timestamp expiry = 13;- Specified by:
hasExpiryin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the expiry field is set.
-
getExpiry
* An expiration timestamp. <p> If the `autoRenewAccount` and `autoRenewPeriod` fields are set, this value SHALL be replaced with the current consensus time extended by the `autoRenewPeriod` duration.<br/> If this value is set and token expiration is enabled in network configuration, this token SHALL expire when consensus time exceeds this value, and MAY be subsequently removed from the network state.<br/> If this value is not set, and the automatic renewal account is also not set, then this value SHALL default to the current consensus time extended by the "default" expiration period from network configuration.
.proto.Timestamp expiry = 13;- Specified by:
getExpiryin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The expiry.
-
hasAutoRenewAccount
public boolean hasAutoRenewAccount()* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token. <p> If this value is set, the token lifetime SHALL be extended by the _smallest_ of the following: <ul> <li>The current `autoRenewPeriod` duration.</li> <li>The maximum duration that this account has funds to purchase.</li> <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic renewal.</li> </ul> If this account's HBAR balance is `0` when the token must be renewed, then the token SHALL be expired, and MAY be subsequently removed from state.<br/> If this value is set, the referenced account MUST sign this transaction.
.proto.AccountID autoRenewAccount = 14;- Specified by:
hasAutoRenewAccountin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the autoRenewAccount field is set.
-
getAutoRenewAccount
* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token. <p> If this value is set, the token lifetime SHALL be extended by the _smallest_ of the following: <ul> <li>The current `autoRenewPeriod` duration.</li> <li>The maximum duration that this account has funds to purchase.</li> <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic renewal.</li> </ul> If this account's HBAR balance is `0` when the token must be renewed, then the token SHALL be expired, and MAY be subsequently removed from state.<br/> If this value is set, the referenced account MUST sign this transaction.
.proto.AccountID autoRenewAccount = 14;- Specified by:
getAutoRenewAccountin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The autoRenewAccount.
-
hasAutoRenewPeriod
public boolean hasAutoRenewPeriod()* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger. This value sets the interval between such events for this token. <p> This value MUST be set.<br/> This value MUST be greater than the configured MIN_AUTORENEW_PERIOD.<br/> This value MUST be less than the configured MAX_AUTORENEW_PERIOD.
.proto.Duration autoRenewPeriod = 15;- Specified by:
hasAutoRenewPeriodin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the autoRenewPeriod field is set.
-
getAutoRenewPeriod
* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger. This value sets the interval between such events for this token. <p> This value MUST be set.<br/> This value MUST be greater than the configured MIN_AUTORENEW_PERIOD.<br/> This value MUST be less than the configured MAX_AUTORENEW_PERIOD.
.proto.Duration autoRenewPeriod = 15;- Specified by:
getAutoRenewPeriodin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The autoRenewPeriod.
-
getMemo
* A short description for this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 16;- Specified by:
getMemoin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The memo.
-
getMemoBytes
public com.google.protobuf.ByteString getMemoBytes()* A short description for this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 16;- Specified by:
getMemoBytesin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The bytes for memo.
-
getTokenTypeValue
public int getTokenTypeValue()* A type for this token, according to IWA classification. <p> If this value is not set, the token SHALL have the default type of fungible/common.<br/> This field SHALL be immutable.
.proto.TokenType tokenType = 17;- Specified by:
getTokenTypeValuein interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The enum numeric value on the wire for tokenType.
-
getTokenType
* A type for this token, according to IWA classification. <p> If this value is not set, the token SHALL have the default type of fungible/common.<br/> This field SHALL be immutable.
.proto.TokenType tokenType = 17;- Specified by:
getTokenTypein interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The tokenType.
-
getSupplyTypeValue
public int getSupplyTypeValue()* A supply type for this token, according to IWA classification. <p> If this value is not set, the token SHALL have the default supply type of "infinite" (which is, as a practical matter, (2<sup><i>63</i></sup>-1)/10<sup><i>decimals</i></sup>).<br/> This field SHALL be immutable.
.proto.TokenSupplyType supplyType = 18;- Specified by:
getSupplyTypeValuein interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The enum numeric value on the wire for supplyType.
-
getSupplyType
* A supply type for this token, according to IWA classification. <p> If this value is not set, the token SHALL have the default supply type of "infinite" (which is, as a practical matter, (2<sup><i>63</i></sup>-1)/10<sup><i>decimals</i></sup>).<br/> This field SHALL be immutable.
.proto.TokenSupplyType supplyType = 18;- Specified by:
getSupplyTypein interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The supplyType.
-
getMaxSupply
public long getMaxSupply()* A maximum supply for this token. <p> This SHALL be interpreted in terms of the smallest fractional unit for this token.<br/> If `supplyType` is "infinite", this MUST be `0`.<br/> This field SHALL be immutable.
int64 maxSupply = 19;- Specified by:
getMaxSupplyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The maxSupply.
-
hasFeeScheduleKey
public boolean hasFeeScheduleKey()* An Hedera key for managing the token custom fee schedule. <p> This key, if set, MAY authorize transactions to modify the `custom_fees` for this token.<br/> If this key is not set, or is an empty `KeyList`, the `custom_fees` for this token SHALL NOT be modified.
.proto.Key fee_schedule_key = 20;- Specified by:
hasFeeScheduleKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the feeScheduleKey field is set.
-
getFeeScheduleKey
* An Hedera key for managing the token custom fee schedule. <p> This key, if set, MAY authorize transactions to modify the `custom_fees` for this token.<br/> If this key is not set, or is an empty `KeyList`, the `custom_fees` for this token SHALL NOT be modified.
.proto.Key fee_schedule_key = 20;- Specified by:
getFeeScheduleKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The feeScheduleKey.
-
getCustomFeesList
* A list of custom fees representing a fee schedule. <p> This list MAY be empty, which SHALL mean that there are no custom fees for this token.<br/> If this token is a non-fungible/unique type, the entries in this list MUST NOT declare a `fractional_fee`.<br/> If this token is a fungible/common type, the entries in this list MUST NOT declare a `royalty_fee`.<br/> Any token type MAY include entries that declare a `fixed_fee`.
repeated .proto.CustomFee custom_fees = 21;- Specified by:
getCustomFeesListin interfaceTokenCreateTransactionBodyOrBuilder
-
getCustomFeesOrBuilderList
* A list of custom fees representing a fee schedule. <p> This list MAY be empty, which SHALL mean that there are no custom fees for this token.<br/> If this token is a non-fungible/unique type, the entries in this list MUST NOT declare a `fractional_fee`.<br/> If this token is a fungible/common type, the entries in this list MUST NOT declare a `royalty_fee`.<br/> Any token type MAY include entries that declare a `fixed_fee`.
repeated .proto.CustomFee custom_fees = 21; -
getCustomFeesCount
public int getCustomFeesCount()* A list of custom fees representing a fee schedule. <p> This list MAY be empty, which SHALL mean that there are no custom fees for this token.<br/> If this token is a non-fungible/unique type, the entries in this list MUST NOT declare a `fractional_fee`.<br/> If this token is a fungible/common type, the entries in this list MUST NOT declare a `royalty_fee`.<br/> Any token type MAY include entries that declare a `fixed_fee`.
repeated .proto.CustomFee custom_fees = 21;- Specified by:
getCustomFeesCountin interfaceTokenCreateTransactionBodyOrBuilder
-
getCustomFees
* A list of custom fees representing a fee schedule. <p> This list MAY be empty, which SHALL mean that there are no custom fees for this token.<br/> If this token is a non-fungible/unique type, the entries in this list MUST NOT declare a `fractional_fee`.<br/> If this token is a fungible/common type, the entries in this list MUST NOT declare a `royalty_fee`.<br/> Any token type MAY include entries that declare a `fixed_fee`.
repeated .proto.CustomFee custom_fees = 21;- Specified by:
getCustomFeesin interfaceTokenCreateTransactionBodyOrBuilder
-
getCustomFeesOrBuilder
* A list of custom fees representing a fee schedule. <p> This list MAY be empty, which SHALL mean that there are no custom fees for this token.<br/> If this token is a non-fungible/unique type, the entries in this list MUST NOT declare a `fractional_fee`.<br/> If this token is a fungible/common type, the entries in this list MUST NOT declare a `royalty_fee`.<br/> Any token type MAY include entries that declare a `fixed_fee`.
repeated .proto.CustomFee custom_fees = 21; -
hasPauseKey
public boolean hasPauseKey()* An Hedera key for managing token "pause". <p> This key, if set, SHALL have "pause" authority for this token and MAY authorize transactions to pause or unpause this token.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL NOT be paused or unpaused.<br/> If this key is removed while the token is paused, the token cannot be unpaused and SHALL remain paused.
.proto.Key pause_key = 22;- Specified by:
hasPauseKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the pauseKey field is set.
-
getPauseKey
* An Hedera key for managing token "pause". <p> This key, if set, SHALL have "pause" authority for this token and MAY authorize transactions to pause or unpause this token.<br/> If this key is not set, or is an empty `KeyList`, this token SHALL NOT be paused or unpaused.<br/> If this key is removed while the token is paused, the token cannot be unpaused and SHALL remain paused.
.proto.Key pause_key = 22;- Specified by:
getPauseKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The pauseKey.
-
getMetadata
public com.google.protobuf.ByteString getMetadata()* Token "Metadata". <p> The value, if set, MUST NOT exceed 100 bytes.<br/> <dl><dt>Examples</dt> <dd>hcs://1/0.0.4896575</dd> <dd>ipfs://bafkreifd7tcjjuwxxf4qkaibkj62pj4mhfuud7plwrc3pfoygt55al6syi</dd> </dl>
bytes metadata = 23;- Specified by:
getMetadatain interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The metadata.
-
hasMetadataKey
public boolean hasMetadataKey()* An Hedera key for managing the token `metadata`. <p> This key, if set, MAY authorize transactions to modify the `metadata` for this token.<br/> If this key is not set, or is an empty `KeyList`, the `metadata` for this token SHALL NOT be modified.
.proto.Key metadata_key = 24;- Specified by:
hasMetadataKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- Whether the metadataKey field is set.
-
getMetadataKey
* An Hedera key for managing the token `metadata`. <p> This key, if set, MAY authorize transactions to modify the `metadata` for this token.<br/> If this key is not set, or is an empty `KeyList`, the `metadata` for this token SHALL NOT be modified.
.proto.Key metadata_key = 24;- Specified by:
getMetadataKeyin interfaceTokenCreateTransactionBodyOrBuilder- Returns:
- The metadataKey.
-
parseFrom
public static TokenCreateTransactionBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TokenCreateTransactionBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static TokenCreateTransactionBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethodin classcom.google.protobuf.GeneratedMessageLite<TokenCreateTransactionBody,TokenCreateTransactionBody.Builder>
-
getDefaultInstance
-
parser
-