Currency class

Currency Documentation. From the stellar.toml CURRENCIES list, one set of fields for each currency supported. Applicable fields should be completed and any that don't apply should be excluded. See Stellar Toml

Constructors

Currency()

Properties

anchorAsset ↔ String?

If anchored token, code / symbol for asset that token is anchored to. E.g. USD, BTC, SBUX, Address of real-estate investment property.

getter/setter pair

anchorAssetType ↔ String?

Type of asset anchored. Can be fiat, crypto, nft, stock, bond, commodity, realestate, or other.

getter/setter pair

approvalCriteria ↔ String?

A human readable string that explains the issuer's requirements for approving transactions.

getter/setter pair

approvalServer ↔ String?

URL of a sep0008 compliant approval service that signs validated transactions.

getter/setter pair

attestationOfReserve ↔ String?

URL to attestation or other proof, evidence, or verification of reserves, such as third-party audits.

getter/setter pair

code ↔ String?

Token code.

getter/setter pair

codeTemplate ↔ String?

A pattern with ? as a single character wildcard. Allows a CURRENCIES entry to apply to multiple assets that share the same info. An example is futures, where the only difference between issues is the date of the contract. E.g. CORN???????? to match codes such as CORN20180604.

getter/setter pair

collateralAddresses ↔ List<String>?

If this is an anchored crypto token, list of one or more public addresses that hold the assets for which you are issuing tokens.

getter/setter pair

collateralAddressMessages ↔ List<String>?

Messages stating that funds in the collateralAddresses list are reserved to back the issued asset.

getter/setter pair

collateralAddressSignatures ↔ List<String>?

These prove you control the collateralAddresses. For each address you list, sign the entry in collateralAddressMessages with the address's private key and add the resulting string to this list as a base64-encoded raw signature.

getter/setter pair

conditions ↔ String?

Conditions on token.

getter/setter pair

contract ↔ String?

Contract ID of the token contract. The token must be compatible with the SEP-41 Token Interface to be defined here. Required for tokens that are not Stellar Assets. Omitted if the token is a Stellar Asset.

getter/setter pair

desc ↔ String?

Description of token and what it represents.

getter/setter pair

displayDecimals ↔ int?

Preference for number of decimals to show when a client displays currency balance.

getter/setter pair

fixedNumber ↔ int?

Fixed number of tokens, if the number of tokens issued will never change.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

image ↔ String?

URL to a PNG image on a transparent background representing token.

getter/setter pair

isAssetAnchored ↔ bool?

true if token can be redeemed for underlying asset, otherwise false.

getter/setter pair

issuer ↔ String?

Token issuer Stellar public key.

getter/setter pair

isUnlimited ↔ bool?

The number of tokens is dilutable at the issuer's discretion.

getter/setter pair

maxNumber ↔ int?

Max number of tokens, if there will never be more than maxNumber tokens.

getter/setter pair

name ↔ String?

A short name for the token.

getter/setter pair

redemptionInstructions ↔ String?

If anchored token, these are instructions to redeem the underlying asset from tokens.

getter/setter pair

regulated ↔ bool?

Indicates whether or not this is a sep0008 regulated asset. If missing, false is assumed.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status ↔ String?

Status of token. One of live, dead, test, or private. Allows issuer to mark whether token is dead/for testing/for private use or is live and should be listed in live exchanges.

getter/setter pair

toml ↔ String?

Alternately, stellar.toml can link out to a separate TOML file for each currency by specifying toml="https://DOMAIN/.well-known/CURRENCY.toml" as the currency's only field. In this case only this field is filled. To load the currency data, you can use StellarToml.currencyFromUrl(String toml).

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited