Class MoneroWalletRpc

Add an address book entry.

Register a listener to receive wallet notifications.

Change the wallet password.

Proves a wallet has a disposable reserve using a signature.

Prove a spend using a signature. Unlike proving a transaction, it does not require the destination public address.

Check a transaction in the blockchain with its secret key.

Prove a transaction by checking its signature.

Optionally save then close the wallet.

Create a new account with a label for the first subaddress.

Create a subaddress within an account.

Create a transaction to transfer funds from this wallet.

Create one or more transactions to transfer funds from this wallet.

Create and open a wallet on the monero-wallet-rpc server.

Example:

// construct client to monero-wallet-rpc
let walletRpc = new MoneroWalletRpc("http://localhost:38084", "rpc_user", "abc123");



// create and open wallet on monero-wallet-rpc
await walletRpc.createWallet({
   path: "mywallet",
   password: "abc123",
   seed: "coexist igloo pamphlet lagoon...",
   restoreHeight: 1543218l
});

Decode an integrated address to get its standard address and payment id.

Delete an address book entry.

Describe a tx set containing unsigned or multisig tx hex to a new tx set containing structured transactions.

Edit an address book entry.

Exchange multisig hex with participants in a M/N multisig wallet.

This process must be repeated with participants exactly N-M times.

Export signed key images.

Export this wallet's multisig info as hex for other participants.

Export outputs in hex format.

Freeze an output.

Get an account.

Return all account tags.

Get accounts with a given tag.

Get the address of a specific subaddress.

Get address book entries.

Get the account and subaddress index of the given address.

Get an attribute.

Get the balance of the wallet, account, or subaddress.

Get the locked and unlocked balances in a single request.

Get the wallet's daemon connection.

Get the blockchain's height.

Get the block height that the wallet is synced to.

Get the blockchain's height by date as a conservative estimate for scanning.

Get incoming transfers.

Get an integrated address based on the given standard address and payment ID. Uses the wallet's primary address if an address is not given. Generates a random payment ID if a payment ID is not given.

Get multisig info about this wallet.

Get new key images from the last imported outputs.

Get the number of blocks until the next and last funds unlock.

Get outgoing transfers.

Get outputs created from previous transactions that belong to the wallet (i.e. that the wallet can spend one time). Outputs are part of transactions which are stored in blocks on the blockchain.

Results can be filtered by passing a query object. Outputs must meet every criteria defined in the query in order to be returned. All filtering is optional and no filtering is applied when not defined.

Get the wallet's path.

Creates a payment URI from a send configuration.

Get the wallet's private spend key.

Get the wallet's private view key.

Get the internal process running monero-wallet-rpc.

Generate a signature to prove an available amount in an account.

Generate a signature to prove the entire balance of the wallet.

Get the wallet's RPC connection.

Get the wallet's mnemonic phrase or seed.

Get the language of the wallet's mnemonic phrase or seed.

Get a list of available languages for the wallet's seed.

Generate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.

Get a subaddress.

Get subaddresses in an account.

Get incoming and outgoing transfers to and from this wallet. An outgoing transfer represents a total amount sent from one or more subaddresses within an account to individual destination addresses, each with their own amount. An incoming transfer represents a total amount received into a subaddress within an account. Transfers belong to transactions which are stored on the blockchain.

Results can be filtered by passing a query object. Transfers must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.

Get a wallet transaction by hash.

Get a transaction's secret key from its hash.

Get a transaction note.

Get notes for multiple transactions.

Get a transaction signature to prove it.

Get wallet transactions. Wallet transactions contain one or more transfers that are either incoming or outgoing to the wallet.

Results can be filtered by passing a query object. Transactions must meet every criteria defined in the query in order to be returned. All criteria are optional and no filtering is applied when not defined.

Get the unlocked balance of the wallet, account, or subaddress.

Gets the version of the wallet.

Import signed key images and verify their spent status.

Import multisig info as hex from other participants.

Import outputs in hex format.

Indicates if this wallet is closed or not.

Indicates if the wallet is connected to daemon.

Indicates if importing multisig data is needed for returning a correct balance.

Check if an output is frozen.

Indicates if the wallet is view-only, meaning it does not have the private spend key and can therefore only observe incoming outputs.

Make this wallet multisig by importing multisig hex from participants.

Open an existing wallet on the monero-wallet-rpc server.

Example:

let wallet = new MoneroWalletRpc("http://localhost:38084", "rpc_user", "abc123");
await wallet.openWallet("mywallet1", "supersecretpassword");

await wallet.openWallet({
   path: "mywallet2",
   password: "supersecretpassword",
   server: "http://locahost:38081", // or object with uri, username, password, etc
   rejectUnauthorized: false
});


Parses a payment URI to a tx config.

Get multisig info as hex to share with participants to begin creating a multisig wallet.

Relay a previously created transaction.

Relay previously created transactions.

Unregister a listener to receive wallet notifications.

Rescan the blockchain from scratch, losing any information which cannot be recovered from the blockchain itself.

WARNING: This method discards local wallet data like destination addresses, tx secret keys, tx notes, etc.

Rescan the blockchain for spent outputs.

Note: this can only be called with a trusted daemon.

Example use case: peer multisig hex is import when connected to an untrusted daemon, so the wallet will not rescan spent outputs. Then the wallet connects to a trusted daemon. This method should be manually invoked to rescan outputs.

Save the wallet at its current path.

Scan transactions by their hash/id.

Sets a human-readable description for a tag.

Set an arbitrary attribute.

Set the wallet's daemon connection.

Set a subaddress label.

Set a note for a specific transaction.

Set notes for multiple transactions.

Sign a message.

Sign multisig transactions from a multisig wallet.

Sign unsigned transactions from a view-only wallet.

Start mining.

Start background synchronizing with a maximum period between syncs.

Save and close the current wallet and stop the RPC server.

Stop mining.

Stop the internal process running monero-wallet-rpc, if applicable.

Stop synchronizing the wallet with the daemon.

Submit signed multisig transactions from a multisig wallet.

Submit signed transactions from a view-only wallet.

Sweep all unmixable dust outputs back to the wallet to make them easier to spend and mix.

NOTE: Dust only exists pre RCT, so this method will throw "no dust to sweep" on new wallets.

Sweep an output by key image.

Sweep all unlocked funds according to the given configuration.

Synchronize the wallet with the daemon as a one-time synchronous process.

Tag accounts.

Thaw a frozen output.

Untag accounts.

Verify a signature on a message.

Compares two transfers by ascending account and subaddress indices.