elmoarmy / csv-contracts

Contributor Success Vaults

Getting Started

Enviroment Requirements

• node >= 16 or LTS

• forge >= 0.2.0

• git >= 2.37.0

• VS Code [recommended]

Installing Dependencies

• Use Foundry:

forge install

• Use Hardhat:

pnpm install

Running tests

• Foundry

forge test

• Hardhat

pnpm hardhat test 
# or 
pnpm test

• Use Hardhat's task framework

pnpm hardhat example

• Install libraries with Foundry which work with Hardhat. This project prefers forge/gitsubmodule installs for external contracts rather than node dependencies.

forge install rari-capital/solmate

Notes

Whenever you install new libraries, make sure to update remappings.txt file by running forge remappings > remappings.txt.

Warning

Windows enviroment users beware that redirecting powershell output to a file will default to UTF16 encoding where we expect remappings.txt to be UTF8 encoded.