Intuition V2 Smart Contracts

The Intuition V2 smart contracts for the Intuition protocol, built using Foundry.

What's Inside

• Forge: compile, test, fuzz, format, and deploy smart contracts
• [Bun]: Foundry defaults to git submodules, but this template also uses Node.js packages for managing dependencies
• Forge Std: collection of helpful contracts and utilities for testing
• Prettier: code formatter for non-Solidity files
• Solhint: linter for Solidity code

Deploy Smart Contracts on Test Network

1. Execute BaseEmissionsControllerDeploy.s.sol
   • Update the INTUITION_SEPOLIA_BASE_EMISSIONS_CONTROLLER in .env
2. Execute MultiVaultMigrationDeploy.s.sol
   • Update the INTUITION_SEPOLIA_MULTI_VAULT_MIGRATION_MODE in .env
3. Execute IntuitionDeployAndSetup.s.sol
   • Update the BASE_SEPOLIA_SATELLITE_EMISSIONS_CONTROLLER in .env
4. Execute BaseEmissionsControllerSetup.s.sol

Upgrade MultiVaultMigrationMode to MultiVault contract post-migration

1. Make sure to set INTUITION_SEPOLIA_PROXY_ADMIN in .env
2. Execute MultiVaultMigrationModeUpgrade.s.sol

Testing

forge test --match-path 'tests/unit/CoreEmissionsController/*.sol'

Usage

This is a list of the most frequently needed commands.

Build

Build the contracts:

$ forge build

Clean

Delete the build artifacts and cache directories:

$ forge clean

Compile

Compile the contracts:

$ forge build

Coverage

Get a test coverage report:

$ forge coverage

Deploy

Deploy to Anvil:

$ forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545

For this script to work, you need to have a MNEMONIC environment variable set to a valid BIP39 mnemonic.

For instructions on how to deploy to a testnet or mainnet, check out the Solidity Scripting tutorial.

Format

Format the contracts:

$ forge fmt

Gas Usage

Get a gas report:

$ forge test --gas-report

Lint

Lint the contracts:

$ bun run lint

Test

Run the tests:

$ forge test

Test Coverage

Generate test coverage and output result to the terminal:

$ bun run test:coverage

Test Coverage Report

Generate test coverage with lcov report (you'll have to open the ./coverage/index.html file in your browser, to do so simply copy paste the path):

$ bun run test:coverage:report

Note

This command requires you to have lcov installed on your machine. On macOS, you can install it with Homebrew: brew install lcov.

License

This project is licensed under MIT.

Deployed Contract Addresses:

EntryPoint: 0x334bE66b33EC87698c16D4386896f8E807d5d2D8