API¶

Addresses¶

aioxrpy.address.decode_address(address)¶

Decodes base58-encoded Ripple account ID

Return type: bytes

aioxrpy.address.encode_address(value)¶

Encodes Ripple account ID using base58

Return type: str

Decimals¶

aioxrpy.decimals.drops_to_xrp(amount)¶

aioxrpy.decimals.xrp_to_drops(amount)¶

Definitions¶

Ripple type and field definitions

class aioxrpy.definitions.RippleField(name, is_serialized, is_signing_field, is_vl_encoded, nth, type_)¶

property field_id¶

classmethod from_definition(name, definition)¶

is_serialized: bool = None¶

is_signing_field: bool = None¶

is_vl_encoded: bool = None¶

name: str = None¶

nth: int = None¶

type_: RippleType = None¶

class aioxrpy.definitions.RippleLedgerEntryType¶

An enumeration.

AccountRoot = 97¶

Amendments = 102¶

Any = -3¶

Check = 67¶

Child = -2¶

Contract = 99¶

DepositPreauth = 112¶

DirectoryNode = 100¶

Escrow = 117¶

FeeSettings = 115¶

GeneratorMap = 103¶

Invalid = -1¶

LedgerHashes = 104¶

Nickname = 110¶

Offer = 111¶

PayChannel = 120¶

RippleState = 114¶

SignerList = 83¶

Ticket = 84¶

class aioxrpy.definitions.RippleTransactionFlags¶

An enumeration.

FullyCanonicalSig = 2147483648¶

class aioxrpy.definitions.RippleTransactionHashPrefix¶

An enumeration.

HASH_TX_ID = b'TXN\x00'¶

HASH_TX_SIGN = b'STX\x00'¶

HASH_TX_SIGN_MULTI = b'SMT\x00'¶

class aioxrpy.definitions.RippleTransactionResult¶

An enumeration.

tecCLAIM = 100¶

tecCRYPTOCONDITION_ERROR = 146¶

tecDIR_FULL = 121¶

tecDST_TAG_NEEDED = 143¶

tecDUPLICATE = 149¶

tecEXPIRED = 148¶

tecFAILED_PROCESSING = 105¶

tecFROZEN = 137¶

tecHAS_OBLIGATIONS = 151¶

tecINSUFFICIENT_RESERVE = 141¶

tecINSUFF_FEE = 136¶

tecINSUF_RESERVE_LINE = 122¶

tecINSUF_RESERVE_OFFER = 123¶

tecINTERNAL = 144¶

tecINVARIANT_FAILED = 147¶

tecKILLED = 150¶

tecNEED_MASTER_KEY = 142¶

tecNO_ALTERNATIVE_KEY = 130¶

tecNO_AUTH = 134¶

tecNO_DST = 124¶

tecNO_DST_INSUF_XRP = 125¶

tecNO_ENTRY = 140¶

tecNO_ISSUER = 133¶

tecNO_LINE = 135¶

tecNO_LINE_INSUF_RESERVE = 126¶

tecNO_LINE_REDUNDANT = 127¶

tecNO_PERMISSION = 139¶

tecNO_REGULAR_KEY = 131¶

tecNO_TARGET = 138¶

tecOVERSIZE = 145¶

tecOWNERS = 132¶

tecPATH_DRY = 128¶

tecPATH_PARTIAL = 101¶

tecTOO_SOON = 152¶

tecUNFUNDED = 129¶

tecUNFUNDED_ADD = 102¶

tecUNFUNDED_OFFER = 103¶

tecUNFUNDED_PAYMENT = 104¶

tefALREADY = -198¶

tefBAD_ADD_AUTH = -197¶

tefBAD_AUTH = -196¶

tefBAD_AUTH_MASTER = -183¶

tefBAD_LEDGER = -195¶

tefBAD_QUORUM = -185¶

tefBAD_SIGNATURE = -186¶

tefCREATED = -194¶

tefEXCEPTION = -193¶

tefFAILURE = -199¶

tefINTERNAL = -192¶

tefINVARIANT_FAILED = -182¶

tefMASTER_DISABLED = -188¶

tefMAX_LEDGER = -187¶

tefNOT_MULTI_SIGNING = -184¶

tefNO_AUTH_REQUIRED = -191¶

tefPAST_SEQ = -190¶

tefTOO_BIG = -181¶

tefWRONG_PRIOR = -189¶

telBAD_DOMAIN = -398¶

telBAD_PATH_COUNT = -397¶

telBAD_PUBLIC_KEY = -396¶

telCAN_NOT_QUEUE = -392¶

telCAN_NOT_QUEUE_BALANCE = -391¶

