Wallet

Control whether saving the wallet to underlying storage is automatic (true, default), or initiated by API calls Wallet performance could improve if automaticFlush is false and the wallet is saved rarely. However state may be lost!

This wallet finds its coins on this blockchain

Give this wallet access to the historical price (epoch seconds) of its token in the provided fiat currency code

True if this wallet is deleted

Any name you may want to call this wallet

Pause blockchain processing if true

Give this wallet access to the spot price of its token in the provided fiat currency code

Returns the current position of this wallet in the blockchain. Since a fork may have occurred, this information does not unambiguously locate the wallet, but it is valuable for UI.

Abort this transaction, whose inputs were reserved by "prepareSend". Update the wallet to release all inputs reserved by this transaction

Return all configured identity domains

Get a repeatable destination, generally used for identity purposes. Given 2 different seeds, this API should at a minimum be statistically unlikely to produce the same address The seed may be public data (a domain name, for example) so wallet security must not depend on it being a secret.

Low level API to generate a new address to receive funds, called by newDestination. Use "newDestination()" in almost all cases. This API does not pre-generate (so may be slow), and does not install the destination into bloom filters, etc, before returning. This means that there may be a race condition between the use of the destination returned here and the wallet's monitoring of that destination which could cause funds to be received but not noticed by this wallet.

Gets a new address: convenience function that is functionally similar to @newDestination but mirrors the bitcoin-cli command

Get a new address to receive funds. Different wallets may support different payment destination types. This API returns whatever is the "default" type for this wallet. This allows generic algorithms to be created that can be applied to many different wallet types. When this API returns, the destination is ready for use (monitoring is installed in remote nodes, IF any remote nodes exist). This API may pre-generate destinations.

Wallet implementations may allow access to addresses generated from specific private keys or nonstandard HD derivation paths. The wallet will never offer these destinations as current payment targets. It will only spend them (and show their balance).

wallet history by transaction

all UTXOs that this wallet is capable of spending (and how to spend them) READ ONLY

Return identity domain data if this domain has previously been used

Get a new address to receive funds. Different wallets may support different payment destination types. This API returns whatever is the "default" type for this wallet. This allows generic algorithms to be created that can be applied to many different wallet types. When this API returns, the destination is ready for use (monitoring is installed in remote nodes, IF any remote nodes exist). This API may pre-generate destinations.

Tell the wallet that now is a good time to top-up a cache of unused destinations

Creates an unsigned transaction that sends to a list of outputs. This function will select input coins from the wallet to fill the passed quantity and sign the transaction, but will not relay the transaction to the network.

Forget all transaction and blockchain state, and asynchronously redo the search for wallet transactions. This is intended for testing and debug

Remove identity domain data

Remove identity information

Write this wallet's changes to underlying storage. Called internally if @automaticSave is true, and/or explicitly called. Synchronous. An inability to save the wallet is a severe problem so exceptions are thrown.

Post this transaction and update the wallet based on any inputs spent. Typically the provided tx came from calling prepareSend

Send funds to multiple destinations. This function will select input coins from the wallet to fill the passed quantity

Send funds to this destination. This function will select input coins from the wallet to fill the passed quantity

Send funds to multiple destinations (native coin only). This function will select input coins from the wallet to fill the passed quantity

Install a callback handler for whenever this wallet changes

Calculate a suggested fee for this transaction

Return whether this wallet is synced with its underlying blockchain. If it is not synced, properties like balance and balanceUnconfirmed express some previous state. In the unsynced case, this API will wait for it to do so, but no more than the provided time in milliseconds. If a height is provided, this API returns true if the wallet is synced up to or beyond this height If a height is not provided (or is -1), this API assumes you mean up to "now". This is special cased with an extra check that the blockchain's tip timestamp is within an hour of now. Of course, since blocks can be discovered at any time, and connected nodes can be slow at processing blocks one cannot ever absolutely know whether the wallet is really synced up to "now", so this function is more accurately described as "nearly synced" for any "now" call.

Return whether this wallet is synced with its underlying blockchain. If it is not synced, properties like balance and balanceUnconfirmed express some previous state. In the unsynced case, this API will wait for it to do so, but no more than the provided time in milliseconds. If a height is provided, this API returns true if the wallet is synced up to or beyond this height If a height is not provided (or is -1), this API assumes you mean up to "now". This is special cased with an extra check that the blockchain's tip timestamp is within an hour of now. Of course, since blocks can be discovered at any time, and connected nodes can be slow at processing blocks one cannot ever absolutely know whether the wallet is really synced up to "now", so this function is more accurately described as "nearly synced" for any "now" call.

Modify the passed transaction to complete it to the extent possible by this wallet, including: Find inputs needed to supply satoshis and/or group tokens for this transaction. If change outputs are required, add them. If mint baton passing outputs are possible then add them if equalizeAuthorities=true If outputs are not fully specified, supply the missing constraints.

Add or update identity domain data

Add or update identity data