https://github.com/generationsoftware/erc5164-interfaces
https://github.com/generationsoftware/erc5164-interfaces
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/generationsoftware/erc5164-interfaces
- Owner: GenerationSoftware
- Created: 2023-08-23T22:14:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-07T23:11:06.000Z (over 2 years ago)
- Last Synced: 2025-01-12T17:47:23.385Z (about 1 year ago)
- Language: Solidity
- Size: 135 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ERC5164 Interfaces
A project that includes the core [ERC5164](https://eips.ethereum.org/EIPS/eip-5164) interfaces:
- interfaces/IMessageDispatcher
- interfaces/IMessageExecutor
And a helper contract:
- abstract/ExecutorAware
## Getting started
The easiest way to get started is by clicking the [Use this template](https://github.com/pooltogether/foundry-template/generate) button at the top right of this page.
If you prefer to go the CLI way:
```
forge init my-project --template https://github.com/pooltogether/foundry-template
```
## Development
### Installation
You may have to install the following tools to use this repository:
- [Foundry](https://github.com/foundry-rs/foundry) to compile and test contracts
- [direnv](https://direnv.net/) to handle environment variables
- [lcov](https://github.com/linux-test-project/lcov) to generate the code coverage report
Install dependencies:
```
npm i
```
### Env
Copy `.envrc.example` and write down the env variables needed to run this project.
```
cp .envrc.example .envrc
```
Once your env variables are setup, load them with:
```
direnv allow
```
### Compile
Run the following command to compile the contracts:
```
npm run compile
```
### Coverage
Forge is used for coverage, run it with:
```
npm run coverage
```
You can then consult the report by opening `coverage/index.html`:
```
open coverage/index.html
```
### Code quality
[Husky](https://typicode.github.io/husky/#/) is used to run [lint-staged](https://github.com/okonet/lint-staged) and tests when committing.
[Prettier](https://prettier.io) is used to format TypeScript and Solidity code. Use it by running:
```
npm run format
```
[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:
```
npm run hint
```
### CI
A default Github Actions workflow is setup to execute on push and pull request.
It will build the contracts and run the test coverage.
You can modify it here: [.github/workflows/coverage.yml](.github/workflows/coverage.yml)
For the coverage to work, you will need to setup the `MAINNET_RPC_URL` repository secret in the settings of your Github repository.