An array of signed Transactions (in object or blob form) to combine into a single signed Transaction.
A single signed Transaction which has all Signers from transactions within it.
Compute AccountRoot Ledger Object Index.
All objects in a ledger's state tree have a unique Index. The AccountRoot Ledger Object Index is derived by hashing the address with a namespace identifier. This ensures every Index is unique.
The classic account address.
The Ledger Object Index for the account.
Compute the Hash of an Escrow LedgerEntry.
Address of the Escrow.
OfferSequence of the Escrow.
The hash of the Escrow LedgerEntry.
Compute the hash of a ledger.
Ledger to compute the hash for.
Allow client to recompute Transaction and State Hashes.
Whether to recompute the Transaction and State Hashes.
The has of ledger.
Compute the hash of a ledger.
Ledger to compute the hash of.
The hash of the ledger.
The Index of a Offer object is the SHA-512Half of the following values, concatenated in order:
This method computes an Offer Index.
The classic account address of the SignerList owner (starting with r).
Sequence of the Offer.
The Index of the account's Offer object.
Compute the hash of a Payment Channel.
Account of the Payment Channel.
Destination Account of the Payment Channel.
Sequence number of the Transaction that created the Payment Channel.
Hash of the Payment Channel.
Hashes the Transaction object as the ledger does. Throws if the transaction is unsigned.
A transaction to hash. Tx may be in binary blob form. Tx must be signed.
A hash of tx.
The Index of a SignerList object is the SHA-512Half of the following values, concatenated in order:
This method computes a SignerList Ledger Object Index.
The classic account address of the SignerList owner (starting with r).
The Index of the account's SignerList object.
Compute the state hash of a list of LedgerEntries.
List of LedgerEntries.
Hash of SHAMap that consists of all entries.
Compute the hash of a Trustline.
One of the addresses in the Trustline.
The other address in the Trustline.
Currency in the Trustline.
The hash of the Trustline.
Hash the given binary transaction data with the single-signing prefix.
See Serialization Format.
The binary transaction blob as a hexadecimal string.
The hash to sign.
Compute the root hash of the SHAMap containing all transactions.
List of Transactions.
The root hash of the SHAMap.
Creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
The account that will sign for this payment channel.
An id for the payment channel to redeem XRP from.
The amount in drops to redeem.
A signature that can be used to redeem a specific amount of XRP from a payment channel.
Converts hex to its string equivalent. Useful to read the Domain field and some Memos.
The hex to convert to a string.
The encoding to use. Defaults to 'utf8' (UTF-8). 'ascii' is also allowed.
The converted string.
Converts a string to its hex equivalent. Useful for Memos.
The string to convert to Hex.
The Hex equivalent of the string.
Creates a cross-chain payment transaction.
The initial payment transaction. If the transaction is signed, then it will need to be re-signed. There must be no more than 2 memos, since one memo is used for the sidechain destination account. The destination must be the sidechain's door account.
the destination account on the sidechain.
A cross-chain payment transaction, where the mainchain door account
is the Destination and the destination account on the sidechain is encoded
in the memos.
Converts a string decimal to the "billionths" format for use with QualityIn/ QualityOut
A string decimal (i.e. ".00034").
A number in the "billionths" format.
Converts a string decimal to "billionths" format for use with TransferRate.
A string decimal between 0 and 1.00
A number in the "billionths" format.
Derive an X-Address from a public key and a destination tag.
Public key and destination tag to encode as an X-Address.
The public key corresponding to an address.
A destination tag to encode into an X-address. False indicates no destination tag.
Whether this address is for use in Testnet.
X-Address.
Convert Drops to XRP.
Drops to convert to XRP. This can be a string, number, or BigNumber.
Amount in XRP.
Computes the complete list of every balance that changed in the ledger as a result of the given transaction.
Transaction metadata.
Parsed balance changes.
Returns true if there are more pages of data.
When there are more results than contained in the response, the response
includes a marker field.
See https://ripple.com/build/rippled-apis/#markers-and-pagination.
Response to check for more pages on.
Whether the response has more pages of data.
Validates that a given address is a valid X-Address or a valid classic address.
Address to validate.
True if address is a valid X-Address or classic address.
Check if a secret is valid.
Secret to test for validity.
True if secret can be derived into a keypair.
Convert an ISO8601 timestmap to a ripple timestamp.
International standard date format.
Seconds since ripple epoch (1/1/2000 GMT).
Converts a string percent to the "billionths" format for use with QualityIn/ QualityOut
A string percent (i.e. ".034%").
A number in the "billionths" format.
Converts a string percent to "billionths" format for use with TransferRate.
A string percent between 0% and 100%.
A number in the "billionths" format.
Converts a quality in "billionths" format to a decimal.
Quality to convert to decimal.
decimal representation of quality.
Convert a ripple timestamp to an Iso8601 timestamp.
Is the number of seconds since Ripple Epoch (1/1/2000 GMT).
Iso8601 international standard date format.
Convert a ripple timestamp to a unix timestamp.
(seconds since 1/1/2000 GMT).
Milliseconds since unix epoch.
Sign a payment channel claim.
Channel identifier specified by the paymentChannelClaim.
Amount specified by the paymentChannelClaim.
Private Key to sign paymentChannelClaim with.
True if the channel is valid.
Converts a transfer rate in "billionths" format to a decimal.
TransferRate to convert to decimal.
decimal representation of transfer Rate.
Convert a unix timestamp to a ripple timestamp.
(ms since unix epoch).
Seconds since Ripple Epoch (1/1/2000 GMT).
Verifies various Transaction Types. Encode/decode and individual type validation.
A Transaction.
Verify the signature of a payment channel claim.
Channel identifier specified by the paymentChannelClaim.
Amount specified by the paymentChannelClaim.
Signature produced from signing paymentChannelClaim.
Public key that signed the paymentChannelClaim.
True if the channel is valid.
Verifies that the given transaction has a valid signature based on public-key encryption.
A transaction to verify the signature of. (Can be in object or encoded string format).
Returns true if tx has a valid signature, and returns false otherwise.
Convert an amount in XRP to an amount in drops.
Amount in XRP.
Amount in drops.
The path_find method searches for a path along which a transaction can
possibly be made, and periodically sends updates when the path changes over
time. For a simpler version that is supported by JSON-RPC, see the
ripple_path_find method.
Decodes a hex string into a transaction | ledger entry
hex string in the XRPL serialization format.
The hex string decoded according to XRPL serialization format.
Encodes a LedgerEntry or Transaction into a hex string
LedgerEntry or Transaction in JSON format.
A hex string representing the encoded object.
Encodes a Transaction for multi-signing
Transaction in JSON format.
The address of the account signing this transaction
A hex string representing the encoded object.
Encodes a Transaction for signing
LedgerEntry in JSON or Transaction format.
A hex string representing the encoded object.
Encodes a PaymentChannelClaim for signing
PaymentChannelClaim in JSON format.
A hex string representing the encoded object.
Generates a modified RFC1751 mnemonic in the same way rippled's wallet_propose does.
An encoded secret in hex format.
A mnemonic following rippled's modified RFC1751 mnemonic standard.
Convert an AccountRoot Flags number into an interface for easy interpretation.
A number which is the bitwise and of all enabled AccountRootFlagsInterface.
An interface with all flags as booleans.
Parses an NFTokenID into the information it is encoding.
Example decoding:
000B 0539 C35B55AA096BA6D87A6E6C965A6534150DC56E5E 12C5D09E 0000000C
+--- +--- +--------------------------------------- +------- +-------
| | | | |
| | | | ---> Sequence: 12 | | | | | | | ---> Scrambled Taxon: 314,953,886
| | | Unscrambled Taxon: 1337
| | |
| | ---> Issuer: rJoxBSzpXhPtAuqFmqxQtGKjA13jUJWthE | | | ---> TransferFee: 1337.0 bps or 13.37%
|
`---> Flags: 11 -> lsfBurnable, lsfOnlyXRP and lsfTransferable
A hex string which identifies an NFToken on the ledger.
a decoded nftokenID with all fields encoded within.
Converts an english mnemonic following rippled's modified RFC1751 standard to an encoded hex secret.
A mnemonic generated using ripple's modified RFC1751 standard.
A Buffer containing an encoded secret.
Sets a transaction's flags to its numeric representation.
A transaction to set its flags to its numeric representation.
Generated using TypeDoc
Takes several transactions with Signer fields (in object or blob form) and creates a single transaction with all Signers that then gets signed and returned.
ValidationError if: