Skip to content

[Feature] Mainnet-specific deployment runbook #205

Closed

Description

@collinsezedike

Summary

docs/src/DEPLOYMENT.md already covers parameter selection (now backed by real analysis in V1_MAINNET_PARAMETERS.md, #190), the deploy sequence, and an admin runbook (key rotation, pausing, resolver rotation). All of it is written testnet-first: every CLI example uses --network testnet, the only worked example uses throwaway resolver1/resolver2/resolver3 test identities, and the doc's own opening line is "this is testnet-only until audited."

What's still missing is the mainnet-specific operational layer: how do you actually run this with real value at stake, not just how do the contract calls work.

Scope

  • Key custody guidance for the admin and resolver roles specifically for a mainnet deployment: hardware wallet or multisig expectations, who holds keys, what happens if one is lost or compromised, cross-referencing V1_MAINNET_PARAMETERS.md's existing "reachability and independence" resolver-composition guidance rather than duplicating it.
  • A concrete go/no-go launch sequence that ties the existing "Mainnet readiness checklist" items together into an actual procedure: what order to do things in, who signs off, what the rollback plan is if something goes wrong in the first hours/days after launch.
  • Incident escalation specifics for a mainnet context: who gets paged, how fast, and what the decision tree looks like for choosing between set_paused and a resolver-committee rotation versus doing nothing and waiting for the normal dispute flow to work.
  • This should be additive to DEPLOYMENT.md (a new section, or a linked mainnet-specific companion doc, the assignee's call), not a rewrite of the existing testnet-focused content, which stays correct and useful as-is.

Proposed approach

Not prescribed. This is explicitly prep work written ahead of the actual audit clearing (the hard blocker per SECURITY.md), the same way V1_MAINNET_PARAMETERS.md was written ahead of live testnet data being available: useful to have ready rather than written under time pressure once the audit finishes. It should say so explicitly wherever it lives, so nobody mistakes its existence for a signal that mainnet deployment is currently authorized.

Activity

  1. Iker2522 commented on Sep 7, 2026

    @Iker2522
    Contributor

    I'd like to take this issue on!

    I can author the production mainnet operational guide and go/no-go launch playbook in docs/src/MAINNET_OPERATIONS.md to complement our existing testnet DEPLOYMENT.md.

    I will define hardware wallet and multi-sig custody standards for Admin and Resolver keys, craft an ordered go/no-go launch checklist with early-stage rollback contingencies, and establish a clear incident escalation decision tree for executing set_paused versus resolver rotations during live production incidents.

    The doc will be fully additive, cross-referencing V1_MAINNET_PARAMETERS.md and explicitly framing the material as pre-audit preparation per SECURITY.md. PR ready in 1–2 days.

  2. Fading-Dev commented on Sep 7, 2026

    @Fading-Dev

    Hello! I’d be glad to work on this. The issue presents a good opportunity to improve the project, and I’m confident I can deliver the requested functionality while keeping the existing behavior intact. I’ll validate everything before opening the PR.

  3. Fading-Dev commented on Sep 7, 2026

    @Fading-Dev

    Hello! I’d be glad to work on this. The issue presents a good opportunity to improve the project, and I’m confident I can deliver the requested functionality while keeping the existing behavior intact. I’ll validate everything before opening the PR.

  4. xtep103 commented on Sep 7, 2026

    @xtep103
    Contributor

    Hi! I'd like to work on this issue.

    After reviewing the description, my understanding is that DEPLOYMENT.md already documents the on-chain deployment and governance mechanics, while the missing piece is the operational guidance required for a real mainnet deployment. My plan would be to add a mainnet-focused operational section (or companion document) covering:

    • Key custody expectations for admin and resolver roles, including loss/compromise response procedures and references to the existing resolver-independence guidance in V1_MAINNET_PARAMETERS.md.
    • A concrete mainnet launch runbook that turns the current readiness checklist into a step-by-step go/no-go process with sign-offs, monitoring, and rollback considerations.
    • Mainnet incident-response and escalation procedures, including guidance on when to pause, when to rotate resolvers, and when to allow the normal dispute process to proceed.
    • A clear disclaimer that this documentation is preparatory only and does not imply mainnet deployment is currently authorized before audit completion.

    I'll aim to keep the work additive and avoid duplicating existing deployment or parameter-selection documentation.

    I'd be happy to put together a draft PR if this approach aligns with the maintainers' expectations.

    Please assign issue to me.

  5. grantfox-oss commented on Sep 7, 2026

    @grantfox-oss

    🦊 GrantFox — @Iker2522 has been assigned to this issue!

    Next steps:

    1. Open a Pull Request referencing this issue (e.g., Closes #205)
    2. Your PR will be reviewed by the drydocs maintainers

    Good luck! Track your progress on GrantFox.

  6. grantfox-oss commented on Sep 11, 2026

    @grantfox-oss

    🎉 This issue has been marked as completed on GrantFox!

    @Iker2522's PR #208 was approved and merged by @collinsezedike.

    🏆 @Iker2522: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (328 total points). Track your full progress on GrantFox.

    👏 Great work, @Iker2522! Keep contributing to drydocs.

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestmediumModerate scope or risk

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions