Creates a new Wallet.
The public key for the account.
The private key used for signing transactions for the account.
(Optional) Options to initialize a Wallet.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Optional
seed?: stringThe seed used to derive the account keys.
Readonly
classicReadonly
privateReadonly
publicOptional
Readonly
seedStatic
fromDerives a wallet from a secret (AKA a seed).
A Wallet derived from a secret (AKA a seed).
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAThe digital signature algorithm to generate an address for.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Alias for wallet.classicAddress.
The wallet's classic address.
Private
checkDecode 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.
A ValidationError if the transaction does not have a TxnSignature/Signers property, or if the serialized Transaction desn't match the original transaction.
XrplError if the transaction includes an issued currency which is equivalent to XRP ignoring case.
A signed and serialized transaction.
The transaction prior to signing.
Gets an X-address in Testnet/Mainnet format.
An X-address.
A tag to be included within the X-address.
A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.
Signs a transaction offline.
A signed transaction.
ValidationError if the transaction is already signed or does not encode/decode to same result.
XrplError if the issued currency being signed is XRP ignoring case.
Wallet instance.
A transaction to be signed offline.
Optional
multisign: string | booleanSpecify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.
Verifies a signed transaction offline.
Returns true if a signedTransaction is valid.
A signed transaction (hex string of signTransaction result) to be verified offline.
Static
Private
deriveDerive a Wallet from a seed.
A Wallet derived from the seed.
The seed used to derive the wallet.
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAThe digital signature algorithm to generate an address for.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Static
fromDerives a wallet from an entropy (array of random numbers).
A Wallet derived from an entropy.
An array of random numbers to generate a seed used to derive a wallet.
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAThe digital signature algorithm to generate an address for.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Static
fromDerives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).
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.
A Wallet derived from a mnemonic.
ValidationError if unable to derive private key from mnemonic input.
A string consisting of words (whitespace delimited) used to derive a wallet.
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAOnly 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
derivationThe path to derive a keypair (publicKey/privateKey). Only used for bip39 conversions.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Optional
mnemonicIf 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.
Static
Private
fromRFC1751Derives a wallet from a RFC1751 mnemonic, which is how wallet_propose
encodes mnemonics.
A Wallet derived from a mnemonic.
A string consisting of words (whitespace delimited) used to derive a wallet.
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAThe digital signature algorithm to generate an address for.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Static
fromDerives a wallet from a seed.
A Wallet derived from a seed.
A string used to generate a keypair (publicKey/privateKey) to derive a wallet.
(Optional) Options to derive a Wallet.
Optional
algorithm?: ECDSAThe digital signature algorithm to generate an address for.
Optional
masterInclude if a Wallet uses a Regular Key Pair. It must be the master address of the account.
Static
generateGenerated using TypeDoc
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