https://github.com/zkemail/email-tx-builder-template
https://github.com/zkemail/email-tx-builder-template
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zkemail/email-tx-builder-template
- Owner: zkemail
- License: mit
- Created: 2024-10-24T13:04:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-06T14:22:21.000Z (over 1 year ago)
- Last Synced: 2025-08-08T15:50:56.899Z (10 months ago)
- Language: TypeScript
- Size: 199 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generic Relayer Template
This template provides an example Solidity contract leveraging [email-tx-builder](https://github.com/zkemail/email-tx-builder/tree/main) and a CLI to use our generic relayer with the example contract in `contracts` and `ts` direcotries, respectively.
## Requirements
- Newer than or equal to `node 20.0.0`.
- Newer than or equal to `forge 0.2.0 (13497a5)`.
## Usage
To use this template, you first need to deploy an `EmitEmailCommand` contract following an instruction in [contracts/README.md](contracts/README.md).
You can then use the CLI as described in [ts/README.md](ts/README.md).