Bitflash BTF · RandomX · MIT

Docsrendered from the repositorynothing hand-written here

Documentation

These pages are generated from the Markdown that ships with the source. If the two ever disagree, the source is right and this site has a bug.

Manual

What Bitflash is, how to run it, wallets and recovery, mining, headless operation, and how nodes find each other.

README.md

Wallet storage

Where the wallet lives on disk. Since 1.2.20 the default is a single self-contained SQLite file, with one-click conversion from the old Berkeley DB wallet.dat and a fallback that is never touched.

docs/storage.md

Proof of work v2

Why RandomX miners could not mine v1, what changed in the input and the key, the switch times, and what a pool sends XMRig.

docs/pow-v2.md

Consensus rules v2

Strict DER and low-S signatures, the height in every coinbase, the retarget window that measures what it divides by: what Bitcoin adopted after 0.1.0, in one switch with PoW v2.

docs/rules-v2.md

JSON-RPC

The bitcoind-shaped interface an exchange integrates through: what listens, what it refuses, and the loop an integration runs.

docs/rpc.md

Bitflash on censored networks

What the node does on its own where Tor is blocked (the ladder of transports), bridges of your own, the onion download mirror, and what none of it can do.

docs/censored-networks.md

Network hardening

Protocol 102: the message checksum, misbehavior scores and bans, initial block download as a state, and block data synced before the index points at it.

docs/net-hardening.md

The treasury

The community fund for the first exchange listing: a 2-of-3 multisig on the chain, who holds the keys, the rules of spending, and how to verify the page against your own node.

docs/treasury.md

Multisig and pay-to-script-hash

Bare m-of-n multisig and the P2SH shapes with the raw-transaction RPC, ahead of the rules v3 switch that makes a script hash safe to pay.

docs/multisig.md

Tor mode

Route outbound discovery traffic through a local Tor SOCKS5 proxy. Transport plumbing only: it does not change consensus, wallet keys, mining, or rendezvous.

docs/tor.md

Mining calculator

A local, WhatToMine-style calculator for mining returns. It fetches no prices and talks to no exchanges: the numbers are yours to check.

docs/mining-calculator.md

Public pool directory

A place for humans to compare pool operators, while nodes still discover pools through Nostr and .btf rather than through any website.

docs/pool-directory.md

Key derivation and address format

The specification that lets a wallet be rebuilt from twelve words without this software. Test vectors included.

docs/derivation.md

Release verification

How releases are checksummed and signed, and the audit a careful user or packager should run before trusting a binary.

docs/release-verification.md

Dependencies

The libraries a build pulls in, pinned by commit, and why each one is there.

docs/dependencies.md

How nodes reach each other

How .btf addressing works over Tor hidden services: the signed descriptor, the three discovery paths, and what it hides.

docs/rendezvous.md

Fair launch verifier

Reproduce the genesis and confirm there was no premine, from your own copy of the chain.

docs/fair-launch.md

UTXO set commitment

A deterministic UTXO-set root you can rebuild from local block files and compare independently.

docs/utxo-commitment.md

UTXO inclusion proofs

Compact proofs that a specific output is in the UTXO root, with a standalone verifier.

docs/utxo-proofs.md

If this project disappears

The derivation document exists for exactly that case. It writes down the paths, the address format and the encoding in enough detail to recover keys from the twelve words with ordinary cryptographic tools and no Bitflash code at all, and it ships with a self-contained script that reproduces the test vectors from scratch.

The project has already been removed from one host without warning. Keep a copy of what matters to you.