Type Members

1.  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.

   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 as CORN20180604. 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.

2.  case class DomainInfo(federationServer: Option[FederationServer] = None, authServer: Option[HttpUrl] = None, transferServer: Option[HttpUrl] = None, kycServer: Option[HttpUrl] = None, webAuthEndpoint: Option[HttpUrl] = None, signerKey: Option[PublicKey] = None, horizonEndpoint: Option[HttpUrl] = None, uriRequestSigningKey: Option[PublicKey] = None, version: Option[String] = None, accounts: List[PublicKey] = List.empty[PublicKey], issuerDocumentation: Option[IssuerDocumentation] = None, pointsOfContact: List[PointOfContact] = Nil, currencies: List[Currency] = Nil, validators: List[Validator] = Nil) extends Product with Serializable

   Data provided by a domain's stellar.toml.

   Data provided by a domain's stellar.toml.

   See also

   https://www.stellar.org/developers/guides/concepts/stellar-toml.html

3.  case class DomainInfoParseException(msg: String, address: List[String] = Nil) extends Exception with Product with Serializable

   The document could not be parsed into a DomainInfo instance.

   The document could not be parsed into a DomainInfo instance.

   msg

   the reason the parsing failed.

4.  case class IssuerDocumentation(name: Option[String] = None, doingBusinessAs: Option[String] = None, url: Option[HttpUrl] = None, logo: Option[HttpUrl] = None, description: Option[String] = None, physicalAddress: Option[String] = None, physicalAddressAttestation: Option[HttpUrl] = None, phoneNumber: Option[String] = None, phoneNumberAttestation: Option[HttpUrl] = None, keybase: Option[String] = None, twitter: Option[String] = None, github: Option[String] = None, email: Option[String] = None, licensingAuthority: Option[String] = None, licenseType: Option[String] = None, licenseNumber: Option[String] = None) extends Product with Serializable

   The Issuer Documentation subsection of the Domain Info parsed from stellar.toml files.

   The Issuer Documentation subsection of the Domain Info parsed from stellar.toml files.

   See also

   https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md#issuer-documentation

5.  case class PointOfContact(name: Option[String], email: Option[String], keybase: Option[String], telegram: Option[String], twitter: Option[String], github: Option[String], idPhotoHash: Option[String], verificationPhotoHash: Option[String]) extends Product with Serializable
6.  trait TomlParsers extends AnyRef
7.  case class Validator(alias: Option[String] = None, displayName: Option[String] = None, publicKey: Option[PublicKey] = None, host: Option[String] = None, history: Option[HttpUrl] = None) extends Product with Serializable

   Validator data as defined in a stellar.toml file.

   Validator data as defined in a stellar.toml file.

   alias

   A name for display in stellar-core configs

   displayName

   A human-readable name for display in quorum explorers and other interfaces

   publicKey

   The Stellar account associated with the node

   host

   The IP:port or domain:port peers can use to connect to the node

   history

   The location of the history archive published by this validator