telCAN_NOT_QUEUE_BLOCKED = -389¶

telCAN_NOT_QUEUE_BLOCKS = -390¶

telCAN_NOT_QUEUE_FEE = -388¶

telCAN_NOT_QUEUE_FULL = -387¶

telFAILED_PROCESSING = -395¶

telINSUF_FEE_P = -394¶

telLOCAL_ERROR = -399¶

telNO_DST_PARTIAL = -393¶

temBAD_AMOUNT = -298¶

temBAD_CURRENCY = -297¶

temBAD_EXPIRATION = -296¶

temBAD_FEE = -295¶

temBAD_ISSUER = -294¶

temBAD_LIMIT = -293¶

temBAD_OFFER = -292¶

temBAD_PATH = -291¶

temBAD_PATH_LOOP = -290¶

temBAD_QUORUM = -271¶

temBAD_REGKEY = -289¶

temBAD_SEND_XRP_LIMIT = -288¶

temBAD_SEND_XRP_MAX = -287¶

temBAD_SEND_XRP_NO_DIRECT = -286¶

temBAD_SEND_XRP_PARTIAL = -285¶

temBAD_SEND_XRP_PATHS = -284¶

temBAD_SEQUENCE = -283¶

temBAD_SIGNATURE = -282¶

temBAD_SIGNER = -272¶

temBAD_SRC_ACCOUNT = -281¶

temBAD_TICK_SIZE = -269¶

temBAD_TRANSFER_RATE = -280¶

temBAD_WEIGHT = -270¶

temCANNOT_PREAUTH_SELF = -267¶

temDISABLED = -273¶

temDST_IS_SRC = -279¶

temDST_NEEDED = -278¶

temINVALID = -277¶

temINVALID_ACCOUNT_ID = -268¶

temINVALID_FLAG = -276¶

temMALFORMED = -299¶

temREDUNDANT = -275¶

temRIPPLE_EMPTY = -274¶

temUNCERTAIN = -266¶

temUNKNOWN = -265¶

terFUNDS_SPENT = -98¶

terINSUF_FEE_B = -97¶

terLAST = -91¶

terNO_ACCOUNT = -96¶

terNO_AUTH = -95¶

terNO_LINE = -94¶

terNO_RIPPLE = -90¶

terOWNERS = -93¶

terPRE_SEQ = -92¶

terQUEUED = -89¶

terRETRY = -99¶

tesSUCCESS = 0¶

class aioxrpy.definitions.RippleTransactionResultCategory¶

Enum containing Ripple transaction categories. https://xrpl.org/tec-codes.html

The original abbreviations for transaction result categories (tec, tel codes) are not expanded anywhere so I had to get creative with the names.

CostlyFailure = 'tec'¶

Failure = 'tef'¶

LocalFailure = 'tel'¶

MalformedFailure = 'tem'¶

RetriableFailure = 'ter'¶

Success = 'tes'¶

class aioxrpy.definitions.RippleTransactionType¶

An enumeration.

AccountDelete = 21¶

AccountSet = 3¶

CheckCancel = 18¶

CheckCash = 17¶

CheckCreate = 16¶

Contract = 9¶

DepositPreauth = 19¶

EnableAmendment = 100¶

EscrowCancel = 4¶

EscrowCreate = 1¶

EscrowFinish = 2¶

Invalid = -1¶

NickNameSet = 6¶

OfferCancel = 8¶

OfferCreate = 7¶

Payment = 0¶

PaymentChannelClaim = 15¶

PaymentChannelCreate = 13¶

PaymentChannelFund = 14¶

SetFee = 101¶

SetRegularKey = 5¶

SignerListSet = 12¶

TicketCancel = 11¶

TicketCreate = 10¶

TrustSet = 20¶

class aioxrpy.definitions.RippleType¶

An enumeration.

AccountID = 8¶

Amount = 6¶

Blob = 7¶

Done = -1¶

Hash128 = 4¶

Hash160 = 17¶

Hash256 = 5¶

LedgerEntry = 10002¶

NotPresent = 0¶

PathSet = 18¶

STArray = 15¶

STObject = 14¶

Transaction = 10001¶

UInt16 = 1¶

UInt32 = 2¶

UInt64 = 3¶

UInt8 = 16¶

Unknown = -2¶

Validation = 10003¶

Vector256 = 19¶

Exceptions¶

exception aioxrpy.exceptions.AccountNotFoundException(payload={})¶

exception aioxrpy.exceptions.InvalidTransactionException(payload={})¶

exception aioxrpy.exceptions.RippleBaseException(error, payload={})¶

exception aioxrpy.exceptions.RippleSerializerUnsupportedTypeException(payload={})¶

