huffplate •

A Robust, Extensible Template for Huff Projects

Warning

These contracts are unaudited and are not recommended for use in production.

Although contracts have been rigorously reviewed, this is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any loss incurred through any use of this codebase.

Getting Started

Click use this template to create a new repository with this repo as the initial state.

Or, if your repo already exists, run:

forge init --template https://github.com/abigger87/huffplate
git submodule update --init --recursive
forge install

Blueprint

lib
├─ forge-std — https://github.com/foundry-rs/forge-std
├─ solmate — https://github.com/Rari-Capital/solmate
scripts
├─ Deploy.s.sol — Simple Deployment Script
src
├─ SimpleStore.sol — A Minimal Storage Contract
test
└─ SimpleStore.t.sol — SimpleStore Tests

Development

Install dependencies, compile your contracts, and test all with Foundry!

forge install
forge build
forge test

First time with Forge/Foundry?

See the official Foundry installation instructions.

Then, install the foundry toolchain installer (foundryup) with:

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:

foundryup

🎉 Foundry is installed! 🎉

Configure Foundry

Using foundry.toml, Foundry is easily configurable.

For a full list of configuration options, see the Foundry configuration documentation.

Acknowledgements

• femplate
• foundry
• solmate
• forge-std
• forge-template
• foundry-toolchain