QuipNetwork/ethereum-sdkPublic

AI summary: The official TypeScript SDK for interacting with Quip Network's EVM smart contracts.

Stars
11.3K
+-1 today
Forks
74
Watchers
19
Open issues
2
Open PRs
2
Contributors
~7
Commits
732
Branches
10
Views (30d)
9

SolidityAGPL-3.0Created Apr 16, 2025Last push 8d ago+-2 stars this week+-4 this month

Quick answers

What is ethereum-sdk?
The official TypeScript SDK for interacting with Quip Network's EVM smart contracts.
What does ethereum-sdk do?
This SDK provides a streamlined, type-safe interface for web and Node.js applications to interact with the Quip Network's smart contracts on Ethereum. It abstracts away the raw ABI calls and transaction formatting, offering developers clean TypeScript methods for core protocol actions. The library handles wallet integrations, contract deployments via the QuipFactory, and complex multi-step transactions. It is designed to accelerate the development of dApps that need to leverage Quip's quantum-resistant features or unique mining mechanics within the EVM ecosystem. It helps interact closely with the Base, Optimism, and Ethereum networks natively.
Who is ethereum-sdk for?
Web3 developers building decentralized applications or services that interact with the Quip Network on Ethereum. Requires TypeScript and general EVM development knowledge.
How do I get started with ethereum-sdk?
npm install @quipnetwork/ethereum-sdk
How popular is ethereum-sdk on GitHub?
QuipNetwork/ethereum-sdk has 11,329 stars and 74 forks on GitHub, and gained -2 stars in the last 7 days.
What license does ethereum-sdk use?
QuipNetwork/ethereum-sdk is released under the AGPL-3.0 license.

Star history

since Jul 28, 2026
05K10KJul 2026Sep 2026Oct 2026Nov 2026
11.3K stars as of Nov 17, 2026. Measured daily since Jul 28, 2026; GitHub no longer exposes earlier star timestamps.

Update history

1 recorded
  • Oct 16, 2026Primary language changed from TypeScript to Solidity.

Contribution activity

