Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/storming0x/serpentor
A set of smart contracts tools for governance written in vyper
https://github.com/storming0x/serpentor
Last synced: 2 months ago
JSON representation
A set of smart contracts tools for governance written in vyper
- Host: GitHub
- URL: https://github.com/storming0x/serpentor
- Owner: storming0x
- License: agpl-3.0
- Created: 2022-08-11T18:57:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T23:35:45.000Z (about 1 year ago)
- Last Synced: 2024-08-03T13:03:57.616Z (6 months ago)
- Language: Solidity
- Size: 654 KB
- Stars: 53
- Watchers: 6
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-web3-tools-and-dapps - Serpentor - Introducing Vyper, the open-source smart contracts for voting and governance on the blockchain. (dApps directory / Smart Contract Templates)
README
## Serpentor
[](https://github.com/storming0x/serpentor/actions/workflows/forge-tests.yml)
[](https://github.com/storming0x/serpentor/actions/workflows/ape-tests.yml)
[](https://www.gnu.org/licenses/agpl-3.0)
A set of smart contracts tools for governance written in vyper
## Contracts
* Timelock.vy - "Vyper implementation of a timelock contract for governance"
* SerpentorBravo.vy - "Vyper implementation of a governance contract for on-chain voting on proposals and execution"
## Requirements
The test environment requires that the `vyper` compiler command can be accessed from your path
[vyper install instructions](https://vyper.readthedocs.io/en/stable/installing-vyper.html)
As an alternative you can also install [vvm](https://github.com/storming0x/vvm-rs)
and run
```bash
vvm install 0.3.6
```
## Setup
This project uses [foundry](https://github.com/foundry-rs/foundry) and [apeworx](https://github.com/ApeWorX/ape) to combine both unit test, fuzz tests with integration tests in python.
Install ape framework.
See [ape quickstart guide](https://docs.apeworx.io/ape/stable/userguides/quickstart.html)
Install [foundry](https://github.com/foundry-rs/foundry)
Install JS dependencies
```bash
npm install
```
## Build
```bash
forge build
```
## Run tests
```bash
forge test
```
## Run tests with traces
```bash
forge test -vvv
```
**Recommendation**: for faster test times install [vvm-rs](https://github.com/storming0x/vvm-rs). This will add a caching layer to the vyper compiler that improves test times with forge. E.g 32s-> 52ms in local benchmarks
## Build with ape
```bash
ape compile
```
## Run python tests
```bash
ape test
```
## Disclaimer
This is **experimental software** and is provided on an "as is" and "as available" basis **without any warranties**.
While the first release has been [audited](https://github.com/yearn/yearn-security/blob/master/audits/202209_ChainSecurity_yearn-serpentor/ChainSecurity_Yearn_Serpentor_audit.pdf), these contracts have not been widely used in production.
- Although the functionality is meant to be compatible with other well tested governance contracts, still expect changes from the original features.
- You should thoroughly read each contract you plan to use.
Use at your own risk.
## Acknowledgements
- [compound governance](https://github.com/compound-finance/compound-protocol/tree/master/contracts/Governance)
- [snekmate](https://github.com/pcaversaccio/snekmate)
- [vyperDeployer](https://github.com/0xKitsune/Foundry-Vyper/blob/main/lib/utils/VyperDeployer.sol)