Foundry Huff Neo

A foundry library for working with Huff contracts using huff-neo. Take a look at the project template to start your own project.

Highlights / Breaking changes:

• Multiple validations before deployment:
  • checking stderr with vm.tryFfi
  • validate that bytecode is larger zero and creation code length
• Use fullpath .deploy("src/Example.huff") before it was .deploy("Example")
• Removed feature to combine code on-the-fly with .with_code(...)
• Remove vm.prank from creation_code(..) to avoid vm.stopPrank(); for broadasting
• Use latest Foundry version

See the CHANGELOG for more details.

Installing

First, install the huff neo compiler (command hnc) by running (you find in the compiler repository for more options):

curl -L https://raw.githubusercontent.com/cakevm/huff-neo/main/hnc-up/install | bash

Then, install this library with forge:

forge install cakevm/foundry-huff-neo

Usage

The HuffNeoDeployer is a Solidity library that takes a filename and deploys the corresponding Huff contract, returning the address that the bytecode was deployed to. To use it, simply import it into your file by doing:

import {HuffNeoDeployer} from "foundry-huff-neo/HuffNeoDeployer.sol";

To compile contracts, you can use HuffNeoDeployer.deploy(string fileName), which takes in a single string representing the filepath. Due to the limits of Foundry/EVM this path should start from the root of your project. When running forge make sure that you are in the root directory of your project.

// SPDX-License-Identifier: Apache-2.0
pragma solidity >=0.8.0 <0.9.0;

import {HuffNeoDeployer} from "foundry-huff-neo/HuffNeoDeployer";

interface Number {
  function setNumber(uint256) external;
  function getNumber() external returns (uint256);
}

contract HuffNeoDeployerExample {
  function deploy() public {
    // Deploy a new instance of test/contracts/Number.huff
    address addr = HuffNeoDeployer.deploy("test/contracts/Number.huff");

    // To call a function on the deployed contract, create an interface and wrap the address like so
    Number number = Number(addr);
  }
}

To deploy a Huff contract with constructor arguments, you can chain commands onto the HuffNeoDeployer.

For example, to deploy the contract src/test/contracts/Constructor.huff with arguments (uint256(0x420), uint256(0x420)), you are encouraged to follow the logic defined in the deploy function of the HuffNeoDeployerArguments contract below.

// SPDX-License-Identifier: Apache-2.0
pragma solidity >=0.8.0 <0.9.0;

import {HuffNeoDeployer} from "foundry-huff-neo/HuffNeoDeployer";

interface Constructor {
  function getArgOne() external returns (address);
  function getArgTwo() external returns (uint256);
}

contract HuffNeoDeployerArguments {
  function deploy() public {
    // Deploy the contract with arguments
    address addr = HuffNeoDeployer
      .config()
      .with_args(bytes.concat(abi.encode(uint256(0x420)), abi.encode(uint256(0x420))))
      .deploy("test/contracts/Constructor.huff");

    // To call a function on the deployed contract, create an interface and wrap the address
    Constructor construct = Constructor(addr);

    // Validate we deployed the Constructor with the correct arguments
    assert(construct.getArgOne() == address(0x420));
    assert(construct.getArgTwo() == uint256(0x420));
  }

  function depreciated_deploy() public {
    address addr = HuffNeoDeployer.deploy_with_args(
      "test/contracts/Constructor.huff",
      bytes.concat(abi.encode(uint256(0x420)), abi.encode(uint256(0x420)))
    );

    // ...
  }
}

Acknowledgements

This project is a hard-fork from foundry-huff. Many thanks to all contributors and to the authors who maintained it for such a long period! Thanks to Huff-Console for the inspiration for the logging.

License

This project is licensed under the Apache 2.0 license.