commits per day, last 52 weeks
NovDecJanFebMarAprMayJunJulAugSepOctNovMonWedFri2025-11-23: 0 commits2025-11-24: 0 commits2025-11-25: 0 commits2025-11-26: 0 commits2025-11-27: 0 commits2025-11-28: 0 commits2025-11-29: 0 commits2025-11-30: 0 commits2025-12-01: 0 commits2025-12-02: 0 commits2025-12-03: 0 commits2025-12-04: 0 commits2025-12-05: 0 commits2025-12-06: 0 commits2025-12-07: 0 commits2025-12-08: 0 commits2025-12-09: 0 commits2025-12-10: 0 commits2025-12-11: 0 commits2025-12-12: 0 commits2025-12-13: 0 commits2025-12-14: 0 commits2025-12-15: 0 commits2025-12-16: 0 commits2025-12-17: 6 commits2025-12-18: 4 commits2025-12-19: 1 commit2025-12-20: 0 commits2025-12-21: 0 commits2025-12-22: 0 commits2025-12-23: 0 commits2025-12-24: 0 commits2025-12-25: 0 commits2025-12-26: 0 commits2025-12-27: 0 commits2025-12-28: 0 commits2025-12-29: 0 commits2025-12-30: 0 commits2025-12-31: 0 commits2026-01-01: 0 commits2026-01-02: 0 commits2026-01-03: 0 commits2026-01-04: 0 commits2026-01-05: 0 commits2026-01-06: 1 commit2026-01-07: 2 commits2026-01-08: 1 commit2026-01-09: 0 commits2026-01-10: 0 commits2026-01-11: 0 commits2026-01-12: 0 commits2026-01-13: 0 commits2026-01-14: 0 commits2026-01-15: 0 commits2026-01-16: 0 commits2026-01-17: 0 commits2026-01-18: 0 commits2026-01-19: 0 commits2026-01-20: 0 commits2026-01-21: 0 commits2026-01-22: 0 commits2026-01-23: 0 commits2026-01-24: 0 commits2026-01-25: 0 commits2026-01-26: 0 commits2026-01-27: 0 commits2026-01-28: 0 commits2026-01-29: 0 commits2026-01-30: 0 commits2026-01-31: 0 commits2026-02-01: 0 commits2026-02-02: 0 commits2026-02-03: 0 commits2026-02-04: 0 commits2026-02-05: 0 commits2026-02-06: 0 commits2026-02-07: 0 commits2026-02-08: 0 commits2026-02-09: 0 commits2026-02-10: 0 commits2026-02-11: 0 commits2026-02-12: 0 commits2026-02-13: 0 commits2026-02-14: 0 commits2026-02-15: 0 commits2026-02-16: 0 commits2026-02-17: 0 commits2026-02-18: 0 commits2026-02-19: 0 commits2026-02-20: 0 commits2026-02-21: 0 commits2026-02-22: 0 commits2026-02-23: 0 commits2026-02-24: 0 commits2026-02-25: 0 commits2026-02-26: 0 commits2026-02-27: 0 commits2026-02-28: 0 commits2026-03-01: 0 commits2026-03-02: 0 commits2026-03-03: 0 commits2026-03-04: 0 commits2026-03-05: 0 commits2026-03-06: 0 commits2026-03-07: 0 commits2026-03-08: 0 commits2026-03-09: 0 commits2026-03-10: 0 commits2026-03-11: 0 commits2026-03-12: 0 commits2026-03-13: 0 commits2026-03-14: 0 commits2026-03-15: 0 commits2026-03-16: 7 commits2026-03-17: 7 commits2026-03-18: 11 commits2026-03-19: 6 commits2026-03-20: 1 commit2026-03-21: 0 commits2026-03-22: 0 commits2026-03-23: 0 commits2026-03-24: 0 commits2026-03-25: 4 commits2026-03-26: 5 commits2026-03-27: 11 commits2026-03-28: 0 commits2026-03-29: 1 commit2026-03-30: 3 commits2026-03-31: 14 commits2026-04-01: 2 commits2026-04-02: 3 commits2026-04-03: 3 commits2026-04-04: 0 commits2026-04-05: 0 commits2026-04-06: 4 commits2026-04-07: 4 commits2026-04-08: 3 commits2026-04-09: 2 commits2026-04-10: 0 commits2026-04-11: 2 commits2026-04-12: 0 commits2026-04-13: 7 commits2026-04-14: 3 commits2026-04-15: 0 commits2026-04-16: 0 commits2026-04-17: 0 commits2026-04-18: 0 commits2026-04-19: 0 commits2026-04-20: 2 commits2026-04-21: 5 commits2026-04-22: 7 commits2026-04-23: 6 commits2026-04-24: 0 commits2026-04-25: 0 commits2026-04-26: 0 commits2026-04-27: 3 commits2026-04-28: 3 commits2026-04-29: 0 commits2026-04-30: 8 commits2026-05-01: 2 commits2026-05-02: 0 commits2026-05-03: 7 commits2026-05-04: 14 commits2026-05-05: 2 commits2026-05-06: 0 commits2026-05-07: 2 commits2026-05-08: 0 commits2026-05-09: 0 commits2026-05-10: 0 commits2026-05-11: 2 commits2026-05-12: 1 commit2026-05-13: 5 commits2026-05-14: 10 commits2026-05-15: 17 commits2026-05-16: 2 commits2026-05-17: 0 commits2026-05-18: 0 commits2026-05-19: 1 commit2026-05-20: 1 commit2026-05-21: 0 commits2026-05-22: 0 commits2026-05-23: 0 commits2026-05-24: 0 commits2026-05-25: 1 commit2026-05-26: 1 commit2026-05-27: 5 commits2026-05-28: 3 commits2026-05-29: 5 commits2026-05-30: 0 commits2026-05-31: 0 commits2026-06-01: 4 commits2026-06-02: 1 commit2026-06-03: 11 commits2026-06-04: 0 commits2026-06-05: 0 commits2026-06-06: 0 commits2026-06-07: 0 commits2026-06-08: 0 commits2026-06-09: 2 commits2026-06-10: 6 commits2026-06-11: 0 commits2026-06-12: 1 commit2026-06-13: 0 commits2026-06-14: 0 commits2026-06-15: 0 commits2026-06-16: 0 commits2026-06-17: 1 commit2026-06-18: 2 commits2026-06-19: 0 commits2026-06-20: 2 commits2026-06-21: 5 commits2026-06-22: 4 commits2026-06-23: 0 commits2026-06-24: 2 commits2026-06-25: 0 commits2026-06-26: 0 commits2026-06-27: 1 commit2026-06-28: 1 commit2026-06-29: 0 commits2026-06-30: 3 commits2026-07-01: 0 commits2026-07-02: 0 commits2026-07-03: 0 commits2026-07-04: 0 commits2026-07-05: 0 commits2026-07-06: 0 commits2026-07-07: 0 commits2026-07-08: 0 commits2026-07-09: 4 commits2026-07-10: 3 commits2026-07-11: 1 commit2026-07-12: 0 commits2026-07-13: 1 commit2026-07-14: 21 commits2026-07-15: 27 commits2026-07-16: 0 commits2026-07-17: 0 commits2026-07-18: 0 commits2026-07-19: 0 commits2026-07-20: 3 commits2026-07-21: 15 commits2026-07-22: 0 commits2026-07-23: 0 commits2026-07-24: 0 commits2026-07-25: 0 commits2026-07-26: 0 commits2026-07-27: 0 commits2026-07-28: 0 commits2026-07-29: 0 commits2026-07-30: 1 commit2026-07-31: 0 commits2026-08-01: 0 commits2026-08-02: 0 commits2026-08-03: 6 commits2026-08-04: 0 commits2026-08-05: 1 commit2026-08-06: 0 commits2026-08-07: 0 commits2026-08-08: 0 commits2026-08-09: 0 commits2026-08-10: 0 commits2026-08-11: 0 commits2026-08-12: 0 commits2026-08-13: 0 commits2026-08-14: 1 commit2026-08-15: 0 commits2026-08-16: 0 commits2026-08-17: 0 commits2026-08-18: 1 commit2026-08-19: 0 commits2026-08-20: 0 commits2026-08-21: 45 commits2026-08-22: 2 commits2026-08-23: 0 commits2026-08-24: 0 commits2026-08-25: 0 commits2026-08-26: 23 commits2026-08-27: 28 commits2026-08-28: 9 commits2026-08-29: 1 commit2026-08-30: 0 commits2026-08-31: 4 commits2026-09-01: 3 commits2026-09-02: 14 commits2026-09-03: 4 commits2026-09-04: 0 commits2026-09-05: 0 commits2026-09-06: 0 commits2026-09-07: 0 commits2026-09-08: 0 commits2026-09-09: 0 commits2026-09-10: 0 commits2026-09-11: 0 commits2026-09-12: 0 commits2026-09-13: 0 commits2026-09-14: 0 commits2026-09-15: 6 commits2026-09-16: 0 commits2026-09-17: 0 commits2026-09-18: 0 commits2026-09-19: 0 commits2026-09-20: 0 commits2026-09-21: 10 commits2026-09-22: 21 commits2026-09-23: 18 commits2026-09-24: 0 commits2026-09-25: 0 commits2026-09-26: 0 commits2026-09-27: 0 commits2026-09-28: 0 commits2026-09-29: 0 commits2026-09-30: 0 commits2026-10-01: 2 commits2026-10-02: 1 commit2026-10-03: 0 commits2026-10-04: 0 commits2026-10-05: 0 commits2026-10-06: 0 commits2026-10-07: 0 commits2026-10-08: 0 commits2026-10-09: 0 commits2026-10-10: 0 commits2026-10-11: 0 commits2026-10-12: 0 commits2026-10-13: 0 commits2026-10-14: 0 commits2026-10-15: 0 commits2026-10-16: 3 commits2026-10-17: 0 commits2026-10-18: 0 commits2026-10-19: 0 commits2026-10-20: 0 commits2026-10-21: 0 commits2026-10-22: 2 commits2026-10-23: 0 commits2026-10-24: 0 commits2026-10-25: 0 commits2026-10-26: 0 commits2026-10-27: 0 commits2026-10-28: 0 commits2026-10-29: 0 commits2026-10-30: 0 commits2026-10-31: 2 commits2026-11-01: 3 commits2026-11-02: 3 commits2026-11-03: 1 commit2026-11-04: 0 commits2026-11-05: 0 commits2026-11-06: 0 commits2026-11-07: 0 commits2026-11-08: 0 commits2026-11-09: 0 commits2026-11-10: 0 commits2026-11-11: 0 commits2026-11-12: 0 commits2026-11-13: 0 commits2026-11-14: 0 commits2026-11-15: 0 commits2026-11-16: 0 commits2026-11-17: 0 commits2026-11-18: 0 commits2026-11-19: 0 commits2026-11-20: 0 commits2026-11-21: 0 commits
569 commits in the last yearLessMore

