Shungy / flood-contracts

Contracts and bindings for the optimal routing liquidity protocol.

Flood Contracts

Getting Started

This project uses Foundry. See the book for instructions on how to install and use Foundry. We follow Nascent development process and security guidelines strictly.

Writing your first test

All you need is to import forge-std/Test.sol and then inherit it from your test contract. Forge-std's Test contract comes with a pre-instatiated cheatcodes environment, the vm. It also has support for ds-test-style logs and assertions. Finally, it supports Hardhat's console.log. The logging functionalities require -vvvv.

pragma solidity 0.8.15;

import "forge-std/Test.sol";

contract ContractTest is Test {
    function testExample() public {
        vm.roll(100);
        console.log(1);
        emit log("hi");
        assertTrue(true);
    }
}

Running Slither

If it is the first time you're using slither, follow the steps in the foundry book to set up your environment.

To run slither do slither . from the root of the project.