Namespaces
Name |
Description |
Bitcoin Core logging facilities: log categories and their bit flags. |
|
Transaction validation functions |
|
High‐performance cache primitives. |
|
Helpers for constructing serialized network messages. |
|
Identifiers for individual peer‐negotiated features (BIP 434). |
|
Bitcoin protocol message types. When adding new message types, don't forget to update ALL_NET_MESSAGE_TYPES below. |
|
Bech32 and Bech32m string encoding used by newer Bitcoin address types. |
|
Constants and error types for the built‐in HTTP server's request parsing. |
|
Implementation details backing the BitSet alias. |
|
Type‐safe C++ RAII wrapper over the libbitcoinkernel C API. |
|
btcsignals is a simple mechanism for signaling events to multiple subscribers. It is api‐compatible with a minimal subset of boost::signals2. |
|
Algorithms and data structures for ordering (linearizing) clusters of dependent transactions. |
|
Shared types used across the node, wallet, and GUI code. |
|
These should be considered an implementation detail of the specific database. |
|
Internal helpers for parsing blobs from hex strings. |
|
Filesystem operations and types |
|
Bridge operations to C stdio |
|
Support for connecting to and accepting connections over the I2P network. |
|
Shared database key types for blockfilterindex and coinstatsindex. |
|
Initialization helpers shared by the node, wallet, and other executables. |
|
Interfaces between the node and the rest of the application. |
|
Kernel library components for validating blocks and maintaining chain state. |
|
The LevelDB library namespace, forward‐declared to avoid a public dependency. |
|
Helpers for estimating the dynamic memory usage of common data structures. |
|
Miniscript: a structured representation of Bitcoin Scripts. |
|
Full‐node components that run the block, chainstate, and mempool machinery. |
|
Low‐level Poly1305 routines based on the public domain poly1305‐donna implementation by Andrew Moon (poly1305‐donna‐32.h). |
|
Helpers for parsing output descriptor strings. |
|
Runtime selection of the SHA‐256 implementation. |
|
Standard library namespace, extended here with a deleted hash specialization. |
|
Getting started with reading this source code. The source is mainly divided into four parts: 1. Exception Classes: These are very basic exception classes derived from runtime_error exception. There are two types of exception thrown from subprocess library: OSError and CalledProcessError |
|
Tiny type‐safe printf‐style string formatting library. |
|
Database key types and constants for the transaction index. |
|
Unit‐test helpers that reach into TxIndex internals. |
|
Application‐agnostic logging interface shared across Bitcoin Core. |
|
Wallet subsystem. |
Namespace Aliases
Name |
Description |
Short namespace alias for tinyformat. |
Types
Name |
Description |
The AEAD_CHACHA20_POLY1305 authenticated encryption algorithm from RFC8439 section 2.8. |
|
A decryption class for AES‐256 in CBC mode with optional PKCS#7 padding. |
|
An encryption class for AES‐256 in CBC mode with optional PKCS#7 padding. |
|
A decryption class for AES‐256. |
|
An encryption class for AES‐256. |
|
Abstract class that implements BIP9‐style threshold logic, and caches results. |
|
Support for all macros providing or using the ser_action parameter of the SerializationOps method. |
|
Action that drives the SerializationOps method to unserialize (read) objects. |
|
Connection status of a manually added node. |
|
Parameters describing a manually added node (‐addnode / ‐connect). |
|
Internal per‐address record stored in the address manager tables. |
|
Stochastic address manager |
|
Private implementation of the address manager (pimpl). |
|
Location information for an address in AddrMan |
|
Serialization wrapper that stores amounts using the compact amount encoding. |
|
Template mixin that adds ‐Wthread‐safety locking annotations and lock order checking to a subset of the mutex API. |
|
An arena manages a contiguous region of memory by dividing it into chunks. |
|
Parses and stores command‐line and configuration file arguments. |
|
Holds configuration for use during UTXO snapshot load and validation. The contents here are security critical, since they dictate which UTXO snapshots are recognized as valid. |
|
Strongly typed hash of a serialized UTXO snapshot. |
|
Non‐refcounted RAII wrapper for FILE* |
|
The BIP324 packet cipher, encapsulating its key derivation, stream cipher, and AEAD. |
|
getblocktemplate status for the BIP9 deployments grouped by signalling state. |
|
Detailed status of an enabled BIP9 deployment |
|
Display status of an in‐progress BIP9 softfork |
|
Tracks banned and discouraged peers. |
|
Wraps a fixed‐size hash value and exposes byte‐range access to it. |
|
Base class for the node's optional block‐chain indexes. |
|
Interface for verifying signatures and time locks encountered during script evaluation. |
|
Interface for signature creators. |
|
Reads individual bits, most significant first, from an underlying byte stream. |
|
Writes individual bits, most significant first, into an underlying byte stream. |
|
Complete block filter struct as defined in BIP 157. Serialization matches payload of "cfilter" messages. |
|
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of blocks by height. An index is constructed for each supported filter type with its own database (ie. filter data for different types are stored in separate databases). |
|
Hashes a block hash by reading its low 64 bits directly, with no salt. |
|
A blocktxn message carrying the transactions requested for a block. |
|
A getblocktxn message requesting specific transactions of a block by index. |
|
Validation state specialized for block‐level results. |
|
Wrapper around an AutoFile& that implements a ring buffer to deserialize from. It guarantees the ability to rewind a given number of bytes. |
|
Wrapper that buffers reads from an underlying stream. Requires underlying stream to support read() and detail_fread() calls to support fixed‐size and variable‐sized reads, respectively. |
|
Wrapper that buffers writes to an underlying stream. Requires underlying stream to support write_buffer() method for efficient buffer flushing and obfuscation. |
|
Wrapper around FeeFrac & derived types, which adds a feerate‐based ordering which treats equal‐feerate but distinct‐size FeeFracs as equals. |
|
Wrapper around FeeFrac & derived types, which adds a total ordering which first sorts by feerate and then by reversed size (i.e., larger sizes come first). |
|
Implementation of Hash named requirement for types that internally store a byte array. This may be used as the hash function in std::unordered_set or std::unordered_map over such types. Internally, this uses a random instance of SipHash‐2‐4. |
|
A CService with information about it as peer |
|
Access to the banlist database (banlist.json) |
|
Record of a single ban, storing when it was created and when it expires. |
|
CBaseChainParams defines the base parameters (shared between bitcoin‐cli and bitcoind) of a given instance of the Bitcoin system. |
|
A full block, extending the header with its transactions and cached check flags. |
|
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce values to make the block's hash satisfy proof‐of‐work requirements. When they solve the proof‐of‐work, they broadcast the block to everyone and the block is added to the block chain. The first transaction in the block is a special one that creates a new coin owned by the creator of the block. |
|
A cmpctblock message: a block header with short transaction IDs for compact relay. |
|
The block chain is a tree shaped structure starting with the genesis block at the root, with each block potentially having multiple candidates to be the next block. A blockindex may have multiple pprev pointing to it, but at most one of them can be part of the currently active branch. |
|
Describes a place in the block chain to another node such that if the other node doesn't have the same branch, it can find a recent common trunk. The further back it is, the further before the fork it may be. |
|
The BlockPolicyEstimator is used for estimating the feerate needed for a transaction to be included in a block within a certain number of blocks. |
|
Undo information for a CBlock |
|
BloomFilter is a probabilistic filter which SPV clients provide so that we can filter the transactions we send them. |
|
An in‐memory indexed chain of blocks. |
|
Chain parameters describing a particular Bitcoin network. |
|
Queue for verifications that have to be performed. The verifications are represented by a type T, which must provide an operator(), returning an std::optional<R>. |
|
RAII‐style controller object for a CCheckQueue that guarantees the passed queue is finished before continuing. |
|
Interface used to notify the UI about node events. |
|
A Coin in one level of the coins database caching hierarchy. |
|
Pure abstract view on the open txout dataset. |
|
CCoinsView backed by another CCoinsView |
|
CCoinsView that adds a memory cache for transactions to another CCoinsView |
|
Cursor for iterating over CoinsView state |
|
CCoinsView backed by the coin database (chainstate/) |
|
This is a minimally invasive approach to shutdown on LevelDB read errors from the chainstate, while keeping user interface out of the common library, which is shared between bitcoind, and bitcoin‐qt and non‐server tools. |
|
CCoinsView that brings transactions from a mempool into view. It does not check for spendings by memory pool transactions. Instead, it provides access to all Coins which are either unspent in the base CCoinsView, are outputs from any mempool transaction, or are tracked temporarily to allow transaction dependencies in package validation. This allows transaction replacement to work as expected, as you want to have all inputs "available" to check signatures, and any cycles in the dependency graph are checked directly in AcceptToMemoryPool. It also allows you to sign a double‐spend directly in signrawtransactionwithkey and signrawtransactionwithwallet, as long as the conflicting transaction is not yet confirmed. |
|
Manages all P2P connections: opening, accepting, servicing and tearing them down. |
|
Batch of changes queued to be written to a CDBWrapper |
|
Iterates over the key‐value entries of a CDBWrapper. |
|
Wraps a LevelDB database, providing typed, serialized key‐value access. |
|
Used to marshal pointers into hashes for db storage. |
|
On‐disk position of a transaction: a block file position plus an offset within the block. |
|
A BIP32 extended private key: a private key plus the chain code and metadata needed for derivation. |
|
A BIP32 extended public key: a public key plus the chain code and metadata needed for derivation. |
|
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac |
|
A rfc5869 HKDF implementation with HMAC_SHA256 and fixed key output length of 32 bytes (L=32) |
|
A hasher class for HMAC‐SHA‐256. |
|
A hasher class for HMAC‐SHA‐512. |
|
A hasher class for Bitcoin's 160‐bit hash (SHA‐256 + RIPEMD‐160). |
|
A hasher class for Bitcoin's 256‐bit hash (double SHA‐256). |
|
inv message data |
|
An encapsulated private key. |
|
A reference to a CKey: the Hash160 of its serialized public key |
|
Used to relay blocks as header + vector<merkle branch> to filtered nodes. |
|
Message header. (4) message start. (12) message type. (4) size. (4) checksum. |
|
A mutable version of CTransaction. |
|
Network address. |
|
Transport protocol agnostic message container. Ideally it should only contain receive time, payload, type and size. |
|
A destination that has no associated address, optionally wrapping a script. |
|
Information about a peer |
|
Per‐connection options passed when constructing a CNode. |
|
Per‐peer state statistics reported for diagnostics (e.g. getpeerinfo). |
|
Reported statistics about a single peer connection. |
|
An outpoint ‐ a combination of a transaction hash and an index n into its vout |
|
Data structure that represents a partial merkle tree. |
|
An encapsulated public key. |
|
A hasher class for RIPEMD‐160. |
|
A single registered RPC command together with its dispatch metadata. |
|
Registry of available RPC commands. |
|
RollingBloomFilter is a probabilistic "keep track of most recently inserted" set. Construct it with the number of items to keep track of, and a false‐positive rate. Unlike CBloomFilter, by default nTweak is set to a cryptographically secure random value for you. Similarly rather than clear() the method reset() is provided, which also changes nTweak to decrease the impact of false‐positives. |
|
A hasher class for SHA1. |
|
A hasher class for SHA‐256. |
|
A hasher class for SHA‐512. |
|
Schedules deferred and recurring background tasks. |
|
Serialized script, used inside transaction inputs and outputs |
|
Closure representing one script verification Note that this stores references to the spending transaction |
|
A reference to a CScript: the Hash160 of its serialization |
|
Script integer with the overflow and encoding semantics of Bitcoin's numeric opcodes. |
|
Witness stack for a single transaction input. |
|
A fully serialized network message, ready to be handed to the transport. |
|
A combination of a network address (CNetAddr) and a (TCP) port |
|
Hasher for CService, suitable for use with unordered containers. |
|
General SipHash‐2‐4 implementation. |
|
A subnet: a network base address together with a netmask. |
|
A helper class for interruptible sleeps. Calling operator() will interrupt any current sleep, and after that point operator bool() will return true until reset. |
|
The basic transaction that is broadcasted on the network and contained in blocks. A transaction can contain multiple inputs and outputs. |
|
An input of a transaction. It contains the location of the previous transaction's output that it claims and a signature that matches the output's public key. |
|
The node's memory pool of unconfirmed transactions. |
|
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in‐mempool transactions that depend on the transaction ("descendant" transactions). |
|
An output of a transaction. It contains the public key that the next input must be able to sign with to claim it. |
|
Undo information for a CTransaction |
|
Implement this to subscribe to events generated in validation and mempool |
|
RAII wrapper for VerifyDB: Verify consistency of the block and coin databases |
|
Base class for ZMQ notifiers that publish node events to a subscriber. |
|
Base class for ZMQ publisher notifiers that send multipart messages to subscribers. |
|
Validation‐interface listener that fans node events out to the configured ZMQ notifiers. |
|
Publishes the hash of each new active chain tip block. |
|
Publishes the hash of each notified transaction. |
|
Publishes the serialized bytes of each new active chain tip block. |
|
Publishes the serialized bytes of each notified transaction. |
|
Publishes lightweight sequence messages for block and mempool events. |
|
Signature checker that consults and updates a SignatureCache to avoid repeat verification. |
|
Unrestricted ChaCha20 cipher. |
|
ChaCha20 cipher that only operates on multiples of 64 bytes. |
|
A BIP32 chain code. Cleansed on destruction. |
|
Holds various statistics on transactions within a chain. Used to estimate verification progress during chain sync. |
|
Chainstate stores and provides an API to update our local knowledge of the current best chain. |
|
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainstate* subdirectory in the data directory and contains a database of UTXOs existing at a different point in history. (See the Chainstate class for more information.) |
|
Compile‐time check that a VarInt mode and integer type are compatible. |
|
Formatter that serializes a time point as its underlying representation type U. |
|
A UTXO entry. |
|
CoinStatsIndex maintains statistics on the UTXO set. |
|
Cursor for iterating over the linked list of flagged entries in CCoinsViewCache. |
|
Noop coins view. |
|
Tunable options for the on‐disk coins (UTXO) view database. |
|
CCoinsViewCache subclass that asynchronously fetches most block input prevouts in parallel during ConnectBlock without mutating the base cache. |
|
A convenience class for constructing the CCoinsView* hierarchy used to facilitate access to the UTXO set. |
|
Formatter for integers in CompactSize format. |
|
Reads a CompactSize value from a stream into a referenced integer. |
|
Writes a fixed integer value to a stream in CompactSize format. |
|
Orders mempool entry handles by the hash of their transaction. |
|
Orders mempool entries by the time they entered the mempool. |
|
A compressed CBlockHeader, which leaves out the prevhash. |
|
A block that has been connected to the active chain, tracked during chain activation. |
|
Test harness that exposes CConnman internals for unit tests. |
|
RAII‐style semaphore lock |
|
Serialization wrapper class for custom integers and enums. |
|
User‐controlled performance and debug options. |
|
Application‐specific storage settings. |
|
Double ended buffer combining vector and stream‐like interfaces. |
|
Default formatter. Serializes objects as themselves. |
|
Signature checker that forwards every check to a wrapped checker. |
|
Comparator that orders pointers by the values they point to. |
|
Interface for parsed descriptor objects. |
|
Cache for single descriptor's derived extended pubkeys |
|
Formatter that (de)serializes a monotonically increasing sequence as differences. |
|
Transactions removed from the chain during a reorg, held for possible re‐addition to the mempool. |
|
RAII class initializing and deinitializing global state for elliptic curve support. Only one instance may be initialized at a time. |
|
An ElligatorSwift‐encoded public key. |
|
Used to return detailed information about a fee estimate calculation. |
|
Used to return detailed information about a feerate bucket. |
|
Enables interaction with an external signing device or service, such as a hardware wallet. See doc/external‐signer.md |
|
Forward‐secure ChaCha20 |
|
Forward‐secure wrapper around AEADChaCha20Poly1305. |
|
Fast randomness source. This is seeded once with secure random data, but is completely deterministic and does not gather more entropy after that. |
|
Aggregate details about how a smart fee estimate was reached. |
|
Quantizes minimum fee values to a discrete set of feerates for fee filter privacy. |
|
Data structure storing a fee and size. |
|
Tagged wrapper around FeeFrac to avoid unit confusion. |
|
A successful fee rate estimate returned by a fee rate estimator. |
|
A failed fee rate estimation, carrying the zero‐value estimation that identifies the estimator and target alongside the error reason. |
|
Tracks fee‐rate estimates derived from observed transactions. |
|
Fillable signing provider that keeps keys in an address‐>secret map |
|
Location of a record within a numbered flat file: a file index and byte offset. |
|
FlatFileSeq represents a sequence of numbered files storing raw data. This class facilitates access to and efficient management of these files. |
|
A signing provider backed by plain in‐memory maps of keys and scripts. |
|
This implements a Golomb‐coded set as defined in BIP 158. It is a compact, probabilistic data structure for testing set membership. |
|
A transaction identifier that holds either a txid or a wtxid. |
|
Signature checker that validates against a concrete spending transaction. |
|
Different type to mark Mutex at global scope |
|
Collection of HTTP header field‐value pairs for a request or response. |
|
A connected HTTP client, holding its socket plus the receive and send buffers. |
|
A single HTTP request being parsed from and replied to over a client connection. |
|
Status line, headers and version of an HTTP response. |
|
Socket‐based HTTP server that accepts connections and dispatches requests to worker threads. |
|
Major and minor components of an HTTP protocol version. |
|
Reads data from an underlying stream, while hashing the read data. |
|
A writer stream (for serialization) that computes a 256‐bit hash. |
|
Writes data to an underlying source stream, while hashing the written data. |
|
Configuration for headers sync memory usage. |
|
HeadersSyncState: |
|
Controls how an RPCResult is rendered in human‐readable help text. The std::string alternative carries the summary text rendered as "...". |
|
Elision mode that hides a field from the rendered help text. |
|
Exception carrying pre‐rendered RPC help text to return to the caller. |
|
Wraps a signing provider, optionally hiding secret keys and key origins. |
|
A snapshot of an index's identity and sync progress. |
|
xoroshiro128++ PRNG. Extremely fast, not appropriate for cryptographic purposes. |
|
Exception thrown when peers.dat has an unsupported addrman version. |
|
Context and parameters for a single JSON‐RPC request. |
|
Parsed components of a configuration key. |
|
Origin information (master key fingerprint and derivation path) for a public key. |
|
KeyPair |
|
A single element of a BIP32 hierarchical deterministic key path. |
|
Opaque holder for the LevelDB‐specific state of a CDBWrapper. |
|
Formatter that serializes a string and rejects lengths above a compile‐time limit. |
|
Limited vector formatter. Throws an error if a vector is oversized. |
|
A local address we advertise, together with how trustworthy it is. |
|
Cached block height and time that satisfy a transaction's relative locktimes. |
|
OS‐dependent allocation and deallocation of locked/pinned memory pages. Abstract base class. |
|
Pool for locked memory chunks. |
|
Singleton class to keep track of locked (ie, non‐swappable) memory, for use in std::allocator templates. |
|
A log category paired with whether it is currently enabled. |
|
Successful response to a port mapping. |
|
Estimate the fee rate required for a transaction to be included in the next block. |
|
MemPoolFeeRateEstimatorCache holds a cache of recent fee rate estimates. A cached fee rate is only provided while it is not older than CACHE_LIFE and the chain tip has not changed. |
|
Validation result for a transaction evaluated by MemPoolAccept (single or package). Here are the expected fields and properties of a result depending on its ResultType, applicable to results returned from package evaluation:+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+| Field or property | VALID | INVALID | MEMPOOL_ENTRY | DIFFERENT_WITNESS || | |‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐| | || | | TX_RECONSIDERABLE | Other | | |+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+| txid in mempool? | yes | no | no* | yes | yes || wtxid in mempool? | yes | no | no* | yes | no || m_state | yes, IsValid() | yes, IsInvalid() | yes, IsInvalid() | yes, IsValid() | yes, IsValid() || m_vsize | yes | no | no | yes | no || m_base_fees | yes | no | no | yes | no || m_effective_feerate | yes | yes | no | no | no || m_wtxids_fee_calculations | yes | yes | no | no | no || m_other_wtxid | no | no | no | no | yes |+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐+ (*) Individual transaction acceptance doesn't return MEMPOOL_ENTRY and DIFFERENT_WITNESS. It returns INVALID, with the errors txn‐already‐in‐mempool and txn‐same‐nonwitness‐data‐in‐mempool respectively. In those cases, the txid or wtxid may be in the mempool for a TX_CONFLICT. |
|
Weight statistics for a recently mined block, used to assess mempool coverage. |
|
Version of SteadyClock that is mockable in the context of tests (via FakeSteadyClock, or Self::SetMockTime), otherwise the system steady clock. |
|
A multiplicative hash of the UTXO set. |
|
MuSig2SecNonce encapsulates a secret nonce in use in a MuSig2 signing session. Since this nonce persists outside of libsecp256k1 signing code, we must handle its construction and destruction ourselves. The secret nonce must be kept a secret, otherwise the private key may be leaked. As such, it needs to be treated in the same way that CKeys are treated. So this class handles the secure allocation of the secp256k1_musig_secnonce object that libsecp256k1 uses, and only gives out references to this object to avoid any possibility of copies being made. Furthermore, objects of this class are not copyable to avoid nonce reuse. |
|
Implementation detail that owns the secure storage of a MuSig2 secret nonce. |
|
A signing provider to be used to interface with multiple signing providers at once. |
|
A signature creator for transactions. |
|
Interface for message handling |
|
Netgroup manager |
|
Holds the permission flags granted to a peer and helpers to query and modify them. |
|
Permissions bound to a specific listening address, parsed from a ‐whitebind entry. |
|
Permissions applied to peers matching a subnet, parsed from a ‐whitelist entry. |
|
Notification payload describing a transaction added to the mempool. |
|
Version of the system clock that is mockable in the context of tests (via FakeNodeClock or ::SetMockTime), otherwise the system clock. |
|
Snapshot of one inbound peer's attributes used by the eviction selection logic. |
|
Scoped guard that disables terminal echo on standard input. |
|
Exception thrown by CHECK_NONFATAL() when its condition is false. |
|
A 3072‐bit number in the MuHash prime field, stored as an array of limbs. |
|
XOR‐based obfuscation over a fixed‐size key, applied to byte ranges. |
|
A public‐key‐hash destination for a P2PKH address. |
|
A structure for PSBTs which contain per‐input information |
|
A structure for PSBTs which contains per output information |
|
A structure for PSBT proprietary types |
|
Validation result for package mempool acceptance. |
|
Validation state for a package, carrying a PackageValidationResult rejection reason. |
|
Wrapper that overrides the GetParams() function of a stream. |
|
Wrapper that serializes objects with the specified parameters. |
|
A block being reconstructed from a compact block plus mempool/extra transactions. |
|
A version of CTransaction with the PSBT format |
|
A pay‐to‐anchor destination for a P2A address. |
|
Drives the peer‐to‐peer message processing and relay logic for a node. |
|
Aggregate information about the peer manager, reported for diagnostics. |
|
C++ wrapper with std::byte span interface around poly1305_donna code. |
|
Forwards all allocations/deallocations to the PoolResource. |
|
A memory resource similar to std::pmr::unsynchronized_pool_resource, but optimized for node‐based containers. It has the following properties: |
|
Access to internals for testing purpose only |
|
Cached transaction data reused across signature‐hash computations for a single transaction. |
|
A transaction sent inline within a compact block, plus its position. |
|
Optimized SipHash‐2‐4 implementation for uint256. |
|
Store a list of transactions to be broadcast privately. Supports the following operations: ‐ Add a new transaction ‐ Remove a transaction ‐ Pick a transaction for sending to one recipient ‐ Query which transaction has been picked for sending to a given recipient node ‐ Mark that a given recipient node has confirmed receipt of a transaction ‐ Query whether a given recipient node has confirmed reception ‐ Query whether any transactions that need sending are currently on the list |
|
A proxy endpoint, either a network service or a local unix domain socket. |
|
Credentials for proxy authentication |
|
A pay‐to‐public‐key destination that has no associated address. |
|
Describes a single argument of an RPC method for validation and help text. |
|
Optional settings controlling how an RPCArg is validated and rendered. |
|
Holds example invocations shown in an RPC method's help text. |
|
Describes an RPC method: its name, arguments, results, examples, and handler. |
|
Describes one part of an RPC method's result for type checking and help text. |
|
Optional settings controlling how an RPCResult is validated and rendered. |
|
The complete set of result variants an RPC method can return. |
|
Mixin class that provides helper randomness functions. |
|
List of reachable networks. Everything is reachable by default. |
|
Notification payload describing a transaction removed from the mempool. |
|
A hasher class for SHA3‐256 (fixed 256‐bit output Keccak). |
|
SipHash‐1‐3‐UJ based hasher for the coins cache and related coins containers. |
|
Hashes a transaction outpoint (COutPoint) with a per‐instance random salt. |
|
Hashes an arbitrary byte span with a per‐instance random SipHash salt. |
|
Hashes a transaction id (Txid) with a per‐instance random salt. |
|
Hashes a uint256 with a per‐instance random salt. |
|
Hashes a witness transaction id (Wtxid) with a per‐instance random salt. |
|
Require empty scratch streams on entry and reset them on exit. |
|
Compact serializer for scripts. |
|
Mutable per‐input state carried through Taproot/Tapscript execution. |
|
A script‐hash destination for a P2SH address. |
|
Location where a config section name was encountered. |
|
Accumulator for the formatted sections that make up RPC help text. |
|
Deleter that securely deallocates a single object through secure_allocator. |
|
Class used by CScheduler clients which may schedule multiple jobs which are required to be run serially. Jobs may not be run on the same thread, but no two jobs will be executed at the same time and memory will be release‐acquire consistent (the scheduler will internally do an acquire before invoking a callback as well as a release at the end). In practice this means that a callback B() will be able to observe all of the effects of callback A() which executed before it. |
|
Orders byte vectors by length first, then lexicographically. |
|
Data structure to cache SHA256 midstates for the ECDSA sighash calculations (bare, P2SH, P2WPKH, P2WSH). |
|
Options that influence how an input is signed. |
|
Valid signature cache, to avoid doing expensive ECDSA signature checking twice for every transaction (once when accepted into memory pool, and again when accepted into the block chain) |
|
We're hashing a nonce into the entries themselves, so we don't need extra blinding in the set hash computation. |
|
Signature material collected for a single transaction input. |
|
Generate the signet tx corresponding to the given block |
|
An interface to be implemented by keystores that support signing. |
|
Shared SipHash state (v0..v3) with its round, compression, and finalization primitives. Internal building block, only meant to be composed by the hasher classes below. |
|
A custom weaker variant of SipHash‐1‐3 without padding, and supporting "jumbo" inputs. |
|
Stream‐like object that only records how many bytes a serialization would write. |
|
RAII helper class that manages a socket and closes it automatically when it goes out of scope. |
|
Like std::source_location, but allowing to override the function name. |
|
Equality comparator for SourceLocation keys, comparing line and file name. |
|
Hash functor for SourceLocation keys, mixing line and file name. |
|
Minimal stream for reading from an existing byte array by std::span. |
|
Minimal stream for writing to an existing span of bytes. |
|
An annotated version of std::mutex for Clang Thread Safety Analysis. |
|
Utility class to construct Taproot outputs from internal key and script tree. |
|
Data needed to spend a Taproot output, including its script tree. |
|
Fixed‐size thread pool for running arbitrary tasks concurrently. |
|
Tracks clock differences against outbound peers and warns when the local clock drifts. |
|
An interprocess or interthread pipe for sending tokens (one‐byte values) over. |
|
One end of a token pipe. |
|
Low‐level handling for Tor control connection. Speaks the SMTP‐like protocol as defined in torspec/control‐spec.txt |
|
Reply from Tor, can be single or multi‐line |
|
Manages the node's Tor hidden service and control connection. |
|
Snapshot of the policy‐relevant data for a mempool transaction. |
|
Serialization parameters controlling whether transaction witnesses are included. |
|
The Transport converts one connection's sent messages to wire bytes, and received bytes back. |
|
Tracks transaction confirmation history for a single time horizon. |
|
Options controlling how TxDoc renders the decoded transaction help. |
|
Data structure to encapsulate fees, sizes, and dependencies for a set of transactions. |
|
Formatter for undo information for a CTxIn |
|
TxIndex is used to look up transactions included in the blockchain by hash. The index is written to a LevelDB database and records the block sequence number and serialized block offset of each transaction by transaction hash. |
|
A found transaction and the hash of the block that contains it. |
|
Information about a mempool transaction. |
|
wrapper for CTxOut that provides a more compact serialization |
|
Transaction reconciliation is a way for nodes to efficiently announce transactions. This object keeps track of all txreconciliation‐related communications with the peers. The high‐level protocol is: 0. Txreconciliation protocol handshake. 1. Once we receive a new transaction, add it to the set instead of announcing immediately. 2. At regular intervals, a txreconciliation initiator requests a sketch from a peer, where a sketch is a compressed representation of short form IDs of the transactions in their set. 3. Once the initiator received a sketch from the peer, the initiator computes a local sketch, and combines the two sketches to attempt finding the difference in sets. 4a. If the difference was not larger than estimated, see SUCCESS below. 4b. If the difference was larger than estimated, initial txreconciliation fails. The initiator requests a larger sketch via an extension round (allowed only once). ‐ If extension succeeds (a larger sketch is sufficient), see SUCCESS below. ‐ If extension fails (a larger sketch is insufficient), see FAILURE below. |
|
Data structure to keep track of, and schedule, transaction downloads from peers. |
|
Holds the outcome and reason of transaction‐level validation. |
|
A spending transaction and the hash of the block that contains it. |
|
TxoSpenderIndex is used to look up which transaction spent a given output. The index is written to a LevelDB database and, for each input of each transaction in a block, records the outpoint that is spent and the hash of the spending transaction. |
|
A dynamically typed JSON value used across Bitcoin Core's RPC layer. |
|
Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type. |
|
Wrapper around std::unique_lock style lock for MutexType. |
|
Transport implementation for the legacy (v1) unencrypted P2P protocol. |
|
Transport implementation for the encrypted BIP324 (v2) P2P protocol, with automatic fallback to v1 when the peer does not speak v2. |
|
Static description of a version‐bits soft fork deployment. |
|
Tag selecting the satoshi‐per‐vbyte FeePerUnit instantiation. |
|
Convenience class for initializing and passing the script execution cache and signature cache. |
|
Test fixture granted access to the interface's protected callbacks. |
|
Dispatches validation event notifications to registered subscribers. |
|
Private implementation details of ValidationSignals. |
|
Template for capturing information about block/transaction validation. This is instantiated by TxValidationState and BlockValidationState for validation information on transactions and blocks respectively. |
|
Serialization wrapper class for integers in VarInt format. |
|
Data structure largely mimicking std::deque, but using single preallocated ring buffer. |
|
Formatter to serialize/deserialize vector elements using another formatter |
|
Minimal stream for overwriting and/or appending to an existing byte vector |
|
BIP 9 allows multiple softforks to be deployed in parallel. We cache per‐period state for every one we implement and warning state for each BIP 323 allowed bit. |
|
Class to implement versionbits logic. |
|
Interface that lets the node initialize the optional wallet component. |
|
Tag selecting the satoshi‐per‐weight‐unit FeePerUnit instantiation. |
|
CTxDestination subtype to encode any future Witness version. |
|
A version‐0 witness key‐hash destination for a P2WPKH address. |
|
A version‐0 witness script‐hash destination for a P2WSH address. |
|
A version‐1 taproot destination for a P2TR address. |
|
Simple wrapper class to serialize objects using a formatter; used by Using(). |
|
A BIP340‐style x‐only public key, storing only the 32‐byte x coordinate. |
|
256‐bit unsigned big integer. |
|
Template base class for fixed‐sized opaque blobs. |
|
Template base class for unsigned big integers. |
|
Bilingual messages: ‐ in GUI: user's native language + untranslated (i.e. English) ‐ in log and stderr: untranslated only |
|
Class that mimics std::deque<bool>, but with std::vector<bool>'s bit packing. |
|
Opaque data structure for holding a block. |
|
Opaque data structure for holding a block hash. |
|
Opaque data structure for holding a btck_BlockHeader. |
|
Opaque data structure for holding a block's spent outputs. |
|
Opaque data structure for holding a block tree entry. |
|
Opaque data structure for holding the state of a block during validation. |
|
Opaque data structure for holding the currently known best‐chain associated with a chainstate. |
|
Opaque data structure for holding the chain parameters. |
|
Opaque data structure for holding a chainstate manager. |
|
Opaque data structure for holding options for creating a new chainstate manager. |
|
Opaque data structure for holding a coin. |
|
Opaque data structure for holding the Consensus Params. |
|
Opaque data structure for holding a kernel context. |
|
Opaque data structure for holding options for creating a new kernel context. |
|
Opaque data structure for holding a logging connection. |
|
Options controlling the format of log messages. |
|
A struct for holding the kernel notification callbacks. The user data pointer may be used to point to user‐defined structures to make processing the notifications easier. |
|
Opaque data structure for holding precomputed transaction data. |
|
Opaque data structure for holding a script pubkey. |
|
Opaque data structure for holding a transaction. |
|
Opaque data structure for holding a transaction input. |
|
Opaque data structure for holding a transaction out point. |
|
Opaque data structure for holding a transaction output. |
|
Opaque data structure for holding a transaction's spent outputs. |
|
Opaque data structure for holding the state of a transaction during validation. |
|
Opaque data structure for holding a btck_Txid. |
|
Holds the validation interface callbacks. The user data pointer may be used to point to user‐defined structures to make processing the validation callbacks easier. Note that these callbacks block any further validation execution when they are called. |
|
Opaque data structure for holding a witness stack. |
|
Exception thrown when a database operation fails. |
|
Dummy data type to identify deserializing constructors. |
|
Multi‐index tag for the index ordered by mempool entry time. |
|
Multi‐index tag for the index keyed by witness‐transaction hash (wtxid). |
|
Map whose keys are pointers, but are compared by their dereferenced values. |
|
Extracts a transaction hash (txid) from a CTxMemPoolEntry or CTransactionRef. |
|
Extracts a transaction witness‐hash (wtxid) from a CTxMemPoolEntry or CTransactionRef. |
|
Implements a drop‐in replacement for std::vector<T> which stores up to N elements directly (without heap allocation). The types Size and Diff are used to store element counts, and can be any unsigned + signed type. |
|
Type‐safe set of script verification flags backed by a bitmask. |
|
Exception thrown for invalid CScriptNum operations or encodings. |
|
Opaque libsecp256k1 context structure. |
|
Opaque libsecp256k1 cache holding the aggregate public key state of a MuSig2 session. |
|
Opaque libsecp256k1 object holding a MuSig2 secret nonce. |
|
Allocator that locks its contents from being paged out of memory and clears its contents before deletion. |
|
Opaque SQLite database connection handle, defined by the SQLite library. |
|
Opaque SQLite prepared statement handle, defined by the SQLite library. |
|
RAII guard that makes failed checks throw instead of abort for the duration of a test. |
|
transaction_identifier represents the two canonical transaction identifier types (txid, wtxid). |
|
160‐bit opaque blob. |
|
256‐bit opaque blob. |
|
Exception thrown on arithmetic errors involving big integers. |
|
Allocator that clears the memory it manages before returning it to the system. |
Type Aliases
Name |
Description |
CustomUintFormatter alias that serializes integers in big‐endian byte order. |
|
A grant over a binary (single‐slot) semaphore. |
|
A bitset supporting at least BITS elements. |
|
Amount in satoshis (Can be negative) |
|
PoolAllocator's MAX_BLOCK_SIZE_BYTES parameter here uses sizeof the data, and adds the size of 4 pointers. We do not know the exact node size used in the std::unordered_node implementation because it is implementation defined. Most implementations have an overhead of 1 or 2 pointers, so nodes can be connected in a linked list, and in some cases the hash value is stored as well. Using an additional sizeof(void*)*4 for MAX_BLOCK_SIZE_BYTES should thus be sufficient so that all implementations can allocate the nodes from the PoolAllocator. |
|
Memory resource backing the pool allocator used by the coins map. |
|
CPrivKey is a serialized private key, with all parameters included (SIZE bytes) |
|
We use a prevector for the script to reduce the considerable memory overhead of vectors in cases where they normally contain a small number of small elements. |
|
Shared pointer to an immutable transaction. |
|
A txout script categorized into standard templates. * CNoDestination: Optionally a script, no corresponding address. * PubKeyDestination: TxoutType::PUBKEY (P2PK), no corresponding address * PKHash: TxoutType::PUBKEYHASH destination (P2PKH address) * ScriptHash: TxoutType::SCRIPTHASH destination (P2SH address) * WitnessV0ScriptHash: TxoutType::WITNESS_V0_SCRIPTHASH destination (P2WSH address) * WitnessV0KeyHash: TxoutType::WITNESS_V0_KEYHASH destination (P2WPKH address) * WitnessV1Taproot: TxoutType::WITNESS_V1_TAPROOT destination (P2TR address) * PayToAnchor: TxoutType::ANCHOR destination (P2A address) * WitnessUnknown: TxoutType::WITNESS_UNKNOWN destination (P2W??? address) A CTxDestination is the internal data type encoded in a bitcoin address |
|
A reference to a constant mempool entry. |
|
Factory function that creates a ZMQ notifier instance. |
|
Key‐value pair stored in the coins map, linking an outpoint to its cache entry. |
|
This saves us from making many heap allocations when serializing and deserializing compressed scripts. |
|
Function type used to resolve a host name to network addresses. |
|
Byte buffer used by the buffered stream wrappers. |
|
Fixed‐size buffer holding an ECDH shared secret (ECDH_SECRET_SIZE bytes). |
|
Map from a derivation index to its cached extended public key. |
|
Fee rate expressed in satoshis per virtual byte. |
|
Fee rate expressed in satoshis per weight unit. |
|
Handler for requests to a certain HTTP path |
|
How a result field is elided in help: printed normally, hidden, or summarized as "...". |
|
Duration of hours stored as a double. |
|
The first four bytes of a key identifier, used as a BIP32 parent fingerprint. |
|
Callback invoked when a wallet is loaded, receiving the wallet interface. |
|
ChronoFormatter alias that allows lossy conversion of the time point representation. |
|
Four‐byte magic prefix that starts every P2P network message. |
|
Duration of milliseconds stored as a double. |
|
Signature checker bound to a CMutableTransaction. |
|
Wrapped mutex: supports waiting but not recursive locking |
|
Type used to uniquely identify a connected peer. |
|
Identifier assigned to a connected peer. |
|
NodeClock time point measured in whole seconds. |
|
PCP mapping nonce. Arbitrary data chosen by the client to identify a mapping. |
|
A package is an ordered list of transactions. The transactions cannot conflict with (spend the same inputs as) one another. |
|
A list of named RPC arguments, each a (name, value) pair. |
|
Outcome of reading or reconstructing a compact block. |
|
Wrapped mutex: supports recursive locking, but no waiting TODO: We should move away from using the recursive lock by default. |
|
Pointer to a factory function returning the metadata for an RPC method. |
|
Socket descriptor type on non‐Windows platforms, mapped to the Windows SOCKET handle. |
|
Error codes returned by the Bitcoin Script interpreter. |
|
Duration of seconds stored as a double. |
|
A std::string that keeps its contents in locked, cleared‐on‐free memory. |
|
Byte‐vector that clears its contents before deletion. |
|
A public key paired with a signature produced for it. |
|
The monotonic steady clock. |
|
Steady clock time point measured in microseconds. |
|
Steady clock time point measured in milliseconds. |
|
Steady clock time point measured in whole seconds. |
|
The wall‐clock system clock. |
|
Maps a block's parent to the threshold state for the following period. |
|
Formatter used to (de)serialize transactions inside compact blocks. |
|
Signature checker bound to an immutable CTransaction. |
|
Translate a message to the native language of the user. |
|
Txid commits to all transaction fields except the witness. |
|
Wtxid commits to all transaction fields including the witness. |
|
Map of banned subnets to their ban entries. |
|
Opaque data structure for holding a block. |
|
Bitflags to control context‐free block checks (optional). |
|
Opaque data structure for holding a block hash. |
|
Opaque data structure for holding a btck_BlockHeader. |
|
Opaque data structure for holding a block's spent outputs. |
|
Opaque data structure for holding a block tree entry. |
|
A granular "reason" why a block was invalid. |
|
Opaque data structure for holding the state of a block during validation. |
|
Opaque data structure for holding the currently known best‐chain associated with a chainstate. |
|
Opaque data structure for holding the chain parameters. |
|
Identifies which Bitcoin chain (network) a set of chain parameters describes. |
|
Opaque data structure for holding a chainstate manager. |
|
Opaque data structure for holding options for creating a new chainstate manager. |
|
Opaque data structure for holding a coin. |
|
Opaque data structure for holding the Consensus Params. |
|
Opaque data structure for holding a kernel context. |
|
Opaque data structure for holding options for creating a new kernel context. |
|
Function signature for freeing user data. |
|
Function signature for the global logging callback. All bitcoin kernel internal logs will pass through this callback. |
|
A collection of logging categories that may be encountered by kernel code. |
|
The level at which logs should be produced. |
|
Opaque data structure for holding a logging connection. |
|
Function signatures for the kernel notifications. |
|
Callback invoked on an unrecoverable kernel error. |
|
Callback invoked when flushing chainstate data fails. |
|
Callback invoked when a new best header tip is seen during sync. |
|
Callback reporting validation or sync progress as a percentage. |
|
Callback invoked when a kernel warning is raised. |
|
Callback invoked when a previously raised kernel warning is cleared. |
|
Opaque data structure for holding precomputed transaction data. |
|
Opaque data structure for holding a script pubkey. |
|
Script verification flags that may be composed with each other. |
|
A collection of status codes that may be issued by the script verify function. |
|
Current sync state passed to tip changed callbacks. |
|
Opaque data structure for holding a transaction. |
|
Opaque data structure for holding a transaction input. |
|
Opaque data structure for holding a transaction out point. |
|
Opaque data structure for holding a transaction output. |
|
Opaque data structure for holding a transaction's spent outputs. |
|
Indicates the reason why a transaction failed validation. The subset of values reachable depends on which validation function was used. |
|
Opaque data structure for holding the state of a transaction during validation. |
|
Opaque data structure for holding a btck_Txid. |
|
Function signatures for the validation interface. |
|
Callback when a block is connected to the active chain. |
|
Callback when a block is disconnected from the active chain. |
|
Callback when a proof‐of‐work valid block is accepted into the tree. |
|
Whether a validated data structure is valid, invalid, or an error was encountered during processing. |
|
Possible warning types issued by validation. |
|
Opaque data structure for holding a witness stack. |
|
Function signature for serializing data. |
|
Maps a message type to the total number of bytes seen for it. |
|
Handle to an opaque libsecp256k1 context. |
|
A unique_ptr whose managed object lives in secure memory and is securely freed. |
Enums
Name |
Description |
How a local address became known, from least to most trusted. |
|
Signature hash types/flags |
|
Chainstate assumeutxo validity. |
|
Outcome of generating or reading the RPC authentication cookie. |
|
Identifies the kind of block filter, controlling which data it indexes. |
|
Enumeration of reason for returned fee estimate. |
|
Bit flags describing how far a block has been validated and which data is available for it. |
|
A "reason" why a block was invalid, suitable for determining whether the provider of the block should be banned/ignored/disconnected/etc. These are much more granular than the rejection codes, which may be more useful for some other use‐cases. |
|
Used by ParseByteUnits() Lowercase base 1000 Uppercase base 1024 |
|
Identifies which Bitcoin chain a node operates on. |
|
General change type (added, updated, removed). |
|
How full the in‐memory coins cache is relative to its budget. |
|
Bit flags describing the direction of a connection. |
|
Different types of connections to a peer. This enum encapsulates the information we have available at the time of opening or accepting the connection. Aside from INBOUND, all types are initiated by us. |
|
Reason a feerate diagram comparison could not confirm an improvement. |
|
Outcome of disconnecting a block from the UTXO set. |
|
How top‐level fields are elided when rendering transaction help. |
|
Identifier for each of the 3 different TxConfirmStats which track history over different time horizons. |
|
Used to determine type of fee estimation requested |
|
Identifier for fee rate estimator. |
|
Selects the unit used when formatting a fee rate as text. |
|
Used to determine the reason a wallet selected a transaction fee rate |
|
How aggressively FlushStateToDisk should flush chainstate to disk. |
|
getdata / inv message types. These numbers are defined by the protocol. When adding a new value, be sure to mention it in the respective BIP. |
|
HTTP request method parsed from a request line. |
|
HTTP status codes |
|
Version of the JSON‐RPC protocol a request or reply uses. |
|
Unsuccessful response to a port mapping. |
|
Reason why a transaction was removed from the mempool, this is passed to the notification signal. |
|
The result of a signed message verification. Message verification takes as an input: ‐ address (with whose private key the message is supposed to have been signed) ‐ signature ‐ message |
|
Enum to specify what *TransactionSignatureChecker's behavior should be when dealing with missing transaction data. |
|
Fine‐grained permissions granted to a peer via ‐whitebind or ‐whitelist. |
|
A network type. |
|
Grouping used to organize options in the help output. |
|
Serializing JSON objects depends on the outer type. Only arrays and dictionaries can be nested in json. The top‐level outer type is "NONE". |
|
Address encoding to use for a newly generated destination. |
|
The roles a participant can play when processing a PSBT. |
|
A "reason" why a package was invalid. It may be that one or more of the included transactions is invalid or the package itself violates our rules. We don't distinguish between consensus and policy violations right now. |
|
The rbf state of unconfirmed transactions |
|
Response body format requested from the REST interface. |
|
Outcome of reading or reconstructing a compact block. |
|
Outcome of trying to register a peer for transaction reconciliation. |
|
Used by SanitizeString() |
|
Error codes returned by the Bitcoin Script interpreter. |
|
nServices flags |
|
Script execution context that selects the signature‐hashing scheme. |
|
Outcome of an attempt to sign a message. |
|
Outcome of attempting to complete validation of an assumeutxo snapshot. |
|
Stage of block synchronization the node is currently in. |
|
Opaque type for BIP9 state. See versionbits_impl.h for details. |
|
Transport layer version |
|
A "reason" why a transaction was invalid, suitable for determining whether the provider of the transaction should be banned/ignored/disconnected/etc. |
|
Verbose level for block's transaction |
|
Classification of a scriptPubKey into a standard output type. |
|
Mode for encoding VarInts. |
|
Outcome of verifying the consistency of the block and coin databases. |
|
First two bits of nFlags control how much IsRelevantAndUpdate actually updates The remaining bits are reserved |
|
Script opcodes |
|
Names of the individual SCRIPT_VERIFY_* verification flags (forward declaration). |
Functions
Name |
Description |
Most paths passed as configuration arguments are treated as relative to the datadir if they are not absolute. |
|
Try to add a transaction to the mempool. This is an internal function and is exposed only for testing. Client code should use ChainstateManager::ProcessTransaction() |
|
Utility function to find any unspent output with a given txid. This function can be quite expensive because in the event of a transaction which is not found in the cache, it can cause up to MAX_OUTPUTS_PER_BLOCK lookups to database, so it should be used with care. |
|
Get a destination of the requested type (if possible) to the specified script. This function will automatically add the script (and any other necessary scripts) to the keystore. |
|
Build a multisig destination and add its keys and script to the keystore. |
|
Utility function to add all of a transaction's outputs to a cache. When check is false, this assumes that overwrites are only possible for coinbase transactions. When check is true, the underlying view may be queried to determine whether an addition is an overwrite. |
|
Normalize univalue‐represented inputs and add them to the transaction |
|
|
|
Normalize, parse, and add outputs to the transaction |
|
Test whether the sum of two integers would overflow. |
|
Get a list of known filter types. |
|
Pre‐allocate a range of a file so later writes into it do not fragment or fail. |
|
Validate and return a CAmount from a UniValue number or string. |
|
Initialize bitcoin core: Basic context setup. |
|
Initialize node and wallet interface pointers. Has no prerequisites or side effects besides allocating memory. |
|
Lock bitcoin core critical directories. |
|
Bitcoin core main initialization. |
|
Initialization: parameter interaction. |
|
Initialization sanity checks. |
|
Overlay the options set in |
|
Converts an arithmetic 256‐bit integer to a uint256 blob. |
|
|
|
Calculate the asmap version, a checksum identifying the asmap being used. |
|
Assert that the given mutex is held by the current thread. |
|
|
|
Assert that the given mutex is not held by the current thread. |
|
Computes the BIP32 child key derivation hash. |
|
Convert a JSON array to a |
|
Convert a |
|
Return the currently selected parameters. This won't change after app startup, except for unit tests. |
|
Pack a vector of bits into bytes, eight bits per byte, least significant bit first. |
|
Find a filter type by its human‐readable name. |
|
Get the human‐readable name for a filter type. Returns empty string for unknown types. |
|
Compute the Merkle root of the transactions in a block. *mutated is set to true if a duplicated subtree was found. |
|
Path of the block policy fee estimator data file. |
|
Compute the Merkle root of the witness transactions in a block. |
|
Build a script by concatenating other scripts, or any argument accepted by CScript::operator<<. |
|
Unpack bytes into a vector of bits, eight bits per byte, least significant bit first. |
|
Return the sum of the claimed work on a given set of headers. No verification of PoW is done. |
|
Calculate LockPoints required to check if transaction will be BIP68 final in the next block to be created on top of tip. |
|
Compute the retargeted proof‐of‐work target after a difficulty adjustment interval. |
|
Sums the value of all outputs of a transaction. |
|
Used by getblockstats to get feerates at different percentiles by weight |
|
Calculates the block height and previous block's median time past at which the transaction will be considered final in the context of BIP 68. For each input that is not sequence locked, the corresponding entries in prevHeights are set to 0 as they do not affect the calculation. |
|
Capitalizes the first character of the given string. This function is locale independent. It only converts lowercase characters in the standard 7‐bit ASCII range. This is a feature, not a limitation. |
|
Locale‐independent, ASCII‐only comparator |
|
|
|
Integer ceiling division (for unsigned values). |
|
Parse a chain type from its canonical string name. |
|
Convert a chain type to its canonical string name. |
|
Context‐independent validity checks. |
|
Check that a block's data (and optionally undo data) is available on disk. |
|
Return true if ‐datadir option points to a valid directory or is not specified. |
|
Check that a directory has enough free space for an additional write. |
|
Called for each transaction(package) if any dust is in the package. Checks that each transaction's parents have their dust spent by the child, where parents are either in the mempool or in the package itself. Sets out_child_state and out_child_wtxid on failure. |
|
Check if transaction will be final in the next block to be created. |
|
Verify that the most recently entered critical section matches the given mutex. |
|
Checks whether pushed data uses the minimal encoding for its opcode. |
|
Check whether a block hash satisfies the proof‐of‐work requirement specified by nBits |
|
Implementation of CheckProofOfWork that verifies a hash against a compact target. |
|
Check if transaction will be BIP68 final in the next block to be created on top of tip. |
|
Check that a signature uses a valid encoding for the given verification flags. |
|
Extract signature and check whether a block has a valid solution |
|
Check standard asmap data (128 bits for IPv6). |
|
Performs context‐independent validity checks on a transaction. |
|
Add two integers, checking for overflow. |
|
Left bit shift with overflow checking. |
|
Forget all known local addresses. |
|
Clear a vector (or std::deque) and release its allocated memory. |
|
Combines PSBTs with the same underlying transaction, resulting in a single PSBT with all partial signatures from each input. |
|
Compare the feerate diagrams implied by the provided sorted chunks data. |
|
Compress amount. |
|
Compresses a script into the compact on‐disk representation. |
|
Compute a Merkle root from the provided leaf hashes. If non‐null, |
|
Compute the BIP341 tapbranch hash from two branches. Spans must be 32 bytes each. |
|
Compute the BIP341 tapleaf hash from leaf version & script. |
|
Compute the BIP341 taproot script tree Merkle root from control block and leaf hash. Requires control block to have valid length (33 + k*32, with k in {0,1,..,128}). |
|
|
|
Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy. |
|
Convert ConnectionType enum to a string value |
|
Create a transaction from univalue parameters |
|
Convert from one power‐of‐2 number base to another. |
|
Build the multi‐line copyright holders string. |
|
Counts the unsigned inputs of a PSBT. |
|
Count the signature operations contributed by a witness spend. |
|
Creates and returns a std::unique_ptr<CBaseChainParams> of the chosen chain. |
|
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain. |
|
Combine the participants' partial signatures into a final MuSig2 aggregate signature. |
|
Generate a MuSig2 public nonce for a signing session and store the matching secret nonce. |
|
Produce this participant's MuSig2 partial signature for the session. |
|
Construct the BIP 328 synthetic xpub for a pubkey |
|
Create a real socket from the operating system. |
|
Helper to create UTXO snapshots given a chainstate and a file handle. |
|
Extract signature data from a transaction input, and insert it. |
|
Read and check asmap from provided binary file. |
|
Decode a base32‐encoded string. |
|
Decode a base58‐encoded string (str) into a byte vector (vchRet). return true if decoding is successful. |
|
Decode a base58‐encoded string (str) that includes a checksum into a byte vector (vchRet), return true if decoding is successful |
|
Decode a base64‐encoded string. |
|
Decode a base64‐encoded PSBT into a PartiallySignedTransaction. |
|
|
|
Decode a double from its IEEE 754 binary64 representation. |
|
Decode a Base58Check‐encoded extended private key. |
|
Decode a Base58Check‐encoded extended public key. |
|
Decode a hex‐encoded serialized block. |
|
Decode a hex‐encoded serialized block header. |
|
Decode a hex‐encoded serialized transaction. |
|
Decode a raw binary PSBT into a PartiallySignedTransaction. |
|
Decode a WIF‐encoded private key. |
|
Reverses CompressAmount, recovering the original amount in satoshis. |
|
Reconstructs a script from its compressed representation. |
|
Build the default local target address for the onion service. |
|
Delete RPC authentication cookie from disk |
|
Remove all lock‐order bookkeeping for the given mutex. |
|
|
|
|
|
|
|
|
|
Get extended key and origin info for a given path |
|
Convert nBits value to target. |
|
Describe an address as a JSON object for RPC output. |
|
Unique identifier that may not change over time, unless explicitly marked as not backwards compatible. This is not part of BIP 380, not guaranteed to be interoperable and should not be exposed to the user. |
|
Deserialize a length‐prefixed KeyOriginInfo from a stream. |
|
Deserialize an HD keypath and insert it into a map keyed by public key. |
|
Deserialize a fixed number of bytes from a stream as a KeyOriginInfo. |
|
Deserialize the MuSig2 participant identifiers from a PSBT MuSig2 field. |
|
Deserialize a PSBT_{IN,OUT}_MUSIG2_PARTICIPANT_PUBKEYS field. |
|
Destroy all open block filter indexes. |
|
Destroy the block filter index with the given type. Returns false if no such index exists. This just releases the allocated memory and closes the database connection, it does not delete the index data. |
|
Destroys the LevelDB database stored at the given path. |
|
Sync directory contents. This is required on some environments to ensure that newly created files are committed to disk. |
|
Look up IP addresses from all interfaces on the machine and add them to the list of local addresses to self‐advertise. The loopback interface is skipped. |
|
Dump the anchor IP address database (anchors.dat) |
|
Writes the peer address database (peers.dat) to disk. |
|
Check that required EC support is available at runtime. |
|
Stamp elision onto an entire vector of RPCResult fields at once. Merges into existing m_opts so that flags like skip_type_check are preserved. |
|
Report whether fuzz determinism is currently enabled. |
|
Base32 encode. If |
|
Encode a byte span as a base58‐encoded string |
|
Encode a byte span into a base58‐encoded string, including checksum |
|
|
|
Encode a destination as an address string. |
|
Encode a double using the IEEE 754 binary64 format. |
|
Encode an extended private key in Base58Check format. |
|
Encode an extended public key in Base58Check format. |
|
Serialize a transaction and encode it as a hex string. |
|
Encode a private key in WIF format. |
|
Get the address manager from a node context, asserting it is present. |
|
Get the address manager from an opaque RPC context, asserting it is present. |
|
Get the argument manager from an opaque RPC context, asserting it is present. |
|
Get the ban manager from an opaque RPC context, asserting it is present. |
|
Get the chainstate manager from an opaque RPC context, asserting it is present. |
|
Get the fee estimator from an opaque RPC context, asserting it is present. |
|
Get the mempool from an opaque RPC context, asserting it is present. |
|
Extract the node context from an opaque RPC context, asserting it is present. |
|
Get the argument manager from a node context, asserting it is present. |
|
Get the ban manager from a node context, asserting it is present. |
|
Get the chainstate manager from a node context, asserting it is present. |
|
Get the connection manager from a node context, asserting it is present. |
|
Get the fee estimator from a node context, asserting it is present. |
|
Get the mempool from a node context, asserting it is present. |
|
Get the mining interface from a node context, asserting it is present. |
|
Get the peer manager from a node context, asserting it is present. |
|
Register that a critical section is being entered, for lock‐order checking. |
|
Check the intersection between two sets of transactions (a set of mempool entries and a set of txids) to make sure they are disjoint. |
|
Build a fee rate estimation error result: a zero‐value estimation identifying the estimator and target, alongside the error message. |
|
Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000. |
|
|
|
Checks whether previously computed sequence locks are satisfied by a block. |
|
Execute a single HTTP request containing one or more JSONRPC requests. Specified jreq will be modified and status will be returned. |
|
Parse a scriptPubKey for the destination. |
|
Report an unrecoverable error, flag the validation state as failed, and notify the node to shut down. |
|
Return the estimation carried by a fee rate estimate result: the successful estimation, or the error's zero‐value estimation. |
|
Parse a fee rate estimator type from its canonical string name. |
|
Convert a fee rate estimator type to its canonical string name. |
|
Ensure file contents are fully committed to disk, using a platform‐specific feature analogous to fsync(). |
|
Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized. |
|
Finalizes a PSBT if possible, combining partial signatures. |
|
Remove every occurrence of a subscript from a script in place. |
|
Return the first element of a vector matching a predicate. |
|
Iterate over all running block filter indexes, invoking fn on each. |
|
Return a comma‐separated list of all supported output type names. |
|
Returns the full client version string, including build metadata. |
|
Format an HD keypath as a string, prefixed with the master key marker "m". |
|
Format a Unix timestamp as an ISO 8601 date string. |
|
ISO 8601 formatting is preferred. Use the FormatISO8601{DateTime,Date} helper functions if possible. |
|
Format an amount as a string denoted in full coins. |
|
Return the string name of an output type. |
|
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line. |
|
RFC1123 formatting https://www.rfc‐editor.org/rfc/rfc1123#section‐5.2.14 Used in HTTP/1.1 responses |
|
Format a script as a compact single‐line string for logging and display. |
|
Formats a BIP14‐style user agent subversion string. |
|
Generate a new RPC authentication cookie and write it to disk |
|
Generate a new random private key. |
|
Gets all existing output types formatted for RPC help sections. |
|
Read the RPC authentication cookie from disk |
|
Get the bind address for a socket as CService. |
|
Compute how much work an nBits value corresponds to. |
|
Get a block filter index by type. Returns nullptr if index has not been initialized or was already destroyed. |
|
|
|
Return the time it would take to redo the work difference between from and to, assuming the current hashrate corresponds to the difficulty at tip, in seconds. |
|
Return the script flags which should be checked for a given block. |
|
Compute the block subsidy (newly created coins) for a block at a given height. |
|
Looks up a buried deployment by its name. |
|
Get the default data directory for the current platform and user. |
|
Get the checksum for a |
|
Get the difficulty of the net wrt to the given block index. |
|
Get the vout index numbers of all dust outputs |
|
Compute the minimum output value below which an output is considered dust. |
|
Get all descendants of iters_conflicting. Checks that there are no more than MAX_REPLACEMENT_CANDIDATES distinct clusters affected. |
|
Get the size of a file by scanning it. |
|
Return the CKeyID of the key involved in a script (if there is a unique one). |
|
Count ECDSA signature operations the old‐fashioned (pre‐0.6) way |
|
Return the port we listen on for incoming connections. |
|
Returns a local address that we should advertise to this peer. |
|
Return the best local address to use when talking to the given peer. |
|
Return all local non‐loopback IPv4 and IPv6 network addresses. |
|
Get a locator for a block index entry. |
|
For testing. |
|
Get the configured name proxy, if any. |
|
Determines which chain a set of network magic bytes belongs to. |
|
Get the canonical name of a network. |
|
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE. |
|
Compute the proof‐of‐work target (nBits) required for the block following pindexLast. |
|
Return the number of cores available on the current system. |
|
Returns the mnemonic name of an opcode. |
|
Count ECDSA signature operations in pay‐to‐script‐hash inputs. |
|
Get the hash of the concatenated wtxids of transactions, with wtxids treated as a little‐endian numbers and sorted in ascending numeric order. |
|
Get the proxy configured for a given network, if any. |
|
Return height of highest block that has been pruned, or std::nullopt if no blocks have been pruned |
|
Extract a query‐string parameter value from a request URI. |
|
Generate random data via the internal PRNG. |
|
Generate a random uint256. |
|
List the human‐readable names of the set verification flags. |
|
Generate a Bitcoin scriptPubKey for the given CTxDestination. Returns a P2PKH script for a CKeyID destination, a P2SH script for a CScriptID, and an empty script for CNoDestination. |
|
Generate a multisig script. |
|
Generate a P2PK script for the given pubkey. |
|
Reads the next opcode, and any pushed data, from a script. |
|
Access the secp256k1 context used for signing and MuSig2 nonce generation. |
|
Return the number of bytes the serialization of an object would occupy. |
|
Adjust a transaction weight to account for its signature operation cost. |
|
Compact Size size < 253 ‐‐ 1 byte size <= USHRT_MAX ‐‐ 3 bytes (253 + 2 bytes) size <= UINT_MAX ‐‐ 5 bytes (254 + 4 bytes) size > UINT_MAX ‐‐ 9 bytes (255 + 8 bytes) |
|
Return the number of bytes the VarInt encoding of a value occupies. |
|
Returns the decompressed byte length of a special (compressed) script. |
|
Gather entropy from various sources, feed it into the internal PRNG, and generate random data using it. |
|
* Get the target for a given block index. |
|
|
|
Compute total signature operation cost of a transaction. |
|
Get the name of a TxoutType as a string |
|
Monotonic uptime (not affected by system time changes). |
|
Compute the virtual size of a single transaction input. |
|
|
|
Compute at which vout of the block's coinbase transaction the witness commitment occurs, or ‐1 if not found |
|
Golomb‐Rice decode a value from a bit stream. |
|
Golomb‐Rice encode a value into a bit stream. |
|
Whether a parsed HD keypath contains at least one hardened derivation step. |
|
Checks if a particular test option is present in ‐test command‐line arg options |
|
Check that the proof of work on each blockheader matches the value in nBits. |
|
|
|
Compute the 160‐bit hash an object. |
|
Check whether a name proxy has been configured. |
|
Format a bitcoin‐cli example invocation with positional arguments. |
|
Format a bitcoin‐cli example invocation with named arguments. |
|
Format a JSON‐RPC example request with positional arguments. |
|
Format a JSON‐RPC example request with named arguments. |
|
Format a string to be used as group of options in help messages |
|
Format a string to be used as option description in help messages |
|
Return whether the user asked for help on the command line. |
|
Return the numeric value of a hexadecimal digit character. |
|
|
|
Parse a hex‐encoded public key, throwing an RPC error if it is invalid. |
|
Check whether a socket error code represents a permanent failure. |
|
The replacement transaction must improve the feerate diagram of the mempool. |
|
Find a descriptor for the specified |
|
Given a TaprootSpendData and the output key, reconstruct its script tree. |
|
Initialize a block filter index for the given type if one does not already exist. Returns true if a new index is created and false if one has already been initialized. |
|
Initialize node context shutdown and args variables. |
|
|
|
Initialize HTTP server. Call this before RegisterHTTPHandler or EventBase(). |
|
Initialize the logging infrastructure |
|
Parameter interaction: change current parameters depending on various rules |
|
Show warning message |
|
Map an IP address to its Autonomous System Number using the given asmap. |
|
Split a raw configuration key into its section, name, and negation. |
|
Interpret a custom permissions level string as fs::perms |
|
Interpret a raw configuration value according to a key and its flags. |
|
Interrupt threads |
|
Interrupt HTTP RPC subsystem. |
|
Interrupt HTTP server threads |
|
Signal the port mapping thread to stop as soon as possible. |
|
Interrupt RPC REST subsystem. |
|
Interrupt the RPC service, unblocking any pending waits. |
|
Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30). |
|
Identifies blocks which coinbase output was subsequently overwritten in the UTXO set (see BIP30). |
|
Determine if a port is "bad" from the perspective of attempting to connect to a node on that port. |
|
Check if a block has been mutated (with respect to its merkle root and witness commitments). |
|
Context‐free check that a package is exactly one child and its parents; not all parents need to be present, but the package must not contain any transactions that are not the child's parents. It is expected to be sorted, which means the last transaction must be the child. |
|
Context‐free check that a package IsChildWithParents() and none of the parents depend on each other (the package is a "tree"). |
|
Checks that these transactions don't conflict, i.e., spend the same prevout. This includes checking that there are no duplicate transactions. Since these checks require looking at the inputs of a transaction, returns false immediately if any transactions have empty vin. |
|
Report whether the given deprecated RPC method is currently enabled. |
|
Tests if the given character is a decimal digit. |
|
Check if a directory is writable by creating a temporary file on it. |
|
Test whether an output is dust at the given relay fee rate. |
|
Check if transaction is final and can be included in a block with the specified height and time. Consensus critical. |
|
Returns true if each character in str is a hex character, and has an even number of hex digits. |
|
Return whether the given address is one of our known local addresses. |
|
Test for OP_SUCCESSx opcodes as defined by BIP342. |
|
Check whether an address is one of the configured proxies. |
|
Test whether an opcode is a data‐push operation. |
|
Determine whether an unconfirmed transaction is signaling opt‐in to RBF according to BIP 125 This involves checking sequence numbers of the transaction, as well as the sequence numbers of all in‐mempool ancestors. |
|
Determine the RBF signaling state of a transaction assuming an empty mempool. |
|
Query whether RPC is running |
|
Check whether a scriptPubKey is known to be segwit. |
|
Tests if the given character is a whitespace character. The whitespace characters are: space, form‐feed ('f'), newline (' '), carriage return ('r'), horizontal tab ('t'), and vertical tab ('v'). |
|
Determine whether a scriptPubKey uses a standard output form. |
|
Check for standard transaction types |
|
Return true if the character introduces a command‐line switch. |
|
If any direct dependencies exist between transactions (i.e. a child spending the output of a parent), checks that all parents appear somewhere in the list before their respective children. No other ordering is enforced. This function cannot detect indirect dependencies (e.g. a transaction's grandparent if its parent is not present). |
|
Check if a string is a valid UNIX domain socket path |
|
Check whether a CTxDestination corresponds to one with an address. |
|
|
|
Context‐free package policy checks: 1. The number of transactions cannot exceed MAX_PACKAGE_COUNT. 2. The total weight cannot exceed MAX_PACKAGE_WEIGHT. 3. If any dependencies exist between transactions, parents must appear before children. 4. Transactions cannot conflict, i.e., spend the same inputs. |
|
Check if the transaction is over standard P2WSH resources limit: 3600bytes witnessScript size, 80bytes per witness stack element, 100 witness stack elements These limits are adequate for multisignatures up to n‐of‐100 using OP_CHECKSIG, OP_ADD, and OP_EQUAL. |
|
Build a JSON‐RPC error object. |
|
Execute an RPC request and return its JSON‐RPC reply. |
|
Build a JSON‐RPC error object for a PSBT error. |
|
Parse JSON‐RPC batch reply into a vector |
|
Build a JSON‐RPC reply object from a result or error. |
|
JSON‐RPC 2.0 request, only used in bitcoin‐cli |
|
Build a JSON‐RPC error object for a transaction error. |
|
The Keccak‐f[1600]permutation. |
|
Compute the coins‐cache usage threshold above which a periodic flush is warranted. |
|
Find the forking point between two chain tips. |
|
Register that the most recently entered critical section is being left. |
|
Returns licensing information (for ‐version) |
|
Get a comma‐separated list of known filter type names. |
|
Loads the address manager (peers.dat), creating a fresh one if needed. |
|
Locale‐independent replacement for std::atoi, provided for backwards compatibility reasons. |
|
Construct a list of hash entries to put in a locator. |
|
Check whether the current thread holds no tracked critical sections. |
|
Access the global logger instance. |
|
|
|
|
|
Resolve a service string with a numeric IP to its first corresponding service. |
|
Parse and resolve a specified subnet string into the appropriate internal representation. |
|
Return a read‐only span of bytes viewing the same memory as the range |
|
Given a uniformly random uint64_t, return an exponentially distributed double with mean 1. |
|
Builds a shared pointer to an immutable transaction from the given value. |
|
Construct a new TxGraph with the specified limit on the number of transactions within a cluster, and on the sum of transaction sizes within a cluster. |
|
Like the std::span constructor, but for (const) unsigned char member types only. Only works for (un)signed char containers. |
|
Return a writable span of bytes viewing the same memory as the range |
|
Like MakeUCharSpan, but returns a writable span of |
|
Determine if script is a "multi_a" script. Returns (threshold, keyspans) if so, and nullopt otherwise. The keyspans refer to bytes in the passed script. |
|
|
|
If an IPv6 address belongs to the address range used by the CJDNS network and the CJDNS network is reachable (‐cjdnsreachable config is set), then change the type from NET_IPV6 to NET_CJDNS. |
|
Move a legacy fee_estimates.dat file to the current block policy fee estimator path, if needed. |
|
Mempool information to JSON |
|
Path of the mempool policy estimator data file. |
|
Mempool to JSON |
|
Hashes a message for signing and verification in a manner that prevents inadvertently signing a transaction. |
|
Sign a message. |
|
Verify a signed message. |
|
Convert milliseconds to a struct timeval for e.g. select. |
|
Returns true when the amount is non‐negative and does not exceed MAX_MONEY. |
|
|
|
Computes an arbitrary unique session ID to identify ongoing signing sessions. It is the SHA256 of the signing (aggregate) pubkey, the participant pubkey, the sighash, and the pubnonce |
|
Computes the 32‐bit MurmurHash3 of the given data. |
|
Try to open a port using RFC 6886 NAT‐PMP. IPv4 only. |
|
Return readable error string for a network error code. |
|
Return an empty block index on top of the tip, with height, time and nBits set |
|
Normalize univalue‐represented outputs |
|
Return the current time point cast to the given precision. Only use this when an exact precision is needed, otherwise use T::clock::now() directly. |
|
Encode a raw Tor v3 address as its human‐readable .onion string. |
|
Get the OutputType for a CTxDestination |
|
Try to open a port using RFC 6887 Port Control Protocol (PCP). Handles IPv4 and IPv6. |
|
Checks whether a PSBTInput is already signed by checking for non‐null finalized fields. |
|
Checks whether a PSBTInput is already signed by doing script verification using final fields. |
|
Return a human‐readable name for a PSBT role. |
|
Must be called for every transaction that is submitted within a package, even if not TRUC. |
|
Return the currently selected parameters. This won't change after app startup, except for unit tests. |
|
Parse a |
|
Parse a string with suffix unit [k|K|m|M|g|G|t|T]. Must be a whole integer, fractions not allowed (0.5t), no whitespace or +‐ Lowercase units are 1000 base. Uppercase units are 1024 base. Examples: 2m,27M,19g,41T |
|
Parse a confirm target option and raise an RPC error if it is invalid. |
|
Parse a URI to get the data format and URI without data format and query string. |
|
Parse a JSON range specified as an int64 or as a [int64, int64]pair. |
|
Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB). Reject negative values or rates larger than 1BTC/kvB. |
|
Parse number as fixed point according to JSON number syntax. |
|
Parse an HD keypaths like "m/7/0'/2000". |
|
Parse a hex‐encoded hash from a named field of an object. |
|
Parse a hex‐encoded hash from a UniValue, throwing an RPC error if it is not valid hex. |
|
Like TryParseHex, but returns an empty vector on invalid input. |
|
Parse a hex‐encoded byte vector from a named field of an object. |
|
Parse a hex‐encoded byte vector from a UniValue, throwing an RPC error if it is not valid hex. |
|
Parse an ISO 8601 date and time string into a Unix timestamp. |
|
Parse a single key path element like "0", "0'", or "0h". Returns the derivation index and hardened status, or an error message. |
|
Parse an amount denoted in full coins. E.g. "0.0034" supplied on the command line. |
|
Parse a network name into its Network enumerator. |
|
Parse an output type from its string name. |
|
Parse normalized outputs into destination, amount tuples |
|
Parse a BIP32 derivation path. |
|
Parse a prevtxs UniValue array and get the map of coins from it |
|
Parse a human‐readable script (opcodes and push data) into a CScript. |
|
Parse a sighash string representation and raise an RPC error if it is invalid. |
|
Parses verbosity from provided UniValue. |
|
The replacement transaction must pay more fees than the original transactions. The additional fees must pay for the replacement's bandwidth at or above the incremental relay feerate. |
|
Return false if the proof‐of‐work requirement specified by new_nbits at a given height is not possible, given the proof‐of‐work on the prior block as specified by old_nbits. |
|
Convert fs::perms to symbolic string of the form 'rwxrwxrwx' |
|
Called for each transaction once transaction fees are known. Does context‐less checks about a single transaction. |
|
Compute a PrecomputedTransactionData object from a psbt. |
|
Log an exception and its originating thread without rethrowing. |
|
Validate (and maybe submit) a package to the mempool. See doc/policy/packages.md for full details on package validation rules. |
|
Produce a script signature using a generic signature creator. |
|
Protect desirable or disadvantaged inbound peers from eviction by ratio. |
|
Prune block files up to a given height. |
|
|
|
Query the OS for the default gateway for |
|
Compute the 160‐bit RIPEMD‐160 hash of an array. |
|
Convert named arguments to command‐specific RPC representation |
|
Convert positional arguments to command‐specific RPC representation |
|
Map a transaction error to the matching RPC error code. |
|
Report whether the RPC server is still warming up. |
|
Check that an object contains the expected keys with the expected value types. |
|
Try to raise the file descriptor limit to the requested number. |
|
Gather non‐cryptographic environment data that changes over time. |
|
Gathers entropy from the low bits of the time at which events occur. Should be called with a uint32_t describing the event at the time an event occurs. |
|
Gather entropy from various expensive sources, and feed them to the PRNG state. |
|
Gather non‐cryptographic environment data that does not change over time. |
|
Initialize global RNG state and log any CPU features that are used. |
|
Check that OS randomness is available and returning the requested number of bytes. |
|
Read the anchor IP address database (anchors.dat) |
|
Read a big‐endian 16‐bit integer from a byte buffer. |
|
Read a big‐endian 32‐bit integer from a byte buffer. |
|
Read a big‐endian 64‐bit integer from a byte buffer. |
|
Read full contents of a file and return them in a std::string. |
|
Decode a CompactSize‐encoded variable‐length integer. |
|
Reads peer addresses from a stream into the address manager. |
|
Read a little‐endian 16‐bit integer from a byte buffer. |
|
Read a little‐endian 32‐bit integer from a byte buffer. |
|
Read a little‐endian 64‐bit integer from a byte buffer. |
|
Read a VarInt‐encoded value from a stream. |
|
Recursively measure the dynamic memory used by the pointee of a shared pointer. |
|
Register the blockchain RPC commands. |
|
Register the fee‐estimation RPC commands. |
|
Register handler for prefix. If multiple handlers match a prefix, the first‐registered one will be invoked. |
|
Register the mempool RPC commands. |
|
Register the mining RPC commands. |
|
Register the network RPC commands. |
|
Register the node RPC commands. |
|
Register the output‐script RPC commands. |
|
Register the raw‐transaction RPC commands. |
|
Register the message‐signing RPC commands. |
|
Register the external‐signer RPC commands. |
|
Register the txout‐proof RPC commands. |
|
Register the ZMQ‐related RPC commands. |
|
Release all directory locks. This is used for unit testing only, at runtime the global destructor will take care of the locks. |
|
Convert a mempool removal reason to a human‐readable string. |
|
Forget a previously recorded local address. |
|
Reduces the size of the PSBT by dropping unnecessary |
|
Rename src to dest. |
|
Throw JSONRPCError if RPC is not running |
|
Execute a command which returns JSON, and parse the result. |
|
Autodetect the best available SHA256 implementation. Returns the name of the implementation. |
|
Compute multiple double‐SHA256's of 64‐byte blobs. output: pointer to a blocks*32 byte output buffer input: pointer to a blocks*64 byte input buffer blocks: the number of hashes to compute. |
|
Single‐SHA256 a 32‐byte input (represented as uint256). |
|
Remove unsafe chars. Safe chars chosen to allow simple messages/URLs/email addresses, but avoid anything even possibly remotely dangerous like & or > |
|
Check that the asmap is well formed for the given address size. |
|
Add two integers, saturating instead of overflowing. |
|
Left bit shift with safe minimum and maximum values. |
|
On platforms that support it, tell the kernel the calling thread is CPU‐intensive and non‐interactive. See SCHED_BATCH in sched(7) for details. |
|
Returns a human‐readable message describing a script error code. |
|
Return the mapping from verification flag names to their enum values. |
|
Return the standard result documentation for a scriptPubKey object. |
|
Render a script as a human‐readable assembly string. |
|
Fill a JSON object with a human‐readable description of a script. |
|
Service flags we assume for addresses obtained from the DNS seeds and the fixed seeds, which don't come with service flags attached. BIP324 support can be safely assumed because the vast majority of listening nodes signals NODE_P2P_V2, and if the assumption is wrong for a given peer we simply reconnect using v1 transport. |
|
State independent service flags. If the return value is changed, contrib/seeds/makeseeds.py should be updated appropriately to filter for nodes with desired service flags (compatible with our new flags). |
|
Mark a local address as having been seen, returning whether it was already known. |
|
Sets the params returned by Params() to those for the given chain. |
|
Select an inbound peer to evict after filtering out (protecting) peers having distinct, difficult‐to‐forge characteristics. The protection logic picks out fixed numbers of desirable peers per various criteria, followed by (mostly) ratios of desirable or disadvantaged peers. If any eviction candidates remain, the selection logic chooses a peer to evict. |
|
Sets the params returned by Params() to those for the given chain type. |
|
Check if transaction is final per BIP 68 sequence numbers and can be included in a block. Consensus critical. Takes as input a list of heights at which tx's inputs (in order) confirmed. |
|
|
|
Serialize a length‐prefixed KeyOriginInfo to a stream. |
|
Serialize a map of HD keypaths to a stream under the given key type. |
|
Serialize a KeyOriginInfo to a stream. |
|
Serialize several objects in sequence to the same stream. |
|
Serialize arguments as a length‐prefixed vector into a stream. |
|
Writes a transaction to a stream, optionally including witness data. |
|
|
|
Set the name proxy to use for all connections to nodes specified by a hostname. After setting this proxy, connecting to a node specified by a hostname won't result in a local lookup of said hostname, rather, connect to the node by asking the name proxy for a proxy connection to the hostname, effectively delegating the hostname lookup to the specified proxy. |
|
Set the proxy used to reach a given network. |
|
Mark warmup as done. RPC calls will be processed from now on. |
|
Enter the warmup state so RPC calls report that the node is starting up. |
|
Set the RPC warmup status. When this is done, all RPC calls will error out immediately with RPC_IN_WARMUP. |
|
|
|
|
|
|
|
Set the arguments for chainparams |
|
Initialize locale, standard streams, and other process‐wide environment settings. |
|
Add help options to the args manager |
|
Initialize networking support for the current platform. |
|
Register all arguments with the ArgsManager |
|
Quote and escape a string so it can be safely passed as a single shell argument. |
|
Shut down the node, stopping threads and releasing resources. |
|
Return whether node shutdown was requested. |
|
Parse a signature‐hash type from its textual name. |
|
Convert a signature‐hash type byte into its textual name. |
|
Signs a PSBTInput, verifying that all provided data matches what is being signed. |
|
|
|
Encode the outcome of a signing attempt as a JSON object |
|
Check whether the sequence numbers on this transaction are signaling opt‐in to replace‐by‐fee, according to BIP 125. Allow opt‐out of transaction replacement by setting nSequence > MAX_BIP125_RBF_SEQUENCE (SEQUENCE_FINAL‐2) on all inputs. |
|
Compute the signature hash for one input under the selected signature version. |
|
Compute the BIP341 Taproot signature hash for one input. |
|
Return a human‐readable description of a signing result. |
|
Must be called for every transaction, even if not TRUC. Not strictly necessary for transactions accepted through AcceptMultipleTransactions. |
|
Connect to a specified destination service through an already connected SOCKS5 proxy. |
|
Parse a scriptPubKey and identify script type for standard scripts. If successful, returns script type and parsed pubkeys or hashes, depending on the type. For example, for a P2SH script, vSolutionsRet will contain the script hash, for P2PKH it will contain the key hash, etc. |
|
Pop the last element off a span, and return a reference to that element. |
|
Check whether this transaction spends any witness program but P2A, including not‐yet‐defined ones. May return |
|
Splits socket address string into host string and port value. Validates port value. |
|
Start HTTP RPC subsystem. Precondition; HTTP and RPC has been started. |
|
Start HTTP server. This is separate from InitHTTPServer to give users race‐condition‐free time to register their handlers between InitHTTPServer and StartHTTPServer. |
|
Validates requirements to run the indexes and spawns each index initial sync thread |
|
Start the port mapping thread that requests a port forward from the gateway. |
|
Start HTTP REST subsystem. Precondition; HTTP and RPC has been started. |
|
Start the RPC service so it begins accepting calls. |
|
Get a string with the state name |
|
Reports whether standard input has data available to read. |
|
Reports whether standard input is connected to a terminal. |
|
Stop HTTP RPC subsystem. Precondition; HTTP and RPC has been stopped. |
|
Stop HTTP server |
|
Stop the port mapping thread and remove any established port mapping. |
|
Stop HTTP REST subsystem. Precondition; HTTP and RPC has been stopped. |
|
Stop the RPC service and release its resources. |
|
Format an internal bug report message that includes its source location. |
|
Return a human‐readable name for a block policy estimate reason. |
|
Return a human‐readable name for a fee estimate horizon. |
|
Returns a human‐readable description of a task submission error. |
|
Return system error string from errno value. Use this instead of std::strerror, which is not thread‐safe. For network errors use NetworkErrorString from sock.h instead. |
|
Return a HashWriter primed for tagged hashes (as specified in BIP 340). |
|
Verify a block, including transactions. |
|
Test whether the LockPoints height and time are still valid on the current chain |
|
Helper to count the seconds of a duration/time_point. |
|
Count the whole seconds of a duration as a signed 64‐bit integer. |
|
Count the ticks of a time point's duration since the clock epoch. |
|
Timing‐attack‐resistant comparison. Takes time proportional to length of first argument. |
|
Copies the bytes of a container into a byte vector. |
|
Convert a TX/WITNESS_TX/WTX CInv to a GenTxid. |
|
Convert string to integral type T. Leading whitespace, a leading +, or any trailing character fail the parsing. The required format expressed as regex is |
|
|
|
|
|
Convert a script‐hash destination back to a script identifier. |
|
|
|
Compute merkle path to the specified transaction |
|
Convert TransportProtocolType enum to a string value |
|
Truncate a file to the given length. |
|
Create a directory and any missing parent directories. |
|
Return the total RAM available on the current system, if detectable. |
|
Parse the hex string into bytes (uint8_t or std::byte). Ignores whitespace. Returns nullopt on invalid input. |
|
Subtract j from i in place, only if it does not underflow. |
|
Explain the UniValue "decoded" transaction object, may include extra fields if processed by wallet |
|
Fill a JSON object with a human‐readable description of a transaction. |
|
|
|
Convert a span to a span of |
|
Converts a uint256 blob to an arithmetic 256‐bit integer. |
|
Sleep for the given duration without responding to interruption. |
|
Release a directory lock previously taken with LockDirectory. |
|
Unregister handler for prefix. |
|
|
|
Unserialize a length‐prefixed vector of objects from a stream. |
|
Unserialize several objects in sequence from the same stream. |
|
Basic transaction serialization format: ‐ uint32_t version ‐ std::vector<CTxIn> vin ‐ std::vector<CTxOut> vout ‐ uint32_t nLockTime |
|
Mark a bilingual_str as untranslated |
|
Write the scriptSig and witness from signature data back into an input. |
|
Updates a PSBTOutput with information from provider. |
|
Decode a percent‐encoded URL string. |
|
Percent‐encode a string for use in a URL. |
|
Cause serialization/deserialization of an object to be done using a specified formatter class. |
|
Check for standard transaction types |
|
Convert an amount in satoshis into a JSON value denominated in whole coins. |
|
Construct a vector with the specified elements. |
|
Verify that an input's scriptSig and witness satisfy the output's scriptPubKey. |
|
Wrapper for getaddrinfo(3). Do not use directly: call Lookup/LookupHost/LookupNumeric/LookupSubNet. |
|
Write a 16‐bit integer to a byte buffer in big‐endian order. |
|
Write a 32‐bit integer to a byte buffer in big‐endian order. |
|
Write a 64‐bit integer to a byte buffer in big‐endian order. |
|
Write contents of std::string to a file. |
|
|
|
Write HD keypaths as strings. |
|
Write a 16‐bit integer to a byte buffer in little‐endian order. |
|
Write a 32‐bit integer to a byte buffer in little‐endian order. |
|
Write a 64‐bit integer to a byte buffer in little‐endian order. |
|
|
|
Translation marker macro helper: return the literal unchanged at compile time. |
|
|
Internal helper. The noreturn enables optimizers to discard invalid paths. |
Converts a 16‐bit value from big‐endian byte order to host byte order. |
|
Converts a 32‐bit value from big‐endian byte order to host byte order. |
|
Converts a 64‐bit value from big‐endian byte order to host byte order. |
|
Block description to JSON |
|
Block header to JSON |
|
Perform context‐free validation checks on a btck_Block. |
|
Copy a block. Blocks are reference counted, so this just increments the reference count. |
|
Count the number of transactions contained in a block. |
|
Parse a serialized raw block into a new block object. |
|
Destroy the block. |
|
Calculate and return the hash of a block. |
|
Get the btck_BlockHeader from the block. |
|
Get the transaction at the provided index. The returned transaction is not owned and depends on the lifetime of the block. |
|
Copy a block hash. |
|
Create a block hash from its raw data. |
|
Destroy the block hash. |
|
Check if two block hashes are equal. |
|
Serializes the block hash to bytes. |
|
Copy a btck_BlockHeader. |
|
Create a btck_BlockHeader from serialized data. |
|
Destroy the btck_BlockHeader. |
|
Get the nBits difficulty target from btck_BlockHeader. |
|
Get the btck_BlockHash. |
|
Get the nonce from btck_BlockHeader. |
|
Get the previous btck_BlockHash from btck_BlockHeader. The returned hash is unowned and only valid for the lifetime of the btck_BlockHeader. |
|
Get the timestamp from btck_BlockHeader. |
|
Get the version from btck_BlockHeader. |
|
Serializes the btck_BlockHeader to bytes. This is consensus serialization that is also used for the P2P network. |
|
Reads the block the passed in block tree entry points to from disk and returns it. |
|
Copy a block's spent outputs. |
|
Returns the number of transaction spent outputs whose data is contained in block spent outputs. |
|
Destroy the block spent outputs. |
|
Returns a transaction spent outputs contained in the block spent outputs at a certain index. The returned pointer is unowned and only valid for the lifetime of block_spent_outputs. |
|
Reads the block spent coins data the passed in block tree entry points to from disk and returns it. |
|
Serializes the block through the passed in callback to bytes. This is consensus serialization that is also used for the P2P network. |
|
Check if two block tree entries are equal. Two block tree entries are equal when they point to the same block. |
|
Return the ancestor of a btck_BlockTreeEntry at the given height. |
|
Return the block hash associated with a block tree entry. |
|
Return the btck_BlockHeader associated with this entry. |
|
Return the height of a certain block tree entry. |
|
Returns the previous block tree entry in the tree, or null if the current block tree entry is the genesis block. |
|
Copies the btck_BlockValidationState. |
|
Create a new btck_BlockValidationState. |
|
Destroy the btck_BlockValidationState. |
|
Returns the validation result from an opaque btck_BlockValidationState pointer. |
|
Returns the validation mode from an opaque btck_BlockValidationState pointer. |
|
Return true if the passed in chain contains the block tree entry. |
|
Retrieve a block tree entry by its height in the currently active chain. Once retrieved there is no guarantee that it remains in the active chain. |
|
Return the height of the tip of the chain. |
|
Copy the chain parameters. |
|
Creates a chain parameters struct with default parameters based on the passed in chain type. |
|
Create a signet chain parameters struct with a user‐provided challenge. |
|
Destroy the chain parameters. |
|
Get btck_ConsensusParams from btck_ChainParameters. The returned btck_ConsensusParams pointer is valid only for the lifetime of the btck_ChainParameters object and must not be destroyed by the caller. |
|
Create a chainstate manager. This is the main object for many validation tasks as well as for retrieving data from the chain and interacting with its chainstate and indexes. |
|
Destroy the chainstate manager. |
|
Returns the best known currently active chain. Its lifetime is dependent on the chainstate manager. It can be thought of as a view on a vector of block tree entries that form the best chain. The returned chain reference always points to the currently active best chain. However, state transitions within the chainstate manager (e.g., processing blocks) will update the chain's contents. Data retrieved from this chain is only consistent up to the point when new data is processed in the chainstate manager. It is the user's responsibility to guard against these inconsistencies. |
|
Get the btck_BlockTreeEntry whose associated btck_BlockHeader has the most known cumulative proof of work. |
|
Retrieve a block tree entry by its block hash. |
|
Triggers the start of a reindex if the wipe options were previously set for the chainstate manager. Can also import an array of existing block files selected by the user. |
|
Create options for the chainstate manager. |
|
Destroy the chainstate manager options. |
|
Set the total database cache used by the chainstate manager. |
|
Sets wipe db in the options. In combination with calling |
|
Set the number of available worker threads used during validation. |
|
|
Sets block tree db in memory in the options. |
|
Sets chainstate db in memory in the options. |
Process and validate the passed in block with the chainstate manager. Processing first does checks on the block, and if these passed, saves it to disk. It then validates the block against the utxo set. If it is valid, the chain is extended with it. The return value is not indicative of the block's validity. Detailed information on the validity of the block can be retrieved by registering the |
|
Processes and validates the provided btck_BlockHeader. |
|
Returns the block height where the transaction that created this coin was included in. |
|
Copy a coin. |
|
Destroy the coin. |
|
Return the transaction output of a coin. The returned pointer is unowned and only valid for the lifetime of the coin. |
|
Returns whether the containing transaction was a coinbase. |
|
Copy the context. |
|
Create a new kernel context. If the options have not been previously set, their corresponding fields will be initialized to default values; the context will assume mainnet chain parameters and won't attempt to call the kernel notification callbacks. |
|
Destroy the context. |
|
Interrupt can be used to halt long‐running validation functions like when reindexing, importing or processing blocks. |
|
Creates an empty context options. |
|
Destroy the context options. |
|
Sets the chain params for the context options. The context created with the options will be configured for these chain parameters. |
|
Set the kernel notifications for the context options. The context created with the options will be configured with these notifications. |
|
Set the validation interface callbacks for the context options. The context created with the options will be configured for these validation interface callbacks. The callbacks will then be triggered from validation events issued by the chainstate manager created from the same context. |
|
Start logging messages through the provided callback. Log messages produced before this function is first called are buffered and on calling this function are logged immediately. |
|
Stop logging and destroy the logging connection. |
|
This disables the global internal logger. No log messages will be buffered internally anymore once this is called and the buffer is cleared. This function should only be called once and is not thread or re‐entry safe. Log messages will be buffered until this function is called, or a logging connection is created. This must not be called while a logging connection already exists. |
|
Disable a specific log category for the global internal logger. This changes a global setting and will override settings for all existing |
|
Enable a specific log category for the global internal logger. This changes a global setting and will override settings for all existing |
|
Set the log level of the global internal logger. This does not enable the selected categories. Use |
|
Set some options for the global internal logger. This changes global settings and will override settings for all existing |
|
Copy precomputed transaction data. |
|
Create precomputed transaction data for script verification. |
|
Destroy the precomputed transaction data. |
|
Copy a script pubkey. |
|
Create a script pubkey from serialized data. |
|
Destroy the script pubkey. |
|
Serializes the script pubkey through the passed in callback to bytes. |
|
Verify if the input at input_index of tx_to spends the script pubkey under the constraints specified by flags. If the |
|
Override the current time with a fixed timestamp for testing. |
|
Run context‐free consensus validation on a btck_Transaction. |
|
Copy a transaction. Transactions are reference counted, so this just increments the reference count. |
|
Get the number of inputs of a transaction. |
|
Get the number of outputs of a transaction. |
|
Create a new transaction from the serialized data. |
|
Destroy the transaction. |
|
Get the transaction input at the provided index. The returned transaction input is not owned and depends on the lifetime of the transaction. |
|
Get a transaction's nLockTime value. |
|
Get the transaction outputs at the provided index. The returned transaction output is not owned and depends on the lifetime of the transaction. |
|
Get the txid of a transaction. The returned txid is not owned and depends on the lifetime of the transaction. |
|
Copy a transaction input. |
|
Destroy the transaction input. |
|
Get the transaction out point. The returned transaction out point is not owned and depends on the lifetime of the transaction. |
|
Serialize the script sig of a transaction input through the passed in callback. |
|
Get a transaction input's nSequence value. |
|
Get the witness stack of a transaction input. The returned witness stack is not owned and depends on the lifetime of the transaction input. |
|
Copy a transaction out point. |
|
Destroy the transaction out point. |
|
Get the output position from the transaction out point. |
|
Get the txid from the transaction out point. The returned txid is not owned and depends on the lifetime of the transaction out point. |
|
Copy a transaction output. |
|
Create a transaction output from a script pubkey and an amount. |
|
Destroy the transaction output. |
|
Get the amount in the output. |
|
Get the script pubkey of the output. The returned script pubkey is not owned and depends on the lifetime of the transaction output. |
|
Copy a transaction's spent outputs. |
|
Returns the number of previous transaction outputs contained in the transaction spent outputs data. |
|
Destroy the transaction spent outputs. |
|
Returns a coin contained in the transaction spent outputs at a certain index. The returned pointer is unowned and only valid for the lifetime of transaction_spent_outputs. |
|
Serializes the transaction through the passed in callback to bytes. This is consensus serialization that is also used for the P2P network. |
|
Create a new btck_TxValidationState. |
|
Destroy the btck_TxValidationState. |
|
Returns the validation result from an opaque btck_TxValidationState pointer. |
|
Returns the validation mode from an opaque btck_TxValidationState pointer. |
|
Copy a txid. |
|
Destroy the txid. |
|
Check if two txids are equal. |
|
Serializes the txid to bytes. |
|
Copy a witness stack. |
|
Return the number of items in a witness stack. |
|
Destroy the witness stack. |
|
Serialize a witness stack item at a given index through the passed in callback. |
|
Return the whole‐microsecond count of a microseconds duration. |
|
Return the whole‐millisecond count of a milliseconds duration. |
|
Return the whole‐second count of a seconds duration. |
|
Converts a 16‐bit value from host byte order to big‐endian byte order. |
|
Converts a 32‐bit value from host byte order to big‐endian byte order. |
|
Converts a 64‐bit value from host byte order to big‐endian byte order. |
|
Converts a 16‐bit value from host byte order to little‐endian byte order. |
|
Converts a 32‐bit value from host byte order to little‐endian byte order. |
|
Converts a 64‐bit value from host byte order to little‐endian byte order. |
|
Helper for Assert()/Assume(). |
|
Helper for CHECK_NONFATAL(). |
|
Reverses the byte order of a 16‐bit value. |
|
Reverses the byte order of a 32‐bit value. |
|
Reverses the byte order of a 64‐bit value. |
|
Converts a 16‐bit value from little‐endian byte order to host byte order. |
|
Converts a 32‐bit value from little‐endian byte order to host byte order. |
|
Converts a 64‐bit value from little‐endian byte order to host byte order. |
|
Constructs an object of type T in secure memory and returns owning pointer. |
|
Secure overwrite a buffer (possibly containing secret data) with zero‐bytes. The write operation will not be optimized out by the compiler. |
|
Non‐GUI handler, which only logs a message. |
|
Non‐GUI handler, which logs and prints messages. |
|
Non‐GUI handler, which logs and prints questions. |
|
Connect all bitcoind signal handlers |
|
Reconnects the regular Non‐GUI handlers after having used noui_test_redirect |
|
Redirect all bitcoind signal handlers to LogInfo. Used to check or suppress output during test runs that produce expected errors |
|
Conversion of GiB to bytes. |
|
Conversion of MiB to bytes. |
|
Bitwise conjunction operators |
|
Multiplication operators |
|
Addition operators |
|
Subtraction operators |
|
Returns the quotient of two big integers. |
|
Returns the value shifted right by a number of bits. |
|
Returns the bitwise XOR of two big integers. |
|
Bitwise disjunction operators |
|
Bitwise complement of a single flag name. |
|
Read a 16‐bit little‐endian integer from a stream and convert it to host byte order. |
|
Read a 32‐bit little‐endian integer from a stream and convert it to host byte order. |
|
Read a 32‐bit big‐endian integer from a stream and convert it to host byte order. |
|
Read a 64‐bit little‐endian integer from a stream and convert it to host byte order. |
|
Read a byte from a stream. |
|
Write a 16‐bit integer to a stream in little‐endian byte order. |
|
Write a 32‐bit integer to a stream in little‐endian byte order. |
|
Write a 32‐bit integer to a stream in big‐endian byte order. |
|
Write a 64‐bit integer to a stream in little‐endian byte order. |
|
Write a byte to a stream. |
|
Convert service flags (a bitmask of NODE_*) to human readable strings. It supports unknown service flags which will be returned as "UNKNOWN[...]". |
|
|
|
Log a ZMQ error together with the underlying libzmq error message. |
|
Returns the value shifted left by a number of bits. |
|
Equality operators |
|
Less‐than operators |
|
Check whether the first feerate is lower than or equal to the second. |
|
Greater‐than operators |
|
Check whether the first feerate is higher than or equal to the second. |
|
Three‐way comparison operators |
Variables
Name |
Description |
How much linearization cost required for TxGraph clusters to have "acceptable" quality, if they cannot be optimally linearized with less cost. |
|
How old addresses can maximally be |
|
How many successive failures are allowed ... |
|
... in at least this duration |
|
Maximum number of times an address can occur in the new table |
|
Over how many buckets entries with new addresses originating from a single group are spread |
|
How recent a successful connection should be before we allow an address to be evicted from tried |
|
After how many failed attempts we give up on a new node |
|
The maximum number of tried addr collisions to store |
|
The maximum time we'll spend trying to resolve a tried table collision |
|
Over how many buckets entries with tried addresses from a single group (/16 for IPv4) are spread |
|
Size of CJDNS address (in bytes). |
|
Size of I2P address (in bytes). |
|
Size of "internal" (NET_INTERNAL) address (in bytes). |
|
Size of IPv4 address (in bytes). |
|
Size of IPv6 address (in bytes). |
|
Prefix for unix domain socket addresses (which are local filesystem paths) |
|
Prefix for unix domain socket addresses (which are local filesystem paths) |
|
Size of TORv3 address (in bytes). This is the length of just the address as used in BIP155, without the checksum and the version byte. |
|
Size of an AES‐256 key, in bytes. |
|
Size of an AES block, in bytes. |
|
All fee estimate horizons, in increasing order of half‐life. |
|
All known message types (see above). Keep this in the same order as the list of messages above. |
|
Always‐false variable template used to make static_assert dependent on a type. |
|
Witness program for Pay‐to‐Anchor output script type |
|
Tag for the input annex. |
|
Interval for ASMap Health Check * |
|
Inverse false positive rate M for the basic block filter type. |
|
Golomb‐Rice coding parameter P for the basic block filter type. |
|
BIP 0031, pong message, is enabled for all versions AFTER this one |
|
Protocol version at which BIP324 short message IDs are implemented. |
|
Size in bytes of a BIP32 extended key serialization without the version prefix. |
|
Size in bytes of a BIP32 extended key serialization including the version prefix. |
|
Default file name of the read‐only configuration file. |
|
Default file name of the read‐write settings file. |
|
Maximum age of a cached fee rate estimate before it is considered stale. |
|
Interval between compact filter checkpoints. See BIP 157. |
|
Documentation for argument 'checklevel'. |
|
All CJDNS addresses start with 0xFC. See https://github.com/cjdelisle/cjdns/blob/master/doc/Whitepaper.md#pulling‐it‐all‐together |
|
Numeric client version encoded as 10000_major + 100_minor + build. |
|
The compactblocks version we support. See BIP 152. |
|
The amount of satoshis in one BTC. |
|
Coinbase transaction outputs can only be spent after this number of new blocks (network rule) |
|
One indivisible minimum value unit ("sat"). |
|
One formatted currency unit ("BTC"). |
|
Defaults to |
|
Socket factory. Defaults to |
|
Reserved non‐dbcache memory usage. |
|
Maximum size of a single LevelDB SST file. |
|
Preallocated buffer size, in bytes, for serialized keys. |
|
Preallocated buffer size, in bytes, for serialized values. |
|
Default for ‐datacarrier |
|
Default for ‐acceptnonstdtxn |
|
Whether we allow importing a fee_estimates file older than MAX_FILE_AGE. |
|
Default for ‐checkaddrman |
|
Default for ‐limitancestorcount, max number of in‐mempool ancestors |
|
Default value for the ‐blockfilterindex option (no filter index enabled). |
|
Default for blocks only |
|
Default for ‐maxmempool when blocksonly is set |
|
Default for ‐blockmaxweight, which controls the range of block weights the mining code will create * |
|
Default for ‐blockmintxfee, which sets the minimum feerate for a transaction in blocks created by mining code * |
|
Default number of non‐mempool transactions to keep around for block reconstruction. Includes orphan, replaced, and rejected transactions. |
|
Default for ‐blockreservedweight * |
|
Default for ‐bytespersigop |
|
Default number of blocks to verify at startup (the ‐checkblocks setting). |
|
Default depth of block‐verification checks performed at startup (the ‐checklevel setting). |
|
Maximum number of transactions per cluster (default) |
|
Maximum size of cluster in virtual kilobytes |
|
Default sigops cost to reserve for coinbase transaction outputs when creating block templates. |
|
Default value for the ‐coinstatsindex option (index disabled). |
|
‐timeout default |
|
Default value for ‐daemon option |
|
Default value for ‐daemonwait option |
|
Default LevelDB write batch size |
|
Default file name for the debug log. |
|
Default for ‐limitdescendantcount, max number of in‐mempool descendants |
|
Default for ‐dnsseed: whether to query the DNS seeds when short on peers. |
|
Default for ‐fixedseeds: whether to fall back to the hardcoded seed addresses. |
|
Default for ‐forcednsseed: whether to always query the DNS seeds. |
|
Default percentage of inbound connection slots that tx‐relaying peers can use |
|
The default value for |
|
The default value for |
|
The default value for |
|
Default for ‐incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or replacement * |
|
Suggested default amount of cache reserved for the kernel (bytes) |
|
‐listen default |
|
Whether to listen for incoming connections on a Tor onion service by default. |
|
Default for |
|
Default for |
|
Default for |
|
Default for |
|
Default for |
|
Default for |
|
Default for ‐maxreceivebuffer, in kilobytes. |
|
Default for ‐maxsendbuffer, in kilobytes. |
|
Maximum number of connected HTTP clients |
|
Default for ‐maxmempool, maximum megabytes of mempool memory usage |
|
The maximum number of peer connections to maintain. |
|
Default maximum tip age before the node is considered out of initial block download. |
|
Default max iterations to try in RPC generatetodescriptor, generatetoaddress, and generateblock. |
|
The default for ‐maxuploadtarget. 0 = Unlimited |
|
Default for ‐mempoolexpiry, expiration time for mempool transactions in hours |
|
Default for ‐minrelaytxfee, minimum relay fee for transactions |
|
Default ban duration for a misbehaving peer, in seconds (24 hours). |
|
‐dns default |
|
Default value for the ‐natpmp option controlling automatic port mapping. |
|
Whether to serve BIP 157 compact block filters to peers by default. |
|
Whether to serve BIP 37 bloom filters to peers by default. |
|
‐peertimeout default |
|
Default for ‐permitbaremultisig |
|
Whether to fall back to legacy V1 serialization when writing mempool.dat |
|
Default number of worker threads used to prefetch block input prevouts. |
|
Default for ‐privatebroadcast. |
|
Whether RPC help documentation is verified at runtime by default. |
|
‐par default (number of script‐checking threads, 0 = auto) |
|
Default size in bytes of the script‐execution result cache. |
|
Default size in bytes of the ECDSA/Schnorr signature cache. |
|
Default host:port address of the Tor control socket. |
|
Default port on which Tor listens for control connections. |
|
Default port on which Tor listens for SOCKS connections. |
|
Default value for the ‐txindex option (index disabled). |
|
Default value for the ‐txospenderindex option (index disabled). |
|
Whether transaction reconciliation protocol should be enabled by default. |
|
Default maximum per‐second rate for sending transaction inventory to peers. |
|
Default for ‐v2transport: whether to enable BIP324 v2 transport. |
|
Default combined size of the signature and script‐execution validation caches. |
|
Default for ‐whitelistforcerelay. |
|
Default for ‐whitelistrelay. |
|
A signature checker that accepts all signatures |
|
A signature creator that just produces 72‐byte empty signatures. |
|
A signature creator that just produces 71‐byte empty signatures. |
|
A shared signing provider used where no real keys are available. |
|
How often to dump banned addresses/subnets to disk. |
|
Min feerate for defining dust. Changing the dust limit changes which transactions are standard and should be done with care and ideally rarely. It makes sense to only increase the dust limit after prior releases were already not creating outputs below the new threshold |
|
Size of ECDH shared secrets. |
|
Example bech32 addresses for the RPCExamples help documentation. They are intentionally invalid to prevent accidental transactions by users. |
|
Run the extra block‐relay‐only connection loop once every 5 minutes. * |
|
An extra transaction can be added to a package, as long as it only has one ancestor and is no larger than this. Not really any reason to make this configurable as it doesn't materially change DoS parameters. |
|
"feature" message type for feature negotiation starts with this version |
|
"feefilter" tells peers to filter invs to you by fee starts with this version |
|
Run the feeler connection loop once every 2 minutes. * |
|
How often recorded fee estimate data is flushed to disk. |
|
Human‐readable names for the FlushStateMode values, indexed by enum value. |
|
True when a failed Assume() should abort rather than continue. |
|
True when the binary is compiled in fuzzing mode. |
|
Global translation function, set by the GUI and null when no translation is available. |
|
Hasher with tag "TapBranch" pre‐fed to it. |
|
Hasher with tag "TapLeaf" pre‐fed to it. |
|
Hasher with tag "TapSighash" pre‐fed to it. |
|
SAM 3.1 and earlier do not support specifying ports and force the port to 0. |
|
initial proto version, to be increased after version/verack negotiation |
|
Prefix of an IPv6 address when it contains an embedded "internal" address. Used when (un)serializing addresses in ADDRv1 format (pre‐BIP155). The prefix comes from 0xFD + SHA256("bitcoin")[0:5]. Such dummy IPv6 addresses are guaranteed to not be publicly routable as they fall under RFC4193's fc00::/7 subnet allocated to unique‐local addresses. |
|
not banning for invalid compact blocks starts with this version |
|
Prefix of an IPv6 address when it contains an embedded IPv4 address. Used when (un)serializing addresses in ADDRv1 format (pre‐BIP155). |
|
Maximum nLockTime. |
|
Threshold for nLockTime. |
|
Flags for nSequence and nLockTime locks |
|
Mandatory script verification flags that all new transactions must comply with for them to be valid. |
|
Maximum number of addnode outgoing nodes |
|
Highest input sequence number that still signals opt‐in replace‐by‐fee under BIP 125 (SEQUENCE_FINAL ‐ 2). |
|
Max memory allocated to block tree DB specific cache (bytes) |
|
Maximum number of block‐relay‐only outgoing connections |
|
The maximum allowed size for a serialized block, in bytes (only for buffer size limits) |
|
The maximum allowed number of signature check operations in a block (network rule) |
|
The maximum allowed weight for a block, see BIP 141 (network rule) |
|
20,000 items with fp rate < 0.1% or 10,000 items and <0.0001% |
|
Hard upper bound on the per‐cluster transaction count limit a TxGraph may be configured with. |
|
Maximum number of outstanding CMPCTBLOCK requests for the same block. |
|
Max memory allocated to coin DB specific cache (bytes) |
|
Maximum total database cache on current architecture (bytes) |
|
Maximum bytes for transactions to store for processing during reorg |
|
Maximum number of ephemeral dust outputs allowed. |
|
Maximum length in bytes of the data payload for a single feature. |
|
Maximum length in bytes of a feature identifier in a feature message. |
|
Maximum number of feeler connections |
|
Block policy estimate files that are more than 60 hours (2.5 days) old will not be read, as fee estimates are based on historical data and may be inaccurate if network activity has changed. |
|
Maximum accepted PSBT file size, capped to bound memory use while reading. |
|
Maximum amount of time that a block timestamp is allowed to exceed the current time before the block will be accepted. |
|
Maximum number of hash functions a bloom filter may use. |
|
Number of headers sent in one getheaders result. We rely on the assumption that if a peer sends less than this number, we reached its tip. Changing this value is a protocol upgrade. |
|
No amount larger than this (in satoshi) is valid. |
|
Maximum value that an opcode can take. |
|
Maximum number of non‐push operations per script. |
|
Default setting for ‐datacarriersize in vbytes. |
|
Maximum number of automatic outgoing nodes over which we'll relay everything (blocks, tx, addrs, etc) |
|
Maximum number of signature check operations in an IsStandard() P2SH script |
|
Default maximum number of transactions in a package. |
|
Default maximum total weight of transactions in a package in weight to allow for context‐less checks. This must allow a superset of sigops weighted vsize limited transactions to not disallow transactions we would have otherwise accepted individually. |
|
Maximum number of dedicated threads allowed for prefetching block input prevouts |
|
Maximum number of private broadcast connections |
|
Maximum length of incoming protocol messages (no message over 4 MB is currently acceptable). |
|
Maximum number of public keys per multisig. |
|
The limit of keys in OP_CHECKSIGADD‐based scripts. It is due to the stack limit in BIP342. |
|
Maximum number of unique clusters that can be affected by an RBF (Rule #5); see GetEntriesForConflicts() |
|
Maximum number of dedicated script‐checking threads allowed |
|
Maximum number of bytes pushable to the stack. |
|
Maximum script length in bytes. |
|
Bit mask with every defined verification flag set. |
|
Number of defined verification flag bits, equal to the value of SCRIPT_VERIFY_END_MARKER. |
|
The maximum size of a serialized object in bytes or number of elements (for eg vectors) when the size is encoded as CompactSize. |
|
Maximum number of values on the script interpreter stack. |
|
The maximum size in bytes of a standard witnessScript |
|
The maximum number of witness stack items in a standard P2WSH script |
|
The maximum size in bytes of each witness stack item in a standard P2WSH script |
|
The maximum size of a standard ScriptSig |
|
The maximum size in bytes of each witness stack item in a standard BIP 342 script (Taproot, leaf version 0xc0) |
|
The maximum number of sigops we're willing to relay/mine in a single tx |
|
The maximum weight for transactions we're willing to relay/mine |
|
Maximum length of the user agent string in |
|
Maximum number of seconds that the timestamp of the first block of a difficulty adjustment period is allowed to be earlier than the last block of the previous period (BIP94). |
|
The maximum number of potentially executed legacy signature operations in a single standard tx |
|
Maximum amount of memory (in bytes) to allocate at once when deserializing vectors. |
|
Maximum time to wait for I/O readiness. It will take up until this time to break off in case of an interruption. |
|
Maximum confirmation target, in blocks, for which the mempool estimator is reliable. |
|
Number of recent mined blocks inspected when assessing mempool health. |
|
Fake height value used in Coin to signify they are only in the memory pool (since 0.8) |
|
Minimum fraction of block weight that must come from the mempool for it to be well represented. |
|
Magic string prefixed to a message before hashing, to domain‐separate it from transactions. |
|
This accounts for the block header, var_int encoding of the transaction count and a minimally viable coinbase transaction. It adds an additional safety margin, because even with a thorough understanding of block serialization, it's easy to make a costly mistake when trying to squeeze every last byte. Setting a lower value is prevented at startup. |
|
Minimum size of a witness commitment structure. Defined in BIP 141. * |
|
Block files containing a block‐height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pruned. |
|
Minimum total database cache (bytes) |
|
Minimum free disk space, in bytes, that a user must allocate for block and undo files. |
|
disconnect from peers older than this proto version |
|
Minimum weight of any serializable CTransaction (10 bytes is the lower bound for its serialized size). |
|
The minimum non‐witness size for transactions we're willing to relay/mine: one larger than 64 |
|
Minimum weight of a valid serialized CTransaction (60 bytes is the lower bound for its serialized size). |
|
Mask covering the bits used to encode a getdata/inv message type. |
|
getdata message type flags |
|
Size in bytes of a serialized MuSig2 public nonce. |
|
Bucket name used to aggregate byte counts for message types not tracked individually. |
|
Human‐readable descriptions of the available net permission flags, for help output. |
|
Index marker for when no witness commitment is present in a coinbase transaction. |
|
Number of file descriptors required for message capture * |
|
Number of weight percentiles reported by the getblockstats RPC. |
|
The output types that can be produced, excluding UNKNOWN. |
|
Mapping nonce size in bytes (see RFC6887 section 11.1). |
|
How much work we ask TxGraph to do after a mempool change occurs (either due to a changeset being applied, a new block being found, or a reorg). |
|
network protocol versioning |
|
Global map key type for the fallback locktime. |
|
Global map key type for the input count. |
|
Global map key type for the output count. |
|
Global map key type for proprietary use. |
|
Global map key type for the transaction‐modifiable flags. |
|
Global map key type for the transaction version. |
|
Global map key type for the unsigned transaction. |
|
Global map key type for the PSBT version number. |
|
Global map key type for an extended public key. |
|
Highest PSBT version this implementation supports. |
|
Input map key type for a BIP32 derivation path. |
|
Input map key type for a HASH160 preimage. |
|
Input map key type for a HASH256 preimage. |
|
Input map key type for a MuSig2 partial signature. |
|
Input map key type for the MuSig2 participant public keys. |
|
Input map key type for a MuSig2 public nonce. |
|
Input map key type for the non‐witness UTXO. |
|
Input map key type for the previous output index. |
|
Input map key type for a partial signature. |
|
Input map key type for the previous transaction id. |
|
Input map key type for proprietary use. |
|
Input map key type for the redeem script. |
|
Input map key type for the required height‐based locktime. |
|
Input map key type for the required time‐based locktime. |
|
Input map key type for a RIPEMD160 preimage. |
|
Input map key type for the finalized scriptSig. |
|
Input map key type for the finalized script witness. |
|
Input map key type for the input sequence number. |
|
Input map key type for a SHA256 preimage. |
|
Input map key type for the sighash type. |
|
Input map key type for a taproot BIP32 derivation path. |
|
Input map key type for the taproot internal key. |
|
Input map key type for a taproot key‐path signature. |
|
Input map key type for a taproot leaf script. |
|
Input map key type for the taproot merkle root. |
|
Input map key type for a taproot script‐path signature. |
|
Input map key type for the witness script. |
|
Input map key type for the witness UTXO. |
|
Magic bytes that prefix every serialized PSBT. |
|
Output map key type for the output amount. |
|
Output map key type for a BIP32 derivation path. |
|
Output map key type for the MuSig2 participant public keys. |
|
Output map key type for proprietary use. |
|
Output map key type for the redeem script. |
|
Output map key type for the output script. |
|
Output map key type for a taproot BIP32 derivation path. |
|
Output map key type for the taproot internal key. |
|
Output map key type for the taproot tree. |
|
Output map key type for the witness script. |
|
Map separator byte, read as a zero‐length key that carries no value. |
|
Script verification flags. |
|
"sendheaders" message type and announcing blocks with headers starts with this version |
|
Init values for CBlockIndex nSequenceId when loaded from disk |
|
Init value for CBlockIndex nSequenceId for a block loaded from disk that is not on the best chain. |
|
short‐id‐based block download starts with this version |
|
Magic bytes marking the start of a serialized UTXO set snapshot. |
|
Used as the flags parameter to sequence and nLocktime checks in non‐consensus code. |
|
For convenience, standard but not mandatory verify flags. |
|
Standard script verification flags that standard transactions will comply with. However we do not ban/disconnect nodes that forward txs violating the additional (non‐mandatory) rules here, to improve forwards and backwards compatibility. |
|
Fixed prefix size of a Taproot control block (leaf byte + internal key). |
|
Maximum number of Merkle branch nodes in a control block. |
|
Maximum total byte size of a Taproot control block. |
|
Byte size of one Merkle branch node in a control block. |
|
Mask isolating the leaf‐version bits of a Taproot control byte. |
|
Leaf version identifying a BIP342 tapscript. |
|
Names of the recognized values for the ‐test command‐line argument. |
|
Time after which to disconnect, after waiting for a ping response (or inactivity). |
|
Timestamp window used as a grace period by code that compares external timestamps (such as timestamps passed to RPCs, or wallet key creation times) to block timestamps. This should be set at least as high as MAX_FUTURE_BLOCK_TIME. |
|
Prefix of an IPv6 address when it contains an embedded TORv2 address. Used when (un)serializing addresses in ADDRv1 format (pre‐BIP155). Such dummy IPv6 addresses are guaranteed to not be publicly routable as they fall under RFC4193's fc00::/7 subnet allocated to unique‐local addresses. |
|
Tor control reply code. Ref: https://spec.torproject.org/control‐spec/replies.html |
|
Syntax error in command argument |
|
Tor control reply code for an unrecognized command. |
|
Maximum number of transactions including a TRUC tx and all its mempool ancestors. |
|
Maximum sigop‐adjusted virtual size of a tx which spends from an unconfirmed TRUC transaction. |
|
Maximum weight of a TRUC child transaction, derived from TRUC_CHILD_MAX_VSIZE. |
|
Maximum number of transactions including an unconfirmed tx and its descendants. |
|
Maximum sigop‐adjusted virtual size of all v3 transactions. |
|
Maximum weight of a TRUC transaction, derived from TRUC_MAX_VSIZE. |
|
Transaction version that marks a transaction as TRUC (BIP 431). |
|
Supported transaction reconciliation protocol version |
|
Highest transaction version accepted by standard relay policy. |
|
Lowest transaction version accepted by standard relay policy. |
|
Serialization parameters that omit transaction witness data. |
|
Serialization parameters that include transaction witness data. |
|
Base user agent name advertised to peers (for example "Satoshi"). |
|
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency. |
|
Weight budget added to the witness size (Tapscript only, see BIP 342). |
|
Validation weight per passing signature (Tapscript only, see BIP 342). |
|
What block version to use for new blocks (pre versionbits) |
|
Total bits available for versionbits (BIP 323) |
|
What bits to set in version for versionbits blocks |
|
What bitmask determines whether versionbits is in use |
|
Lookup table of deployment info, indexed by version‐bits deployment position. |
|
Weight given to non‐witness bytes relative to witness bytes when computing block weight (BIP 141). |
|
Byte length of a witness v0 P2WPKH key hash. |
|
Byte length of a witness v0 P2WSH script hash. |
|
Byte length of a witness v1 Taproot output key. |
|
"wtxidrelay" message type for wtxid‐based relay starts with this version |
|
Mutex to guard access to validation specific variables, such as reading or changing the chainstate. |
|
Tag instance used to select deserializing constructors. |
|
Whether to discover our own local addresses (‐discover). |
|
Whether to accept incoming connections (‐listen). |
|
Whether client IP addresses are included in log output. |
|
Whether DNS name lookups are allowed, set by the |
|
Global argument manager shared across the application. |
|
The global UTXO set hash object. |
|
When true, failed checks throw an exception instead of aborting (test only). |
|
The DNS resolver used by lookup functions; overridable for tests. |
|
Runtime toggle that enables fuzz determinism when it is not fixed at compile time. |
|
Guards access to mapLocalHost. |
|
Global set of networks currently considered reachable. |
|
Interrupt SOCKS5 reads or writes. |
|
The global transaction index, used in GetTransaction. May be null. |
|
The global txo spender index. May be null. |
|
Global wallet initialization interface, either the real wallet or a stub. |
|
The process‐wide ZMQ notification interface, or nullptr when ZMQ is disabled. |
|
Map of our known local addresses to their advertised service info. |
|
Bytes‐per‐sigop ratio used to weight signature operations against transaction size in policy checks. |
|
Connection timeout in milliseconds, set by the |
|
Subversion as sent to the P2P network in |
|
The global RPC command dispatch table. |
|
The process‐wide UI signal interface used to communicate with the front end. |
Concepts
Name |
Description |
Satisfied by types whose pointer can be cast to an unsigned char pointer via UCharCast. |
|
Constrains a type to a single‐byte type usable as a raw buffer element. |
|
Matches char only when it is a distinct type from int8_t, used to forbid serializing char. |
|
Check if type contains a stream by seeing if has a GetStream() method. |
|
A concept for RandomMixin‐based random number generators. |
|
If none of the specialized versions above matched, default to calling member function. |
|
A concept for C++ std::chrono durations. |
|
Satisfied only by the Txid and Wtxid identifier types. |
|
Satisfied by types that provide an Unserialize member function. |
Using Declarations
Macros
Name |
Description |
Identity function. Abort if the value compares equal to zero. |
|
Assume is the identity function. |
|
Identity function. Throw a NonFatalCheckError when the condition evaluates to false |
|
Copyright string used in Windows .rc files |
|
Implement the Ser and Unser methods needed for implementing a formatter (see Using below). |
|
List of possible chain / network names |
|
Defines a range accessor method |
|
NONFATAL_UNREACHABLE() is a macro that is used to mark unreachable code. It throws a NonFatalCheckError. |
|
Implement the Serialize and Unserialize methods by delegating to a single templated static method that takes the to‐be‐(de)serialized object as a parameter. This approach has the advantage that the constness of the object becomes a template parameter, and thus allows a single implementation that sees the object as const for serializing and non‐const for deserializing, without casts. |
|
Formatter methods can retrieve parameters attached to a stream using the SER_PARAMS(type) macro as long as the stream is created directly or indirectly with a parameter of that type. This permits making serialization depend on run‐time context in a type‐safe way. |
|
Helper macro for SerParams structs |
|
Converts the parameter X to a string after macro replacement on X has been performed. Don't merge these into one macro! |
|
Run code while locking a mutex. |
|
enable all optional context‐free block checks |
|
run the base context‐free block checks only |
|
verify merkle root (and mutation detection) |
|
run CheckProofOfWork via CheckBlockHeader |
|
this block was cached as being invalid and we didn't store the reason why |
|
invalid by consensus rules (excluding any below reasons) |
|
the block header may be on a too‐little‐work chain |
|
invalid proof of work or time too old |
|
A block this one builds on is invalid |
|
We don't have the previous block the checked one is built on |
|
the block's data didn't match the data committed to by the PoW |
|
block timestamp was > 2 hours in the future (or our clock is bad) |
|
initial value. Block has not yet been rejected |
|
enable CHECKLOCKTIMEVERIFY (BIP65) |
|
enable CHECKSEQUENCEVERIFY (BIP112) |
|
enforce strict DER (BIP66) compliance |
|
enforce NULLDUMMY (BIP147) |
|
evaluate P2SH (BIP16) subscripts |
|
enable TAPROOT (BIPs 341 & 342) |
|
enable WITNESS (BIP141) |
|
The flags were combined in an invalid way. |
|
The taproot flag was set, so valid spent_outputs have to be provided. |
|
tx already in mempool or conflicts with a tx in the chain |
|
invalid by consensus rules |
|
inputs (covered by txid) failed policy rules |
|
violated mempool's fee/size/descendant/RBF/etc limits |
|
transaction was missing some of its inputs |
|
otherwise didn't meet local policy rules |
|
this node does not have a mempool so can't validate the transaction |
|
transaction spends a coinbase too early, or violates locktime/sequence locks |
|
fails some policy, but might be acceptable if submitted in a (different) package |
|
transaction was not validated because package failed |
|
initial value. Tx has not yet been rejected |
|
witness may have been malleated or is prior to SegWit activation |
|
transaction is missing a witness |
|
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for details) |
BCLog namespace
Bitcoin Core logging facilities: log categories and their bit flags.
Types
Name |
Description |
Fixed window rate limiter for logging. |
|
Central logger that formats entries and writes them to the console, a file and callbacks. |
|
RAII‐style object that outputs timing information to logs. |
Type Aliases
Name |
Description |
Bit mask holding a set of BCLog::LogFlags log categories. |
|
Alias for compatibility. Prefer util::log::Level over BCLog::Level in new code. |
Enums
Name |
Description |
Debug logging categories, each a distinct bit in a CategoryMask. |
Variables
Name |
Description |
Default for whether log rate limiting is enabled. |
|
Default global log severity level. |
|
buffer up to 1MB of log data prior to StartLogging |
|
maximum number of bytes per source location that can be logged within the rate‐limit window |
|
time window after which log ratelimit stats are reset |
Consensus namespace
Transaction validation functions
Types
Name |
Description |
Struct for each individual consensus rule change using BIP9. |
|
Parameters that influence chain consensus. |
Enums
Name |
Description |
A buried deployment is one where the height of the activation has been hardcoded into the client implementation long after the consensus change has activated. See BIP 90. Consensus changes for which the new rules are enforced from genesis are not listed here. |
|
Identifiers for BIP9 version‐bits deployments. |
Functions
Name |
Description |
Check whether all inputs of this transaction are valid (no double spends and amounts) This does not modify the UTXO set. This does not check scripts and sigs. |
|
|
CuckooCache namespace
High‐performance cache primitives.
Types
Name |
Description |
|
|
|
NetMsg namespace
Helpers for constructing serialized network messages.
Functions
Name |
Description |
Build a serialized network message of the given type from its payload. |
NetMsgFeature namespace
Identifiers for individual peer‐negotiated features (BIP 434).
NetMsgType namespace
Bitcoin protocol message types. When adding new message types, don't forget to update ALL_NET_MESSAGE_TYPES below.
Variables
Name |
Description |
The addr (IP address) message relays connection information for peers on the network. |
|
The addrv2 message relays connection information for peers on the network just like the addr message, but is extended to allow gossiping of longer node addresses (see BIP155). |
|
The block message transmits a single serialized block. |
|
Contains a BlockTransactions. Sent in response to a "getblocktxn" message. |
|
cfcheckpt is a response to a getcfcheckpt request containing a vector of evenly spaced filter headers for blocks on the requested chain. |
|
cfheaders is a response to a getcfheaders request containing a filter header and a vector of filter hashes for each subsequent block in the requested range. |
|
cfilter is a response to a getcfilters request containing a single compact filter. |
|
Contains a CBlockHeaderAndShortTxIDs object ‐ providing a header and list of "short txids". |
|
BIP 434 Peer feature negotiation |
|
The feefilter message tells the receiving peer not to inv us any txs which do not meet the specified min fee rate. |
|
The filteradd message tells the receiving peer to add a single element to a previously‐set bloom filter, such as a new public key. |
|
The filterclear message tells the receiving peer to remove a previously‐set bloom filter. |
|
The filterload message tells the receiving peer to filter all relayed transactions and requested merkle blocks through the provided filter. |
|
The getaddr message requests an addr message from the receiving node, preferably one with lots of IP addresses of other receiving nodes. |
|
The getblocks message requests an inv message that provides block header hashes starting from a particular point in the block chain. |
|
Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message. |
|
getcfcheckpt requests evenly spaced compact filter headers, enabling parallelized download and validation of the headers between them. Only available with service bit NODE_COMPACT_FILTERS as described by BIP 157 & 158. |
|
getcfheaders requests a compact filter header and the filter hashes for a range of blocks, which can then be used to reconstruct the filter headers for those blocks. Only available with service bit NODE_COMPACT_FILTERS as described by BIP 157 & 158. |
|
getcfilters requests compact filters for a range of blocks. Only available with service bit NODE_COMPACT_FILTERS as described by BIP 157 & 158. |
|
The getdata message requests one or more data objects from another node. |
|
The getheaders message requests a headers message that provides block headers starting from a particular point in the block chain. |
|
The headers message sends one or more block headers to a node which previously requested certain headers with a getheaders message. |
|
The inv message (inventory message) transmits one or more inventories of objects known to the transmitting peer. |
|
The mempool message requests the TXIDs of transactions that the receiving node has verified as valid but which have not yet appeared in a block. |
|
The merkleblock message is a reply to a getdata message which requested a block using the inventory type MSG_MERKLEBLOCK. |
|
The notfound message is a reply to a getdata message which requested an object the receiving node does not have available for relay. |
|
The ping message is sent periodically to help confirm that the receiving peer is still connected. |
|
The pong message replies to a ping message, proving to the pinging node that the ponging node is still alive. |
|
The sendaddrv2 message signals support for receiving ADDRV2 messages (BIP155). It also implies that its sender can encode as ADDRV2 and would send ADDRV2 instead of ADDR to a peer that has signaled ADDRV2 support by sending SENDADDRV2. |
|
Contains a 1‐byte bool and 8‐byte LE version number. Indicates that a node is willing to provide blocks via "cmpctblock" messages. May indicate that a node prefers to receive new block announcements via a "cmpctblock" message rather than an "inv", depending on message contents. |
|
Indicates that a node prefers to receive new block announcements via a "headers" message rather than an "inv". |
|
Contains a 4‐byte version number and an 8‐byte salt. The salt is used to compute short txids needed for efficient txreconciliation, as described by BIP 330. |
|
The tx message transmits a single transaction. |
|
The verack message acknowledges a previously‐received version message, informing the connecting node that it can begin to send other messages. |
|
The version message provides information about the transmitting node to the receiving node at the beginning of a connection. |
|
Indicates that a node prefers to relay transactions via wtxid, rather than txid. |
bech32 namespace
Bech32 and Bech32m string encoding used by newer Bitcoin address types.
Types
Name |
Description |
Result of decoding a Bech32(m) string: its encoding, human‐readable part, and payload. |
Enums
Name |
Description |
Character limits for Bech32(m) encoded strings. Character limits are how we provide error location guarantees. These values should never exceed 2ˆ31 ‐ 1 (max value for a 32‐bit int), since there are places where we may need to convert the CharLimit::VALUE to an int. In practice, this should never happen since this CharLimit applies to an address encoding and we would never encode an address with such a massive value |
|
Which Bech32 variant a string uses, or that decoding failed. |
Functions
Name |
Description |
Decode a Bech32 or Bech32m string. |
|
Encode a Bech32 or Bech32m string. If hrp contains uppercase characters, this will cause an assertion error. Encoding must be one of BECH32 or BECH32M. |
|
Return the positions of errors in a Bech32 string. |
Variables
Name |
Description |
Number of trailing checksum characters in a Bech32(m) string. |
|
Character separating the human‐readable part from the data section. |
bitcoin_http namespace
Constants and error types for the built‐in HTTP server's request parsing.
Types
Name |
Description |
Thrown when a request body exceeds MAX_BODY_SIZE (or will exceed, in chunked transfer) so the server can reply with more specific code 413 (content too large) vs general 400 (bad request) |
Variables
Name |
Description |
Maximum size of an HTTP request body |
|
Maximum size of each headers line in an HTTP request, also the maximum size of all headers total. See https://github.com/bitcoin/bitcoin/pull/6859 And libevent http.c evhttp_parse_headers_() |
|
Shortest valid request line, used by libevent in evhttp_parse_request_line() |
bitset_detail namespace
Implementation details backing the BitSet alias.
Types
Name |
Description |
A bitset implementation backed by a single integer of type I. |
|
A bitset implementation backed by N integers of type I. |
Functions
Name |
Description |
Count the number of bits set in an unsigned integer type. |
|
Return an object with the binary AND between respective bits from a and b. |
|
Return an object with the binary AND NOT between respective bits from a and b. |
|
Return an object with the binary XOR between respective bits from a and b. |
|
Return an object with the binary OR between respective bits from a and b. |
|
Swap two bitsets. |
|
Equality operators |
btck namespace
Type‐safe C++ RAII wrapper over the libbitcoinkernel C API.
Types
Name |
Description |
Owning wrapper over a |
|
Owning wrapper over a |
|
CRTP mixin adding block‐hash operations shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
CRTP mixin adding block‐header accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
CRTP mixin adding block‐validation‐state accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
Owning wrapper over |
|
Non‐owning view over a |
|
Owning wrapper over |
|
Owning wrapper over a |
|
CRTP mixin adding coin accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Non‐owning view over |
|
Owning wrapper over a |
|
Owning wrapper over |
|
Owning RAII handle for a copyable C object of type |
|
Random‐access iterator that lazily materializes views of a collection by index. |
|
Base class for receiving kernel notifications; override the handlers you need. |
|
Connects a user log sink of type |
|
Owning wrapper over a |
|
CRTP mixin adding out‐point accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over |
|
Read‐only random‐access view over an indexed C‐handle collection. |
|
Read‐only random‐access view over an indexed C‐handle collection. |
|
Owning wrapper over a |
|
CRTP mixin adding script‐pubkey operations shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
CRTP mixin adding transaction accessors shared by the view and owning types. |
|
Owning wrapper over a |
|
CRTP mixin adding transaction‐input accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
CRTP mixin adding transaction‐output accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
CRTP mixin adding accessors over the coins spent by one transaction. |
|
Non‐owning view over a |
|
Non‐owning view over a |
|
Owning wrapper over a |
|
Owning wrapper over a |
|
CRTP mixin adding transaction‐id operations shared by the view and owning types. |
|
Non‐owning view over a |
|
Owning RAII handle for a non‐copyable C object, backed by std::unique_ptr. |
|
Base class for receiving validation events; override the handlers you need. |
|
Non‐owning view over a const C handle of type |
|
Owning wrapper over a |
|
CRTP mixin adding witness‐stack accessors shared by the view and owning types. |
|
Non‐owning view over a |
|
Trait marking an enum as a bitmask; specialize to |
Enums
Name |
Description |
Selects which block checks to run, mirroring |
|
Reason a block failed validation, mirroring |
|
Bitcoin network the chain parameters describe, mirroring |
|
Logging category, mirroring |
|
Logging verbosity level, mirroring |
|
Script verification flags, mirroring |
|
Status of a script verification call, mirroring |
|
Stage of block synchronization, mirroring |
|
Reason a transaction failed validation, mirroring |
|
Outcome of a validation operation, mirroring |
|
Kernel warning condition, mirroring |
Functions
Name |
Description |
Runs consensus‐level checks on a standalone transaction. |
|
Throws if a freshly returned C handle is null, otherwise passes it through. |
|
Disables all kernel logging. |
|
Disables logging for a category. |
|
Enables logging for a category. |
|
Sets the log level for a single category. |
|
Applies global logging options. |
|
Bitwise AND of two bitmask‐enum values. |
|
Bitwise AND‐assign for a bitmask‐enum value. |
|
Returns an iterator advanced by |
|
Bitwise XOR of two bitmask‐enum values. |
|
Bitwise XOR‐assign for a bitmask‐enum value. |
|
Bitwise OR of two bitmask‐enum values. |
|
Bitwise OR‐assign for a bitmask‐enum value. |
|
Bitwise complement of a bitmask‐enum value. |
|
Overrides the kernel's notion of the current time, for testing. |
|
Serializes a C object into a byte vector using its |
Concepts
Name |
Description |
Satisfied by enums opted into bitmask operators via is_bitmask_enum. |
|
Satisfied when a container exposes a size accessor and an indexed element accessor. |
|
Satisfied by a type exposing |
btcsignals namespace
btcsignals is a simple mechanism for signaling events to multiple subscribers. It is api‐compatible with a minimal subset of boost::signals2.
Types
Name |
Description |
A combiner, which checks if at least one callback returned true. |
|
State object representing the liveness of a registered callback. signal::connect() returns an enabled connection which can be held and disabled in the future. |
|
The default combiner, which only returns void. |
|
RAII‐style connection management that disconnects on destruction. |
|
Functor for calling zero or more connected callbacks. |
cluster_linearize namespace
Algorithms and data structures for ordering (linearizing) clusters of dependent transactions.
Types
Name |
Description |
Data structure that holds a transaction graph's preprocessed data (fee, size, ancestors, descendants). |
|
A default cost model for SFL for SetType=BitSet<64>, based on benchmarks. |
|
A set of transactions together with their aggregate feerate. |
|
Class to represent the internal state of the spanning‐forest linearization (SFL) algorithm. |
Type Aliases
Name |
Description |
Data type to represent transaction indices in DepGraphs and the clusters they represent. |
|
Simple default transaction ordering function for SpanningForestState::GetLinearization() and Linearize(), which just sorts by DepGraphIndex. |
Functions
Name |
Description |
Compute the feerates of the chunks of linearization. Identical to ChunkLinearizationInfo, but only returns the chunk feerates, not the corresponding transaction sets. |
|
Compute the chunks of linearization as SetInfos. |
|
Find or improve a linearization for a cluster. |
|
Improve a given linearization. |
|
Swap two SetInfo objects. |
|
Equality operators |
Concepts
Name |
Description |
Concept for function objects that return std::strong_ordering when invoked with two Args. |
common namespace
Shared types used across the node, wallet, and GUI code.
Types
Name |
Description |
Details about a configuration initialization failure. |
|
Instructions for how a PSBT should be signed or filled with information. |
|
Stored settings. This struct combines settings from the command line, a read‐only configuration file, and a read‐write runtime settings file. |
|
Accessor for list of settings that skips negated values when iterated over. The last boolean |
Type Aliases
Name |
Description |
Callback function to let the user decide whether to abort loading if settings.json file exists and can't be parsed, or to ignore the error and overwrite the file. |
|
Settings value type (string/integer/boolean/null variant). |
Enums
Name |
Description |
Outcome of reading configuration and initializing the data directory. |
|
Error conditions reported while processing a PSBT. |
Functions
Name |
Description |
Build the error message for an invalid amount value. |
|
Build a warning that a configured amount is unusually high. |
|
Parse a fee estimate mode from its string name. |
|
Format a single fee mode and its description. |
|
List the available fee estimate mode names. |
|
Build the detailed help text describing all fee modes. |
|
Map lookup helper. |
|
Get settings value from combined sources: forced settings, command line arguments, runtime read‐write settings, and the read‐only config file. |
|
Get combined setting value similar to GetSetting(), except if setting was specified multiple times, return a list of all the values specified. |
|
Read config files, and create datadir and settings.json if they don't exist. |
|
Return the error message shown when an invalid estimate mode is given. |
|
Build the error message for an invalid port value. |
|
Return true if a setting is set in the default config file section, and not overridden by a higher priority command‐line or network section value. |
|
Return a bilingual message describing a PSBT error. |
|
Read settings file. |
|
Build the error message for a failed address resolution. |
|
Return a human‐readable description of a fee reason. |
|
Return a bilingual message describing a transaction error. |
|
Write settings file. |
dbwrapper_private namespace
These should be considered an implementation detail of the specific database.
Functions
Name |
Description |
Work around circular dependency, as well as for testing in dbwrapper_tests. Database obfuscation should be considered an implementation detail of the specific database. |
detail namespace
Internal helpers for parsing blobs from hex strings.
Functions
Name |
Description |
Writes the hex string (in reverse byte order) into a new uintN_t object and only returns a value iff all of the checks pass: ‐ Input length is uintN_t::size()*2 ‐ All characters are hex |
|
Like FromHex(std::string_view str), but allows an "0x" prefix and pads the input with leading zeroes if it is shorter than the expected length of uintN_t::size()*2. |
fs namespace
Filesystem operations and types
Types
Name |
Description |
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path::string() method, which have unsafe and unpredictable behavior on Windows (see implementation note in PathToString for details) |
fsbridge namespace
Bridge operations to C stdio
Types
Name |
Description |
Advisory lock on a file, released when the object is destroyed. |
Type Aliases
Name |
Description |
Callable type matching fopen, so a custom file opener can be injected. |
Functions
Name |
Description |
Helper function for joining two paths |
|
Open a file, handling path encoding correctly across platforms. |
i2p namespace
Support for connecting to and accepting connections over the I2P network.
Namespaces
Name |
Description |
Types and helpers for talking to an I2P router over the SAM (v3) protocol. |
Types
Name |
Description |
An established connection with another peer. |
Type Aliases
Name |
Description |
Binary data. |
i2p::sam namespace
Types and helpers for talking to an I2P router over the SAM (v3) protocol.
Types
Name |
Description |
I2P SAM session. |
Variables
Name |
Description |
The maximum size of an incoming message from the I2P SAM proxy (in bytes). Used to avoid a runaway proxy from sending us an "unlimited" amount of data without a terminator. The longest known message is ~1400 bytes, so this is high enough not to be triggered during normal operation, yet low enough to avoid a malicious proxy from filling our memory. |
index_util namespace
Shared database key types for blockfilterindex and coinstatsindex.
Types
Name |
Description |
Database key for an index entry looked up by block hash. |
|
Database key for an index entry looked up by block height. |
Functions
Name |
Description |
Copy an index entry from the height index to the hash index. |
|
Look up a single index entry for a block, trying the height index then the hash index. |
Variables
Name |
Description |
Key prefix byte identifying an entry in the hash index. |
|
Key prefix byte identifying an entry in the height index. |
init namespace
Initialization helpers shared by the node, wallet, and other executables.
Functions
Name |
Description |
Registers the logging‐related command‐line options with the argument manager. |
|
Writes the package name and version banner to the log. |
|
Enables or disables the debug logging categories selected by the arguments. |
|
Sets the global logging severity level selected by the arguments. |
|
Applies the general logging options (log file, timestamps, thread names, and similar flags) parsed from the arguments to the global logger. |
|
Opens the debug log file and begins writing buffered log messages. |
interfaces namespace
Interfaces between the node and the rest of the application.
Types
Name |
Description |
Summary of the current block and header tip, returned from initialization. |
|
Block data sent with blockConnected, blockDisconnected notifications. |
|
A lightweight reference to a block by hash and height. |
|
Interface giving clients read and write access to the node's chain state. |
|
Interface for a client (such as a wallet) attached to the node. |
|
Interface for process initialization and inter‐process setup. |
|
Interface exposing block‐template creation to mining clients. |
|
Interface to a single wallet exposed to the node. |
|
Interface for loading and creating wallets. |
kernel namespace
Kernel library components for validating blocks and maintaining chain state.
Types
Name |
Description |
An options struct for |
|
Access to the block database (blocks/index/) |
|
On‐disk statistics describing the contents of one block file. |
|
Aggregate statistics computed over the UTXO set. |
|
Byte budgets for the validation caches, derived from a single total. |
|
An options struct for |
|
Identifies which chainstate (active or background) a notification refers to. |
|
Process‐wide context owning the libbitcoin_kernel global state. |
|
Result type for use with std::variant to indicate that an operation should be interrupted. |
|
Options struct containing limit options for a CTxMemPool. Default constructor populates the struct with sane default values which can be modified. |
|
Tunable options controlling memory‐pool acceptance and limits. |
|
A base class defining functions for notifying about certain kernel events. |
Type Aliases
Name |
Description |
Simple result type for functions that need to propagate an interrupt status and don't have other return values. |
Enums
Name |
Description |
Selects the hashing scheme used to summarize the UTXO set. |
|
Categories of node warning raised by the validation kernel. |
Functions
Name |
Description |
Folds a coin into the running MuHash of the UTXO set. |
|
Computes aggregate statistics over the UTXO set. |
|
Computes the serialization‐agnostic size measure of an output script. |
|
Tests whether a variant result holds the Interrupted alternative. |
|
Builds block metadata from a block index entry. |
|
Removes a coin from the running MuHash of the UTXO set. |
|
Ensure a usable environment with all necessary library support. |
|
Writes a human‐readable form of a chainstate role to a stream. |
Variables
Name |
Description |
Default for whether block files are obfuscated (XOR‐ed) on disk. |
leveldb namespace
The LevelDB library namespace, forward‐declared to avoid a public dependency.
Types
Name |
Description |
LevelDB storage environment abstraction. |
memusage namespace
Helpers for estimating the dynamic memory usage of common data structures.
Types
Name |
Description |
Layout model of a doubly linked list node, used to size std::list. |
|
Layout model of the control block shared by shared_ptr/weak_ptr, used for sizing. |
|
Layout model of a libstdc++ red‐black tree node, used to size STL containers. |
|
Layout model of an unordered container node, used to size hashed containers. |
Functions
Name |
Description |
|
|
|
miniscript namespace
Miniscript: a structured representation of Bitcoin Scripts.
Types
Name |
Description |
A node in a miniscript expression. |
|
This type encapsulates the miniscript type system properties. |
Type Aliases
Name |
Description |
A single script opcode together with any immediate data it pushes. |
Enums
Name |
Description |
Three‐valued result for whether a satisfaction or dissatisfaction is available. |
|
The different node types in miniscript. |
|
The script context a Miniscript is used under. |
Functions
Name |
Description |
Compare two miniscript subtrees, using a non‐recursive algorithm. |
|
Unordered traversal of a miniscript node tree. |
|
Decodes a Miniscript from a Bitcoin Script. |
|
Parses a Miniscript from its textual (policy‐language) representation. |
|
Whether the context Tapscript, ensuring the only other possibility is P2WSH. |
|
The only way to publicly construct a Type is using this literal operator. |
node namespace
Full‐node components that run the block, chainstate, and mempool machinery.
Types
Name |
Description |
Generate a new block, without valid proof‐of‐work |
|
Options controlling which checks a block‐template validity check performs. |
|
Block template creation options. These override node defaults, but can't exceed node limits (e.g. block_reserved_weight can't exceed max block weight). |
|
Maintains a tree of blocks (stored in |
|
Options controlling how long a block‐template wait call blocks and when it returns. |
|
Tracks the current block file and how far its undo data has been written. |
|
Orders block indices purely by height, without tie‐breaking. |
|
Orders block indices by most accumulated work, for choosing the best tip. |
|
A candidate block together with the per‐transaction data needed to finalize it. |
|
Cache sizes split between the optional indexes and the kernel (validation) caches. |
|
Options controlling how the chainstate is loaded and verified. |
|
Template containing all coinbase transaction fields that are set by our miner code. Clients are expected to add their own outputs and typically also expand the scriptSig. |
|
Options controlling how a persisted mempool file is imported. |
|
Cache sizes allotted to each optional block‐chain index. |
|
Comparator ordering map iterators by their key, for use in ordered sets of iterators. |
|
Kernel notification handler that tracks chain state for code above the validation layer. |
|
State tracked by the KernelNotifications interface meant to be used by mining code, index code, RPCs, and other code sitting above the validation layer. |
|
A minimal version of BlockAssembler, using the same ancestor set scoring algorithm. Allows us to run this algorithm on a limited set of transactions (e.g. subset of mempool or transactions that are not yet in mempool) instead of the entire mempool, ignoring consensus rules. Callers may use this to: ‐ Calculate the "bump fee" needed to spend an unconfirmed UTXO at a given feerate ‐ "Linearize" a list of transactions to see the order in which they would be selected for inclusion in a block |
|
Container for tracking updates to ancestor feerate as we include ancestors in the "block". |
|
NodeContext struct containing references to chain state and connection state. |
|
Holds the results of AnalyzePSBT (miscellaneous information about a PSBT) |
|
Holds an analysis of one input from a PSBT |
|
A parent/child transaction package queued for joint mempool validation. |
|
Records the oldest block an external component still needs, to guard it from pruning. |
|
Follow‐up actions returned after a transaction is rejected from the mempool. |
|
Metadata describing a serialized UTXO snapshot file. |
|
Per‐peer connection attributes that affect transaction download scheduling. |
|
Class responsible for deciding what transactions to request and, once downloaded, whether and how to validate them. It is also responsible for deciding what transaction packages to validate and how to resolve orphan transactions. Its data structures include TxRequestTracker for scheduling requests, rolling bloom filters for remembering transactions that have already been {accepted, rejected, confirmed}, an orphanage, and a registry of each peer's transaction relay‐related information. |
|
Private implementation of TxDownloadManager. |
|
Options used to construct a TxDownloadManager. |
|
A class to track orphan transactions (failed on TX_MISSING_INPUTS) Since we cannot distinguish orphans from bad transactions with non‐existent inputs, we heavily limit the amount of announcements (unique (NodeId, wtxid) pairs), the number of inputs, and size of the orphans stored (both individual and summed). We also try to prevent adversaries from churning this data structure: once global limits are reached, we continuously evict the oldest announcement (sorting non‐reconsiderable orphans before reconsiderable ones) from the most resource‐intensive peer until we are back within limits. ‐ Peers can exceed their individual limits (e.g. because they are very useful transaction relay peers) as long as the global limits are not exceeded. ‐ As long as the orphan has 1 announcer, it remains in the orphanage. ‐ No peer can trigger the eviction of another peer's orphans. ‐ Peers' orphans are effectively protected from eviction as long as they don't exceed their limits. Not thread‐safe. Requires external synchronization. |
|
Manages warning messages within a node. |
Type Aliases
Name |
Description |
Map from block hash to its in‐memory block index entry. |
|
Chainstate load status code and optional error string. |
Enums
Name |
Description |
Which kind of chainstate a block file belongs to, used to segment storage. |
|
Chainstate load status. Simple applications can just check for the success case, and treat other cases as errors. More complex applications may want to try reindexing in the generic failure case, and pass an interrupt callback and exit cleanly in the interrupted case. |
|
Reason a raw block read from disk failed. |
|
Result of attempting to submit or broadcast a transaction. |
|
How to broadcast a local transaction. Used to influence |
|
Categories of node‐level warning shown to the user and over RPC. |
Functions
Name |
Description |
Abort the node in response to a fatal, unrecoverable internal error. |
|
Insert the coinbase transaction and compute the merkle root of a block. |
|
Provides helpful miscellaneous information about where a PSBT is in the signing workflow. |
|
|
|
Submit a transaction to the mempool and (optionally) relay it to all P2P peers. |
|
Split the configured total database cache across the indexes and kernel caches. |
|
Check option values for validity. Returns an error for invalid values. |
|
Wait while the best known header extends the current chain tip AND at least one block is being added to the tip every 3 seconds. If the tip is sufficiently far behind, allow up to 20 seconds for the next tip update. |
|
Dump the mempool to a file. |
|
Return a path to the snapshot‐based chainstate dir, if one exists. |
|
Look up unspent output information. Returns coins in the mempool and in the current chain UTXO set. Iterates through all the keys in the map and populates the values. |
|
Replace null optional values with their hardcoded defaults. |
|
Return the default total database cache size in bytes. |
|
Get the minimum time a miner should use in the next block. This always accounts for the BIP94 timewarp rule, so does not necessarily reflect the consensus limit. |
|
Return the hash and height of the active chain tip. |
|
Return transaction with a given hash. If mempool is provided and block_index is not provided, check it first for the tx. If ‐txindex is available, check it next for the tx. Finally, if block_index is provided, check for tx by reading entire block from disk. |
|
RPC helper function that wraps warnings.GetMessages(). |
|
Load blocks from the given files and activate the best chain, even if none are imported. |
|
Interrupt a blocking wait call. |
|
This sequence can have 4 types of outcomes: |
|
Import the file and attempt to add its contents to the mempool. |
|
Log a warning when the configured database cache is larger than available RAM allows. |
|
Wrapper around Minisketch::Minisketch(32, implementation, capacity). |
|
Wrapper around Minisketch::CreateFP. |
|
|
|
Return the on‐disk path used to load and save the persisted mempool. |
|
Merge two BlockCreateOptions structs, replacing null values in |
|
Read coins‐view database options from the argument manager. |
|
Read database options from the argument manager. |
|
Read the mining options set in |
|
Apply notification‐related options from the argument manager. |
|
Read the blockhash of the snapshot base block that was used to construct the chainstate. |
|
Update an old GenerateCoinbaseCommitment from CreateNewBlock after the block txs have changed |
|
Determine whether the mempool should be persisted across restarts. |
|
Report whether the configured database cache is large enough to warrant a warning. |
|
Submit a block and capture the validation state via the BlockChecked callback. Returns whether the block was accepted as a new valid block. |
|
Update a block header's time field and return the new time. |
|
Verify a chainstate that has already been loaded. |
|
Return a new block template when fees rise to a certain threshold or after a new tip; return nullopt if timeout is reached. |
|
Waits for the connected tip to change until timeout has elapsed. During node initialization, this will wait until the tip is connected (regardless of |
|
Write out the blockhash of the snapshot base block that was used to construct this chainstate. This value is read in during subsequent initializations and used to reconstruct snapshot‐based chainstates. |
|
Stream insertion operators |
Variables
Name |
Description |
The pre‐allocation chunk size for blk?????.dat files (since 0.8) |
|
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls. By default, a transaction with a burn value higher than this will be rejected by these RPCs and the GUI. This can be overridden with the maxburnamount argument. |
|
Default value for TxOrphanage::m_max_global_latency_score. Helps limit the maximum latency for operations like EraseForBlock and LimitOrphans. |
|
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls. Also used by the GUI when broadcasting a completed PSBT. By default, a transaction with a fee rate higher than this will be rejected by these RPCs and the GUI. This can be overridden with the maxfeerate argument. |
|
Default for ‐persistmempool, indicating whether the node should attempt to automatically load the mempool on start and save to disk on shutdown |
|
Default for whether block templates print each transaction's modified fee. |
|
Default value for TxOrphanage::m_reserved_usage_per_peer. Helps limit the total amount of memory used by the orphanage. |
|
Default for |
|
How long to wait before downloading a transaction from an additional peer |
|
The maximum size of a blk?????.dat file (since 0.8) |
|
Maximum number of transactions to consider for requesting, per peer. It provides a reasonable DoS limit to per‐peer memory usage spent on announcements, while covering peers continuously sending INVs at the maximum rate (by our own policy, see DEFAULT_TX_SEND_RATE) for several minutes, while not receiving the actual transaction (from any peer) in response to requests for them. |
|
Maximum number of in‐flight transaction requests from a peer. It is not a hard limit, but the threshold at which point the OVERLOADED_PEER_TX_DELAY kicks in. |
|
How long to delay requesting transactions from non‐preferred peers |
|
How long to delay requesting transactions from overloaded peers (see MAX_PEER_TX_REQUEST_IN_FLIGHT). |
|
The file in the snapshot chainstate dir which stores the base blockhash. This is needed to reconstruct snapshot chainstates on init. |
|
Suffix appended to the chainstate (leveldb) dir when created based upon a snapshot. |
|
Size of header written by WriteBlock before a serialized CBlock (8 bytes) |
|
How long to delay requesting transactions via txids, if we have wtxid‐relaying peers |
|
The pre‐allocation chunk size for rev?????.dat files (since 0.8) |
|
Total overhead when writing undo data: header (8 bytes) plus checksum (32 bytes) |
Using Declarations
Name |
Description |
Bring the kernel block‐tree database type into the node namespace. |
|
Bring the kernel block‐file info type into the node namespace. |
poly1305_donna namespace
Low‐level Poly1305 routines based on the public domain poly1305‐donna implementation by Andrew Moon (poly1305‐donna‐32.h).
Types
Name |
Description |
Incremental state for a Poly1305 one‐time authenticator computation. |
Functions
Name |
Description |
Finish a Poly1305 computation and write the 16‐byte authentication tag. |
|
Initialize a Poly1305 state with a 32‐byte one‐time key. |
|
Feed message bytes into a Poly1305 state. |
script namespace
sha256_implementation namespace
Runtime selection of the SHA‐256 implementation.
Enums
Name |
Description |
Bit flags selecting which CPU‐specific SHA‐256 implementations may be used. |
std namespace
Standard library namespace, extended here with a deleted hash specialization.
Types
Name |
Description |
Disable default std::hash for CTransactionRef to prevent accidentally comparing by pointer. Use CTransactionRefHash or provide a custom hasher. |
subprocess namespace
Getting started with reading this source code. The source is mainly divided into four parts: 1. Exception Classes: These are very basic exception classes derived from runtime_error exception. There are two types of exception thrown from subprocess library: OSError and CalledProcessError
Namespaces
Name |
Description |
Low‐level helpers shared by the subprocess implementation (argument quoting, pipes, descriptors). |
Types
Name |
Description |
class: Buffer This class is a very thin wrapper around std::vector<char> This is basically used to determine the length of the actual data stored inside the dynamically resized vector. |
|
class: CalledProcessError Thrown when there was error executing the command. Check Popen class API's to know when this exception can be thrown. |
|
class: OSError Thrown when some system call fails to execute or give result. The exception message contains the name of the failed system call with the stringisized errno code. Check Popen class API's to know when this exception would be thrown. Its usual that the API exception specification would have this exception together with CalledProcessError. |
|
class: Popen This is the single most important class in the whole library and glues together all the helper classes to provide a common interface to the client. |
|
Option to specify the error channel for the child process. It can be: 1. An already open file descriptor. 2. A file name. 3. IOTYPE. Usually a PIPE or STDOUT |
|
Option to specify the executable name separately from the args sequence. In this case the cmd args must only contain the options required for this executable. |
|
Option to specify the input channel for the child process. It can be: 1. An already open file descriptor. 2. A file name. 3. IOTYPE. Usual a PIPE |
|
Option to specify the output channel for the child process. It can be: 1. An already open file descriptor. 2. A file name. 3. IOTYPE. Usually a PIPE. |
|
Base class for all arguments involving string value. |
Type Aliases
Name |
Description |
Buffer holding the data captured from the child's error descriptor. |
|
Buffer holding the data captured from the child's output descriptor. |
Enums
Name |
Description |
Used for redirecting input/output/error |
Variables
Name |
Description |
Default buffer capacity for OutBuffer and ErrBuffer, in bytes. |
|
Maximum buffer size allocated on the stack when reading an error from a pipe. |
subprocess::util namespace
Low‐level helpers shared by the subprocess implementation (argument quoting, pipes, descriptors).
tinyformat namespace
Tiny type‐safe printf‐style string formatting library.
Types
Name |
Description |
List of template arguments format(), held in a type‐opaque way. |
|
Format string wrapper that checks the format at compile time. |
|
Wrapper marking a format string as runtime data, skipping compile‐time checks. |
|
Exception thrown when formatting fails. Added for Bitcoin Core. |
Type Aliases
Name |
Description |
Reference to type‐opaque format list for passing to vformat() |
Functions
Name |
Description |
|
|
|
|
Make type‐agnostic format list from list of template arguments. |
|
Format list of arguments to std::cout, according to the given format string |
|
Format list of arguments to std::cout, then append a newline. |
|
Format a list of arguments to a stream according to a format string. |
txindex namespace
Database key types and constants for the transaction index.
Types
Name |
Description |
Key for looking up the sequence number assigned to the block with the given hash. |
|
Key for looking up the hash of the block with the given sequence number. |
|
The location of a transaction: the sequence number of the block that contains it and the transaction's serialized byte offset from the start of that block (including the header), so the on‐disk position is simply block_data_pos + tx_offset_in_block. |
|
Hashed txindex key: a truncated txid hash prefix plus the block position. |
Type Aliases
Name |
Description |
Integer type holding the truncated txid hash prefix of a key. |
Functions
Name |
Description |
Compute the txid‐hash key prefix for a transaction. |
|
Key of a legacy (pre‐hashing) txindex row: the full txid under the 't' prefix. |
|
Compare two positions for equality by block sequence and offset. |
Variables
Name |
Description |
Serialized size of a block header, the offset of the first byte after it. |
|
Key holding the sync locator for the current (v2) index format. |
|
Key prefix mapping a block hash to its sequence number. |
|
Key prefix mapping a block sequence number to its block hash. |
|
Key holding the next block sequence number to assign. |
|
Key holding the salt used to hash txids. |
|
Prefix of a legacy (pre‐hashing) txindex row. |
|
Key prefix for a hashed txindex row keyed by txid hash prefix and position. |
|
Empty value of a hashed txindex row, whose position is encoded in its key. |
|
Number of leading txid‐hash bytes kept in a hashed txindex key. |
txindex_tests namespace
Unit‐test helpers that reach into TxIndex internals.
Types
Name |
Description |
Test fixture granting access to TxIndex private members. |
util namespace
Application‐agnostic logging interface shared across Bitcoin Core.
Namespaces
Name |
Description |
Application‐agnostic logging interface shared across Bitcoin Core. |
Types
Name |
Description |
Exception thrown when the value of an errored util::Expected is accessed. |
|
Compile‐time bilingual format string carrying a checked format and its translatable literal. |
|
A wrapper for a compile‐time partially validated format string |
|
Wraps a failure message used to construct a util::Result in the error state. |
|
The util::Expected class provides a standard way for low‐level functions to return either error values or result values. |
|
Task runner that processes each callback synchronously on insertion. |
|
Reads a character buffer line by line or in fixed‐length chunks. |
|
Overloaded helper for std::visit. This helper and std::visit in general are useful to write code that switches on a variant type. Unlike if/else‐if and switch/case statements, std::visit will trigger compile errors if there are unhandled cases. |
|
The util::Result class provides a standard way for functions to return either error messages or result values. |
|
Helper class that manages an interrupt flag, and allows a thread or signal to interrupt another thread. |
|
This header provides an interface and simple implementation for a task runner. Another threaded, serial implementation using a queue is available in the scheduler module's SerialTaskRunner. |
|
A token bucket rate limiter. |
|
Compile‐time literal string that can be translated with an optional translation function. |
|
The util::Unexpected class represents an unexpected value stored in util::Expected. |
Enums
Name |
Description |
Outcome of trying to acquire a directory lock. |
Functions
Name |
Description |
Helper function to access the contained object of a std::any instance. Returns a pointer to the object if passed instance has a value and the type matches, nullptr otherwise. |
|
consteval version of HexDigit() without the lookup table. |
|
Check if a string does not contain any embedded NUL (0) characters |
|
Extracts the error message from a result. |
|
Cross‐platform wrapper for POSIX execvp function. Arguments and return value are the same as for POSIX execvp, and the argv array should consist of null terminated strings and be null terminated itself, like the POSIX function. |
|
Return path to current executable assuming it was invoked with argv0. If path could not be determined, returns an empty path. |
|
Check whether a container begins with the given prefix. |
|
|
|
Acquire an exclusive lock on a directory via a lock file. |
|
Create an unordered multi‐line list of items. |
|
Return a copy of str with the given prefix removed, if present. |
|
Return a view of str with the given prefix removed, if present. |
|
Return a view of str with the given suffix removed, if present. |
|
Replace every occurrence of a substring in place. |
|
|
|
|
|
Get the thread's internal (in‐memory) name; used e.g. for identification in logging. |
|
Rename a thread both in terms of an internal (in‐memory) name as well as its system thread name. |
|
Set the internal (in‐memory) name of the current thread only. |
|
Locale‐independent version of std::to_string |
|
A wrapper for do‐something‐once thread functions. |
|
Return a copy of str with leading and trailing pattern characters removed. |
|
Return a view of str with leading and trailing pattern characters removed. |
|
|
|
Compile‐time hex literal returning a |
|
Compile‐time hex literal returning a |
|
Compile‐time hex literal returning a |
|
Compile‐time hex literal returning a |
|
Addition operators |
|
Write the translated form of a literal to an output stream. |
util::log namespace
Application‐agnostic logging interface shared across Bitcoin Core.
Types
Name |
Description |
A single log message together with its metadata. |
|
Structure and constant for tagging not to rate limit. |
Type Aliases
Name |
Description |
Opaque to util::log; interpreted by consumers (e.g., BCLog::LogFlags). |
Enums
Name |
Description |
Severity level of a log entry. |
Functions
Name |
Description |
Send message to be logged. Applications using the logging library need to provide this. |
|
|
|
Format a log message and forward it to util::log::Log. |
|
Return whether messages with specified category should be debug logged. Applications using the logging library need to provide this. |
|
Return whether messages with specified category should be trace logged. Applications using the logging library need to provide this. |
Variables
Name |
Description |
Tag value passed to logging macros to opt out of rate limiting. |
wallet namespace
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 |
wallet::DBKeys namespace
Record type prefixes used as keys in the wallet database.
Variables
Name |
Description |
Legacy accounting entry record. |
|
Active external ScriptPubKeyMan record. |
|
Active internal ScriptPubKeyMan record. |
|
Best block locator scanned by the wallet. |
|
Best block locator without a merkle branch. |
|
Encrypted private key record. |
|
Watch‐only script record. |
|
Legacy default key record. |
|
Destination metadata record. |
|
Wallet flags record. |
|
HD chain data record. |
|
Unencrypted private key record. |
|
Key metadata record. |
|
Keys in this set pertain only to legacy wallets and are removed during migration to descriptors. |
|
Locked UTXO record. |
|
Master key record used to encrypt other keys. |
|
Minimum client version required to read the wallet. |
|
Address book label record. |
|
Legacy wallet key record. |
|
Next transaction ordering position record. |
|
Key pool entry record. |
|
Address purpose record. |
|
Wallet settings record. |
|
Wallet transaction record. |
|
Wallet format version record. |
|
Wallet descriptor record. |
|
Encrypted descriptor private key record. |
|
Descriptor private key record. |
|
Watch‐only key metadata record. |
|
Watch‐only script record. |
|
Wallet transaction variant record. |
wallet::WalletTool namespace
Command‐line wallet tool commands.
Functions
Name |
Description |
Runs a wallet‐tool command such as create, info, or dump. |
wallet::feebumper namespace
Helpers for replacing a wallet transaction with a higher‐fee version.
Types
Name |
Description |
Signature checker that records the weight of every valid signature it verifies. |
|
Accumulates signature counts and weights to estimate transaction size. |
Enums
Name |
Description |
Outcome of a fee‐bumping operation. |
Functions
Name |
Description |
Commit the bumpfee transaction. |
|
Create bumpfee transaction based on feerate estimates. |
|
Sign the new transaction, |
|
Return whether transaction can be bumped. |
wallet::wallet_crypto_tests namespace
Test‐only helpers for exercising the wallet crypto internals.