Signals and awards

derived from tracked data
  • Widely adopted

    11,329 stars

  • Continuous integration

    Automated checks passing

What ethereum-sdk does

This SDK provides a streamlined, type-safe interface for web and Node.js applications to interact with the Quip Network's smart contracts on Ethereum. It abstracts away the raw ABI calls and transaction formatting, offering developers clean TypeScript methods for core protocol actions. The library handles wallet integrations, contract deployments via the QuipFactory, and complex multi-step transactions. It is designed to accelerate the development of dApps that need to leverage Quip's quantum-resistant features or unique mining mechanics within the EVM ecosystem. It helps interact closely with the Base, Optimism, and Ethereum networks natively.

Web3 developers building decentralized applications or services that interact with the Quip Network on Ethereum. Requires TypeScript and general EVM development knowledge.

  • Type-Safe Contract Bindings: Automatically generated TypeScript interfaces for all Quip EVM contracts.
  • QuipFactory Integration: Simplifies the programmatic deployment and configuration of new Quip wallets.
  • Transaction Abstraction: Hides the complexity of gas estimation, nonce tracking, and raw transaction signing.
  • Environment Configuration: Built-in support for managing RPC endpoints and API keys across different networks.
  • EVM Compatibility: Works seamlessly with standard Ethereum tooling like Hardhat, Ethers.js, and Viem.

Where teams use it

dApp Frontend Development

Allows a React developer to easily integrate Quip wallet creation into a web interface.

Automated Testing

Enables QA engineers to write robust integration tests for protocols building on top of Quip.

Backend Indexing

Helps Node.js services reliably parse and react to events emitted by the Quip smart contracts.

Cross-Chain Relayers

Provides the necessary abstractions for building bridges between Quip's Substrate chain and Ethereum.

Getting started: npm install @quipnetwork/ethereum-sdk

README

main branch

Quip Network SDK

License: AGPL-3.0-or-later

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 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 You're consuming the published @quip.network/ethereum-sdk npm package.
INVARIANTS.md You're auditing, extending, or porting the contracts/SDK. All cryptographic, on-chain, and SDK invariants in one place.
GOVERNANCE.md Factory + paymaster trust model: what the owner can do, what they can't, recommended posture, and the planned move to on-chain governance.
DEPLOYMENTS.md Canonical contract addresses, per-chain deployment status, salt schemes.
MIDL-DEPLOYMENT.md Deploying onto MIDL (chain 777). Separate from the EVM workflow.
MIDL-REOWN-INTEGRATION.md Integrating Quip with Reown AppKit on MIDL.
TODO.md Roadmap and known gaps.

