Class Wallet

A utility for deriving a wallet composed of a keypair (publicKey/privateKey). A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers). It provides functionality to sign/verify transactions offline.

Example


// Derive a wallet from a base58 encoded seed.
const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
console.log(seedWallet)
// Wallet {
// publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
// privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
// classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
// seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
// }.

// Sign a JSON Transaction
 const signed = seedWallet.signTransaction({
     TransactionType: 'Payment',
     Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
     ...........
}).

console.log(signed)
// '1200007321......B01BE1DFF3'.
console.log(decode(signed))
// {
//   TransactionType: 'Payment',
//   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
//   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
//   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
//   ...........
// }

Hierarchy

  • Wallet

Constructors

constructor

Properties

classicAddress privateKey publicKey seed? fromSecret

Accessors

address

Methods

checkTxSerialization getXAddress sign verifyTransaction deriveWallet fromEntropy fromMnemonic fromRFC1751Mnemonic fromSeed generate

Constructors

constructor

  • Creates a new Wallet.

    Parameters

    • publicKey: string

      The public key for the account.

    • privateKey: string

      The private key used for signing transactions for the account.

    • opts: {
          masterAddress?: string;
          seed?: string;
      } = {}

      (Optional) Options to initialize a Wallet.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

      • Optional seed?: string

        The seed used to derive the account keys.

    Returns Wallet

Properties

Readonly classicAddress

classicAddress: string

Readonly privateKey

privateKey: string

Readonly publicKey

publicKey: string

Optional Readonly seed

seed?: string

Static fromSecret

fromSecret: ((seed: string, opts?: {
    algorithm?: ECDSA;
    masterAddress?: string;
}) => Wallet) = Wallet.fromSeed

Type declaration

    • (seed: string, opts?: {
          algorithm?: ECDSA;
          masterAddress?: string;
      }): Wallet

    • Derives a wallet from a secret (AKA a seed).

      Returns

      A Wallet derived from a secret (AKA a seed).

      Parameters

      • seed: string
      • opts: {
            algorithm?: ECDSA;
            masterAddress?: string;
        } = {}

        (Optional) Options to derive a Wallet.

        • Optional algorithm?: ECDSA

          The digital signature algorithm to generate an address for.

        • Optional masterAddress?: string

          Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

      Returns Wallet

Accessors

address

Methods

Private checkTxSerialization

  • Decode a serialized transaction, remove the fields that are added during the signing process, and verify that it matches the transaction prior to signing. This gives the user a sanity check to ensure that what they try to encode matches the message that will be recieved by rippled.

    Throws

    A ValidationError if the transaction does not have a TxnSignature/Signers property, or if the serialized Transaction desn't match the original transaction.

    Throws

    XrplError if the transaction includes an issued currency which is equivalent to XRP ignoring case.

    Parameters

    • serialized: string

      A signed and serialized transaction.

    • tx: Transaction

      The transaction prior to signing.

    Returns void

getXAddress

  • Gets an X-address in Testnet/Mainnet format.

    Returns

    An X-address.

    Parameters

    • tag: number | false = false

      A tag to be included within the X-address.

    • isTestnet: boolean = false

      A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.

    Returns string

sign

  • Signs a transaction offline.

    Returns

    A signed transaction.

    Throws

    ValidationError if the transaction is already signed or does not encode/decode to same result.

    Throws

    XrplError if the issued currency being signed is XRP ignoring case.

    Parameters

    • this: Wallet

      Wallet instance.

    • transaction: Transaction

      A transaction to be signed offline.

    • Optional multisign: string | boolean

      Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.

    Returns {
        hash: string;
        tx_blob: string;
    }

    • hash: string
    • tx_blob: string

verifyTransaction

  • Verifies a signed transaction offline.

    Returns

    Returns true if a signedTransaction is valid.

    Parameters

    • signedTransaction: string | Transaction

      A signed transaction (hex string of signTransaction result) to be verified offline.

    Returns boolean

Static Private deriveWallet

  • Derive a Wallet from a seed.

    Returns

    A Wallet derived from the seed.

    Parameters

    • seed: string

      The seed used to derive the wallet.

    • opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

      • Optional algorithm?: ECDSA

        The digital signature algorithm to generate an address for.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    Returns Wallet

Static fromEntropy

  • Derives a wallet from an entropy (array of random numbers).

    Returns

    A Wallet derived from an entropy.

    Parameters

    • entropy: number[] | Uint8Array

      An array of random numbers to generate a seed used to derive a wallet.

    • opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

      • Optional algorithm?: ECDSA

        The digital signature algorithm to generate an address for.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    Returns Wallet

Static fromMnemonic

  • Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).

    Deprecated

    since version 2.6.1. Will be deleted in version 3.0.0. This representation is currently deprecated in rippled. You should use another method to represent your keys such as a seed or public/private keypair.

    Returns

    A Wallet derived from a mnemonic.

    Throws

    ValidationError if unable to derive private key from mnemonic input.

    Parameters

    • mnemonic: string

      A string consisting of words (whitespace delimited) used to derive a wallet.

    • opts: {
          algorithm?: ECDSA;
          derivationPath?: string;
          masterAddress?: string;
          mnemonicEncoding?: "bip39" | "rfc1751";
      } = {}

      (Optional) Options to derive a Wallet.

      • Optional algorithm?: ECDSA

        Only used if opts.mnemonicEncoding is 'rfc1751'. Allows the mnemonic to generate its secp256k1 seed, or its ed25519 seed. By default, it will generate the secp256k1 seed to match the rippled wallet_propose default algorithm.

      • Optional derivationPath?: string

        The path to derive a keypair (publicKey/privateKey). Only used for bip39 conversions.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

      • Optional mnemonicEncoding?: "bip39" | "rfc1751"

        If set to 'rfc1751', this interprets the mnemonic as a rippled RFC1751 mnemonic like wallet_propose generates in rippled. Otherwise the function defaults to bip39 decoding.

    Returns Wallet

Static Private fromRFC1751Mnemonic

  • Derives a wallet from a RFC1751 mnemonic, which is how wallet_propose encodes mnemonics.

    Returns

    A Wallet derived from a mnemonic.

    Parameters

    • mnemonic: string

      A string consisting of words (whitespace delimited) used to derive a wallet.

    • opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      }

      (Optional) Options to derive a Wallet.

      • Optional algorithm?: ECDSA

        The digital signature algorithm to generate an address for.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    Returns Wallet

Static fromSeed

  • Derives a wallet from a seed.

    Returns

    A Wallet derived from a seed.

    Parameters

    • seed: string

      A string used to generate a keypair (publicKey/privateKey) to derive a wallet.

    • opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

      • Optional algorithm?: ECDSA

        The digital signature algorithm to generate an address for.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    Returns Wallet

Static generate

  • Generates a new Wallet using a generated seed.

    Returns

    A new Wallet derived from a generated seed.

    Parameters

    • algorithm: ECDSA = DEFAULT_ALGORITHM

      The digital signature algorithm to generate an address for.

    Returns Wallet

Settings

Member Visibility

Theme

Generated using TypeDoc