Skip to content

SHOWCASE.md

Latest commit

 

History

History
84 lines (63 loc) · 3.3 KB

SHOWCASE.md

File metadata and controls

84 lines (63 loc) · 3.3 KB
Raw

FrostDAO Showcase

This page is a guided map of the project for reviews, onboarding, and technical walkthroughs.

What To Show First

  1. Terminal UI: start with frostdao tui for the most complete interactive flow.
  2. 2-of-3 DKG: show distributed key generation with keygen-round1, keygen-round2, and keygen-finalize.
  3. Taproot address output: show that all parties derive the same Bitcoin address with dkg-address.
  4. Resharing: show that shares can rotate while the Bitcoin address stays the same.
  5. NIP-44 encrypted exchange: show encrypted round 2 share delivery for safer coordination.

Core Capabilities

Area What It Demonstrates Start Here
CLI Scriptable wallet creation, signing, address, balance, and recovery workflows CLI Reference
TUI Keymap Unified terminal keyboard shortcuts TUI Keymap
Backup Share mnemonic, manifest, verification, and storage guidance Backup Guide
Run Guide Current build, test, TSS, HTSS, reshare, recovery, and Nostr usage Run Guide
User Flow Multi-device product flow from room join to signing and reshare User Flow
Production Readiness Release gates, runbooks, and mainnet criteria Production Readiness
Protocols TSS, HTSS, DKG, signing, derivation, reshare, and recovery overview Protocols
Nostr Relay-based message protocol for DKG, signing, and resharing Nostr Protocol
Miniscript Optional Taproot policy templates and agent payment drafts Miniscript
Security Security invariants, threat model, and mainnet cautions Security Model

Preview Commands

Run the fast quality gate before any walkthrough or review:

./scripts/quality.sh

Run a local 2-of-3 DKG walkthrough:

./scripts/dkg-walkthrough.sh

Run a local resharing walkthrough:

./scripts/reshare-walkthrough.sh

Build the CLI:

./scripts/build.sh --release

Code Tour

Path Purpose
src/protocol/keygen.rs DKG round orchestration and wallet finalization
src/protocol/signing.rs FROST signing flow
src/protocol/reshare.rs Share refresh and migration
src/protocol/recovery.rs Share recovery
src/crypto/birkhoff.rs HTSS interpolation math
src/crypto/hd.rs BIP-86 compatible threshold HD derivation
src/crypto/nip44.rs Encrypted party-to-party payload support
src/btc/transaction.rs Bitcoin transaction construction and broadcast
src/tui/ Terminal application state, screens, and components
tests/ Unit and integration coverage for crypto, DKG, signing, resharing, and encryption

Verification Coverage

The test suite covers:

  • Birkhoff interpolation and HTSS signer validation.
  • HD child derivation and threshold derivation consistency.
  • BIP-39 mnemonic backup and restore flows.
  • NIP-44 encryption and encrypted DKG exchange.
  • CLI-driven DKG, address, wallet listing, signing, and resharing flows.
  • Taproot script construction and Bitcoin signing helpers.

Use the full gate when preparing a release or recorded walkthrough:

./scripts/quality.sh --full