Prerequisites

  • Node.js ≥ 20 and a package manager (npm, bun, yarn, or pnpm). Examples below show bun but npm run <script> works identically.
  • Foundry — forge, cast, anvil. The canonical toolchain for compiling, testing, and deploying the contracts on EVM chains.
  • soldeer — Foundry's package manager. Run forge soldeer install (or make install) once after cloning.
  • GNU Make — drives every workflow via the Makefile.
  • jq — required by the storage-layout snapshot/check targets.

Hardhat is also installed, but it's used only for MIDL deploy scripts (deploy/midl_regtest/). All EVM compilation, testing, deployment, and release-bytecode generation go through Foundry. See hardhat.config.cts for the scope of the Hardhat configuration.

Installation

⚠️ npm install alone is not sufficient for a fresh clone — the SDK build (forge build → copy-abi → tsc) needs Foundry's soldeer dependencies materialized first. Use make install below; it runs forge soldeer install and npm install together.

git clone <repo>
cd ethereum-sdk
make install          # forge soldeer install + npm install

Environment setup

Copy .env.example to .env.

Variables are loaded automatically by the Makefile and Foundry's [rpc_endpoints] table. The base set below is enough for building, testing, running utility scripts, and SDK development:

# RPC endpoints (one per chain you target)
API_URL_SEPOLIA=https://eth-sepolia.g.alchemy.com/v2/...
API_URL_BASE_SEPOLIA=https://base-sepolia.g.alchemy.com/v2/...
API_URL_OP_SEPOLIA=https://opt-sepolia.g.alchemy.com/v2/...
API_URL_MAINNET=https://eth-mainnet.g.alchemy.com/v2/...
API_URL_BASE=https://base-mainnet.g.alchemy.com/v2/...
API_URL_OPTIMISM=https://opt-mainnet.g.alchemy.com/v2/...

# Operator wallet — signs any broadcast (deploys, vetting, utility scripts).
# For test/build only, can be omitted. For live-contract deploys this MUST
# be the key of DEPLOY_OPERATOR (see the Deployment section).
PRIVATE_KEY=0x...

# Etherscan v2 — one key covers Ethereum, Base, Optimism, and their L2 testnets.
# Required when deploys pass --verify (the default).
ETHERSCAN_API_KEY=...

Deployment targets require additional variables — they're listed in the Deployment section alongside the targets that consume them, so you only set what you actually need.

Network aliases must match [rpc_endpoints] in foundry.toml:

Alias Chain Chain ID
sepolia Ethereum Sepolia 11155111
base_sepolia Base Sepolia 84532
op_sepolia Optimism Sepolia 11155420
mainnet Ethereum Mainnet 1
base Base Mainnet 8453
optimism Optimism Mainnet 10

MIDL Testnet (chain 777) uses a different toolchain — see MIDL-DEPLOYMENT.md.


Contract development (Foundry)

make build                 # forge build
make test                  # forge test
make test-v                # forge test -vvv (verbose stack traces)
make gas                   # forge test --gas-report
make snapshot              # forge snapshot
make lint                  # solhint contracts/**/*.sol
make format                # prettier across .ts/.js/.json/.sol

forge build and forge test use the default profile, which compiles WOTSPlus as an inline library so tests don't need a pre-deployed address. The deploy profile (FOUNDRY_PROFILE=deploy) links WOTSPlus at the CREATE3-predicted address from foundry.toml and is used only by deployment scripts.

Local node

anvil                      # local EVM node on :8545

Storage layout drift gate

The WOTS+ wallet uses ERC-7201 namespaced storage (quip.storage.wallet.wotsplus), which forge inspect storageLayout cannot see directly. A test-only probe contract surfaces the layout, and the canonical fixture is test/deprecated/fixtures/WOTSPlusImplementation.storageLayout.json:

make storage-layout-check       # CI gate — fails if layout drifted
make storage-layout-snapshot    # regenerate fixture (only after intentional change)

If storage-layout-check fails, the upgrade path is broken unless you also write a corresponding migrator. Do not regenerate the snapshot to silence the gate.


SDK development (TypeScript)

The SDK is the npm package @quip.network/ethereum-sdk. It depends on the compiled contract ABIs, so SDK builds always include a contract build.

bun run build              # forge build + copy ABIs + tsc
bun run test:unit          # jest (TypeScript unit + integration tests)
bun run smoke:fork         # jest, but only the fork smoke test
bun run smoke:tarball      # pack + dry-install the SDK to verify exports

bun run is interchangeable with npm run here — both invoke the same package.json scripts. Use whichever you prefer.

Publishing a release

The release script regenerates src/v1/addresses.json and deployments/bytecode/ from the current Foundry build (compiler settings in foundry.toml), then prepares the tarball for npm publish:

make release               # forge build + tsx scripts/release.ts
bun run smoke:tarball      # verify the tarball before publishing
npm publish

scripts/release.ts reads Foundry artifacts from out/, computes CREATE3 addresses (DEPLOY_OPERATOR is REQUIRED — live canonical addresses are sender-guarded CreateX deployments and therefore a function of the operator; sunset WOTS+-era rows keep their Deployer derivation), links the WOTSPlus library into the QuipWallet (WOTS+ implementation) bytecode — the factory links no libraries since the WOTS+ decoupling — and snapshots each release under deployments/bytecode/<Contract>.sol/ with the compiler settings recorded verbatim from each artifact's metadata. MIDL deploys consume those snapshots via lib/deploy.cts::loadReleaseBytecode so the bytecode actually deployed on MIDL matches what was compiled by Foundry for the EVM chains.


Deployment

EVM deployments go through Foundry scripts in script/, driven by the Makefile. The live flow is two NUMBERED scripts run in order — 01_DeployFactory.s.sol, then 02_DeployShrincs.s.sol — both idempotent. Each step writes a broadcast log to broadcast/<Script>.s.sol/<chainId>/ for replay/inspection.

⚠️ Steps 1 and 2 are governance-sensitive. deploy-factory-<chain> sets the initial WalletFactory owner; deploy-shrincs-<chain> sets the ShrincsPaymaster owner and requires the caller to be the factory owner (vetting is onlyOwner), as does vet-impl-<chain>. Double-check FACTORY_OWNER / SHRINCS_PAYMASTER_OWNER are addresses you actually want as the long-term operators. Both steps require PRIVATE_KEY to be DEPLOY_OPERATOR's key — live canonical addresses are sender-guarded CreateX deployments, a function of the operator address, and no other key can consume the canonical salts.

Pipeline (per chain)

The numbered steps below also list the .env variables each one consumes. Set only the ones for the steps you're running.

0. Predict the CREATE3 addresses for the current bytecode.

DEPLOY_OPERATOR=0x... make predict-addresses
# or: DEPLOY_OPERATOR=0x... forge script script/PredictAddresses.s.sol

No RPC needed. DEPLOY_OPERATOR is required for the live-contract rows (their addresses are a function of it — sender-guarded CreateX salts); without it only the sunset WOTS+-era rows print.

1. Deploy the WalletFactory (UUPS impl + ERC-1967 proxy). ⚠️ Governance-sensitive. Contact Rick first. FACTORY_OWNER becomes the only address that can vet implementations, collect creation fees, and upgrade the factory implementation on this chain going forward. The factory PROXY address is the permanent identity every wallet bakes in — the impl behind it is replaceable via upgradeToAndCall.

make deploy-factory-base-sepolia

Env: PRIVATE_KEY (must be DEPLOY_OPERATOR's key), DEPLOY_OPERATOR (the operator every live canonical address derives from — guard that key), FACTORY_OWNER, MAX_FEE (WalletFactory creation fee in wei), ETHERSCAN_API_KEY.

2. Deploy the Shrincs family — ShrincsWallet impl (vetted; becomes latestWalletImpl) + ShrincsPaymaster (impl + proxy). The script locates the factory at its canonical derived address only — there is no FACTORY_ADDRESS override — and refuses to broadcast unless that address hosts an ERC-1967 proxy owned by the operator. ⚠️ SHRINCS_PAYMASTER_OWNER becomes the only address that can configure the ShrincsPaymaster; PRIVATE_KEY must also be the factory owner (vetting).

make deploy-shrincs-base-sepolia

Env: PRIVATE_KEY, DEPLOY_OPERATOR, SHRINCS_PAYMASTER_OWNER, SHRINCS_VERIFIER_PUBLIC_KEY (abi-encoded verifier bundle from scripts/gen-shrincs-paymaster-verifier.mjs — the commitment and leaf budget are derived from it on-chain), ETHERSCAN_API_KEY.

Ops: vet an implementation on the factory. ⚠️ Requires the calling PRIVATE_KEY to be the factory's current owner. The factory's vetImplementation is onlyOwner, so any other key produces a revert; a successful vet makes the impl the new latestWalletImpl. Contact Rick for coordination if you're not the registered factory owner on the target chain.

IMPLEMENTATION=0x... make vet-impl-base-sepolia

Env: PRIVATE_KEY (must equal the factory owner), FACTORY_ADDRESS, IMPLEMENTATION.

Sunset WOTS+ family (optional, frozen under script/deprecated/). make deploy-deployer-<chain> bootstraps the legacy Deployer (anyone can run it — unguarded salt), then make deploy-impl-<chain> deploys a WOTSPlusImplementation through it under FOUNDRY_PROFILE=deploy (env: PRIVATE_KEY, DEPLOYER_ADDRESS, FACTORY_ADDRESS). Vetting a WOTS+ impl AFTER step 2 would flip latestWalletImpl back to WOTS+ — the intended default is Shrincs.

Adding a new chain

Per-chain Makefile targets currently exist for base_sepolia as a worked example. To add support for another chain:

  1. Add an alias in foundry.toml [rpc_endpoints] and [etherscan].
  2. Copy the *-base-sepolia targets in the Makefile and rename them for the new alias.
  3. Run steps 0–2 above against the new alias.

For one-off runs against arbitrary chains, use the bare make deploy-* targets with an explicit RPC override:

RPC_URL=$API_URL_SEPOLIA make deploy-factory
RPC_URL=$API_URL_SEPOLIA make deploy-shrincs

Canonical contract addresses and salts are in DEPLOYMENTS.md.

Utility scripts

make fund-deployer         # send ETH from PRIVATE_KEY to the operator deployer
make drain-deployer        # sweep remaining ETH back out
make balance               # print operator balances across configured chains

All three are TypeScript scripts in scripts/ invoked via npx tsx. They read RPC and key material from .env. The drain-deployer script replaces the old npx hardhat run scripts/drainDeployer.ts --network <name> invocation that was used in the V1 deployment flow.

Contract verification

Deploy targets pass --verify to forge by default. Etherscan v2 is configured per-chain in foundry.toml [etherscan], so a single ETHERSCAN_API_KEY covers mainnet, Base, Optimism, and their L2 testnets.

To verify an already-deployed contract independently:

# WalletFactory implementation (constructor: uint256 maxFee_ — the MAX_FEE immutable;
# the owner is NOT a constructor arg, it is set on the proxy via initialize)
forge verify-contract \
  --rpc-url base_sepolia \
  --chain base_sepolia \
  --constructor-args $(cast abi-encode "constructor(uint256)" "$MAX_FEE") \
  0x77622e199DfF602f937fC5E5eB6479aE4b18161F \
  contracts/WalletFactory.sol:WalletFactory

# WalletFactory proxy (OpenZeppelin ERC1967Proxy; constructor: address implementation,
# bytes data — `data` is the initialize(address) call that sets FACTORY_OWNER)
forge verify-contract \
  --rpc-url base_sepolia \
  --chain base_sepolia \
  --constructor-args $(cast abi-encode "constructor(address,bytes)" \
      0x77622e199DfF602f937fC5E5eB6479aE4b18161F \
      $(cast calldata "initialize(address)" "$FACTORY_OWNER")) \
  0xA2B2F71456a799FCf4EF7A3111c4B96b3e928cc8 \
  @openzeppelin-contracts-5.6.1/proxy/ERC1967/ERC1967Proxy.sol:ERC1967Proxy

The above are the canonical CREATE3 addresses (identical on every chain the operator has deployed to — make predict-addresses prints them, and src/v1/shrincs/addresses.ts ships them to integrators). The live MAX_FEE is 1e18. The full per-chain history, including the sunset WOTS+-era contracts and the pre-V2 CREATE2 mainnet addresses, is in DEPLOYMENTS.md.


License

Copyright (C) 2024–2026 quip.network

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/. See COPYING for the full license text.

View on GitHub

Recent activity

commits and pull requests

Code frequency

additions and deletions
+259.6K-259.6KWeek of 2025-11-23: +0 linesWeek of 2025-11-23: -0 linesWeek of 2025-11-30: +0 linesWeek of 2025-11-30: -0 linesWeek of 2025-12-07: +0 linesWeek of 2025-12-07: -0 linesWeek of 2025-12-14: +17,358 linesWeek of 2025-12-14: -6,278 linesWeek of 2025-12-21: +0 linesWeek of 2025-12-21: -0 linesWeek of 2025-12-28: +0 linesWeek of 2025-12-28: -0 linesWeek of 2026-01-04: +153 linesWeek of 2026-01-04: -107 linesWeek of 2026-01-11: +0 linesWeek of 2026-01-11: -0 linesWeek of 2026-01-18: +0 linesWeek of 2026-01-18: -0 linesWeek of 2026-01-25: +0 linesWeek of 2026-01-25: -0 linesWeek of 2026-02-01: +0 linesWeek of 2026-02-01: -0 linesWeek of 2026-02-08: +0 linesWeek of 2026-02-08: -0 linesWeek of 2026-02-15: +0 linesWeek of 2026-02-15: -0 linesWeek of 2026-02-22: +0 linesWeek of 2026-02-22: -0 linesWeek of 2026-03-01: +0 linesWeek of 2026-03-01: -0 linesWeek of 2026-03-08: +0 linesWeek of 2026-03-08: -0 linesWeek of 2026-03-15: +4,480 linesWeek of 2026-03-15: -3,796 linesWeek of 2026-03-22: +1,493 linesWeek of 2026-03-22: -707 linesWeek of 2026-03-29: +8,458 linesWeek of 2026-03-29: -6,463 linesWeek of 2026-04-05: +2,846 linesWeek of 2026-04-05: -560 linesWeek of 2026-04-12: +7,016 linesWeek of 2026-04-12: -1,241 linesWeek of 2026-04-19: +20,129 linesWeek of 2026-04-19: -6,550 linesWeek of 2026-04-26: +5,573 linesWeek of 2026-04-26: -1,968 linesWeek of 2026-05-03: +9,630 linesWeek of 2026-05-03: -1,771 linesWeek of 2026-05-10: +35,034 linesWeek of 2026-05-10: -19,319 linesWeek of 2026-05-17: +215 linesWeek of 2026-05-17: -94 linesWeek of 2026-05-24: +4,501 linesWeek of 2026-05-24: -2,613 linesWeek of 2026-05-31: +14,332 linesWeek of 2026-05-31: -10,061 linesWeek of 2026-06-07: +254,777 linesWeek of 2026-06-07: -237 linesWeek of 2026-06-14: +35,542 linesWeek of 2026-06-14: -35,438 linesWeek of 2026-06-21: +28,987 linesWeek of 2026-06-21: -53,010 linesWeek of 2026-06-28: +44 linesWeek of 2026-06-28: -130 linesWeek of 2026-07-05: +2,599 linesWeek of 2026-07-05: -8,545 linesWeek of 2026-07-12: +107,971 linesWeek of 2026-07-12: -101,887 linesWeek of 2026-07-19: +4,106 linesWeek of 2026-07-19: -5,713 linesWeek of 2026-07-26: +1,904 linesWeek of 2026-07-26: -317 linesWeek of 2026-08-02: +2,461 linesWeek of 2026-08-02: -320 linesWeek of 2026-08-09: +407 linesWeek of 2026-08-09: -321 linesWeek of 2026-08-16: +6,006 linesWeek of 2026-08-16: -259,623 linesWeek of 2026-08-23: +12,527 linesWeek of 2026-08-23: -23,348 linesWeek of 2026-08-30: +11,230 linesWeek of 2026-08-30: -2,028 linesWeek of 2026-09-06: +0 linesWeek of 2026-09-06: -0 linesWeek of 2026-09-13: +583 linesWeek of 2026-09-13: -265 linesWeek of 2026-09-20: +7,598 linesWeek of 2026-09-20: -2,387 linesWeek of 2026-09-27: +166 linesWeek of 2026-09-27: -7 linesWeek of 2026-10-04: +0 linesWeek of 2026-10-04: -0 linesWeek of 2026-10-11: +968 linesWeek of 2026-10-11: -446 linesWeek of 2026-10-18: +4 linesWeek of 2026-10-18: -22 linesWeek of 2026-10-25: +451 linesWeek of 2026-10-25: -438 linesWeek of 2026-11-01: +102 linesWeek of 2026-11-01: -29 linesWeek of 2026-11-08: +0 linesWeek of 2026-11-08: -0 linesWeek of 2026-11-15: +0 linesWeek of 2026-11-15: -0 linesNov 23, 2025Nov 15, 2026
+609.7K lines added, -556K removed over the last year.

Commits per week

last 52 weeks
610Week of 2025-11-23: 0 commitsWeek of 2025-11-30: 0 commitsWeek of 2025-12-07: 0 commitsWeek of 2025-12-14: 11 commitsWeek of 2025-12-21: 0 commitsWeek of 2025-12-28: 0 commitsWeek of 2026-01-04: 4 commitsWeek of 2026-01-11: 0 commitsWeek of 2026-01-18: 0 commitsWeek of 2026-01-25: 0 commitsWeek of 2026-02-01: 0 commitsWeek of 2026-02-08: 0 commitsWeek of 2026-02-15: 0 commitsWeek of 2026-02-22: 0 commitsWeek of 2026-03-01: 0 commitsWeek of 2026-03-08: 0 commitsWeek of 2026-03-15: 32 commitsWeek of 2026-03-22: 20 commitsWeek of 2026-03-29: 26 commitsWeek of 2026-04-05: 15 commitsWeek of 2026-04-12: 10 commitsWeek of 2026-04-19: 20 commitsWeek of 2026-04-26: 16 commitsWeek of 2026-05-03: 25 commitsWeek of 2026-05-10: 37 commitsWeek of 2026-05-17: 2 commitsWeek of 2026-05-24: 15 commitsWeek of 2026-05-31: 16 commitsWeek of 2026-06-07: 9 commitsWeek of 2026-06-14: 5 commitsWeek of 2026-06-21: 12 commitsWeek of 2026-06-28: 4 commitsWeek of 2026-07-05: 8 commitsWeek of 2026-07-12: 49 commitsWeek of 2026-07-19: 18 commitsWeek of 2026-07-26: 1 commitsWeek of 2026-08-02: 7 commitsWeek of 2026-08-09: 1 commitsWeek of 2026-08-16: 48 commitsWeek of 2026-08-23: 61 commitsWeek of 2026-08-30: 25 commitsWeek of 2026-09-06: 0 commitsWeek of 2026-09-13: 6 commitsWeek of 2026-09-20: 49 commitsWeek of 2026-09-27: 3 commitsWeek of 2026-10-04: 0 commitsWeek of 2026-10-11: 3 commitsWeek of 2026-10-18: 2 commitsWeek of 2026-10-25: 2 commitsWeek of 2026-11-01: 7 commitsWeek of 2026-11-08: 0 commitsWeek of 2026-11-15: 0 commitsNov 23, 2025Nov 15, 2026
569 commits in the last 52 weeks.

When work happens

weekday and hour
SunMonTueWedThuFriSat036912151821Sun 0:00 — 0 commitsSun 1:00 — 0 commitsSun 2:00 — 0 commitsSun 3:00 — 0 commitsSun 4:00 — 0 commitsSun 5:00 — 0 commitsSun 6:00 — 0 commitsSun 7:00 — 0 commitsSun 8:00 — 0 commitsSun 9:00 — 0 commitsSun 10:00 — 1 commitsSun 11:00 — 2 commitsSun 12:00 — 0 commitsSun 13:00 — 1 commitsSun 14:00 — 1 commitsSun 15:00 — 2 commitsSun 16:00 — 1 commitsSun 17:00 — 2 commitsSun 18:00 — 1 commitsSun 19:00 — 0 commitsSun 20:00 — 0 commitsSun 21:00 — 1 commitsSun 22:00 — 2 commitsSun 23:00 — 3 commitsMon 0:00 — 9 commitsMon 1:00 — 7 commitsMon 2:00 — 0 commitsMon 3:00 — 0 commitsMon 4:00 — 0 commitsMon 5:00 — 0 commitsMon 6:00 — 0 commitsMon 7:00 — 0 commitsMon 8:00 — 0 commitsMon 9:00 — 2 commitsMon 10:00 — 6 commitsMon 11:00 — 7 commitsMon 12:00 — 5 commitsMon 13:00 — 5 commitsMon 14:00 — 5 commitsMon 15:00 — 10 commitsMon 16:00 — 4 commitsMon 17:00 — 6 commitsMon 18:00 — 14 commitsMon 19:00 — 1 commitsMon 20:00 — 3 commitsMon 21:00 — 5 commitsMon 22:00 — 9 commitsMon 23:00 — 3 commitsTue 0:00 — 4 commitsTue 1:00 — 4 commitsTue 2:00 — 5 commitsTue 3:00 — 4 commitsTue 4:00 — 0 commitsTue 5:00 — 0 commitsTue 6:00 — 0 commitsTue 7:00 — 4 commitsTue 8:00 — 8 commitsTue 9:00 — 9 commitsTue 10:00 — 5 commitsTue 11:00 — 0 commitsTue 12:00 — 1 commitsTue 13:00 — 3 commitsTue 14:00 — 11 commitsTue 15:00 — 11 commitsTue 16:00 — 3 commitsTue 17:00 — 5 commitsTue 18:00 — 8 commitsTue 19:00 — 4 commitsTue 20:00 — 9 commitsTue 21:00 — 13 commitsTue 22:00 — 8 commitsTue 23:00 — 6 commitsWed 0:00 — 9 commitsWed 1:00 — 9 commitsWed 2:00 — 14 commitsWed 3:00 — 8 commitsWed 4:00 — 6 commitsWed 5:00 — 0 commitsWed 6:00 — 3 commitsWed 7:00 — 1 commitsWed 8:00 — 0 commitsWed 9:00 — 4 commitsWed 10:00 — 5 commitsWed 11:00 — 5 commitsWed 12:00 — 14 commitsWed 13:00 — 3 commitsWed 14:00 — 8 commitsWed 15:00 — 16 commitsWed 16:00 — 6 commitsWed 17:00 — 5 commitsWed 18:00 — 2 commitsWed 19:00 — 5 commitsWed 20:00 — 8 commitsWed 21:00 — 6 commitsWed 22:00 — 9 commitsWed 23:00 — 19 commitsThu 0:00 — 14 commitsThu 1:00 — 8 commitsThu 2:00 — 3 commitsThu 3:00 — 4 commitsThu 4:00 — 4 commitsThu 5:00 — 0 commitsThu 6:00 — 0 commitsThu 7:00 — 0 commitsThu 8:00 — 0 commitsThu 9:00 — 2 commitsThu 10:00 — 0 commitsThu 11:00 — 5 commitsThu 12:00 — 2 commitsThu 13:00 — 5 commitsThu 14:00 — 8 commitsThu 15:00 — 9 commitsThu 16:00 — 8 commitsThu 17:00 — 8 commitsThu 18:00 — 14 commitsThu 19:00 — 11 commitsThu 20:00 — 2 commitsThu 21:00 — 2 commitsThu 22:00 — 5 commitsThu 23:00 — 1 commitsFri 0:00 — 3 commitsFri 1:00 — 0 commitsFri 2:00 — 1 commitsFri 3:00 — 5 commitsFri 4:00 — 3 commitsFri 5:00 — 0 commitsFri 6:00 — 0 commitsFri 7:00 — 0 commitsFri 8:00 — 1 commitsFri 9:00 — 6 commitsFri 10:00 — 12 commitsFri 11:00 — 14 commitsFri 12:00 — 11 commitsFri 13:00 — 21 commitsFri 14:00 — 12 commitsFri 15:00 — 5 commitsFri 16:00 — 5 commitsFri 17:00 — 1 commitsFri 18:00 — 10 commitsFri 19:00 — 5 commitsFri 20:00 — 3 commitsFri 21:00 — 1 commitsFri 22:00 — 3 commitsFri 23:00 — 0 commitsSat 0:00 — 2 commitsSat 1:00 — 2 commitsSat 2:00 — 2 commitsSat 3:00 — 0 commitsSat 4:00 — 1 commitsSat 5:00 — 0 commitsSat 6:00 — 0 commitsSat 7:00 — 0 commitsSat 8:00 — 0 commitsSat 9:00 — 0 commitsSat 10:00 — 2 commitsSat 11:00 — 0 commitsSat 12:00 — 2 commitsSat 13:00 — 0 commitsSat 14:00 — 0 commitsSat 15:00 — 0 commitsSat 16:00 — 0 commitsSat 17:00 — 0 commitsSat 18:00 — 0 commitsSat 19:00 — 0 commitsSat 20:00 — 1 commitsSat 21:00 — 0 commitsSat 22:00 — 1 commitsSat 23:00 — 0 commits
Commit volume by weekday and hour (UTC). Larger dots mean more commits.
DateListRankStars gained
Feb 12, 2026daily#22+156
Feb 11, 2026daily#10+267