Skip to content

privacy-ethereum/social-recovery-sdk

Repository files navigation

Social Recovery SDK

A composable SDK for adding social recovery to smart wallets. Designate guardians who can collectively restore wallet access using EOA signatures, Passkeys, or zero-knowledge proofs of emails and passport.

Security notice: this project has not been audited and is not production-ready

Structure

contracts/   # Solidity smart contracts (Foundry)
sdk/         # TypeScript SDK
circuits/    # Noir ZK circuits for zkJWT
docs/        # Documentation
example/     # Standalone demo app + standalone demo wallet contracts

Quick Start

# Contracts
cd contracts && forge install && forge build && forge test

# SDK
cd sdk && npm install && npm run build && npm test

# SDK ↔ Contracts e2e (spins up Anvil automatically)
cd sdk && npm run test:e2e

# Circuits
cd circuits/zkjwt && nargo build && nargo test

---

# Standalone example app
cd example/aa-wallet && npm install && npm run local:up

# Stop local example stack:
cd example/aa-wallet && npm run local:down

Documentation

See docs/ for detailed documentation, SPEC.md for the full technical specification, ARCHITECTURE.md for the project architecture, ROADMAP.md for the development roadmap, and CHECKLIST.md for the current progress tracking.