exception aioxrpy.exceptions.RippleTransactionCostlyFailureException(error, payload={})¶

exception aioxrpy.exceptions.RippleTransactionException(error, category, payload={})¶

exception aioxrpy.exceptions.RippleTransactionFailureException(error, payload={})¶

exception aioxrpy.exceptions.RippleTransactionLocalFailureException(error, payload={})¶

exception aioxrpy.exceptions.RippleTransactionMalformedException(error, payload={})¶

exception aioxrpy.exceptions.RippleTransactionRetriableException(error, payload={})¶

exception aioxrpy.exceptions.UnknownRippleException(payload={})¶

exception aioxrpy.exceptions.ValidatedLedgerUnavailableException(payload={})¶

Hash¶

aioxrpy.hash.first_half_of_sha512(*data)¶

Returns first 32 bytes of SHA512 hash

Return type: bytes

aioxrpy.hash.hash_transaction(prefix, tx, suffix)¶

Serializes transaction object and returns first half of SHA512 hash

Return type: bytes

Keys¶

class aioxrpy.keys.RippleKey(*, private_key=None, public_key=None)¶

RippleKey instance

Parameters

private_key (Union[str, bytes, None]) – private key or master seed,
public_key (Optional[bytes]) – public key

If no arguments are passed, new key will be generated.

sign(data, sigencode=<function sigencode_der>, **kwargs)¶

Signs the provided data and returns a canonical signature

Return type: str

sign_tx(tx, *, multi_sign=False, **kwargs)¶

Return type: str

to_account()¶

Returns base58-encoded RIPEMD-160 hash of SHA256 hash of public key, which is used as an account name on Ripple ledger.

For example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh

Return type: str

to_public()¶

Returns public key encoded in compressed format.

Return type: bytes

verify(data, signature, *, sigdecode=<function sigdecode_der>, **kwargs)¶

Return type: bool

verify_tx(tx, signature, *, multi_sign=False, **kwargs)¶

Return type: bool

aioxrpy.keys.make_canonical(r, s, order)¶: Makes ecdsa signature canonical

aioxrpy.keys.signing_key_from_seed(encoded_seed)¶

Derives SigningKey from master seed.

Reference: https://ripple.com/wiki/Account_Family#Root_Key_.28GenerateRootDeterministicKey.29

Return type: SigningKey

RPC¶

Serializer¶

class aioxrpy.serializer.AccountIDSerializer¶

Serializer for AccountID type

deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, str]

serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.AmountSerializer¶

deserialize(value)¶: Returns a tuple containing length of original data and deserialized value

scale_to_xrp_amount(value)¶

serialize(value)¶: Returns byte-encoded value

class aioxrpy.serializer.ArraySerializer¶

deserialize(value)¶: Returns a tuple containing length of original data and deserialized value

serialize(value)¶: Returns byte-encoded value

class aioxrpy.serializer.BaseSerializer¶

abstract deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, Any]

abstract serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.BasicTypeSerializer(fmt='')¶

Serializes basic types such as integers and floats using struct module

Params fmt: format string, please refer to documentation for struct module

deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, Any]

serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.BlobSerializer¶

Serializer for blob format

Reference: https://xrpl.org/serialization.html#length-prefixing

deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, bytes]

serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.CurrencySerializer¶

Currency code serializer

[12 reserved bytes][3-character currency code][5 reserved bytes]

deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, str]

serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.HashSerializer(length)¶

deserialize(value)¶: Returns a tuple containing length of original data and deserialized value

serialize(value)¶: Returns byte-encoded value

class aioxrpy.serializer.ObjectSerializer¶

To serialize an object to Ripple format, we need to follow these steps:

Convert each field data to binary format
Sort fields in “canonical order”
Prefix each field with a field ID.
Concatenate fields (with prefixes) in their sorted order

deserialize(value)¶

Returns a tuple containing length of original data and deserialized value

Return type: Tuple[int, Dict]

serialize(value)¶

Returns byte-encoded value

Return type: bytes

class aioxrpy.serializer.PathSetSerializer¶

deserialize(value)¶: Returns a tuple containing length of original data and deserialized value

serialize(value)¶: Returns byte-encoded value

aioxrpy.serializer.decode(key, binary)¶

aioxrpy.serializer.deserialize(binary)¶

Deserializes object from binary format. Shorthand for ObjectSerializer().deserialize(binary)

Return type: Dict

aioxrpy.serializer.encode(key, value)¶

aioxrpy.serializer.lookup_field(binary)¶

aioxrpy.serializer.serialize(obj)¶

Serializes object to binary format. Shorthand for ObjectSerializer().serialize(obj)

Return type: bytes