Class TokenInfo

The information returned from the GetTokenInfo ConsensusClient method call. It represents the details concerning Tokens and Assets.

Inheritance

object

TokenInfo

Implements

IEquatable<TokenInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public sealed record TokenInfo : IEquatable<TokenInfo>

Properties

Administrator

Administrator key for signing transactions modifying this token's properties.

Declaration

public Endorsement? Administrator { get; }

Property Value

Type	Description
Endorsement

Ceiling

The maximum number of tokens allowed in circulation at a given time. The value of 0 is unbounded.

Declaration

public long Ceiling { get; }

Property Value

Type	Description
long

Circulation

The total balance of tokens in all accounts (the whole denomination).

Declaration

public ulong Circulation { get; }

Property Value

Type	Description
ulong

ConfiscateEndorsement

Administrator key for signing transactions that completely remove tokens from a crypto address.

Declaration

public Endorsement? ConfiscateEndorsement { get; }

Property Value

Type	Description
Endorsement

Decimals

The number of decimal places which each token may be subdivided.

Declaration

public uint Decimals { get; }

Property Value

Type	Description
uint

Deleted

Flag indicating the token has been deleted.

Declaration

public bool Deleted { get; }

Property Value

Type	Description
bool

Expiration

Expiration date for the token. Will renew as determined by the renew period and balance of auto renew account.

Declaration

public ConsensusTimeStamp Expiration { get; }

Property Value

Type	Description
ConsensusTimeStamp

GrantKycEndorsement

Administrator key for signing transactions updating the grant or revoke KYC status of an account.

Declaration

public Endorsement? GrantKycEndorsement { get; }

Property Value

Type	Description
Endorsement

KycStatus

The current default KYC status of the token.

Declaration

public TokenKycStatus KycStatus { get; }

Property Value

Type	Description
TokenKycStatus

Ledger

Identification of the Ledger (Network) this token information was retrieved from.

Declaration

public BigInteger Ledger { get; }

Property Value

Type	Description
BigInteger

Memo

The memo associated with the token instance.

Declaration

public string Memo { get; }

Property Value

Type	Description
string

MetadataEndorsement

Administrator key for signing transactions for adjusting metadata of tokens or assets

Declaration

public Endorsement? MetadataEndorsement { get; }

Property Value

Type	Description
Endorsement

Name

Name of this token

Declaration

public string Name { get; }

Property Value

Type	Description
string

PauseEndorsement

Administrator key for signing transactions that can pause or continue the exchange of all assets across all accounts on the network.

Declaration

public Endorsement? PauseEndorsement { get; set; }

Property Value

Type	Description
Endorsement

PauseStatus

The current paused/frozen status of the token for all accounts.

Declaration

public TokenTradableStatus PauseStatus { get; }

Property Value

Type	Description
TokenTradableStatus

RenewAccount

Optional address of the account supporting the auto renewal of the token at expiration time. The token lifetime will be extended by the RenewPeriod at expiration time if this account contains sufficient funds. The private key associated with this account must sign the transaction if RenewAccount is specified.

Declaration

public EntityId? RenewAccount { get; }

Property Value

Type	Description
EntityId

RenewPeriod

Interval of the token and auto-renewal period. If the associated renewal account does not have sufficient funds to renew at the expiration time, it will be renewed for a period of time the remaining funds can support. If no funds remain, the token instance will be deleted.

Declaration

public TimeSpan? RenewPeriod { get; }

Property Value

Type	Description
TimeSpan?

Royalties

The list of royalties assessed on transactions by the network when transferring this token.

Declaration

public IReadOnlyList<IRoyalty> Royalties { get; }

Property Value

Type	Description
IReadOnlyList<IRoyalty>

RoyaltiesEndorsement

Administrator key for signing transactions updating the royalties (custom transfer fees) associated with this token.

Declaration

public Endorsement? RoyaltiesEndorsement { get; set; }

Property Value

Type	Description
Endorsement

SupplyEndorsement

Administrator key for signing transactions for minting or unminting tokens in the treasury account.

Declaration

public Endorsement? SupplyEndorsement { get; }

Property Value

Type	Description
Endorsement

SuspendEndorsement

Administrator key for signing transactions for freezing or unfreezing an account's ability to transfer tokens.

Declaration

public Endorsement? SuspendEndorsement { get; }

Property Value

Type	Description
Endorsement

Symbol

The string symbol representing this token.

Declaration

public string Symbol { get; }

Property Value

Type	Description
string

Token

The Hedera address of this token.

Declaration

public EntityId Token { get; }

Property Value

Type	Description
EntityId

TradableStatus

The current default suspended/frozen status of the token.

Declaration

public TokenTradableStatus TradableStatus { get; }

Property Value

Type	Description
TokenTradableStatus

Treasury

The treasury account holding uncirculated tokens.

Declaration

public EntityId Treasury { get; }

Property Value

Type	Description
EntityId

Type

The type of token this represents, fungible token or Non-Fungible token (NFT).

Declaration

public TokenType Type { get; }

Property Value

Type	Description
TokenType

Implements

IEquatable<T>