com.hedera.hashgraph.sdk.proto.TokenOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: token.proto
// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;
public interface TokenOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.Token)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The unique entity id of this token.
*
*
* .proto.TokenID token_id = 1;
* @return Whether the tokenId field is set.
*/
boolean hasTokenId();
/**
*
**
* The unique entity id of this token.
*
*
* .proto.TokenID token_id = 1;
* @return The tokenId.
*/
com.hedera.hashgraph.sdk.proto.TokenID getTokenId();
/**
*
**
* The unique entity id of this token.
*
*
* .proto.TokenID token_id = 1;
*/
com.hedera.hashgraph.sdk.proto.TokenIDOrBuilder getTokenIdOrBuilder();
/**
*
**
* The human-readable name of this token. Need not be unique. Maximum length allowed is 100 bytes.
*
*
* string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
*
**
* The human-readable name of this token. Need not be unique. Maximum length allowed is 100 bytes.
*
*
* string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
**
* The human-readable symbol for the token. It is not necessarily unique. Maximum length allowed is 100 bytes.
*
*
* string symbol = 3;
* @return The symbol.
*/
java.lang.String getSymbol();
/**
*
**
* The human-readable symbol for the token. It is not necessarily unique. Maximum length allowed is 100 bytes.
*
*
* string symbol = 3;
* @return The bytes for symbol.
*/
com.google.protobuf.ByteString
getSymbolBytes();
/**
*
**
* The number of decimal places of this token. If decimals are 8 or 11, then the number of whole
* tokens can be at most a few billions or millions, respectively. For example, it could match
* Bitcoin (21 million whole tokens with 8 decimals) or hbars (50 billion whole tokens with 8 decimals).
* It could even match Bitcoin with milli-satoshis (21 million whole tokens with 11 decimals).
*
*
* int32 decimals = 4;
* @return The decimals.
*/
int getDecimals();
/**
*
**
* The total supply of this token.
*
*
* int64 total_supply = 5;
* @return The totalSupply.
*/
long getTotalSupply();
/**
*
**
* The treasury account id of this token. This account receives the initial supply of
* tokens as well as the tokens from the Token Mint operation once executed. The balance
* of the treasury account is decreased when the Token Burn operation is executed.
*
*
* .proto.AccountID treasury_account_id = 6;
* @return Whether the treasuryAccountId field is set.
*/
boolean hasTreasuryAccountId();
/**
*
**
* The treasury account id of this token. This account receives the initial supply of
* tokens as well as the tokens from the Token Mint operation once executed. The balance
* of the treasury account is decreased when the Token Burn operation is executed.
*
*
* .proto.AccountID treasury_account_id = 6;
* @return The treasuryAccountId.
*/
com.hedera.hashgraph.sdk.proto.AccountID getTreasuryAccountId();
/**
*
**
* The treasury account id of this token. This account receives the initial supply of
* tokens as well as the tokens from the Token Mint operation once executed. The balance
* of the treasury account is decreased when the Token Burn operation is executed.
*
*
* .proto.AccountID treasury_account_id = 6;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getTreasuryAccountIdOrBuilder();
/**
*
**
* (Optional) The admin key of this token. If this key is set, the token is mutable.
* A mutable token can be modified.
* If this key is not set on token creation, it cannot be modified.
*
*
* .proto.Key admin_key = 7;
* @return Whether the adminKey field is set.
*/
boolean hasAdminKey();
/**
*
**
* (Optional) The admin key of this token. If this key is set, the token is mutable.
* A mutable token can be modified.
* If this key is not set on token creation, it cannot be modified.
*
*
* .proto.Key admin_key = 7;
* @return The adminKey.
*/
com.hedera.hashgraph.sdk.proto.Key getAdminKey();
/**
*
**
* (Optional) The admin key of this token. If this key is set, the token is mutable.
* A mutable token can be modified.
* If this key is not set on token creation, it cannot be modified.
*
*
* .proto.Key admin_key = 7;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getAdminKeyOrBuilder();
/**
*
**
* (Optional) The kyc key of this token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key kyc_key = 8;
* @return Whether the kycKey field is set.
*/
boolean hasKycKey();
/**
*
**
* (Optional) The kyc key of this token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key kyc_key = 8;
* @return The kycKey.
*/
com.hedera.hashgraph.sdk.proto.Key getKycKey();
/**
*
**
* (Optional) The kyc key of this token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key kyc_key = 8;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getKycKeyOrBuilder();
/**
*
**
* (Optional) The freeze key of this token. This key is needed for freezing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key freeze_key = 9;
* @return Whether the freezeKey field is set.
*/
boolean hasFreezeKey();
/**
*
**
* (Optional) The freeze key of this token. This key is needed for freezing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key freeze_key = 9;
* @return The freezeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFreezeKey();
/**
*
**
* (Optional) The freeze key of this token. This key is needed for freezing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key freeze_key = 9;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFreezeKeyOrBuilder();
/**
*
**
* (Optional) The wipe key of this token. This key is needed for wiping the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key wipe_key = 10;
* @return Whether the wipeKey field is set.
*/
boolean hasWipeKey();
/**
*
**
* (Optional) The wipe key of this token. This key is needed for wiping the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key wipe_key = 10;
* @return The wipeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getWipeKey();
/**
*
**
* (Optional) The wipe key of this token. This key is needed for wiping the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key wipe_key = 10;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getWipeKeyOrBuilder();
/**
*
**
* (Optional) The supply key of this token. This key is needed for minting or burning token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key supply_key = 11;
* @return Whether the supplyKey field is set.
*/
boolean hasSupplyKey();
/**
*
**
* (Optional) The supply key of this token. This key is needed for minting or burning token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key supply_key = 11;
* @return The supplyKey.
*/
com.hedera.hashgraph.sdk.proto.Key getSupplyKey();
/**
*
**
* (Optional) The supply key of this token. This key is needed for minting or burning token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key supply_key = 11;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getSupplyKeyOrBuilder();
/**
*
**
* (Optional) The fee schedule key of this token. This key should be set, in order to make any
* changes to the custom fee schedule.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key fee_schedule_key = 12;
* @return Whether the feeScheduleKey field is set.
*/
boolean hasFeeScheduleKey();
/**
*
**
* (Optional) The fee schedule key of this token. This key should be set, in order to make any
* changes to the custom fee schedule.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key fee_schedule_key = 12;
* @return The feeScheduleKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFeeScheduleKey();
/**
*
**
* (Optional) The fee schedule key of this token. This key should be set, in order to make any
* changes to the custom fee schedule.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key fee_schedule_key = 12;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFeeScheduleKeyOrBuilder();
/**
*
**
* (Optional) The pause key of this token. This key is needed for pausing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key pause_key = 13;
* @return Whether the pauseKey field is set.
*/
boolean hasPauseKey();
/**
*
**
* (Optional) The pause key of this token. This key is needed for pausing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key pause_key = 13;
* @return The pauseKey.
*/
com.hedera.hashgraph.sdk.proto.Key getPauseKey();
/**
*
**
* (Optional) The pause key of this token. This key is needed for pausing the token.
* If this key is not set on token creation, it can only be set if the token has admin key set.
*
*
* .proto.Key pause_key = 13;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getPauseKeyOrBuilder();
/**
*
**
* The last used serial number of this token.
*
*
* int64 last_used_serial_number = 14;
* @return The lastUsedSerialNumber.
*/
long getLastUsedSerialNumber();
/**
*
**
* The flag indicating if this token is deleted.
*
*
* bool deleted = 15;
* @return The deleted.
*/
boolean getDeleted();
/**
*
**
* The type of this token. A token can be either FUNGIBLE_COMMON or NON_FUNGIBLE_UNIQUE.
* If it has been omitted during token creation, FUNGIBLE_COMMON type is used.
*
*
* .proto.TokenType token_type = 16;
* @return The enum numeric value on the wire for tokenType.
*/
int getTokenTypeValue();
/**
*
**
* The type of this token. A token can be either FUNGIBLE_COMMON or NON_FUNGIBLE_UNIQUE.
* If it has been omitted during token creation, FUNGIBLE_COMMON type is used.
*
*
* .proto.TokenType token_type = 16;
* @return The tokenType.
*/
com.hedera.hashgraph.sdk.proto.TokenType getTokenType();
/**
*
**
* The supply type of this token.A token can have either INFINITE or FINITE supply type.
* If it has been omitted during token creation, INFINITE type is used.
*
*
* .proto.TokenSupplyType supply_type = 17;
* @return The enum numeric value on the wire for supplyType.
*/
int getSupplyTypeValue();
/**
*
**
* The supply type of this token.A token can have either INFINITE or FINITE supply type.
* If it has been omitted during token creation, INFINITE type is used.
*
*
* .proto.TokenSupplyType supply_type = 17;
* @return The supplyType.
*/
com.hedera.hashgraph.sdk.proto.TokenSupplyType getSupplyType();
/**
*
**
* The id of the account (if any) that the network will attempt to charge for the
* token's auto-renewal upon expiration.
*
*
* .proto.AccountID auto_renew_account_id = 18;
* @return Whether the autoRenewAccountId field is set.
*/
boolean hasAutoRenewAccountId();
/**
*
**
* The id of the account (if any) that the network will attempt to charge for the
* token's auto-renewal upon expiration.
*
*
* .proto.AccountID auto_renew_account_id = 18;
* @return The autoRenewAccountId.
*/
com.hedera.hashgraph.sdk.proto.AccountID getAutoRenewAccountId();
/**
*
**
* The id of the account (if any) that the network will attempt to charge for the
* token's auto-renewal upon expiration.
*
*
* .proto.AccountID auto_renew_account_id = 18;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getAutoRenewAccountIdOrBuilder();
/**
*
**
* The number of seconds the network should automatically extend the token's expiration by, if the
* token has a valid auto-renew account, and is not deleted upon expiration.
* If this is not provided in a allowed range on token creation, the transaction will 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;
* @return The autoRenewSeconds.
*/
long getAutoRenewSeconds();
/**
*
**
* The expiration time of the token, in seconds since the epoch.
*
*
* int64 expiration_second = 20;
* @return The expirationSecond.
*/
long getExpirationSecond();
/**
*
**
* An optional description of the token with UTF-8 encoding up to 100 bytes.
*
*
* string memo = 21;
* @return The memo.
*/
java.lang.String getMemo();
/**
*
**
* An optional description of the token with UTF-8 encoding up to 100 bytes.
*
*
* string memo = 21;
* @return The bytes for memo.
*/
com.google.protobuf.ByteString
getMemoBytes();
/**
*
**
* The maximum supply of this token.
*
*
* int64 max_supply = 22;
* @return The maxSupply.
*/
long getMaxSupply();
/**
*
**
* The flag indicating if this token is paused.
*
*
* bool paused = 23;
* @return The paused.
*/
boolean getPaused();
/**
*
**
* The flag indicating if this token has accounts associated to it that are frozen by default.
*
*
* bool accounts_frozen_by_default = 24;
* @return The accountsFrozenByDefault.
*/
boolean getAccountsFrozenByDefault();
/**
*
**
* The flag indicating if this token has accounts associated with it that are KYC granted by default.
*
*
* bool accounts_kyc_granted_by_default = 25;
* @return The accountsKycGrantedByDefault.
*/
boolean getAccountsKycGrantedByDefault();
/**
*
**
* (Optional) The custom fees of this token.
*
*
* repeated .proto.CustomFee custom_fees = 26;
*/
java.util.List
getCustomFeesList();
/**
*
**
* (Optional) The custom fees of this token.
*
*
* repeated .proto.CustomFee custom_fees = 26;
*/
com.hedera.hashgraph.sdk.proto.CustomFee getCustomFees(int index);
/**
*
**
* (Optional) The custom fees of this token.
*
*
* repeated .proto.CustomFee custom_fees = 26;
*/
int getCustomFeesCount();
/**
*
**
* (Optional) The custom fees of this token.
*
*
* repeated .proto.CustomFee custom_fees = 26;
*/
java.util.List
getCustomFeesOrBuilderList();
/**
*
**
* (Optional) The custom fees of this token.
*
*
* repeated .proto.CustomFee custom_fees = 26;
*/
com.hedera.hashgraph.sdk.proto.CustomFeeOrBuilder getCustomFeesOrBuilder(
int index);
/**
*
**
* Metadata of the created token definition
*
*
* bytes metadata = 27;
* @return The metadata.
*/
com.google.protobuf.ByteString getMetadata();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
* @return Whether the metadataKey field is set.
*/
boolean hasMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
* @return The metadataKey.
*/
com.hedera.hashgraph.sdk.proto.Key getMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getMetadataKeyOrBuilder();
}