https://github.com/zkemail/clave-email-recovery
Clave module for Email-based Account Recovery
https://github.com/zkemail/clave-email-recovery
Last synced: 12 months ago
JSON representation
Clave module for Email-based Account Recovery
- Host: GitHub
- URL: https://github.com/zkemail/clave-email-recovery
- Owner: zkemail
- License: mit
- Created: 2024-09-13T09:12:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-28T10:18:52.000Z (over 1 year ago)
- Last Synced: 2025-06-14T17:02:58.873Z (12 months ago)
- Language: TypeScript
- Size: 921 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audits/cantina_audit_311024.pdf
Awesome Lists containing this project
README
# Clave Email Recovery Contracts
## 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](#environment-variables).
- `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
- [Website](https://getclave.io/)
- [GitHub](https://github.com/getclave)
- [Twitter](https://twitter.com/getclave)
## 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
```