Wallet subsystem.
Namespaces
Name |
Description |
Record type prefixes used as keys in the wallet database. |
|
Command‐line wallet tool commands. |
|
Helpers for replacing a wallet transaction with a higher‐fee version. |
|
Test‐only helpers for exercising the wallet crypto internals. |
Types
Name |
Description |
Breakdown of a wallet's balance by category. |
|
RAII class that provides access to a BerkeleyRODatabase |
|
Cursor that iterates over the records of a BerkeleyRODatabase. |
|
A class representing a BerkeleyDB file from which we can only read records. This is used only for migration of legacy to descriptor wallets |
|
Compares equal to any byte span that begins with the same prefix. |
|
Address book data. |
|
Coin Control Features. |
|
Encryption/decryption context with key information |
|
Simple HD chain data model. |
|
Metadata about a wallet key, such as its creation time and HD derivation info. |
|
Master key for wallet encryption |
|
Legacy class used for deserializing vtxPrev for backwards compatibility. vtxPrev was removed in commit 93a18a3650292afbb441a47d1fa1b94aeb0164e3, but old wallet.dat files may still contain vtxPrev vectors of CMerkleTxs. These need to get deserialized for field alignment when deserializing a CWalletTx, but the deserialized values are discarded.* |
|
A UTXO under consideration for use in funding a new transaction. |
|
A single received or sent output belonging to the wallet. |
|
A transaction output target: a destination, an amount, and fee handling. |
|
A CWallet maintains a set of transactions and balances, and provides the ability to create new transactions. |
|
A transaction with a bunch of additional info that only the owner cares about. It includes any unrecorded transactions needed to link it back to the block chain. |
|
Cachable amount subdivided into avoid reuse and all balances |
|
Parameters for filtering which OutputGroups we may use in coin selection. We start by being very selective and requiring multiple confirmations and then get more permissive if we cannot fund the transaction. |
|
Parameters that filter which coins are considered available for spending. |
|
Parameters for one iteration of Coin Selection. |
|
COutputs available for spending, stored by OutputType. This struct is really just a wrapper around OutputType vectors with a convenient method for concatenating and returning all COutputs as one vector. |
|
Outcome of building a new transaction, bundling the transaction with its fee details. |
|
RAII class that provides access to a WalletDatabase |
|
Iterates over records stored in a wallet database. |
|
Options controlling how a wallet database is opened or created. |
|
Callbacks invoked when a wallet database transaction commits or aborts. |
|
A ScriptPubKeyMan backed by a single output descriptor. |
|
A pair of output group collections split by whether they hold only positive‐value UTXOs. |
|
An in‐memory SQLiteDatabase. Used as a temporary build artifact where no on‐disk persistence is needed. |
|
Manages the minimum data needed to load and migrate a legacy wallet. |
|
SigningProvider wrapper for LegacyDataSPKM that does not provide private keys. |
|
struct containing information needed for migrating legacy wallets to descriptor wallets |
|
Result of migrating a legacy wallet to descriptor wallets. |
|
Result of resolving the minimum fee rate to use for a transaction. |
|
A group of UTXOs paid to the same output script. |
|
Stores several 'Groups' whose were mapped by output type. |
|
Comparator ordering shared pointers to COutput by the pointed‐to output. |
|
Holds the user‐supplied details for a single manually selected transaction input. |
|
A wrapper to reserve an address from a wallet |
|
RAII class that provides access to a WalletDatabase |
|
RAII class that provides a database cursor |
|
An instance of this class represents one SQLite3 database. |
|
Class responsible for executing SQL statements in SQLite databases. Methods are virtual so they can be overridden by unit tests testing unusual database conditions. |
|
A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet. It contains the scripts and keys related to the scriptPubKeys it manages. A ScriptPubKeyMan will be able to give out scriptPubKeys to be used, as well as marking when a scriptPubKey has been used. It also handles when and how to store a scriptPubKey and its related scripts and keys, including encryption. |
|
Pairs a coin eligibility filter with whether mixing output types is allowed. |
|
The set of inputs chosen by a coin selection algorithm, along with its metrics. |
|
Holds the virtual size and weight of a transaction. |
|
State of rejected transaction that conflicts with a confirmed block. |
|
State of transaction confirmed in a block. |
|
State of transaction added to mempool. |
|
State of transaction not confirmed or conflicting with a known block and not in the mempool. May conflict with the mempool, or with an unknown block, or be abandoned, never broadcast, or rejected from the mempool for another reason. |
|
State of transaction loaded in an unrecognized state with unexpected hash or index values. Treated as inactive (with serialized hash and index values preserved) by default, but may enter another state if transaction is added to the mempool, or confirmed, or abandoned, or found conflicting. |
|
Access to the wallet database. Opens the database and provides read and write access to it. Each read and write is its own transaction. Multiple operation transactions can be started using TxnBegin() and committed using TxnCommit() Otherwise the transaction will be committed when the object goes out of scope. Optionally (on by default) it will flush to disk on close. Every 1000 writes will automatically trigger a flush to disk. |
|
WalletContext struct containing references to state shared between CWallet instances, like the reference to the chain interface, and the list of opened wallets. |
|
An instance of this class represents one database. |
|
Exportable form of a WalletDescriptor with the descriptor as a string and without its ID or cache. |
|
Descriptor with some wallet metadata |
|
A destination together with whether it belongs to the internal (change) chain. |
|
Wallet‐layer error with both programmatic and user‐facing information. |
|
RAII object to check and reserve a wallet rescan |
|
Wallet storage things that ScriptPubKeyMans need in order to be able to store things to the wallet database. It provides access to things that are part of the entire wallet and not specific to a ScriptPubKeyMan such as wallet flags, wallet version, encryption keys, encryption status, and the database itself. This allows a ScriptPubKeyMan to have callbacks into CWallet without causing a circular dependency. WalletStorage should be the same for all ScriptPubKeyMans of a wallet. |
|
A single wallet transaction output, pairing a wallet transaction with one of its outputs. |
|
Orders wallet transactions by their position in the ordered transaction list. |
Type Aliases
Name |
Description |
Ordered map of raw key/value records read from a BerkeleyDB file. |
|
Secure byte buffer used to hold sensitive key material in memory. |
|
Map from key id to its public key and encrypted private key material. |
|
Output groups keyed by the eligibility filter that selected them. |
|
Map from key id to its private key. |
|
Callback invoked when a wallet is loaded, receiving the wallet interface. |
|
A set of COutput pointers ordered by the pointed‐to output. |
|
Subset of states transaction sync logic is implemented to handle. |
|
All possible CWalletTx states |
Enums
Name |
Description |
Address purpose field that has been been stored with wallet sending and receiving addresses since BIP70 payment protocol support was added in https://github.com/bitcoin/bitcoin/pull/2539. This field is not currently used for any logic inside the wallet, but it is still shown in RPC and GUI interfaces and saved for new addresses. It is basically redundant with an address's IsMine() result. |
|
Error statuses for the wallet database. Values are in order of severity. When multiple errors occur, the most severe (highest value) will be returned. |
|
On‐disk format of a wallet database. |
|
Result of opening or creating a wallet database. |
|
Identifies which coin selection algorithm produced a result. |
|
Machine‐readable wallet error codes. |
|
Feature and state flags stored on a wallet. |
Functions
Name |
Description |
Register a loaded wallet with the wallet context. |
|
Add wallet name to persistent configuration so it will be loaded on startup. |
|
Returns whether all of the inputs belong to the wallet |
|
Appends the wallet's last processed block to an RPC result object. |
|
Attempt to find a valid input set that preserves privacy by not mixing OutputTypes. |
|
Select a set of coins such that nTargetValue is met; never select unconfirmed coins if they are not ours |
|
Populate the CoinsResult struct with vectors of available COutputs, organized by OutputType. |
|
Returns the path to the Berkeley DB data file for a wallet path. |
|
Splits a wallet transaction into received and sent entries plus its fee. |
|
Returns the cached change amount of a wallet transaction. |
|
Returns the cached total credit of a wallet transaction. |
|
Returns the cached total debit of a wallet transaction. |
|
Returns whether a wallet transaction debits from the wallet. |
|
|
|
|
|
|
|
Attempt to find a valid input set that meets the provided eligibility filter and target. Multiple coin selection algorithms will be run and the input set that produces the least waste (according to the waste metric) will be chosen. |
|
Select coins using the CoinGrinder deterministic search algorithm. |
|
Creates a new wallet database from a previously dumped file. |
|
Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also create the change output, when needed |
|
Create a new wallet and load it into the context. |
|
Decrypts an encrypted private key and validates it against its public key. |
|
Decrypts a secret with the master key using the given IV. |
|
Set a height‐based locktime for new transactions (uses the height of the current chain tip unless we are not synced with the current chain |
|
Dumps the records of a wallet database to a human‐readable file. |
|
Encrypts a secret with the master key using the given IV. |
|
Ensures that a wallet name is specified across the endpoint and wallet_name. Throws |
|
Retrieves the WalletContext stored in an RPC context, throwing if absent. |
|
Throws an RPC error if the wallet is locked. |
|
Export the descriptors from a wallet so that they can be imported elsewhere |
|
Make a new watchonly wallet file containing the public descriptors from this wallet The exported watchonly wallet file will be named and placed at the path specified in 'destination' |
|
Fetch and validate coin control selected inputs. Coins could be internal (from the wallet) or external. |
|
Find non‐change parent output. |
|
Insert additional inputs into the transaction by calling CreateTransaction(); |
|
Choose a random change target for each transaction to make it harder to fingerprint the Core wallet based on the change output values of transactions it creates. Change target covers at least change fees and adds a random value on top of it. The random value is between 50ksat and min(2 * payment_value, 1milsat) When payment_value <= 25ksat, the value is just 50ksat. |
|
Builds a new wallet descriptor for the given key and output type. |
|
Returns the confirmed balance held at each of the wallet's addresses. |
|
Groups addresses that are believed to share a common owner. |
|
Return the human‐readable name of a selection algorithm. |
|
Resolves the effective avoid‐reuse flag from a request parameter. |
|
Computes the wallet's balance broken down by category. |
|
Return the default wallet and report how many wallets are loaded. |
|
Return the maximum feerate for discarding change. |
|
Return the minimum fee for this size given a fee rate result. |
|
Estimate the minimum fee rate considering user set parameters and the required fee |
|
Return the minimum required absolute fee for this size based on the required fee rate |
|
Return the minimum required feerate taking into account the minimum relay feerate and user set minimum transaction feerate |
|
Look up a loaded wallet by name. |
|
Get the path of the wallet directory. |
|
Figures out what wallet, if any, to use for a JSONRPCRequest. |
|
Extracts the wallet name encoded in a JSON‐RPC request endpoint, if any. |
|
Determine the path that the wallet is stored in |
|
Returns the RPC commands provided by the wallet component. |
|
Return all wallets currently loaded in the context. |
|
Group coins by the provided filters. |
|
Register a callback invoked whenever a wallet is loaded. |
|
Translates a wallet loading result into the appropriate RPC error. |
|
|
|
Returns whether the output spent by an input belongs to the wallet. |
|
Returns whether the file at the path is a Berkeley DB file. |
|
Returns whether the file at the path is a SQLite file. |
|
Select coins using the original Knapsack approximation, used as a fallback. |
|
Validates and extracts an address label from an RPC value. |
|
Return list of available coins and locked coins grouped by non‐change output address. |
|
Recursively list database paths in directory. |
|
Loads an encrypted key from a database record into the wallet. |
|
Loads a master encryption key from a database record into the wallet. |
|
Loads HD chain data from a database record into the wallet. |
|
Loads an unencrypted key from a database record into the wallet. |
|
Load an existing wallet from disk into the context. |
|
Load wallet databases. |
|
Logs information about the database, including available engines, features, and other capabilities. |
|
Return object giving access to Berkeley Read Only database at specified path. |
|
Creates or opens a wallet database at the given path. |
|
Create a new in‐memory wallet database. |
|
Open or create a SQLite wallet database at the given path. |
|
Open the database backend for a wallet. |
|
Called periodically by the schedule thread. Prompts individual wallets to resend their transactions. Actual rebroadcast schedule is managed by the wallets themselves. |
|
|
|
Fire the load‐wallet callbacks for a newly loaded wallet. |
|
Returns the change amount an output contributes. |
|
Returns the credit an output contributes if it belongs to the wallet. |
|
Returns whether an output is a change output of the wallet. |
|
Parse an address purpose from its serialized string form. |
|
Convert an address purpose to its serialized string form. |
|
Fetch parent descriptors of this scriptPubKey. |
|
Fills database options from command‐line arguments. |
|
Remove a wallet from the wallet context and optionally update its load‐on‐startup setting. |
|
Remove wallet name from persistent configuration so it will not be loaded on startup. |
|
Restore a wallet from a backup file. |
|
Executes the provided function 'func' within a database transaction context. |
|
Returns the path to the SQLite data file for a wallet path. |
|
Return the version of the SQLite library in use. |
|
Returns whether a script is a change output of the wallet. |
|
Select all coins from coin_control, and if coin_control 'm_allow_other_inputs=true', call 'AutomaticCoinSelection' to select a set of coins such that nTargetValue ‐ pre_set_inputs.total_amount is met. |
|
Select coins using the Branch and Bound algorithm to find a changeless solution. |
|
Select coins by Single Random Draw (SRD). SRD selects eligible OutputGroups from a shuffled ordering until the effective value of the input set suffices to create the recipient outputs and a change output with an amount of at least CHANGE_LOWER. While the maximum selection weight is exceeded during selection, the OutputGroup with the lowest effective value is dropped from the selection before additional OutputGroups are selected. Due to this greedy approach, SRD can fail to discover possible solutions in pathological cases. |
|
Complete startup of wallets. |
|
Returns the total change amount of a transaction. |
|
Returns the total credit of a transaction's outputs owned by the wallet. |
|
Return TxState or SyncTxState as a string for logging or debugging. |
|
Stop and unload all wallets held by the context. |
|
Responsible for reading and validating the ‐wallet arguments and verifying the wallet database. |
|
Explicitly delete the wallet. Blocks the current thread until the wallet is destructed. |
|
Less‐than operators |
Variables
Name |
Description |
lower bound for randomly‐chosen target change amount |
|
upper bound for randomly‐chosen target change amount |
|
Default for ‐addresstype |
|
Default for ‐avoidpartialspends |
|
‐consolidatefeerate default |
|
‐disablewallet default |
|
‐discardfee default |
|
‐fallbackfee default |
|
Default for ‐keypool |
|
maximum fee increase allowed to do partial spend avoidance, even for nodes with this feature disabled by default |
|
Default maximum chain depth for a coin to be considered available. |
|
Default minimum chain depth for a coin to be considered available. |
|
Default for ‐spendzeroconfchange |
|
‐maxtxfee default |
|
‐mintxfee default |
|
‐txconfirmtarget default |
|
‐walletbroadcast default |
|
‐walletcrosschain default |
|
‐walletrbf default |
|
Default for ‐walletrejectlongchains |
|
Default transaction version used when building wallet transactions. |
|
Pre‐calculated constants for input size estimation in virtual size |
|
Help text appended to RPC methods that require the wallet passphrase. |
|
discourage APS fee higher than this amount |
|
‐maxtxfee will warn if called with a higher fee than this amount (in satoshis) |
|
Discourage users to set fees higher than this amount (in satoshis) per kB |
|
Bitmask of all wallet flags recognized by this version. |
|
Output types associated with LegacyDataSPKM. |
|
Bitmask of wallet flags that may be changed after wallet creation. |
|
RPC result describing the block a piece of wallet information was generated on. |
|
Maps each wallet flag string name back to its flag value. |
|
Constant representing an unknown spkm creation time |
|
Size in bytes of the AES initialization vector. |
|
Size in bytes of the AES‐256 encryption key derived for the wallet. |
|
Size in bytes of the salt mixed into the passphrase during key derivation. |
|
Maps each wallet flag to its serialized string name. |
|
minimum recommended increment for replacement txs |
Created with MrDocs