Skip to content

Add Phase-2 TBV testnet documentation#443

Open
web3jenks wants to merge 2 commits into
mainfrom
feat/testnet-docs-restructure-phase-2-ready
Open

Add Phase-2 TBV testnet documentation#443
web3jenks wants to merge 2 commits into
mainfrom
feat/testnet-docs-restructure-phase-2-ready

Conversation

@web3jenks
Copy link
Copy Markdown
Collaborator

Summary

  • Add Phase-2 TBV testnet documentation: Safety & trust assumptions and the Technical Details section.
  • Add Confluence-matched diagrams for the new Phase-2 pages.
  • Remove Phase-1 redirects that would otherwise hide the newly published Phase-2 pages.

Confluence alignment

  • Synced against the TBV Testnet Documentation Draft tree.
  • Excluded skipped/unpublishable Confluence pages, including the skipped TBV fees page and placeholder-heavy security/whitepaper pages.
  • Built on top of the borrowing wording update so the Phase-2 branch matches the current user-facing terminology.

Validation

  • ALGOLIA_APP_ID=local ALGOLIA_API_KEY_READONLY=local npm run build
  • Known existing warnings remain: remote release/v3.x staking-script fetch 404, Docusaurus markdown config deprecation, stale Browserslist data, and existing top-level redirect warnings for /stakers, /developers, /operators.

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

🔐 Commit Signature Verification

All 2 commit(s) passed verification

Commit Author Signature Key Type Key Check
d72803c44ef7 Jenks sk-ssh-ed25519
42bc9cb2766d Jenks sk-ssh-ed25519

Summary

  • Commits verified: 2
  • Signature check: ✅ All passed
  • Key type enforcement: ✅ All sk-ssh-ed25519

Required key type: sk-ssh-ed25519 (FIDO2 hardware key)

Last verified: 2026-06-03 01:49 UTC

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Jun 3, 2026

Greptile Summary

This PR publishes Phase-2 TBV testnet documentation. The main changes are:

  • New Safety & trust assumptions page.
  • New Technical Details section for architecture, actors, and Aave v4 integration.
  • Updated TBV terminology from lending dashboard to Testnet app and borrowing position.
  • Removed redirects that previously hid Phase-2 TBV routes.
  • Added two Confluence-matched diagram images.

Confidence Score: 4/5

This is close, but the self-challenge docs should be fixed before merging.

  • The new trust model pages give conflicting instructions about whether depositors can broadcast fraud challenges.
  • The new Phase-2 pages are not added to the manual TBV sidebar, so they are hard to discover from navigation.
  • One architecture step mixes the Pre-PegIn refund path with active vault redemption.

sidebars-default.js, docs/trustless-bitcoin-vault/technical-details/protocol-actors.mdx, and docs/trustless-bitcoin-vault/technical-details/protocol-architecture.mdx.

Important Files Changed

Filename Overview
sidebars-default.js The manual TBV sidebar was not updated for the newly published pages or the borrowing label.
docs/trustless-bitcoin-vault/technical-details/protocol-actors.mdx The new actor documentation contradicts itself on who can broadcast fraud challenges.
docs/trustless-bitcoin-vault/technical-details/protocol-architecture.mdx The new architecture page mostly documents lifecycle flow, but one peg-out step mixes refund and redemption paths.

Reviews (1): Last reviewed commit: "docs(tbv): add phase 2 testnet documenta..." | Re-trigger Greptile


The protocol is designed to progressively decentralize participation. Two protocol surfaces have permissionless elements:

* **Fraud monitoring.** Anyone can monitor for fraudulent claims by running a watcher and checking Ethereum-side events. Broadcasting an on-chain `ChallengeAssert` requires being a registered Universal Challenger in the current `ProtocolParams` set; the registry is governed at the protocol level. The Testnet roadmap includes progressive opening of the challenger set so additional operators can earn challenger rewards by successfully disputing invalid claims.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Clarify challenge permissioning

This line says broadcasting an on-chain ChallengeAssert requires being a registered Universal Challenger, but this new page also says the depositor can broadcast ChallengeAssert themselves when no Universal Challenger acts. The safety page repeats that self-challenge as a core trust assumption. Readers now get two incompatible recovery models: either depositors can block a fraudulent claim themselves, or they cannot unless they are registered challengers. Please make this permissioning consistent so operators and depositors know which recovery path is actually available.


With the proof generated, the claimer follows the Bitcoin-side flow:

* **Claim transaction.** Spends from the vault's Taproot output via the appropriate leaf (repayment, liquidation, or refund).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Separate refund flow

This peg-out section lists refund as one of the Claim transaction leaves for spending the vault output. The same page describes refund as the Pre-PegIn HTLC expiry path, while peg-out is triggered by withdrawal, liquidation, or direct redemption after a vault is Active/Redeemed. As written, implementers can read this as saying an active vault redemption uses the refund leaf, which mixes two different Bitcoin outputs and lifecycle states.

Suggested change
* **Claim transaction.** Spends from the vault's Taproot output via the appropriate leaf (repayment, liquidation, or refund).
* **Claim transaction.** Spends from the vault's Taproot output via the appropriate leaf (repayment or liquidation).

Comment on lines +2 to +8
"label": "Use TBV Testnet For Borrowing",
"position": 4,
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"description": "Depositor critical path for the Aave v4 integration on TBV: step-by-step walkthroughs from the first peg-in to redeeming BTC."
"description": "Borrower critical path for the Aave v4 integration on TBV: step-by-step walkthroughs from the first peg-in to redeeming BTC."
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Sidebar ignores rename

This category label was renamed to “Borrowing”, but the TBV sidebar is manually defined in sidebars-default.js and still hardcodes “Use TBV Testnet For Lending”. Because this _category_.json is not what renders that manual sidebar entry, the visible navigation keeps the old wording while the generated category metadata says something else.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment on lines +1 to +10
{
"label": "Technical Details",
"position": 5,
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"description": "Optional deeper reading: protocol architecture, actors, and the Aave v4 application layer. Not required to use the product on Testnet."
}
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Add sidebar entries

This new technical-details category is only defined through _category_.json, but the Trustless Bitcoin Vault docs use a manually enumerated sidebar in sidebars-default.js. Since that sidebar was not updated with the Technical Details category or the new Safety page, these newly published Phase-2 pages are reachable by direct URL but are not discoverable from the TBV navigation.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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