Class XRPL

connected

name

provider

rpc_url

signer

wallet

connect

• connect(with_reconnect?): Promise<boolean>

• Connects to the RPC provider

  Parameters

  • with_reconnect: boolean = true

  Returns Promise<boolean>

  A boolean indicating if the connection was successful

connectWallet

• connectWallet(privateKey): Promise<Wallet>

• Connects to a wallet using a private key

  Parameters

  • privateKey: string

    The private key of the wallet

  Returns Promise<Wallet>

  The wallet object

disconnect

• disconnect(): Promise<boolean>

• Disconnects from the RPC provider and the wallet

  Returns Promise<boolean>

  A boolean indicating if the disconnection was successful

getAddress

• getAddress(): string

• Returns the address of the connected wallet

  Returns string

getBalance

• getBalance(address, multi?): Promise<string>

• Gets the balance of a wallet

  Parameters

  • address: string

    The wallet address
  • multi: boolean = true

  Returns Promise<string>

  The balance of the wallet as a string

getEmptyTransaction

• getEmptyTransaction(): Promise<{
      Account: string;
      Amount: string;
      Destination: string;
      Sequence: number;
      TransactionType: "Payment";
  }>

• Creates a skeleton transaction

  Returns Promise<{
      Account: string;
      Amount: string;
      Destination: string;
      Sequence: number;
      TransactionType: "Payment";
  }>

preparePay

• preparePay(address, amount): Promise<{}>
• Alias

  Creates a signed transaction to transfer default chain currency

  Parameters

  • address: string
  • amount: string | number

    The amount to transfer

  Returns Promise<{}>

  The signed transaction

  prepareTransfer

preparePays

• preparePays(payments): Promise<{}[]>

• Creates a list of signed transactions to transfer default chain currency

  Parameters

  • payments: IPayOptions[]

    A list of transfers to prepare

  Returns Promise<{}[]>

  An ordered list of signed transactions

prepareTransfer

• prepareTransfer<T, Options>(this, receiver, amount, options?): Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

• Creates a signed transaction to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • receiver: string

    The receiver's address
  • amount: string

    The amount to transfer
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

  The signed transaction

prepareTransfers

• prepareTransfers<T, Options>(this, payments, options?): Promise<Awaited<ReturnType<T["preparePays"]>>>

• Creatthis.provider = new JsonRpcProvider(this.rpc_url)es a list of signed transactions to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • payments: IPayOptions[]

    A list of transfers to prepare
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>>

  An ordered list of signed transactions

setRpc

• setRpc(rpc_url): Promise<void>

• Sets the RPC URL only. Use await instance.connect() to connect to the rpc provider

  Parameters

  • rpc_url: string

  Returns Promise<void>

signMessage

• signMessage(message, options?): Promise<string>

• Signs a message using the connected wallet

  Parameters

  • message: string

    The message to sign
  • Optionaloptions: {
        privateKey?: string;
    }

    Options

    • OptionalprivateKey?: string

  Returns Promise<string>

  The signed message

signTransaction

• signTransaction(transaction, options?): Promise<{}>

• Signs a transaction using the connected wallet

  Parameters

  • transaction: Transaction
  • Optionaloptions: {
        privateKey: string;
    }

    Options

    • privateKey: string

  Returns Promise<{}>

  The signed transaction

signTransactions

• signTransactions(transactions, options?): Promise<{}[]>

• Signs a list of transactions using the connected wallet. The transaction nonce is incremented for each transaction in order of appearance.

  Parameters

  • transactions: Transaction[]

    A list of transactions to sign
  • Optionaloptions: {
        privateKey: string;
    }

    Options

    • privateKey: string

  Returns Promise<{}[]>

verifyMessage

• verifyMessage(message, signature, publicKey): Promise<boolean>

• Verifies a message using the connected wallet

  Parameters

  • message: string

    The message to verify
  • signature: string

    The signature to verify
  • publicKey: string

  Returns Promise<boolean>

  A boolean indicating if the message was verified

Staticcreate

• create<T>(this, rpc_url?): Promise<T>

• Creates a new instance of this sdk

  Type Parameters

  • T extends DefaultChain

  Parameters

  • this: (new (rpc_url: string) => T)
    • • new (rpc_url): T

      • Parameters

        • rpc_url: string

        Returns T

  • rpc_url: string = ""

    The RPC URL

  Returns Promise<T>

  The sdk instance connected to the RPC provider