ethereum-sdk

# Quip Network SDK

[![License: AGPL-3.0-or-later](https://img.shields.io/badge/license-AGPL--3.0--or--later-blue.svg)](#license)

This repository contains the smart contracts and TypeScript SDK for the Quip Network — post-quantum-secured smart-contract wallets on EVM chains.

**Active development — not production-ready.** APIs, contract addresses, and the on-chain key schema may change between releases. See [TODO.md](TODO.md) for outstanding work.

Active Dev Branch : deploy/testnet

---

## Directory Map 

| Path                   | Purpose                                                                                                     |
| ---------------------- | ----------------------------------------------------------------------------------------------------------- |
| `contracts/`           | Live Solidity contracts: `WalletFactory` (UUPS), the SHRINCS wallet family (`shrincs/`); sunset code (incl. the `Deployer`) under `deprecated/`. |
| `contracts/deprecated/` | Sunset WOTS+ wallet family (`wots/`) + `QuipPaymaster`. Fully functional, still tested; no new features.   |
| `script/`              | Foundry deployment scripts (`*.s.sol`); sunset-family scripts under `script/deprecated/`.                   |
| `scripts/`             | TypeScript operational scripts: `release.ts`, `fundDeployer.cts`, `drainDeployer.cts`, `balance.cts`, etc.  |
| `src/v1/`              | Current TypeScript SDK: shared surface (`src/v1/index.ts`) + SHRINCS clients (`src/v1/shrincs/`).           |
| `src/deprecated/`      | Sunset SDKs: the WOTS+ half of v1 (`v1/`) and the legacy v0 SDK (`v0/`).                                    |
| `test/`                | Foundry tests (Solidity); sunset-family suites under `test/deprecated/`.                                    |
| `src/v1/tests/`        | Jest tests (TypeScript). SHRINCS: `src/v1/shrincs/tests/`; WOTS+: `src/deprecated/v1/tests/`.               |
| `deploy/midl_regtest/` | Hardhat deploy scripts for MIDL Bitcoin L2 only.                                                            |
| `Makefile`             | The canonical interface for build / test / deploy.             |

## Documentation map

| Document                                                   | Context                                                                                                                 |
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **This README**                                            | Setup, build/test commands, deploy commands.                                                                            |
| **[SDK_README.md](SDK_README.md)**                         | You're consuming the published `@quip.network/ethereum-sdk` npm package.                                                |
| **[INVARIANTS.md](INVARIANTS.md)**                         | You're auditing, extendi