Class TakerAmount
One side of an order book: XRP, an issued currency, or an MPT (XLS-33).
An issued currency names Currency and Issuer, XRP names only
Currency, and an MPT names only MptIssuanceId.
Inheritance
Namespace: Xrpl.Models.Methods
Assembly: Xrpl.dll
Syntax
public class TakerAmount
Properties
| Edit this page View SourceCurrency
The standard format for currency codes is a three-character string such as USD.
This is intended for use with ISO 4217 Currency Codes
As a 160-bit hexadecimal string, such as "0158415500000000C1F76FF6ECB0BAC600000000".
The following characters are permitted:
all uppercase and lowercase letters, digits, as well as the symbols ? ! @ # $ % ^ * ( ) { } [ ] | and symbols ampersand, less, greater
Currency codes are case-sensitive.
MUST NOT be combined with MptIssuanceId.
Declaration
[JsonPropertyName("currency")]
public string Currency { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Issuer
Generally, the account that issues this token.
In special cases, this can refer to the account that holds the token instead.
MUST NOT be combined with MptIssuanceId.
Declaration
[JsonPropertyName("issuer")]
public string Issuer { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MptIssuanceId
The MPT issuance whose book to read, as its 48-character hex ID.
MPT order books exist only under the MPTokensV2 amendment (XLS-82).
MUST NOT be combined with Currency or Issuer.
Declaration
[JsonPropertyName("mpt_issuance_id")]
public string MptIssuanceId { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
| Edit this page View SourceFromAsset(IssuedCurrency)
The side of a book that trades asset: XRP, an issued currency or an MPT.
Declaration
public static TakerAmount FromAsset(Common.IssuedCurrency asset)
Parameters
| Type | Name | Description |
|---|---|---|
| Common.IssuedCurrency | asset |
Returns
| Type | Description |
|---|---|
| TakerAmount |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException |
|