Skip to main content

CoinMetadata

Namespace: IotaSdk

The coin metadata associated with the given coin type.

public record class CoinMetadata : System.IDisposable, System.IEquatable`1[[IotaSdk.CoinMetadata, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance Object → CoinMetadata
Implements IDisposable, IEquatable<CoinMetadata>
Attributes NullableContextAttribute, NullableAttribute

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Properties​

Address​

The CoinMetadata object ID.

public ObjectId Address { get; init; }

Property Value​

ObjectId

Version​

Version of the token.

public ulong Version { get; init; }

Property Value​

UInt64

Decimals​

The number of decimal places used to represent the token.

public int? Decimals { get; init; }

Property Value​

Int32?

Description​

Optional description of the token, provided by the creator of the token.

public string? Description { get; init; }

Property Value​

String

IconUrl​

Icon URL of the coin.

public string? IconUrl { get; init; }

Property Value​

String

Name​

Full, official name of the token.

public string? Name { get; init; }

Property Value​

String

Symbol​

The token's identifying abbreviation.

public string? Symbol { get; init; }

Property Value​

String

Supply​

The overall quantity of tokens that will be issued.

public ulong? Supply { get; init; }

Property Value​

UInt64?

Constructors​

CoinMetadata(ObjectId, UInt64, Int32?, String, String, String, String, UInt64?)​

The coin metadata associated with the given coin type.

public CoinMetadata(ObjectId Address, ulong Version, int? Decimals = null, string? Description = null, string? IconUrl = null, string? Name = null, string? Symbol = null, ulong? Supply = null)

Parameters​

Address ObjectId
The CoinMetadata object ID.

Version UInt64
Version of the token.

Decimals Int32?
The number of decimal places used to represent the token.

Description String?
Optional description of the token, provided by the creator of the token.

IconUrl String?
Icon URL of the coin.

Name String?
Full, official name of the token.

Symbol String?
The token's identifying abbreviation.

Supply UInt64?
The overall quantity of tokens that will be issued.

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Methods​

Dispose()​

public void Dispose()