Skip to content

PRODUCTION_READINESS.md

Latest commit

 

History

History
76 lines (59 loc) · 4.66 KB

PRODUCTION_READINESS.md

File metadata and controls

76 lines (59 loc) · 4.66 KB
Raw

Production Readiness

This document defines the release bar for FrostDAO multi-device use. The current codebase has protocol foundations, deterministic transport tests, CLI flows, TUI screens, and documentation. Treat live relay orchestration as production-bound only after the gates below pass.

Quality Gate

Run before every release candidate:

./scripts/doctor.sh
./scripts/quality.sh --full

Run before any relay-backed release candidate, once against an operator-controlled local relay and once against an independent public relay:

./scripts/nostr-relay-smoke.sh ws://127.0.0.1:8080
./scripts/nostr-relay-smoke.sh wss://relay.damus.io

The relay smoke test publishes and receives a public room join, direct per-recipient signing nonce and signing share envelopes, and a public tx_broadcast announcement. The doctor check verifies documentation links, stale command/keymap strings, CLI/docs command drift, script executable bits, and agent-payment draft semantics. The full gate runs doctor first, then checks formatting, strict Clippy, all tests, debug build, and rustdoc warnings.

Security Invariants

  • Private shares, DKG round 2 shares, signing nonces, signing shares, reshare sub-shares, and recovery sub-shares are never published in plaintext.
  • Nonces are generated for one signing session and are never reused.
  • Nostr messages are accepted only for the active room and intended party.
  • Outbound direct Nostr signing messages are sent only to parties that have joined the active room.
  • Nostr messages include message_id, created_at, and optional expires_at; receivers keep a replay cache.
  • Every party verifies their written share mnemonic with dkg-verify-mnemonic.
  • TSS signer sets satisfy t-of-n.
  • HTSS signer sets satisfy the Birkhoff rank rule: sorted ranks must have rank[i] <= i.
  • Reshare preserves the group secret when the goal is device rotation without address rotation.
  • Recovery reconstructs one missing party share, not the full wallet secret.

Release Runbook

  1. Start from a clean test profile and run ./scripts/doctor.sh, then ./scripts/quality.sh --full.
  2. Create a 2-of-3 TSS wallet with CLI commands from User Flow.
  3. Derive at least two addresses and verify they remain deterministic across devices.
  4. Generate, verify, and restore-test a backup mnemonic for each party.
  5. Build and sign a testnet transaction using an explicit session ID.
  6. Reshare the wallet to a new party set and verify the address fingerprint is unchanged.
  7. Recover one lost party share and verify the recovered wallet public key/address.
  8. Repeat steps 2-7 with HTSS ranks and verify invalid rank sets are rejected.
  9. Run the same ceremonies through the Nostr message envelope and relay transport.
  10. Record relay failures, duplicate messages, expired messages, and wrong-recipient messages as rejected.

Required Before Mainnet

  • Wire the guarded TUI room runtime into live relay keygen, signing, reshare, and recovery ceremonies.
  • Run the opt-in relay smoke test against at least one local relay and one public relay for every release candidate.
  • Complete public relay-backed TUI room transport testing for relay-backed rooms.
  • Wire real cryptographic signing share generation, combination, and testnet transaction broadcast into the relay-backed TUI signing path.
  • Extend structured audit logs that exclude secret material to every live relay ceremony path.
  • Complete an external cryptography/security review for FROST, HTSS, NIP-44 use, reshare, and recovery.
  • Default to testnet/signet until the user deliberately enables mainnet; DKG transaction build and broadcast require FROSTDAO_ENABLE_MAINNET_BITCOIN=1 for mainnet.

Operational Defaults

  • Default message TTL: 1 hour.
  • Maximum accepted future clock skew: 5 minutes.
  • Default relay: wss://relay.damus.io.
  • Recommended production relay setup: at least two relays, one controlled by the operator and one independent fallback.
  • Recommended threshold: choose t > n / 2 unless the organization has a documented reason not to.

Documentation Map

  • Showcase: walkthrough and code tour.
  • Run Guide: current commands and end-to-end dry runs.
  • Backup Guide: share mnemonic, manifest, verification, and storage guidance.
  • User Flow: task-oriented multi-device flow.
  • Protocols: TSS, HTSS, DKG, signing, derivation, reshare, and recovery overview.
  • Nostr Protocol: message envelope, kinds, and validation.
  • ROAST And Hardware: robust coordinator and hardware/PSBT integration direction.
  • Security Model: invariants, threat model, and mainnet cautions.