Skip to content

docs: v2 deployment guide and testnet runbook - #105

Open
ReinaMaze wants to merge 4 commits into
drydocs:mainfrom
ReinaMaze:docs/v2-deployment-guide
Open

docs: v2 deployment guide and testnet runbook#105
ReinaMaze wants to merge 4 commits into
drydocs:mainfrom
ReinaMaze:docs/v2-deployment-guide

Conversation

@ReinaMaze

Copy link
Copy Markdown

close #100

docs: v2 deployment guide and testnet runbook

Summary

Adds comprehensive deployment and operations documentation for Tholos v2 (stake-weighted resolution), covering parameter selection, deployment walkthrough, and admin procedures.

Changes

  • New: docs/src/DEPLOYMENT_V2.md — Complete v2 deployment guide mirroring v1's structure but addressing v2's distinct requirements

    • Parameter selection guidance for all v2-specific parameters (registration_duration_secs, anti_snipe_extension_secs, anti_snipe_hard_max_secs, reveal_duration_secs, max_position, max_total_weight)
    • Deploy walkthrough with stellar CLI commands for build, deploy, and initialize
    • Admin runbook documenting set_paused_v2 and cancel_round with narrower pause semantics (new assertions only, not in-flight disputes)
    • Integration notes on voter secrecy (salted commitments), TTLs, and v1/v2 coexistence
    • Explicit note: no canonical v2 testnet deployment yet (per CONTRIBUTING.md's contract address verification requirement)
  • Updated: docs/src/SUMMARY.md — Added DEPLOYMENT_V2.md under "Deployment & Operations" nav section

Scope

This is scoped to v2's own testnet deployment guidance only. The separate mainnet-launch deployment runbook (if open) remains v1-focused and not addressed here.

Testing

  • No committed contract addresses (as required by CI)
  • All cross-document links resolve (CONTRACT.md, V2_RESOLUTION.md, BOND_SIZING.md, SECURITY.md, DEPLOYMENT.md, INTEGRATION.md, CONTRIBUTING.md, V2_MIGRATION.md)
  • Markdown structure valid (no trailing whitespace, closed code blocks, proper tables)
  • Workspace membership verified
  • CI checks ready to pass

References

  • Source of truth: contracts/tholos-v2/src/lib.rs's initialize function
  • Parameter constraints: docs/src/V2_RESOLUTION.md
  • v1 template: docs/src/DEPLOYMENT.md
  • Address verification policy: CONTRIBUTING.md#reviewing-prs

Comment thread docs/src/DEPLOYMENT_V2.md Outdated
Comment thread docs/src/DEPLOYMENT_V2.md Outdated
Comment thread docs/src/DEPLOYMENT_V2.md Outdated
Comment thread docs/src/DEPLOYMENT_V2.md Outdated
Comment thread docs/src/DEPLOYMENT_V2.md Outdated
Comment thread docs/src/DEPLOYMENT_V2.md
Comment thread docs/src/DEPLOYMENT_V2.md
@ReinaMaze

Copy link
Copy Markdown
Author

@collinsezedike Done Sir

@collinsezedike

Copy link
Copy Markdown
Collaborator

Hey @ReinaMaze, I don't see any new commits on this PR, it's still on the same commit the review was against. Did you push to the right branch?

@collinsezedike

Copy link
Copy Markdown
Collaborator

Hey @ReinaMaze, this has been sitting a while with no update, so I went ahead and fixed the review findings directly on your branch: the base_bond/MAX_BOND_AMOUNT rationale, trimmed the parameter-selection bullets, pointed the pause-scope rationale at V2_RESOLUTION.md instead of duplicating it, corrected cancel_round's actual behavior (it does finalize the round, and doesn't itself move tokens for a disputed round), fixed the VoteCommitmentPreimage field list, and pointed the compute-commitment reference at its real usage comment instead of a nonexistent README. No action needed on your end.

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.

[Feature] Write a DEPLOYMENT.md equivalent for tholos-v2

2 participants