Class TokenRecord

A transaction record containing information regarding new token coin balance, typically returned from methods that can affect a change on the total circulation supply.

Inheritance
object
TransactionReceipt
TransactionRecord
TokenRecord
Implements
Inherited Members
Namespace: Hiero
Assembly: Hiero.dll
Syntax
public sealed record TokenRecord : TransactionRecord, IEquatable<TransactionReceipt>, IEquatable<TransactionRecord>, IEquatable<TokenRecord>
Remarks

Best-effort when inferred, exactly as for TokenReceipt: a supply of exactly zero cannot be recognised as a token operation. Records obtained from GetTransactionRecordAsync(ConsensusClient, TransactionId, CancellationToken, Action<IConsensusContext>?), GetAllTransactionRecordsAsync(ConsensusClient, TransactionId, CancellationToken, Action<IConsensusContext>?) or GetAccountRecordsAsync(ConsensusClient, EntityId, CancellationToken, Action<IConsensusContext>?) therefore arrive as a plain TransactionRecord in that case. No value is lost — the substitution happens only when the value is zero. Test rather than cast:

ulong circulation = record is TokenRecord token ? token.Circulation : 0;

Properties

| Edit this page View Source

Circulation

The current (new) total supply of the token across all accounts, in its smallest unit: divide by 10^Decimals for whole tokens. For an NFT class, the number of NFTs.

Declaration
public ulong Circulation { get; }
Property Value
Type Description
ulong

Implements