Skip to content

[docs] Split the operator runbook examples into Mainnet and Testnet tabs - #1392

Merged
Bridgerz merged 5 commits into
mainfrom
bridgerzoske/runbook-network-tabs
Oct 10, 2026
Merged

Bridgerz merged 5 commits into
mainfrom
bridgerzoske/runbook-network-tabs

Conversation

@Bridgerz

@Bridgerz Bridgerz commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #1391.

Summary

Every worked example in the runbook was Signet and Sui testnet, so a mainnet validator had to translate each one by hand. The network-specific examples are now tabs, and the mainnet tab carries the mainnet hosting policy for the Sui fullnode and the Bitcoin node.

Changes

  • Tabs: Sui RPC (1.4), Bitcoin node (1.5), validator config (3.1), CLI config (3.2), metrics push (8.2) and one troubleshooting fix (11.1). They share one group, so picking a network in one switches the page, and ?network=mainnet or ?network=testnet in the URL preselects it. Mainnet is first and the default.
  • The config templates now carry each network's ids, chain ids and URLs instead of placeholders. The two templates differ only in those values.
  • Mainnet: validators are asked to self-host the Sui fullnode and strongly encouraged to self-host the Bitcoin node, and advised to keep both off the Hashi node's host. The Bitcoin section says what a provider must cover if one is used. The examples use host placeholders instead of loopback. Testnet guidance is unchanged.
  • Self-hosted Sui fullnode: needs rpc.enable-indexing: true, which is off by default. Without it the list calls the node makes return NotFound, which Hashi reports as a missing package or object. Added to 1.4 and to the matching troubleshooting entry.
  • Mainnet Bitcoin node: sizing (about 775 GB of block data in October 2026, before the two indexes), why the node cannot be pruned, a bitcoin.conf bound to a private interface, and checks against the 800000 start height.
  • trm-api-key: still optional, strongly encouraged on mainnet, with a pointer to the sanctions page for creating a key.

Verification

  • npm run build in design/ passes. The built page has six tab groups with Mainnet selected and every code block rendered.
  • Both config templates parse as TOML, with every root key above the tables.
  • enable-indexing is from reading the Sui source (default false; the state service list calls return not-found without the index) and the calls the node makes at the mainnet-1.0 commit. It has not been reproduced against a fullnode with indexing off.

@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-10 00:45 UTC

@Bridgerz
Bridgerz added this pull request to stack #1393 October 9, 2026 23:54
@Bridgerz
Bridgerz marked this pull request as ready for review October 10, 2026 00:00
@Bridgerz
Bridgerz requested a review from bmwill as a code owner October 10, 2026 00:00
Base automatically changed from bridgerzoske/runbook-mainnet-registration to main October 10, 2026 00:29
Every worked example was Signet and Sui testnet, so a mainnet validator
had to translate each one by hand.

- Network-specific examples (Sui RPC, Bitcoin node, validator config,
  CLI config, metrics push, one troubleshooting fix) are now synced
  tabs, Mainnet first, with each network's ids and URLs filled in.
- Mainnet asks validators to self-host the Sui fullnode and the Bitcoin
  node on hosts separate from the Hashi node. Testnet guidance is
  unchanged.
- A self-hosted fullnode needs rpc.enable-indexing, which is off by
  default; without it the node's list calls return NotFound.
- Mainnet Bitcoin node sizing, config and checks.
- trm-api-key stays optional and is strongly encouraged on mainnet.
Hashi looks up each deposit's block with getrawtransaction by txid, which
needs txindex, and Bitcoin Core refuses txindex on a pruned node.
Mainnet validators are asked to self-host the Sui fullnode; the Bitcoin
node is strongly encouraged rather than required. Says what a provider
must cover if one is used.
The light client drops peers that do not advertise both NODE_NETWORK and
NODE_COMPACT_FILTERS, and a pruned node never advertises NODE_NETWORK.
On Bitcoin mainnet the light client anchors at a built-in checkpoint just
below Taproot activation for any start height above it, including the
default, and does not wait on bitcoind for a start-height block.
@Bridgerz
Bridgerz force-pushed the bridgerzoske/runbook-network-tabs branch from 65b930a to 766a02b Compare October 10, 2026 00:29
@Bridgerz
Bridgerz merged commit 17dbe11 into main Oct 10, 2026
13 checks passed
@Bridgerz
Bridgerz deleted the bridgerzoske/runbook-network-tabs branch October 10, 2026 00:45
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.

2 participants