com.hederahashgraph.api.proto.java.TokenCreateTransactionBodyOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: token_create.proto
package com.hederahashgraph.api.proto.java;
public interface TokenCreateTransactionBodyOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.TokenCreateTransactionBody)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The publicly visible name of the token. The token name is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string name = 1;
* @return The name.
*/
java.lang.String getName();
/**
*
**
* The publicly visible name of the token. The token name is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string name = 1;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
**
* The publicly visible token symbol. The token symbol is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string symbol = 2;
* @return The symbol.
*/
java.lang.String getSymbol();
/**
*
**
* The publicly visible token symbol. The token symbol is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string symbol = 2;
* @return The bytes for symbol.
*/
com.google.protobuf.ByteString
getSymbolBytes();
/**
*
**
* For tokens of type FUNGIBLE_COMMON - the number of decimal places a
* token is divisible by. For tokens of type NON_FUNGIBLE_UNIQUE - value
* must be 0
*
*
* uint32 decimals = 3;
* @return The decimals.
*/
int getDecimals();
/**
*
**
* Specifies the initial supply of tokens to be put in circulation. The
* initial supply is sent to the Treasury Account. The supply is in the
* lowest denomination possible. In the case for NON_FUNGIBLE_UNIQUE Type
* the value must be 0
*
*
* uint64 initialSupply = 4;
* @return The initialSupply.
*/
long getInitialSupply();
/**
*
**
* The account which will act as a treasury for the token. This account
* will receive the specified initial supply or the newly minted NFTs in
* the case for NON_FUNGIBLE_UNIQUE Type
*
*
* .proto.AccountID treasury = 5;
* @return Whether the treasury field is set.
*/
boolean hasTreasury();
/**
*
**
* The account which will act as a treasury for the token. This account
* will receive the specified initial supply or the newly minted NFTs in
* the case for NON_FUNGIBLE_UNIQUE Type
*
*
* .proto.AccountID treasury = 5;
* @return The treasury.
*/
com.hederahashgraph.api.proto.java.AccountID getTreasury();
/**
*
**
* The account which will act as a treasury for the token. This account
* will receive the specified initial supply or the newly minted NFTs in
* the case for NON_FUNGIBLE_UNIQUE Type
*
*
* .proto.AccountID treasury = 5;
*/
com.hederahashgraph.api.proto.java.AccountIDOrBuilder getTreasuryOrBuilder();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 6;
* @return Whether the adminKey field is set.
*/
boolean hasAdminKey();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 6;
* @return The adminKey.
*/
com.hederahashgraph.api.proto.java.Key getAdminKey();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 6;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getAdminKeyOrBuilder();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 7;
* @return Whether the kycKey field is set.
*/
boolean hasKycKey();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 7;
* @return The kycKey.
*/
com.hederahashgraph.api.proto.java.Key getKycKey();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 7;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getKycKeyOrBuilder();
/**
*
**
* The key which can sign to freeze or unfreeze an account for token transactions. If empty,
* freezing is not possible
*
*
* .proto.Key freezeKey = 8;
* @return Whether the freezeKey field is set.
*/
boolean hasFreezeKey();
/**
*
**
* The key which can sign to freeze or unfreeze an account for token transactions. If empty,
* freezing is not possible
*
*
* .proto.Key freezeKey = 8;
* @return The freezeKey.
*/
com.hederahashgraph.api.proto.java.Key getFreezeKey();
/**
*
**
* The key which can sign to freeze or unfreeze an account for token transactions. If empty,
* freezing is not possible
*
*
* .proto.Key freezeKey = 8;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getFreezeKeyOrBuilder();
/**
*
**
* The key which can wipe the token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 9;
* @return Whether the wipeKey field is set.
*/
boolean hasWipeKey();
/**
*
**
* The key which can wipe the token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 9;
* @return The wipeKey.
*/
com.hederahashgraph.api.proto.java.Key getWipeKey();
/**
*
**
* The key which can wipe the token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 9;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getWipeKeyOrBuilder();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 10;
* @return Whether the supplyKey field is set.
*/
boolean hasSupplyKey();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 10;
* @return The supplyKey.
*/
com.hederahashgraph.api.proto.java.Key getSupplyKey();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 10;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getSupplyKeyOrBuilder();
/**
*
**
* The default Freeze status (frozen or unfrozen) of Hedera accounts relative to this token. If
* true, an account must be unfrozen before it can receive the token
*
*
* bool freezeDefault = 11;
* @return The freezeDefault.
*/
boolean getFreezeDefault();
/**
*
**
* The epoch second at which the token should expire; if an auto-renew account and period are
* specified, this is coerced to the current epoch second plus the autoRenewPeriod
*
*
* .proto.Timestamp expiry = 13;
* @return Whether the expiry field is set.
*/
boolean hasExpiry();
/**
*
**
* The epoch second at which the token should expire; if an auto-renew account and period are
* specified, this is coerced to the current epoch second plus the autoRenewPeriod
*
*
* .proto.Timestamp expiry = 13;
* @return The expiry.
*/
com.hederahashgraph.api.proto.java.Timestamp getExpiry();
/**
*
**
* The epoch second at which the token should expire; if an auto-renew account and period are
* specified, this is coerced to the current epoch second plus the autoRenewPeriod
*
*
* .proto.Timestamp expiry = 13;
*/
com.hederahashgraph.api.proto.java.TimestampOrBuilder getExpiryOrBuilder();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 14;
* @return Whether the autoRenewAccount field is set.
*/
boolean hasAutoRenewAccount();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 14;
* @return The autoRenewAccount.
*/
com.hederahashgraph.api.proto.java.AccountID getAutoRenewAccount();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 14;
*/
com.hederahashgraph.api.proto.java.AccountIDOrBuilder getAutoRenewAccountOrBuilder();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 15;
* @return Whether the autoRenewPeriod field is set.
*/
boolean hasAutoRenewPeriod();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 15;
* @return The autoRenewPeriod.
*/
com.hederahashgraph.api.proto.java.Duration getAutoRenewPeriod();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 15;
*/
com.hederahashgraph.api.proto.java.DurationOrBuilder getAutoRenewPeriodOrBuilder();
/**
*
**
* The memo associated with the token (UTF-8 encoding max 100 bytes)
*
*
* string memo = 16;
* @return The memo.
*/
java.lang.String getMemo();
/**
*
**
* The memo associated with the token (UTF-8 encoding max 100 bytes)
*
*
* string memo = 16;
* @return The bytes for memo.
*/
com.google.protobuf.ByteString
getMemoBytes();
/**
*
**
* IWA compatibility. Specifies the token type. Defaults to FUNGIBLE_COMMON
*
*
* .proto.TokenType tokenType = 17;
* @return The enum numeric value on the wire for tokenType.
*/
int getTokenTypeValue();
/**
*
**
* IWA compatibility. Specifies the token type. Defaults to FUNGIBLE_COMMON
*
*
* .proto.TokenType tokenType = 17;
* @return The tokenType.
*/
com.hederahashgraph.api.proto.java.TokenType getTokenType();
/**
*
**
* IWA compatibility. Specified the token supply type. Defaults to INFINITE
*
*
* .proto.TokenSupplyType supplyType = 18;
* @return The enum numeric value on the wire for supplyType.
*/
int getSupplyTypeValue();
/**
*
**
* IWA compatibility. Specified the token supply type. Defaults to INFINITE
*
*
* .proto.TokenSupplyType supplyType = 18;
* @return The supplyType.
*/
com.hederahashgraph.api.proto.java.TokenSupplyType getSupplyType();
/**
*
**
* IWA Compatibility. Depends on TokenSupplyType. For tokens of type FUNGIBLE_COMMON - the
* maximum number of tokens that can be in circulation. For tokens of type NON_FUNGIBLE_UNIQUE -
* the maximum number of NFTs (serial numbers) that can be minted. This field can never be
* changed!
*
*
* int64 maxSupply = 19;
* @return The maxSupply.
*/
long getMaxSupply();
/**
*
**
* The key which can change the token's custom fee schedule; must sign a TokenFeeScheduleUpdate
* transaction
*
*
* .proto.Key fee_schedule_key = 20;
* @return Whether the feeScheduleKey field is set.
*/
boolean hasFeeScheduleKey();
/**
*
**
* The key which can change the token's custom fee schedule; must sign a TokenFeeScheduleUpdate
* transaction
*
*
* .proto.Key fee_schedule_key = 20;
* @return The feeScheduleKey.
*/
com.hederahashgraph.api.proto.java.Key getFeeScheduleKey();
/**
*
**
* The key which can change the token's custom fee schedule; must sign a TokenFeeScheduleUpdate
* transaction
*
*
* .proto.Key fee_schedule_key = 20;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getFeeScheduleKeyOrBuilder();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 21;
*/
java.util.List
getCustomFeesList();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 21;
*/
com.hederahashgraph.api.proto.java.CustomFee getCustomFees(int index);
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 21;
*/
int getCustomFeesCount();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 21;
*/
java.util.List
getCustomFeesOrBuilderList();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 21;
*/
com.hederahashgraph.api.proto.java.CustomFeeOrBuilder getCustomFeesOrBuilder(
int index);
/**
*
**
* The Key which can pause and unpause the Token.
* If Empty the token pause status defaults to PauseNotApplicable, otherwise Unpaused.
*
*
* .proto.Key pause_key = 22;
* @return Whether the pauseKey field is set.
*/
boolean hasPauseKey();
/**
*
**
* The Key which can pause and unpause the Token.
* If Empty the token pause status defaults to PauseNotApplicable, otherwise Unpaused.
*
*
* .proto.Key pause_key = 22;
* @return The pauseKey.
*/
com.hederahashgraph.api.proto.java.Key getPauseKey();
/**
*
**
* The Key which can pause and unpause the Token.
* If Empty the token pause status defaults to PauseNotApplicable, otherwise Unpaused.
*
*
* .proto.Key pause_key = 22;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getPauseKeyOrBuilder();
/**
*
**
* Metadata of the created token definition.
*
*
* bytes metadata = 23;
* @return The metadata.
*/
com.google.protobuf.ByteString getMetadata();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
*
*
* .proto.Key metadata_key = 24;
* @return Whether the metadataKey field is set.
*/
boolean hasMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
*
*
* .proto.Key metadata_key = 24;
* @return The metadataKey.
*/
com.hederahashgraph.api.proto.java.Key getMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
*
*
* .proto.Key metadata_key = 24;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getMetadataKeyOrBuilder();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy