Skip to content

zkemail/clave-email-recovery

Repository files navigation

Clave Email Recovery Contracts

Clave ZkEmail

Project structure

  • /contracts: smart contracts.
  • /deploy: deployment and contract interaction scripts.
  • /test: test files
  • hardhat.config.ts: configuration file.

Commands

  • npx hardhat compile will compile the contracts, typescript bindings are generated automatically.
  • npx hardhat deploy {contract name} {constructor arguments} will deploy and verify the contract. Requires environment variable setup.
  • npm run test: run tests.

Environment variables

In order to prevent users to leak private keys, this project includes the dotenv package which is used to load environment variables. It's used to load the wallet private key, required to run the deploy script.

To use it, rename .env.example to .env and enter your private key.

PRIVATE_KEY=123cde574ccff....

Official Links

Usage of scripts

scripts/dkim_registry.ts

$ npx ts-node scripts/dkim_registry.ts --help

scripts/kill_switch.ts

$ npx ts-node scripts/kill_switch.ts --help

About

Clave module for Email-based Account Recovery

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published