Skip to content

docs: document signet and testnet4 networks (CLI values, ports) - #3

Open
MeABzZz wants to merge 1 commit into
BTCDecoded:mainfrom
MeABzZz:docs/signet-testnet4
Open

MeABzZz wants to merge 1 commit into
BTCDecoded:mainfrom
MeABzZz:docs/signet-testnet4

Conversation

@MeABzZz

@MeABzZz MeABzZz commented Oct 21, 2026

Copy link
Copy Markdown

What

Document every network the blvm CLI accepts. The tables listed mainnet, testnet3 and regtest only; --network also takes signet and testnet4.

  • getting-started/first-node.md and node/configuration.md network tables: new --network column, plus Signet and Testnet4 rows.
  • protocol/overview.md: Signet (0f1bf2e1) and Testnet4 (1c163f28) rows with magic bytes and ports.
  • Enumerations in configuration-reference, glossary, api-index, rpc-api, troubleshooting, performance, and deployment-posture now include signet/testnet4. Removed the outdated "Signet is not yet a supported network" note.
  • Fixed the default P2P bind. When no listen_addr is set by CLI, env or config file, blvm binds 127.0.0.1:<port>, not 0.0.0.0 (src/bin/main.rs:968). Added a one-line note on setting 0.0.0.0:<port> for inbound peers.

Why

The CLI's Network enum (blvm src/bin/main.rs:324) has had Signet and Testnet4 for a while, but the docs still describe three networks.

Sources (from code)

  • CLI values: #[derive(ValueEnum)] enum Network { Regtest, Testnet, Signet, Testnet4, Mainnet }
  • Ports: blvm::default_p2p_port_for_network / default_rpc_addr_for_network (src/lib.rs). Signet 38333/38332, Testnet4 48333/48332.
  • Magic bytes: blvm-protocol 0.1.35 network_params.rs
  • REST (RPC port + 10000) and assume-valid defaults (signet 267 665, testnet4 0): blvm-node 0.1.75 config/mod.rs

Verified

./scripts/verify-book-inputs.sh OK. mdbook build (v0.4.43 + mdbook-governance-vars) exits 0 with no ERROR/WARN lines.

Note: signet's derived REST port (48332) is the same as testnet4's default RPC port. That only matters when both run on one host.

The blvm CLI Network enum (src/bin/main.rs) accepts regtest, testnet,
signet, testnet4 and mainnet, but the network tables only listed three.
Add --network values and default P2P/RPC ports from
blvm::default_p2p_port_for_network / default_rpc_addr_for_network, magic
bytes from blvm-protocol network_params, REST and assume-valid defaults
from blvm-node. Also correct the unset-listen_addr P2P default to loopback
(127.0.0.1), which is what main.rs binds, and drop the stale 'Signet is
not yet supported' note.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant