/** * ## Token * Tokens represent both fungible and non-fungible units of exchange. * The `Token` here represents a token within the network state. * * ### Keywords * The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", * "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this * document are to be interpreted as described in [RFC2119](https://www.ietf.org/rfc/rfc2119) * and clarified in [RFC8174](https://www.ietf.org/rfc/rfc8174). */ syntax = "proto3"; package proto; // SPDX-License-Identifier: Apache-2.0 import "services_basic_types.proto"; import "services_custom_fees.proto"; option java_package = "com.hederahashgraph.api.proto.java"; // <<>> This comment is special code for setting PBJ Compiler java package option java_multiple_files = true; /** * An Hedera Token Service(HTS) token. * * A token SHALL represent a fungible or non-fungible unit of exchange.
* The specified Treasury Account SHALL receive the initial supply of tokens and * SHALL determine distribution of all tokens once minted. * */ message Token { /** * A unique identifier for this token. */ TokenID token_id = 1; /** * A human-readable name for this token. *

* This value MAY NOT be unique.
* This value SHALL NOT exceed 100 bytes when encoded as UTF-8. */ string name = 2; /** * A human-readable symbol for the token. *

* This value SHALL NOT be unique.
* This value SHALL NOT exceed 100 bytes when encoded as UTF-8. */ string symbol = 3; /** * A number of decimal places for this token. *

* If decimals are 8 or 11, then the number of whole tokens can be at most * billions or millions, respectively. More decimals allows for a more * finely-divided token, but also limits the maximum total supply. *

* Examples *

* All token amounts in the network are stored as integer amounts, with each * unit representing 10-decimals whole tokens. *

* For tokens with `token_type` set to `NON_FUNGIBLE_UNIQUE` this MUST be 0. */ int32 decimals = 4; /** * A _current_ total supply of this token, expressed in the smallest unit * of the token. *

* The number of _whole_ tokens this represents is (total_supply / * 10decimals). The value of total supply, MUST be within the * positive range of a twos-compliment signed 64-bit integer. * The `total_supply`, therefore MUST be between 1, and * 9,223,372,036,854,775,807, inclusive. *

* This value SHALL be reduced when a `token_burn` or `token_wipe_account` * operation is executed, and SHALL be increased when a `token_mint` * operation is executed. */ int64 total_supply = 5; /** * A treasury account identifier for this token. *

* When the token is created, the initial supply given in the token create * transaction SHALL be minted and deposited in the treasury account.
* All token mint transactions for this token SHALL deposit the new minted * tokens in the treasury account.
* All token burn transactions for this token SHALL remove the tokens to be * burned from the treasury account. */ AccountID treasury_account_id = 6; /** * Access control for general modification of this token. *

* This key MUST sign any `token_update` transaction that * changes any attribute of the token other than expiration_time. * Other attributes of this token MAY be changed by transactions other than * `token_update`, and MUST be signed by one of the other purpose-specific * keys assigned to the token.
* This value can be set during token creation, and SHALL NOT be * modified thereafter, unless the update transaction is signed by both * the existing `admin_key` and the new `admin_key`.
* If the `admin_key` is not set for a token, that token SHALL be immutable. */ Key admin_key = 7; /** * Access control for KYC for this token. *

* Know Your Customer (KYC) status may be granted for an account by a token * grant kyc transaction signed by this key.
* If this key is not set, then KYC status cannot be granted to an account * for this token, and any `TokenGrantKyc` transaction attempting to grant * kyc to an account for this token SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key kyc_key = 8; /** * Access control to freeze this token. *

* A token may be frozen for an account, preventing any transaction from * transferring that token for that specified account, by a token freeze * account transaction signed by this key.
* If this key is not set, the token cannot be frozen, and any transaction * attempting to freeze the token for an account SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key freeze_key = 9; /** * Access control of account wipe for this token. *

* A token may be wiped, removing and burning tokens from a specific * account, by a token wipe transaction, which MUST be signed by this key. * The `treasury_account` cannot be subjected to a token wipe. A token burn * transaction, signed by the `supply_key`, serves to burn tokens held by * the `treasury_account` instead.
* If this key is not set, the token cannot be wiped, and any transaction * attempting to wipe the token from an account SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key wipe_key = 10; /** * Access control of token mint/burn for this token. *

* A token mint transaction MUST be signed by this key, and any token mint * transaction not signed by the current `supply_key` for that token * SHALL NOT succeed.
* A token burn transaction MUST be signed by this key, and any token burn * transaction not signed by the current `supply_key` for that token * SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key supply_key = 11; /** * Access control of the `custom_fees` field for this token. *

* The token custom fee schedule may be changed, modifying the fees charged * for transferring that token, by a token update transaction, which MUST * be signed by this key.
* If this key is not set, the token custom fee schedule cannot be changed, * and any transaction attempting to change the custom fee schedule for * this token SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key fee_schedule_key = 12; /** * Access control of pause/unpause for this token. *

* A token may be paused, preventing any transaction from transferring that * token, by a token update transaction signed by this key.
* If this key is not set, the token cannot be paused, and any transaction * attempting to pause the token SHALL NOT succeed.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key pause_key = 13; /** * A last used serial number for this token. *

* This SHALL apply only to non-fungible tokens.
* When a new NFT is minted, the serial number to apply SHALL be calculated * from this value. */ int64 last_used_serial_number = 14; /** * A flag indicating that this token is deleted. *

* A transaction involving a deleted token MUST NOT succeed. */ bool deleted = 15; /** * A type for this token. *

* A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.
* If this value was omitted during token creation, `FUNGIBLE_COMMON` * SHALL be used. */ TokenType token_type = 16; /** * A supply type for this token. *

* A token SHALL have either `INFINITE` or `FINITE` supply type.
* If this value was omitted during token creation, the value `INFINITE` * SHALL be used. */ TokenSupplyType supply_type = 17; /** * An identifier for the account (if any) that the network will attempt * to charge for this token's auto-renewal upon expiration. *

* This field is OPTIONAL. If it is not set then renewal fees SHALL be * charged to the account identified by `treasury_account_id`. */ AccountID auto_renew_account_id = 18; /** * A number of seconds by which the network should automatically extend * this token's expiration. *

* If the token has a valid auto-renew account, and is not deleted upon * expiration, the network SHALL attempt to automatically renew this * token.
* If this is not provided in an allowed range on token creation, the * transaction SHALL fail with `INVALID_AUTO_RENEWAL_PERIOD`.
* The default values for the minimum period and maximum period are 30 days * and 90 days, respectively. */ int64 auto_renew_seconds = 19; /** * An expiration time for this token, in seconds since the epoch. *

* For this purpose, `epoch` SHALL be the * UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`. */ int64 expiration_second = 20; /** * A short description of this token. *

* This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` * (default 100) bytes when encoded as UTF-8. */ string memo = 21; /** * A maximum supply of this token.
* This is the maximum number of tokens of this type that may be issued. *

* This limit SHALL apply regardless of `token_type`.
* If `supply_type` is `INFINITE` then this value MUST be 0.
* If `supply_type` is `FINITE`, then this value MUST be greater than 0. */ int64 max_supply = 22; /** * A flag indicating that this token is paused. *

* A transaction involving a paused token, other than token_unpause, * MUST NOT succeed. */ bool paused = 23; /** * A flag indicating that accounts associated to this token are frozen by * default. *

* Accounts newly associated with this token CANNOT transact in the token * until unfrozen.
* This SHALL NOT prevent a `tokenReject` transaction to return the tokens * from an account to the treasury account. */ bool accounts_frozen_by_default = 24; /** * A flag indicating that accounts associated with this token are granted * KYC by default. */ bool accounts_kyc_granted_by_default = 25; /** * A custom fee schedule for this token. */ repeated CustomFee custom_fees = 26; /** * A Token "Metadata". *

* This value, if set, SHALL NOT exceed 100 bytes. */ bytes metadata = 27; /** * Access Control of metadata update for this token. *

* A transaction to update the `metadata` field of this token MUST be * signed by this key.
* If this token is a non-fungible/unique token type, a transaction to * update the `metadata` field of any individual serialized unique token * of this type MUST be signed by this key.
* If this key is not set, the token metadata SHALL NOT be changed after it * is created.
* If this key is not set, the metadata for any individual serialized token * of this type SHALL NOT be changed after it is created.
* This key MAY be set when the token is created, and MAY be set or modified * via a token update transaction signed by the `admin_key`.
* If `admin_key` is not set, this value, whether set or unset, * SHALL be immutable. */ Key metadata_key = 28; }