Huff Project Template

Template repository for getting started quickly with Huff projects using Foundry

                                        .&%@&&&&&&
                                    ,..&&&@&&&&&@
                                    @&*&&&&@&&&&@&&
                                    &&&&&& @&&&&&&&@
                                    &&&&&%&&&&&&&&&&&
                                    &&&&&&&&&   &&&&,
                                    &@&&&&&&&&@(
                                    .&/&&&&&&&@&&&
                                        &&&&&&&&&&& &@
                                        &&&&&&&&&&&&
                                        @&&&&&&&&&/
                                        &&&&&&&&&
                                        &&&&&&&&&&&&&
                                    /&&&&&&&&&&&@&&&@@
                                ██   ██ ██    ██ ███████ ███████
                                ██   ██ ██    ██ ██      ██
                                ███████ ██    ██ █████   █████
                                ██   ██ ██    ██ ██      ██
                                ██   ██  ██████  ██      ██

Getting Started

Click "Use this template" on GitHub to create a new repository with this repo as the initial state.

Once you've cloned and entered into your repository, you need to install the necessary dependencies. In order to do so, simply run:

make

If you'd like to specify a Huff compiler version, you can run:

make version=x.y.z

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.