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.
read / write
- anchorAssetType ↔ String
-
Type of asset anchored. Can be fiat, crypto, stock, bond, commodity, realestate, or other.
read / write
- approvalCriteria ↔ String
-
A human readable string that explains the issuer's requirements for approving transactions.
read / write
- approvalServer ↔ String
-
URL of a sep0008 compliant approval service that signs validated transactions.
read / write
- code ↔ String
-
Token code.
read / write
- 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.read / write -
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.
read / write
-
collateralAddressMessages
↔ List<
String> -
Messages stating that funds in the collateralAddresses list are reserved to back the issued asset.
read / write
-
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.
read / write
- conditions ↔ String
-
Conditions on token.
read / write
- desc ↔ String
-
Description of token and what it represents.
read / write
- displayDecimals ↔ int
-
Preference for number of decimals to show when a client displays currency balance.
read / write
- fixedNumber ↔ int
-
Fixed number of tokens, if the number of tokens issued will never change.
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- image ↔ String
-
URL to a PNG image on a transparent background representing token.
read / write
- isAssetAnchored ↔ bool
-
true if token can be redeemed for underlying asset, otherwise false.
read / write
- issuer ↔ String
-
Token issuer Stellar public key.
read / write
- isUnlimited ↔ bool
-
The number of tokens is dilutable at the issuer's discretion.
read / write
- maxNumber ↔ int
-
Max number of tokens, if there will never be more than maxNumber tokens.
read / write
- name ↔ String
-
A short name for the token.
read / write
- redemptionInstructions ↔ String
-
If anchored token, these are instructions to redeem the underlying asset from tokens.
read / write
- regulated ↔ bool
-
Indicates whether or not this is a sep0008 regulated asset. If missing, false is assumed.
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, 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.
read / write
- 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).
read / write
Methods
-
noSuchMethod(
Invocation invocation ) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
Operators
-
operator ==(
Object other ) → bool -
The equality operator. [...]
inherited