Skip to content

Commit ddaac49

Browse files
web3jenksclaudekkkk666
authored
testnet docs restructure (#439)
* feat: restructure docs for TBV launch — new top nav and vault user documentation Restructures the docs site navigation to add Trustless Bitcoin Vault sections: - New top nav: Overview, Vault Users, Vault Builders, Vault Operators - Vault Users section with 5 pages: Overview, Vault Creation, Vault Redemption, Protocol Actors, Fees - Vault Builders and Vault Operators as placeholders for future content - Overview sidebar now includes Bitcoin Staking and Babylon Genesis sub-sections consolidating staker, developer, and operator content - All existing content preserved at original URLs for backward compatibility Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: sidebar restructure + add Mermaid diagrams to vault user pages - Remove networks sidebar icon CSS rules and className - Fix sidebar to prevent bitcoin_staking.mdx from appearing as top-level item - Nest operators and developers content under Babylon Genesis category - Fix Babylon Genesis child ordering: Architecture, BABY Tokens, Governance, Networks, then Specifications last - Add Mermaid architecture diagram to vault-users overview - Add Mermaid sequence diagram to vault-creation (7-stage peg-in flow) - Add Mermaid sequence diagram to vault-redemption (peg-out + challenge flow) - Add Mermaid actor relationship diagram to protocol-actors - Add Mermaid fee flow diagram to fees Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: move Bitcoin Staking inside Overview sidebar category Bitcoin Staking was floating as a root-level sidebar item outside the Overview category. Now correctly nested inside Overview between Trustless Bitcoin Vault and Babylon Genesis, matching the intended structure. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: wrap Research/Security/Support in explicit sidebar categories The autogenerated directives were producing flat items without category headers. Wrapping them in explicit category blocks restores the Research, Security, and Support groupings in the sidebar. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: remove ghost sidebars, add displayed_sidebar to all migrated docs, fix governance nesting - Add displayed_sidebar: guides to all .mdx files in stakers/, developers/bitcoin_staking/, developers/babylon_genesis_chain/, operators/, and developers top-level pages so they show the Overview sidebar instead of old standalone sidebars - Remove stakers/developers/operators standalone sidebar entries from sidebars-default.js - Add link properties to all _category_.json files to eliminate duplicate label/doc pairs - Fix governance.mdx sidebar_position from 4.1 to 0 - Rename operators category label from "BabylonOperators" to "Node Operators" - Add redirects for retired /stakers/, /developers/, /operators/ top nav pages Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: group Babylon Genesis sidebar into Build on Genesis + Run a Node Developer content (chain info, explorers, dApps, wallet setup) now grouped under "Build on Genesis" collapsible category. Operator content (Babylon Node, Validators, Finality Providers, Covenant Emulator) now grouped under "Run a Node" collapsible category. Reduces sidebar length significantly. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: rewrite vault users for external publication, update builder/operator placeholders Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: clean up Babylon Genesis sidebar — remove networks, flatten governance, move vigilantes - Remove mainnet.mdx and testnet.mdx network pages (redundant with developers/bitcoin_staking/networks) - Move Vigilantes under BTC Staking Program in Architecture - Flatten governance proposal subfolders (reviewing_proposals, drafting_proposals, submit_proposals) directly into governance/ - Add redirects for all moved/removed URLs - Significantly reduces sidebar depth and clutter Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address Codex review feedback on vault docs Codex review found and fixed: - Legacy governance redirects pointing at non-existent routes - Babylon Genesis network redirects pointing at removed pages - CometBFT navbar item using relative path - Internal implementation details exposed in public docs (SP1 CUDA, secure channels, internal state labels, ChallengeAssert terminology) - Unexplained jargon (fairness payment token, Core Spoke) simplified - Vault Builders placeholder referenced private APIs — generalized - Vault Operators placeholder locked in specific stack choices — generalized - Removed dead diagram placeholder comments - Rewrote sections to be user-facing rather than internal-ops style Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: vault creation — add depositor auth, fix HTLC secret reveal flow Phase 1: Added secret/hashlock generation and Pre-PegIn HTLC broadcast. Phase 2: Added depositor authentication (auth anchor + BIP-322 fallback), Bitcoin 6-confirmation wait, PegIn input signing step. Phase 3: Replaced incorrect Merkle inclusion proof / Bitcoin light client description with correct HTLC secret reveal activation mechanism. Updated timeline to reflect actual flow durations. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs(vault-operators): document vaultd + btcwd daemon architecture Replace placeholder with the current operator-facing architecture: - vaultd handles protocol coordination (BaBe, tx graphs, claims) - btcwd is the remote BTC signer with gRPC + HMAC identity binding - Daemon-to-daemon gRPC with CWT bearer tokens - Public RPC vs loopback admin RPC split (--disable-auth guard) - Auth anchor / BIP-322 fallback for depositor authentication Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs(vault-operators): align with verified vaultd + btcwd CLI surface Source verification: clap CLI definitions in btc-vault@origin/main (crates/vaultd/src/cli/** and crates/btc-wallet-daemon/src/cli/**) read on 2026-05-01. Key corrections: - Replace "identity binding" / "identity pin" with HMAC shared-secret language (the actual auth model between vaultd and btcwd). - Document the two HTTP JSON-RPC listeners per vaultd: public RPC (configurable, default 127.0.0.1:8080) and admin RPC (always 127.0.0.1, defaults to public port + 1000 = 9080/9081/9082 by convention). - Clarify: --disable-auth affects only the public RPC listener; the admin RPC has no auth and relies on its loopback bind plus DNS-rebinding host filter. - Distinguish PostgreSQL vaultd state DB from SQLite btcwd BDK store. - Document btcwd default 127.0.0.1:9091 + --allow-insecure-bind. - Add real CLI subcommand references (vaultd vp/vk/uc, dev, security-council, watchtower) instead of placeholder language. * docs(trustless-bitcoin-vault): add testnet docs restructure with single top nav Add a Trustless Bitcoin Vault top-nav entry hosting the TBV open Testnet documentation set ported from Confluence (Vladyslav Horilyi's WIP draft tree at page 450068492). Structure under /trustless-bitcoin-vault/: - Getting Started landing page (index.mdx) - Start Here: What is TBV, How it works, TBV vs alternatives, Safety & trust - Testnet Info: Setup, Contract addresses, Protocol parameters - Use TBV Testnet for Lending: Quickstart, Create a vault, Borrow & repay, Withdraw & redeem, Liquidation risk, FAQ - Technical Details: Protocol architecture, Protocol actors, Aave v4 integration - Reference: Glossary, Fees, Audits & security, Community & support Navbar: the three Vault Users / Vault Builders / Vault Operators top-nav items from feat/tbv-docs-restructure (PR #430) collapse into the single Trustless Bitcoin Vault entry. Overview is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(trustless-bitcoin-vault): embed Confluence screenshots and restructure Create a Vault peg-in steps Add 59 screenshots and diagrams from Vlad's Confluence drafts (downloaded via the Atlassian REST API + /wiki/exportword MIME-multipart extraction). Embed them inline across: - start-here/: cross-chain diagram (What is TBV), safety overview (Safety & trust) - use-for-lending/quickstart.mdx: full 20-screenshot walkthrough across all 6 steps - use-for-lending/create-a-vault.mdx: 18 screenshots across the peg-in flow - use-for-lending/borrow-and-repay.mdx: 10 screenshots (add collateral, borrow, repay) - use-for-lending/withdraw-and-redeem.mdx: 8 screenshots covering the withdrawal flow - technical-details/protocol-architecture.mdx: architecture diagram Restructure Create a Vault to expose the depositor signing actions that Vlad's screenshots show but the prose previously omitted: - New Step 5 'Sign the Claim transaction graph' (was buried in Step 4 'Wait') - New Step 6 'Sign the Payout transactions' - New Step 7 'Download claimer artifacts' (critical for the self-claim fallback) - Old Step 5 'Activate' renumbered to Step 8 with sub-screenshots - Old Step 6 'Add as collateral' renumbered to Step 9 and reframed as 'After activation' to match the auto-supply behaviour in Quickstart / How it works Also normalize 'Collateral card' / 'Loans card' references to 'section' to match Vlad's latest portal wording. Images stored under static/img/trustless-bitcoin-vault/<section>/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(trustless-bitcoin-vault): consolidate Overview/bitcoin-vault into the dedicated top-nav section - Delete docs/guides/overview/bitcoin-vault.mdx; its content is superseded by the full Trustless Bitcoin Vault section under /trustless-bitcoin-vault/. - sidebars-default.js: the Overview sidebar entry for Trustless Bitcoin Vault now uses a 'link' item pointing to /trustless-bitcoin-vault/ instead of loading the standalone overview doc. - docusaurus.config.js: add a client-redirect from /guides/overview/bitcoin-vault/ → /trustless-bitcoin-vault/ so old URLs and bookmarks still resolve. - docs/trustless-bitcoin-vault/index.mdx: rename title + sidebar_label + h1 from 'Getting Started' to 'Trustless Bitcoin Vault' so the top-nav click, the page title, and the sidebar identity all match. - docs/guides/overview/overview.mdx: redirect the Trustless Bitcoin Vault Card and 'Learn more' link to the new /trustless-bitcoin-vault/ path. Net effect: clicking the 'Trustless Bitcoin Vault' top-nav button (the only non-Overview top-nav entry) lands the user on the new Trustless Bitcoin Vault section at /trustless-bitcoin-vault/, and the Overview/Trustless-Bitcoin-Vault sidebar entry just deep-links to the same place. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: delete docs/vault-{users,builders,operators}/ directories and sidebars The PR #430 'Vault Users / Vault Builders / Vault Operators' content has been fully superseded by the new Trustless Bitcoin Vault section at /trustless-bitcoin-vault/. Earlier commits removed the three nav items but left the underlying docs directories + sidebar definitions on disk for direct-URL access. Doing that turned out to be confusing — clicking sidebar items inside the Overview section could still surface vault-users/* pages even though they were no longer in the top nav. This commit: - Deletes docs/vault-users/, docs/vault-builders/, docs/vault-operators/ including their _category_.json files and all .mdx content. - Removes vaultUsers, vaultBuilders, vaultOperators sidebars from sidebars-default.js (they referenced now-deleted dirNames and would have caused the next 'autogenerated' resolve to fail). After this change, the only Vault-related navigation surface in the entire docs site is the single 'Trustless Bitcoin Vault' top-nav entry pointing to /trustless-bitcoin-vault/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(trustless-bitcoin-vault): replace 59 low-res screenshots with full-resolution originals The first image-embed pass (commit e7a3d41) extracted images from Confluence's `/wiki/exportword` MIME-multipart response, which scales images down to Word's embedded-image DPI. Result was ~95 KB per diagram and ~6-30 KB per UI screenshot — visible quality loss when viewed on the docs site. Switch to fetching the originals directly from `/wiki/download/attachments/{pageId}/{filename}`. That path rejects Basic-auth API tokens (`www-authenticate: OAuth`) on Atlassian Cloud, so this run uses session-cookie auth: the cookie pair (tenant.session.token + cloud.session.token) preserved across the 302 redirect to media-api.atlassian.com. Numbers per file vary by source dimensions, but the headline diagrams are now: - start-here/what-is-tbv-cross-chain-diagram.png: 3.0 MB (4K, was 95 KB) - start-here/safety-and-trust-overview.png: 3.4 MB (was 110 KB) - technical-details/protocol-architecture-diagram.png: 3.4 MB (was 106 KB) - use-for-lending/create-vault-deposit-form.png: 1.5 MB (was 32 KB) Total section image weight: 22 MB across 59 files. Downloader script kept in the job dir (~/.claude/jobs/f6d072fa/) for re-use when Vlad refreshes screenshots on Confluence. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(docs): zoomable + wider markdown images site-wide Two changes that together make markdown screenshots (especially the new 4K Confluence captures in /trustless-bitcoin-vault/) display larger and clickable for a full-resolution overlay. src/theme/MDXComponents.js Wraps every markdown <img> in react-medium-image-zoom's <Zoom> component before passing it to the renderer. Logos and small SVG icons under /icons/ are skipped so they keep their default behaviour. Previously only <ThemedImage> JSX got zoom (via the existing src/theme/ThemedImage swizzle); markdown `![](path)` syntax fell back to a plain <img> with no zoom. That gap is closed here. src/css/custom.css - Forces .markdown img to fill the prose column (width: 100%) with a consistent border + light shadow and cursor: zoom-in cue. - On viewports >=1280px, images extend ~80px past the column edges so high-resolution screenshots get more real estate before the user has to click into the zoom overlay. - Inline icons inside paragraphs (`p > img:not(:only-child)`) keep the small, no-shadow, inline treatment. - Bumps the zoom overlay z-index to 9999 so it always wins over the navbar and sidebars. Pairs with the existing src/theme/ThemedImage swizzle — the two together ensure every image on the site, whether written as <ThemedImage> or markdown ![](), is now zoomable. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * style(docs): image width 70% desktop, 100% under 996px breakpoint Per feedback the +80px breakout on wide viewports made tall screenshots overwhelm the prose; readers were having to scroll past UI captures to find the next paragraph. Switch to a more conservative responsive treatment: - Default (>= 997px): width: 70% — centred, plenty of margin for the eye to register surrounding prose, click to zoom for the full 4K overlay. - @media (max-width: 996px): width: 100% — Docusaurus collapses the sidebar here, so the prose column is already narrow; images get the full available width. The 996px breakpoint matches the existing sidebar/menu collapse rule already in this file, so screenshots scale at the same point the layout shifts to mobile. Inline icon rule, dark-mode border/shadow, and z-index of the zoom overlay are unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(trustless-bitcoin-vault): swap placeholder data for confirmed Confluence values Vlad and team filled in the (placeholder for team data) fields on four pages in the Confluence source. Mirror the confirmed values across the PR so the rendered docs no longer say 'placeholder for team data'. Setup - Ethereum wallet support: 'all wallets compatible with WalletConnect' - Bitcoin signet faucet: https://tbv-faucet.testnet.babylonlabs.io/ - Bitcoin signet explorer: https://mempool.space/signet - Ethereum testnet: Sepolia (chain ID 11155111) - Sepolia RPC: https://ethereum-sepolia-rpc.publicnode.com/ - Sepolia explorer: https://sepolia.etherscan.io/ - Demo app URL: https://btc-vaults.testnet.babylonlabs.io/ Contract addresses - All Sepolia deployments confirmed (BTCVaultRegistry, ProtocolParams, AaveAdapter, BabylonCoreSpoke, BTCVaultSwap, vaultBTC, etc.) - 4 Chainlink-compatible oracles confirmed (BTC/USD, WBTC/USD, USDC/USD, USDT/USD) - 3 test borrowable asset addresses confirmed - Each address links to its Etherscan page Community & support - Discord: discord.gg/qwTzSmtP - Twitter / X: @babylonlabs_io - Telegram: t.me/babyloncommunity - GitHub: github.com/babylonlabs-io - Partnership email: bd@babylonlabs.io FAQ Replace the 'coming soon' stub with Vlad's full v1 FAQ (~30 questions across seven sections: Wallets & setup, Deposit/peg-in, Borrow & repay, Health factor & liquidation, Withdraw/redeem, Trust & recovery, Troubleshooting). All internal links rewired to relative paths. Audits & security still has placeholders pending team confirmation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Restructure docs around Trustless Bitcoin Vault * Disable gtag during local development * docs: align TBV docs structure * fix: cover moved docs redirects * docs: update TBV testnet setup * docs: sync TBV Confluence refresh * docs: fix TBV screenshot order * docs: sync TBV Confluence images * docs: sync TBV docs and screenshots to Confluence source Rewrite the Trustless Bitcoin Vault doc set to match the latest Confluence source of truth across all sections: - start-here: what-is-tbv, how-it-works, tbv-vs-alternatives, safety-and-trust-assumptions - testnet-info: setup, contract-addresses, protocol-parameters - use-for-lending: quickstart, create-a-vault, borrow-and-repay, withdraw-and-redeem, liquidation-risk - technical-details: protocol-architecture, protocol-actors, aave-v4-integration - reference: glossary, community-and-support Notable content changes: BABE described as a proof verifier (not fraud detection), vault bound to one application at peg-in, AVK / Application Vault Keeper terminology, added Application Vault Keeper and Security Council key tables to contract-addresses, trimmed glossary to the canonical term set. Sync use-for-lending screenshots: add 2026-06-01 borrow/repay, create-a-vault, and quickstart captures plus withdraw captures; remove superseded borrow-and-repay JPGs. * Align TBV testnet docs with Confluence * Add publishable TBV FAQ and glossary * Clarify TBV overview introduction * Add TBV research papers to sidebar --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Kevin Liu <337459676@qq.com>
1 parent 7f25cf7 commit ddaac49

308 files changed

Lines changed: 3005 additions & 3599 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/developers/babylon_genesis_chain/_category_.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,9 @@
22
"position": 1,
33
"label": "Babylon Genesis Chain",
44
"collapsible": true,
5-
"collapsed": false
6-
}
5+
"collapsed": false,
6+
"link": {
7+
"type": "doc",
8+
"id": "developers/babylon_genesis_chain/babylon_genesis_chain"
9+
}
10+
}

docs/developers/babylon_genesis_chain/baby_faucets.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: BABY Faucets
34
sidebar_class_name: baby_faucets_sidebar
45
sidebar_position: 5

docs/developers/babylon_genesis_chain/babylon_genesis_chain.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: Babylon Genesis Chain
34
sidebar_class_name: babylon_chain_sidebar
45
sidebar_position: 1

docs/developers/babylon_genesis_chain/btc_faucets.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: BTC Faucets
34
sidebar_class_name: btc_faucets_sidebar
45
sidebar_position: 6

docs/developers/babylon_genesis_chain/chain_information.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: Chain Information
34
sidebar_class_name: chain_information_sidebar
45
sidebar_position: 1

docs/developers/babylon_genesis_chain/dapps/dapps.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
sidebar_class_name: dapps_sidebar
34
sidebar_label: Bitcoin Secured dApps
45
sidebar_position: 1

docs/developers/babylon_genesis_chain/dapps/simple_staking_dapp.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
sidebar_class_name: dapps_sidebar
34
sidebar_label: Simple Staking DApp
45
sidebar_position: 1

docs/developers/babylon_genesis_chain/dapps/smart_contract_deployment.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: Smart Contract Deployment
34
sidebar_class_name: smart_contract_deployment_sidebar
45
sidebar_position: 1

docs/developers/babylon_genesis_chain/explorers/explorers.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: Explorers
34
sidebar_class_name: explorers_sidebar
45
sidebar_position: 3

docs/developers/babylon_genesis_chain/node_information.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
displayed_sidebar: guides
23
title: Node Information
34
sidebar_class_name: node_information_sidebar
45
sidebar_position: 1

0 commit comments

Comments
 (0)