Class XRP

XRP Ledger chain adapter implementation

Provides functionality to interact with the XRP Ledger blockchain including balance queries, address derivation, transaction preparation, signing, and broadcasting.

Hierarchy (View Summary)

ChainAdapter<XRPTransactionRequest, XRPUnsignedTransaction>
- XRP

Index

Constructors

constructor

Methods

getBalance deriveAddressAndPublicKey serializeTransaction deserializeTransaction prepareTransactionForSigning finalizeTransactionSigning generateTxnSignature broadcastTx

Constructors

constructor

new XRP(
    params: {
        rpcUrl: string;
        contract: ChainSignatureContract;
        client?: Client;
    },
): XRP
Creates a new XRP chain adapter instance
Parameters
- params: { rpcUrl: string; contract: ChainSignatureContract; client?: Client }
  Configuration parameters
  - rpcUrl: string
    XRP Ledger RPC endpoint URL
  - contract: ChainSignatureContract
    Instance of the chain signature contract for MPC operations
  - Optionalclient?: Client
    Optional XRPL client instance (for testing)
Returns XRP
Overrides ChainAdapter.constructor
- Defined in src/chain-adapters/XRP/XRP.ts:36

Methods

getBalance

getBalance(address: string): Promise<{ balance: bigint; decimals: number }>
Retrieves the XRP balance for a given address
Parameters
- address: string
  The XRP address to query
Returns Promise<{ balance: bigint; decimals: number }>
Promise resolving to balance information with amount in drops and decimal places

Throws
Error if the balance query fails for reasons other than account not found
Overrides ChainAdapter.getBalance
- Defined in src/chain-adapters/XRP/XRP.ts:59

deriveAddressAndPublicKey

deriveAddressAndPublicKey(
predecessor: string,
path: string,
): Promise<{ address: string; publicKey: string }>
Derives an XRP address and compressed public key from the given path and predecessor
Parameters
- predecessor: string
  The predecessor for key derivation
- path: string
  The derivation path
Returns Promise<{ address: string; publicKey: string }>
Promise resolving to the derived address and compressed public key

Throws
Error if public key derivation fails
Overrides ChainAdapter.deriveAddressAndPublicKey
- Defined in src/chain-adapters/XRP/XRP.ts:110

serializeTransaction

serializeTransaction(transaction: XRPUnsignedTransaction): string
Serializes an XRP unsigned transaction to a JSON string
Parameters
- transaction: XRPUnsignedTransaction
  The unsigned transaction to serialize
Returns string
JSON string representation of the transaction
Overrides ChainAdapter.serializeTransaction
- Defined in src/chain-adapters/XRP/XRP.ts:156

deserializeTransaction

deserializeTransaction(serialized: string): XRPUnsignedTransaction
Deserializes a JSON string back to an XRP unsigned transaction
Parameters
- serialized: string
  The JSON string to deserialize
Returns XRPUnsignedTransaction
The deserialized unsigned transaction
Overrides ChainAdapter.deserializeTransaction
- Defined in src/chain-adapters/XRP/XRP.ts:166

prepareTransactionForSigning

prepareTransactionForSigning(
    transactionRequest: XRPTransactionRequest,
): Promise<
    {
        transaction: XRPUnsignedTransaction;
        hashesToSign: contracts.HashToSign[];
    },
>
Prepares an XRP transaction for signing by autofilling required fields and generating signing hash
Parameters
- transactionRequest: XRPTransactionRequest
  The transaction request containing payment details
Returns Promise<
    {
        transaction: XRPUnsignedTransaction;
        hashesToSign: contracts.HashToSign[];
    },
>
Promise resolving to the prepared unsigned transaction and hash to sign

Throws
Error if transaction preparation fails
Overrides ChainAdapter.prepareTransactionForSigning
- Defined in src/chain-adapters/XRP/XRP.ts:177

finalizeTransactionSigning

finalizeTransactionSigning(
    params: {
        transaction: XRPUnsignedTransaction;
        rsvSignatures: RSVSignature[];
    },
): string
Finalizes transaction signing by applying RSV signatures to the prepared transaction
Parameters
- params: { transaction: XRPUnsignedTransaction; rsvSignatures: RSVSignature[] }
  Object containing the unsigned transaction and RSV signatures
  - transaction: XRPUnsignedTransaction
    The unsigned transaction to sign
  - rsvSignatures: RSVSignature[]
    Array of RSV signatures (only first signature is used)
Returns string
JSON string of the signed transaction ready for broadcast

Throws
Error if no signatures are provided
Overrides ChainAdapter.finalizeTransactionSigning
- Defined in src/chain-adapters/XRP/XRP.ts:235

generateTxnSignature

generateTxnSignature(r: string, s: string, v: number): string
Generates a DER-encoded transaction signature from RSV signature components
Parameters
- r: string
  The R component of the signature in hex
- s: string
  The S component of the signature in hex
- v: number
  The V component of the signature (recovery ID)
Returns string
DER-encoded signature in uppercase hex format
- Defined in src/chain-adapters/XRP/XRP.ts:271

broadcastTx

broadcastTx(txSerialized: string): Promise<{ hash: string }>
Broadcasts a signed XRP transaction to the network
Parameters
- txSerialized: string
  JSON string of the signed transaction
Returns Promise<{ hash: string }>
Promise resolving to the transaction hash

Throws
Error if transaction submission fails or is rejected by the network
Overrides ChainAdapter.broadcastTx
- Defined in src/chain-adapters/XRP/XRP.ts:310

Class XRP

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

rpcUrl: string

contract: ChainSignatureContract

Optionalclient?: Client

Returns XRP

Methods

getBalance

Parameters

Returns Promise<{ balance: bigint; decimals: number }>

Throws

deriveAddressAndPublicKey

Parameters

Returns Promise<{ address: string; publicKey: string }>

Throws

serializeTransaction

Parameters

Returns string

deserializeTransaction

Parameters

Returns XRPUnsignedTransaction

prepareTransactionForSigning

Parameters

Returns Promise< { transaction: XRPUnsignedTransaction; hashesToSign: contracts.HashToSign[]; },>

Throws

finalizeTransactionSigning

Parameters

transaction: XRPUnsignedTransaction

rsvSignatures: RSVSignature[]

Returns string

Throws

generateTxnSignature

Parameters

Returns string

broadcastTx

Parameters

Returns Promise<{ hash: string }>

Throws

Settings

On This Page

`Optional`client?: Client

Returns Promise<
{
transaction: XRPUnsignedTransaction;
hashesToSign: contracts.HashToSign[];
},
>