XRPL Amount Models

An Amount is an object specifying a currency, a quantity of that currency, and the counterparty (issuer) on the trustline that holds the value. For XRP, there is no counterparty.

class xrpl.models.amounts.IssuedCurrencyAmount(*args: List[Any], **kwargs: Dict[str, Any])

Bases: xrpl.models.currencies.issued_currency.IssuedCurrency

Specifies an amount in an issued currency.

See https://xrpl.org/currency-formats.html#issued-currency-amounts.

currency: str

This field is required.

classmethod from_dict(value: Dict[str, Union[str, int, List[Any], Dict[str, Any]]]) → xrpl.models.base_model.BaseModel

Construct a new BaseModel from a dictionary of parameters.

Parameters

value – The value to construct the BaseModel from.

Returns

A new BaseModel object, constructed using the given parameters.

Raises

XRPLModelException – If the dictionary provided is invalid.

classmethod from_xrpl(value: Union[str, Dict[str, Any]]) → xrpl.models.base_model.BaseModel

Creates a BaseModel object based on a JSON-like dictionary of keys in the JSON format used by the binary codec, or an actual JSON string representing the same data.

Parameters

value – The dictionary or JSON string to be instantiated.

Returns

A BaseModel object instantiated from the input.

classmethod is_dict_of_model(dictionary: Any) → bool

Checks whether the provided dictionary is a dictionary representation of this class.

Note: This only checks the exact model, and does not count model inheritance. This method returns False if the dictionary represents a subclass of this class.

Parameters

dictionary – The dictionary to check.

Returns

True if dictionary is a dict representation of an instance of this class; False if not.

is_valid() → bool

Returns whether this BaseModel is valid.

Returns

Whether this BaseModel is valid.

issuer: str

This field is required.

to_amount(value: Union[str, int, float]) → xrpl.models.amounts.issued_currency_amount.IssuedCurrencyAmount

Converts an IssuedCurrency to an IssuedCurrencyAmount.

Parameters

value – The amount of issued currency in the IssuedCurrencyAmount.

Returns

An IssuedCurrencyAmount that represents the issued currency and the

provided value.

to_currency() → xrpl.models.currencies.issued_currency.IssuedCurrency

Build an IssuedCurrency from this IssuedCurrencyAmount.

Returns

The IssuedCurrency for this IssuedCurrencyAmount.

to_dict() → Dict[str, str]

Returns the dictionary representation of an IssuedCurrencyAmount.

Returns

The dictionary representation of an IssuedCurrencyAmount.

validate() → None

Raises if this object is invalid.

Raises

XRPLModelException – if this object is invalid.

value: Union[str, int, float]

This field is required.

xrpl.models.amounts.get_amount_value(amount: Union[xrpl.models.amounts.issued_currency_amount.IssuedCurrencyAmount, str]) → float

Returns the value of an amount irrespective of its currency.

Parameters

amount – The Amount object whose value we want.

Returns

The value of the amount irrespective of its currency.

xrpl.models.amounts.is_issued_currency(amount: Union[xrpl.models.amounts.issued_currency_amount.IssuedCurrencyAmount, str]) → bool

Returns whether amount is an issued currency value, as opposed to an XRP value.

Parameters

amount – The Amount object whose type is being checked.

Returns

Whether the amount is an issued currency value.

xrpl.models.amounts.is_xrp(amount: Union[xrpl.models.amounts.issued_currency_amount.IssuedCurrencyAmount, str]) → bool

Returns whether amount is an XRP value, as opposed to an issued currency.

Parameters

amount – The Amount object whose type is being checked.

Returns

Whether the amount is an XRP value.

xrpl.models.amounts.Amount

The central part of internal API.

This represents a generic version of type ‘origin’ with type arguments ‘params’. There are two kind of these aliases: user defined and special. The special ones are wrappers around builtin collections and ABCs in collections.abc. These must have ‘name’ always set. If ‘inst’ is False, then the alias can’t be instantiated, this is used by e.g. typing.List and typing.Dict.

alias of Union[xrpl.models.amounts.issued_currency_amount.IssuedCurrencyAmount, str]