https://github.com/refcell/evolve
On-Chain Experiment Hub
https://github.com/refcell/evolve
Last synced: 9 months ago
JSON representation
On-Chain Experiment Hub
- Host: GitHub
- URL: https://github.com/refcell/evolve
- Owner: refcell
- License: agpl-3.0
- Created: 2022-03-31T16:50:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T19:41:54.000Z (almost 4 years ago)
- Last Synced: 2025-05-05T15:54:40.466Z (9 months ago)
- Language: Solidity
- Size: 338 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# evolve • [](https://github.com/abigger87/evolve/actions/workflows/tests.yml) [](https://github.com/abigger87/evolve/actions/workflows/lints.yml)  
An On-Chain Experimentation Hub.
## Overview
This repo contains infrastructure for an on-chain experimentation hub. The entrypoint is [`Evolve.sol`](./src/Evolve.sol), an ERC20 to orchestrate protocol governance.
`Evolve` is deployed on mainnet at [`0x14813e8905a0f782f796a5273d2efbe6551100d6`](https://etherscan.io/address/0x14813e8905a0f782f796a5273d2efbe6551100d6).
## Blueprint
```ml
lib
├─ ds-test — https://github.com/dapphub/ds-test
├─ forge-std — https://github.com/brockelmore/forge-std
├─ solmate — https://github.com/Rari-Capital/solmate
src
├─ tests
│ └─ ...
└─ Evolve — The main hub erc20 token
```
## Installation
To install with [Foundry](https://github.com/gakonst/foundry):
```
forge install abigger87/evolve
```
To install with [DappTools](https://github.com/dapphub/dapptools):
```
dapp install abigger87/evolve
```
## Development
**Setup & Dependencies**
```bash
make
```
**Compilation**
```bash
make build
```
**Testing**
```bash
make test
```
**Deployment & Verification**
Inside the [`scripts/`](./scripts/) directory are a few preconfigured scripts that can be used to deploy and verify contracts.
Scripts take inputs from the cli, using silent mode to hide any sensitive information.
NOTE: These scripts are required to be _executable_ meaning they must be made executable by running `chmod +x ./scripts/*`.
NOTE: For local deployment, make sure to run `yarn` or `npm install` before running the `deploy_local.sh` script. Otherwise, hardhat will error due to missing dependencies.
NOTE: these scripts will prompt you for the contract name and deployed addresses (when verifying). Also, they use the `-i` flag on `forge` to ask for your private key for deployment. This uses silent mode which keeps your private key from being printed to the console (and visible in logs).
### First time with Forge/Foundry?
See the official Foundry installation [instructions](https://github.com/gakonst/foundry/blob/master/README.md#installation).
Then, install the [foundry](https://github.com/gakonst/foundry) toolchain installer (`foundryup`) with:
```bash
curl -L https://foundry.paradigm.xyz | bash
```
Now that you've installed the `foundryup` binary,
anytime you need to get the latest `forge` or `cast` binaries,
you can run `foundryup`.
So, simply execute:
```bash
foundryup
```
🎉 Foundry is installed! 🎉
### Writing Tests with Foundry
With [Foundry](https://github.com/gakonst/foundry), tests are written in Solidity! 🥳
Create a test file for your contract in the `src/tests/` directory.
To learn more about writing tests in Solidity for Foundry and Dapptools, reference Rari Capital's [solmate](https://github.com/Rari-Capital/solmate/tree/main/src/test) repository largely created by [@transmissions11](https://twitter.com/transmissions11).
### Configure Foundry
Using [foundry.toml](./foundry.toml), Foundry is easily configurable.
For a full list of configuration options, see the Foundry [configuration documentation](https://github.com/gakonst/foundry/blob/master/config/README.md#all-options).
## License
[AGPL-3.0-only](https://github.com/abigger87/evolve/blob/master/LICENSE)
## Acknowledgements
- [femplate](https://github.com/abigger87/femplate)
- [foundry](https://github.com/gakonst/foundry)
- [solmate](https://github.com/Rari-Capital/solmate)
- [forge-std](https://github.com/brockelmore/forge-std)
- [clones-with-immutable-args](https://github.com/wighawag/clones-with-immutable-args).
- [foundry-toolchain](https://github.com/onbjerg/foundry-toolchain) by [onbjerg](https://github.com/onbjerg).
- [forge-template](https://github.com/FrankieIsLost/forge-template) by [FrankieIsLost](https://github.com/FrankieIsLost).
- [Georgios Konstantopoulos](https://github.com/gakonst) for [forge-template](https://github.com/gakonst/forge-template) resource.
## Disclaimer
_These smart contracts are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk._