Introduction

This is a forge template repo so you can easily get started with Foundry with Solidity 0.7.6. To use this as a template do the following:

forge init --template https://github.com/ichidao/template-foundry-contracts-0-7 project_name

Below is instructions for using this developing and using Foundry/forge with this project.

Getting Started

Note that this is a template repository targeting Solidity 0.7 and you should create new repos and target this as a template.

Install and update foundry.

curl -L https://foundry.paradigm.xyz/ | bash
foundryup

Select the correct solidity version:

solc-select use 0.7.6

Install dependencies, set env vars and test.

git clone [email protected]:ichidao/foundry-contracts.git
cd foundry-contracts
forge install
export MAINNET_RPC_URL=https://mainnet.infura.io/v3/REPLACE_ME
export ETHERSCAN_API_KEY=REPLACE_ME
forge test -vvv --etherscan-api-key $ETHERSCAN_API_KEY

Development

Setup

export MAINNET_RPC_URL=https://mainnet.infura.io/v3/$INFURA_ID
forge install

Note that dependencies are managed via git submodules and the below is purely for reference:

forge install transmissions11/solmate
forge install OpenZeppelin/[email protected]
forge install Uniswap/[email protected]
forge install Uniswap/[email protected]
forge install ichifarm/util-contracts
forge install [email protected]:ichifarm/[email protected]

If installing the ichifarm/util-contracts doesn't work try the following:

cd lib
git submodule add [email protected]:ichifarm/util-contracts.git

Building

forge build

Testing

forge test -vvv --etherscan-api-key $ETHERSCAN_API_KEY
forge test -vvv --match-test "testMoveIchiPrice" --etherscan-api-key $ETHERSCAN_API_KEY

Analyzing

pip3 install slither-analyzer
pip3 install solc-select
solc-select install 0.7.6
solc-select use 0.7.6
slither src/contracts/ICHISpotOracleUSDUniswapV3.sol

Test Deploy to Forked Mainnet

export ALICE=0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
anvil --fork-url https://mainnet.infura.io/v3/$INFURA_ID

# --------------------------------------------------
# Deploy via scripting, not verification won't
# work in a forked environment
# --------------------------------------------------
forge script script/DeployICHISpotOracleUSDUniswapV3.mainnet.s.sol:DeployICHISpotOracleUSDUniswapV3 \
  --fork-url http://localhost:8545 \
  --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
  --broadcast \
  --etherscan-api-key $ETHERSCAN_API_KEY \
  -vvvv \
  --sender $ALICE

# --------------------------------------------------
# Deploy directly via creating, these do the same
# but the above scripting is easier
# Note verification won't work in a forked env.
# --------------------------------------------------
forge create --rpc-url http://localhost:8545 \
  --constructor-args 0x111111517e4929D3dcbdfa7CCe55d30d4B6BC4d6 10000 \
  --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 src/contracts/ICHISpotOracleUSDUniswapV3.sol:ICHISpotOracleUSDUniswapV3 \
  --etherscan-api-key $ETHERSCAN_API_KEY \

Test Deploy to Goerli

Have a test MetaMask wellet and switch it to Goerli.

Use https://goerlifaucet.com/ to send some Goerli ETH.

# --------------------------------------------------
# Deploy the contract via the Forge scripting
# --------------------------------------------------
forge script script/DeployICHISpotOracleUSDUniswapV3.goerli.s.sol:DeployICHISpotOracleUSDUniswapV3 \
  --rpc-url https://goerli.infura.io/v3/$INFURA_ID \
  -i 1 \
  --optimize \
  --optimizer-runs 200 \
  --broadcast \
  --verify \
  --etherscan-api-key $ETHERSCAN_API_KEY \
  -vvvv \
  --sender $SENDER

# --------------------------------------------------
# If the verification fails above re-run the above
# without the --broadcast to re-check the verification
# --------------------------------------------------
forge script script/DeployICHISpotOracleUSDUniswapV3.goerli.s.sol:DeployICHISpotOracleUSDUniswapV3 \
  --rpc-url https://goerli.infura.io/v3/$INFURA_ID \
  -i 1 \
  --optimize \
  --optimizer-runs 200 \
  --verify \
  --etherscan-api-key $ETHERSCAN_API_KEY \
  -vvvv \
  --sender $SENDER

# ------------------------------------------------------
# Call forge create directly, the above is preferred
# but this works too
# ------------------------------------------------------
forge create --chain goerli \
  --force \
  --optimize \
  --optimizer-runs 200 \
  --rpc-url https://goerli.infura.io/v3/$INFURA_ID \
  --constructor-args 0x9b0757aCaCA5160CEBc3D16769E4f2bCe71BFbF2 10000 \
  -i src/contracts/ICHISpotOracleUSDUniswapV3.flattened.sol:ICHISpotOracleUSDUniswapV3 \
  --etherscan-api-key $ETHERSCAN_API_KEY \
  --verify

# ------------------------------------------------------
# This shouldn't be necessary but if you want to directly
# verify a contract the below the script is an example
# ------------------------------------------------------
forge verify-contract --chain-id 5 \
  --num-of-optimizations 200 \
  --compiler-version v0.7.6+commit.7338295f \
  --constructor-args $(cast abi-encode "constructor(address,uint24)" 0x9b0757aCaCA5160CEBc3D16769E4f2bCe71BFbF2 10000) \
  0x54b0E44840032EdcD03a27e3a0cb77a64aD6204A src/contracts/ICHISpotOracleUSDUniswapV3.sol:ICHISpotOracleUSDUniswapV3 $ETHERSCAN_API_KEY

# ------------------------------------------------------
# Manually check the status of a verification GUID
# ------------------------------------------------------
forge verify-check --chain-id 5 spzud5ksw8isuglvjg1wsxtyv8y3ab71qpsfrp42rbhdqyh65c $ETHERSCAN_API_KEY

# ------------------------------------------------------
# To manually encode the constructor args
# ------------------------------------------------------
cast abi-encode "constructor(address,uint32)" 0x9b0757aCaCA5160CEBc3D16769E4f2bCe71BFbF2 10000

References:

• Verification examples
• solc versions

Debugging

forge test -vvv --debug "testMoveIchiPrice" --etherscan-api-key $ETHERSCAN_API_KEY

Deployment & Verification

Inside the utils/ directory are a few preconfigured scripts that can be used to deploy and verify contracts.

Scripts take inputs from the cli, using silent mode to hide any sensitive information.

NOTE: These scripts are required to be executable meaning they must be made executable by running chmod +x ./utils/*.

NOTE: these scripts will prompt you for the contract name and deployed addresses (when verifying). Also, they use the -i flag on forge to ask for your private key for deployment. This uses silent mode which keeps your private key from being printed to the console (and visible in logs).

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! 🎉

Troubleshooting

When deploying a contract you may see ProviderError(JsonRpcError(JsonRpcError { code: -32000, message: "execution reverted", data: None })). This could happen if you have incorrect constructor args. For example if deploying the ICHISpotOracleUSDUniswapV3 to goerli but you are using the mainnet ICHI V2 address, this error can happen.

License

AGPL-3.0-only

Acknowledgements

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