Skip to content

README.md

Latest commit

 

History

History
160 lines (125 loc) · 7.67 KB

README.md

File metadata and controls

160 lines (125 loc) · 7.67 KB
Raw

rbitcoin

coverage

Bitcoin full node in Rust aimed at production server-side use: multi-peer IBD, tip follow, block/tx relay (tip mode), optional Core-class JSON-RPC, and in-process Electrum + optional Esplora REST (scripthash index via --sh-index, default off; 0.8 Core+electrs drop-in: COMPAT.md) — built around a relational archive (Class A/B/C) and a pure-Rust consensus/script path.

0.8.99 is the in-tree version (pre-0.9.0). Last published GitHub Release tag is 0.8.0 (patch line v0.8.x: Linux musl + Windows CRT-static + Darwin aarch64). Occupied 0.6.x stores refuse — wipe the datadir and redo IBD. Schema 24 and 25 open in place and rewrite to 26. Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone is block 840000 (0000000000000000000320283a032748cef8227873ff4872689bf23f1cda83a5): script/sig checks skip only on that header path once it contains that hash and the block is the path hash at its height (--milestone 0 is full scripts; an explicit height is height-only). Signet’s default milestone is 0 (every script). Electrum/Esplora need --sh-index (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.
License MIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version 0.8.99 (pre-0.9.0) — CHANGELOG.md
Platform Linux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
Security SECURITY.md — 0.8.x supported published line; no LTS until 1.0
Design docs/architecture.md — why this node is different
Develop rustup 1.95, no Nix — CONTRIBUTING.md
Coverage Live production-file LCOV (badge; last green master coverage job). Every PR must not drop that ratio. Highest published line coverage among bitcoin full nodes — TESTING.md

Why this node is different

Most full nodes center a UTXO set + block files (Bitcoin Core). Most Electrum backends are external indexers of another node. rbitcoin does neither: no UTXO set (relational archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~730 GiB with the cold append-only files (seqsigwit ~486, txstat ~11, input ~29) — census in SCHEMA.md, --sh-index costs in OPERATOR.md
  • Under ~30 h IBD on a laptop-class host with --milestone 0
  • Modest RAM during sync — no multi‑GiB dbcache pause
  • Pure-Rust consensus/scripts (no libbitcoinconsensus)
  • Highest published line coverage among bitcoin full nodes (live production-file LCOV on the badge; every PR must not drop that ratio) — TESTING.md
  • Reproducible static musl for ordinary Linux hosts

Core / Fulcrum contrasts: docs/architecture.md. Product surface: COMPAT.md. RPC subset: docs/rpc.md.

Status

Core pipelines exist (store, consensus, P2P IBD, tip follow, scripthash, Electrum, Esplora REST, libre mempool) for the server-side / wallet-client backend role. 0.7 mainnet is early production / high-scrutiny — not a Core or Fulcrum replacement, not a soak badge. Run signet first, then mainnet with monitoring (OPERATOR.md). First hour on regtest (mine → Electrum → Esplora): docs/operator/operations.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. Ongoing test growth is docs/quality.md. A 1.0 tag waits on a support window in SECURITY.md.

0.8: drop-in for mempool/electrs or Blockstream electrs HTTP (not address-prefix, not their /api/v1/ Node process). Core RPC for that stack is TCP plus an opt-in Core cookie (--rpc-cookie-file), so stock mempool CORE_RPC works unpatched; a unix-socket patch stays optional. Product surface: COMPAT.md.

Authorship: first-party code is AI-written (Grok / xAI) under Brandon Black (@reardencode) prompting — details in SECURITY.md. Default milestone and script skip: OPERATOR.md. Signet lab: docs/experimental-mainnet.md.

Build

Develop (any OS, Nix optional)

Nix is not required. Rust 1.95 via rustup (rust-toolchain.toml). Clone, first build, --smoke, and Windows/macOS notes: CONTRIBUTING.md (Getting started).

git clone https://github.com/reardencode/rbitcoin.git && cd rbitcoin
cargo build -p rbitcoin-node -p rbitcoin-cli

Linux-only optional pin (nix develop / nix-shell, same flake.lock as release). Agents use one worktree per session (topic branch per PR) and let Actions run workspace/coverage gates — AGENTS.md.

Portable static release (Linux operator)

Pinned nixpkgs + Cargo.lock musl static binaries. Commands and byte-identity: docs/reproducible-builds.md. Day-to-day flags: OPERATOR.md. Experimental mainnet: docs/experimental-mainnet.md.

Do not use cargo build --release inside nix-shell / nix develop as the operator binary — that links against the Nix store glibc and fails outside the store.

Crates

Workspace crate ownership and dependency orientation: docs/CRATES.md.

Documentation

Full map (one owner per fact): docs/README.md.

Audience Start
Operator OPERATOR.md
Product / interop COMPAT.md
Contributor CONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
Agent AGENTS.md
On-disk SCHEMA.md
Tests TESTING.md

Design uniqueness: docs/architecture.md. Security contact: SECURITY.md.

Seqsigwit-window prune (--prune-seqsigwit), BIP158 filters, silent-payment tweaks, GBT, and the SV2 template provider are product.

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • A wallet, a GUI, Core -prune of blk files, or a full Core RPC clone
  • A claim of complete mainnet script validation under the default milestone (use --milestone 0 for full scripts)
  • A multi-OS port — Linux is the supported IO target today

License

Licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. See CONTRIBUTING.md.