case class Currency(asset: Option[NonNativeAsset] = None, name: Option[String] = None, description: Option[String] = None, status: Option[Status] = None, displayDecimals: Int = 7, conditions: Option[String] = None, image: Option[HttpUrl] = None, fixedQuantity: Option[Int] = None, maxQuantity: Option[Int] = None, isUnlimited: Option[Boolean] = None, isAnchored: Option[Boolean] = None, anchoredAssetType: Option[String] = None, anchoredAsset: Option[String] = None, redemptionInstructions: Option[String] = None, collateral: List[Collateral] = Nil, isRegulated: Boolean = false, approvalServer: Option[HttpUrl] = None, approvalCriteria: Option[String] = None) extends Product with Serializable
Currency data as defined in a stellar.toml file.
- asset
The issued token. The asset code may be a template.
?characters represent single character wildcards. This allows the currency to represent 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 asCORN20180604. The absence of?characters means the asset code is literal.- name
A short (<= 20 char) name for the currency
- description
A human-readable description for the currency and what it represents.
- status
Mark whether token is dead/for testing/for private use or is live and should be listed in live exchanges.
- displayDecimals
Preference for number of decimals to show when a client displays currency balance. 0-7
- conditions
Human-readable conditions for use of the token.
- image
URL to a PNG image on a transparent background representing token.
- fixedQuantity
Fixed number of tokens, if the number of tokens issued will never change.
- maxQuantity
Max number of tokens, if there is an upper limit to the number of tokens that will exist.
- isUnlimited
Declares whether the number of tokens is dilutable at the issuer's discretion.
- isAnchored
Declares whether the token is redeemable for an underlying asset.
- anchoredAssetType
Type of asset anchored. For example, fiat, crypto, stock, bond, commodity, real-estate...
- anchoredAsset
If anchored token, code / symbol for asset that token is anchored to. E.g. USD, BTC, SBUX, Address of real-estate investment property.
- redemptionInstructions
If anchored token, these are instructions to redeem the underlying asset from tokens.
- collateral
If this is an anchored crypto token, list of one or more collateral descriptors.
- approvalServer
URL of a sep0008 compliant approval service that signs validated transactions.
- approvalCriteria
a human readable string that explains the issuer's requirements for approving transactions.
- Alphabetic
- By Inheritance
- Currency
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Currency(asset: Option[NonNativeAsset] = None, name: Option[String] = None, description: Option[String] = None, status: Option[Status] = None, displayDecimals: Int = 7, conditions: Option[String] = None, image: Option[HttpUrl] = None, fixedQuantity: Option[Int] = None, maxQuantity: Option[Int] = None, isUnlimited: Option[Boolean] = None, isAnchored: Option[Boolean] = None, anchoredAssetType: Option[String] = None, anchoredAsset: Option[String] = None, redemptionInstructions: Option[String] = None, collateral: List[Collateral] = Nil, isRegulated: Boolean = false, approvalServer: Option[HttpUrl] = None, approvalCriteria: Option[String] = None)
- asset
The issued token. The asset code may be a template.
?characters represent single character wildcards. This allows the currency to represent 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 asCORN20180604. The absence of?characters means the asset code is literal.- name
A short (<= 20 char) name for the currency
- description
A human-readable description for the currency and what it represents.
- status
Mark whether token is dead/for testing/for private use or is live and should be listed in live exchanges.
- displayDecimals
Preference for number of decimals to show when a client displays currency balance. 0-7
- conditions
Human-readable conditions for use of the token.
- image
URL to a PNG image on a transparent background representing token.
- fixedQuantity
Fixed number of tokens, if the number of tokens issued will never change.
- maxQuantity
Max number of tokens, if there is an upper limit to the number of tokens that will exist.
- isUnlimited
Declares whether the number of tokens is dilutable at the issuer's discretion.
- isAnchored
Declares whether the token is redeemable for an underlying asset.
- anchoredAssetType
Type of asset anchored. For example, fiat, crypto, stock, bond, commodity, real-estate...
- anchoredAsset
If anchored token, code / symbol for asset that token is anchored to. E.g. USD, BTC, SBUX, Address of real-estate investment property.
- redemptionInstructions
If anchored token, these are instructions to redeem the underlying asset from tokens.
- collateral
If this is an anchored crypto token, list of one or more collateral descriptors.
- approvalServer
URL of a sep0008 compliant approval service that signs validated transactions.
- approvalCriteria
a human readable string that explains the issuer's requirements for approving transactions.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val anchoredAsset: Option[String]
- val anchoredAssetType: Option[String]
- val approvalCriteria: Option[String]
- val approvalServer: Option[HttpUrl]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val asset: Option[NonNativeAsset]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val collateral: List[Collateral]
- val conditions: Option[String]
- val description: Option[String]
- val displayDecimals: Int
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fixedQuantity: Option[Int]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val image: Option[HttpUrl]
- val isAnchored: Option[Boolean]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isRegulated: Boolean
- val isUnlimited: Option[Boolean]
- val maxQuantity: Option[Int]
- val name: Option[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val redemptionInstructions: Option[String]
- val status: Option[Status]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated