Keystore

This repository provides a complete implementation of a Merkle tree Keystore, a supporting ERC-4337 account, and verifiers for common verification schemes.

Refer to the spec for a full deep dive into the implemented Keystore protocol.

Deployments

All contracts are deployed deterministically with the following addresses.

Contract	Address
Keystore	0x69C9F626b5Bd934C0F9806346682eD407FB978d3
KeystoreAccountFactory	0x625cF8EDec3f68d48D3aA385F356524B04760BE8
UserOpECDSAVerifier	0x52949503fF5c34caEa4FC98F0723ebD0c300f232
UserOpMultiSigVerifier	0x0A3BC9523755f2B4e95458E1d8ABa8441cB61927
UserOpWebAuthnVerifier	0xE19620169A26aEbC4Fe229A073639da6b009bF1a
UserOpWebAuthnCosignVerifier	0x939C10DCdA11A73eCCc563340aBE3d257859dC6d

Usage

Before being able to run any command, you need to create a .env file and set your environment variables. You can follow the example in .env.example.

Install dependencies

$ forge install
$ npm install

Build

$ forge build

Test

$ forge test

Deploy

# Keystoresource .env && forge script script/DeployKeystore.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast
# Keystore account factorysource .env && forge script script/DeployKeystoreAccountFactory.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast
# Verifierssource .env && forge script script/DeployUserOpECDSAVerifier.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast
source .env && forge script script/DeployUserOpMultiSigVerifier.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast
source .env && forge script script/DeployUserOpWebAuthnVerifier.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast
source .env && forge script script/DeployUserOpWebAuthnCosignVerifier.s.sol --rpc-url $ETH_RPC_URL --ledger --verify --broadcast

Example scripts

The following commands are useful for users and application developers to work with the Keystore protocol.

Verify configuration

A minimal script to generate and verify a UCMT using the openzeppelin Merkle tree library.

$ npm run examples:verify-ucmt