mirror of
https://github.com/getwax/wax.git
synced 2026-01-08 22:57:58 -05:00
Update plugins README
This commit is contained in:
@@ -8,17 +8,7 @@ Please note, these plugins are in a pre-alpha state and are not ready for produc
|
||||
2. Run `yarn submodules` to initialize git submodules
|
||||
3. Run `yarn` to install hardhat dependencies
|
||||
4. Run `forge install` to install foundry dependencies
|
||||
|
||||
## (optional) ZKP Plugins
|
||||
|
||||
Link `zkp` directory for ZKP based plugins. Make sure you have [circom installed](../zkp/README.md).
|
||||
```bash
|
||||
cd ../zkp
|
||||
yarn
|
||||
yarn link
|
||||
cd ../plugins
|
||||
yarn link '@getwax/circuits'
|
||||
```
|
||||
5. Run `cp .env.example .env` to create an `.env` file with the values from `.env.example`
|
||||
|
||||
## Build & generate Typechain definitions
|
||||
|
||||
@@ -29,20 +19,14 @@ yarn build
|
||||
## Forge tests
|
||||
|
||||
```bash
|
||||
forge test
|
||||
forge test --no-match-path test/unit/safe/SafeZkEmailRecoveryPlugin.t.sol -vvv
|
||||
```
|
||||
|
||||
## Hardhat tests
|
||||
|
||||
To run the hardhat tests, you'll need to run a node and a bundler as some of them are integration tests:
|
||||
|
||||
1. Create an `.env` file with the values from `.env.example`:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Start a geth node, fund accounts, deploy Safe contracts, and start a bundler:
|
||||
1. Start a geth node, fund accounts, deploy Safe contracts, and start a bundler:
|
||||
|
||||
```bash
|
||||
# Note: This uses geth. There is also start-hardhat.sh for using hardhat. See
|
||||
@@ -50,7 +34,7 @@ cp .env.example .env
|
||||
./script/start.sh
|
||||
```
|
||||
|
||||
3. Run the plugin tests:
|
||||
2. Run the plugin tests:
|
||||
|
||||
```bash
|
||||
yarn hardhat test
|
||||
|
||||
Reference in New Issue
Block a user