Smart contract code for Fei Protocol and the FEI stablecoin

1. Git clone this repo: git clone [email protected]:fei-protocol/fei-protocol-core.git
2. Install dependencies: npm install
3. Set the relevant environment variables in a gitignored .env: MAINNET_ALCHEMY_API_KEY and ETH_PRIVATE_KEY. You can use the .env.example as a base
4. To run the Hardhat based unit tests, run npm run test:hardhat

Fei makes use of Forge as a smart contract development framework alongside Hardhat. To set this up run: npm run setup

Note that this has only been tested on Linux; you may encounter issues running on other operating systems.

• Node v12 or v16 (you can manage Node versions easily with NVM)

• run npm run test to run Forge based unit tests
• run npm run test:hardhat to run Hardhat based unit tests
• run npm run test:integration to run Solidity integration tests, forked from a pinned Mainnet block
• run npm run test:integration:latest to run Solidity integration tests, forked from the latest block
• run npm run test:e2e to run end-to-end/integration tests
• run npm run test:all to run all tests
• run npm run lint to lint ts files and sol files
• run npm lint:all to lint ts AND js files
• run npm run lint:sol to lint .sol files
• run npm run lint:fix to fix linting errors, if fixable automatically
• run npm run prettier:ts to run prettier and automatically format all ts files automatically
• run npm run prettier:sol to run prettier and automatically format all Solidity files automatically
• run npm run prettier to run prettier and format all files
• run npm run coverage:hardhat to run smart-contract coverage based off of all tests
• run npm run calldata to generage calldata for a proposal
• run npm run check-proposal to run tests for a specific dao proposal
• run npm run compile to compile smart contracts, if needed

See the docs

Fei Protocol is under the AGPL v3 license