Note this codebase is experimental and is not ready to be used in production, it is meant as a learning resource.
Generated with: Versatile Huff Project Template using Foundry.
Getting Started
Requirements
The following will need to be installed in order to use this template. Please follow the links and instructions.
- Git
- You'll know you've done it right if you can run
git --version
- You'll know you've done it right if you can run
- Foundry / Foundryup
- This will install
forge
,cast
, andanvil
- You can test you've installed them right by running
forge --version
and get an output like:forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)
- To get the latest of each, just run
foundryup
- This will install
- Huff Compiler
- You'll know you've done it right if you can run
huffc --version
and get an output like:huffc 0.2.0
- You'll know you've done it right if you can run
Quickstart
- Clone this repo or use template
Click "Use this template" on GitHub to create a new repository with this repo as the initial state.
Or run:
git clone https://github.com/huff-language/huff-project-template
cd huff-project-template
- Install dependencies
Once you've cloned and entered into your repository, you need to install the necessary dependencies. In order to do so, simply run:
forge install
- Build & Test
To build and test your contracts, you can run:
forge build
forge test
For more information on how to use Foundry, check out the Foundry Github Repository and the foundry-huff library repository.
Blueprint
lib
├─ forge-std — https://github.com/foundry-rs/forge-std
├─ foundry-huff — https://github.com/huff-language/foundry-huff
├─ solmate - https://github.com/transmissions11/solmate
src
├─ utils
| ├─ signedWadMath.huff - An extension of https://github.com/pentagonxyz/huffmate/blob/main/src/math/FixedPointMath.huff
| ├─ testHelpers.huff - A collection of helpers for writing huff tests
| ├─ testWadMath.t.huff - Huff tests for signedWadMath huff methods
| └─ returnUtils.huff - Utils for wrapper contracts
├─ wrappers
| ├─ LinearVRGDAWrapper.huff - A testing wrapper for linear VRGDAs
| └─ LogisticVRGDAWrapper.huff - A testing wrapper for linear VRGDAs
├─ LinearVRGDA.huff - A linear VRGDA implementation
├─ LogisticVRGDA.huff - A logistic VRGDA implementation
└─ VRGDA.huff - A VRGDA implementation
License
Acknowledgements
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.