Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

rbitcoin

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 for wallet clients (scripthash index via --shindex, default off; not a graphical block-explorer stack) — built around a libbitcoin-class relational archive and a pure-Rust consensus/script path.

0.5.1 is the current named published 0.x line (GitHub Release: Linux musl + Windows CRT-static + Darwin aarch64). Not 1.0: schema can still refuse a named wipe (SCHEMA.md, OPERATOR.md); default mainnet --milestone 840000 skips historical script/sig checks (--milestone 0 is full scripts); Electrum/Esplora need --shindex (default off) after tip. Run signet first, then mainnet with monitoring. Report security issues privately: SECURITY.md. Runbook: docs/experimental-mainnet.md.

LicenseMIT OR Apache-2.0 (LICENSE-MIT, LICENSE-APACHE)
Version0.5.1CHANGELOG.md
PlatformLinux musl is the operator path. Windows / Darwin are published snapshots (no IoRing; Darwin not notarized)
SecuritySECURITY.md0.5.x supported published line; no LTS until 1.0
Designdocs/architecture.md — why this node is different
Developrustup 1.95, no Nix — CONTRIBUTING.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 (libbitcoin-class archive), Electrum + txindex in-process.

  • ~200 GiB hot pin/annotate set (schema 17); ~700 GiB with cold inwit — census in SCHEMA.md, --shindex 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 (nolibbitcoinconsensus)
  • 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.5 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): OPERATOR.md. Finishing any one operator’s first full mainnet sync is not a gate for using or packaging this tree. 1.0 gates: docs/road-to-1.0.md.

Non-goal: powering a graphical block explorer (search boxes, address-prefix autocomplete, explorer-only catalogue APIs). 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 a worktree branch 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.

Crate map

CrateRole
rbitcoin-primitivesShared types / newtypes
rbitcoin-storeMap-free Class A/B/C tables (fd pread/pwrite), scripthash, bulk IO
rbitcoin-queryDomain API (archive, confirm, reconstruct, Electrum joins)
rbitcoin-consensusValidation / confirm; pure-Rust scripts; milestone = scripts only
rbitcoin-netP2P + IBD (modular ibd/), tip follow, relay
rbitcoin-mempoolCluster graph + libre admission
rbitcoin-electrumElectrum TCP server
rbitcoin-esploraEsplora REST + wallet-scoped WS (opt-in)
rbitcoin-logLeveled stderr logger
rbitcoin-rpcDocumented Core-class JSON-RPC subset (not full Core)
rbitcoin-cliCLI client
rbitcoin-nodeNode binary
rbitcoin-benchOptional Electrum/Esplora client benchmark (--features cli; not a default/musl product bin)
rbitcoin-testHigh-level test harness

Documentation

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

AudienceStart
OperatorOPERATOR.md
Product / interopCOMPAT.md
ContributorCONTRIBUTING.md (getting started: rustup, Linux / macOS / Windows)
AgentAGENTS.md
On-diskSCHEMA.md
TestsTESTING.md

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

What this is not

  • Production multi-tenant Electrum or “drop-in Core”
  • Wallet, mining, GUI, or pruning
  • Full Core JSON-RPC surface
  • 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.

About

Bitcoin full node in Rust: map-free relational archive, pure-Rust consensus, multi-peer IBD, Electrum for wallet backends

Topics

Resources

Contributing

Security policy

Stars

35 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages