Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbx-protocol/juice-contracts-v3
⚙️ Juicebox core V3 contracts.
https://github.com/jbx-protocol/juice-contracts-v3
ethereum juicebox solidity
Last synced: 3 days ago
JSON representation
⚙️ Juicebox core V3 contracts.
- Host: GitHub
- URL: https://github.com/jbx-protocol/juice-contracts-v3
- Owner: jbx-protocol
- Created: 2022-09-11T17:14:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T09:59:05.000Z (9 months ago)
- Last Synced: 2024-10-19T06:40:18.485Z (26 days ago)
- Topics: ethereum, juicebox, solidity
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@jbx-protocol/juice-contracts-v3
- Size: 8.58 MB
- Stars: 15
- Watchers: 1
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Security: security/postmortem/5.24.2022.md
Awesome Lists containing this project
README
# juice-contracts-v3
Protocol overview, architecture, and API documentation: https://info.juicebox.money/dev/
## Develop
### Unit Tests
To run the unit tests suite (in Javascript), you'll need to run `yarn install` first then manually run Hardhat in order to enable ESM support:
```bash
node --require esm ./node_modules/.bin/hardhat test --network hardhat
```
Alternatively, you can run a local Hardhat node in another terminal using
```bash
yarn chain --network hardhat
```
then run the following:
```bash
yarn test
```
It might happens that Hardhat cannot resolve custom error (test failing on "Expecter nameOfTheError() but reverted
without a reason string"), just restart yarn chain.
### System Tests
End-to-end tests have been written in Solidity, using Foundry.
To get set up:
1. Install [Foundry](https://github.com/gakonst/foundry).
```bash
curl -L https://foundry.paradigm.xyz | sh
```
2. Install external lib(s)
```bash
git submodule update --init --recursive
```
3. Run tests:
```bash
forge test
```
4. Update Foundry periodically:
```bash
foundryup
```
Resources:
- [The Forge-Book](https://onbjerg.github.io/foundry-book/forge)
### Coverage
To check current unit tests coverage:
```bash
node --require esm ./node_modules/.bin/hardhat coverage --network hardhat
```
A few notes:
- Hardhat doesn't support [esm](https://nodejs.org/api/esm.html) yet, hence running manually with node.
- We are currently using a forked version of [solidity-coverage](https://www.npmjs.com/package/solidity-coverage) that includes optimizer settings. Ideally we will move to the maintained version after this is fixed on their end.
- Juicebox V3 codebase being quite large, Solidity Coverage might run out of memory if you modify/add parts to it. Please check [Solidity-coverage FAQ](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md) in order to address the issue.
## Deploy
Juicebox uses the [Hardhat Deploy](https://github.com/wighawag/hardhat-deploy) plugin to deploy contracts to a given network. But before using it, you must create a `./mnemonic.txt` file containing the mnemonic phrase of the wallet used to deploy. You can generate a new mnemonic using [this tool](https://github.com/itinance/mnemonics). Generate a mnemonic at your own risk.
Then, to execute the `./deploy/deploy.js` script, run the following:
```bash
npx hardhat deploy --network $network
```
\_You'll likely want to set the optimizer runs to 10000 in `./hardhat.config.js` before deploying to prevent contract size errors. The preset value of 1000000 is necessary for hardhat to run unit tests successfully. Bug about this opened [here](https://github.com/NomicFoundation/hardhat/issues/2657#issuecomment-1113890401).
Contract artifacts will be outputted to `./deployments/$network/**` and should be checked in to the repo.
## Verification
To verify the contracts on [Etherscan](https://etherscan.io), make sure you have an `ETHERSCAN_API_KEY` set in your `./.env` file. Then run the following:
```bash
npx hardhat --network $network etherscan-verify
```
This will verify all of the deployed contracts in `./deployments`.