Skip to content

Latest commit

 

History

History
13 lines (13 loc) · 3.88 KB

README.md

File metadata and controls

13 lines (13 loc) · 3.88 KB

Documentation

Entry points

Need Owner
Run a node, mine regtest, recover, use REST, inspect snapshots, watch stalls Getting started, Solo-mining generate path, template extras, Recovery contract, REST guide, Snapshot inspector, Runtime stall watchdog
Trace validation, state, and services module by module Architecture contract, primitives, script, consensus, storage, utxo, chain, node, p2p, mempool, mining, index, rpc
Find clauses and evidence, learn vocabulary, follow invariants, change the repo Contract index, Validation tooling, Concepts, Project invariants, Agent guidelines, contributing, Source and test organization policy, Reorg coverage map
Run the native pool, assess Lightning, evaluate silent payments, place instrumentation Native pool operation, pool contract, In-process Lightning integration, Lightning interop matrix, Silent Payments feasibility, Observability boundary, tracing/USDT
Read the node handbook chapter by chapter Book

Detailed policies and generated inputs

Source compatibility, Database migration, mempool policy, P2P compatibility, BIP adoption, BIP support matrix. Contracts take precedence over local source comments, detailed policies, and informative guides, in that order; a code-vs-contract disagreement is drift to investigate, not permission to silently change either side. Compatibility for every RPC, REST, and ZMQ surface is owned by crates/rpc/src/registry.rs (pinned by crates/rpc/core-compat.toml); RPC reference is generated from the registry, do not edit it by hand. Treat the hot-path ledger as a machine-consumed input too.

Evidence and implementation status

External evidence lives in ecosystem-compat.toml under the ecosystem compatibility contract. Registry status is not external verification. Do not conflate the two. Benchmarks retain methods, measurements, and decisions under the hot-path contract. UNMEASURED, planned, and BLOCKED are not successful results. Formal models obey the formal verification contract. A compiled build is not proof of a target design. The default binary is kernel-free. Library defaults follow validation-default.md. The optional kernel lane does not imply native-default promotion. The node runs BIP324 v2 transport by default. --v2transport=false keeps every connection on v1. P2pServiceConfig::default() leaves v2 transport off. Live bidirectional Core 31.1 interop is recorded (BIP adoption, BIP 324 row in bip-support.md).