Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Heuristic Waterfall Implementation #58

Merged
merged 10 commits into from
Aug 3, 2023
Merged

Heuristic Waterfall Implementation #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1b77344
add: heuristic waterfall contracts and tests
samparsky Jul 25, 2023
dc2504b
chore: increase fuzz runs, add test assertions
samparsky Jul 25, 2023
6d2d1c6
chore: add waterfallmodulefactory tests
samparsky Jul 31, 2023
5d64904
chore: remove unused errors
samparsky Jul 31, 2023
07d72f5
chore: add fuzz tests to waterfallfactory
samparsky Jul 31, 2023
35541de
chore: add unit and fuzz tests waterfallmodule
samparsky Aug 1, 2023
49b05cf
chore: move constants to Waterfalltesthelper
samparsky Aug 1, 2023
6afbcb8
chore: add testCan_waterfallPushAndPull erc20 test case
samparsky Aug 2, 2023
18495d1
fix: remove trailing bracket
samparsky Aug 2, 2023
3dad737
chore: add testFuzzCan_waterfallPullDepositsToRecipients fuzz test case
samparsky Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion foundry.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,7 @@ number_underscore = "thousands"
quote_style = "double"
single_line_statement_blocks = "single"
tab_width = 2
wrap_comments = true
wrap_comments = true

[fuzz]
runs = 1000
282 changes: 282 additions & 0 deletions src/test/waterfall/WaterfallFactory.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;

import "forge-std/Test.sol";
import { WaterfallModule } from "src/waterfall/WaterfallModule.sol";
import { WaterfallModuleFactory } from "src/waterfall/WaterfallModuleFactory.sol";
import {MockERC20} from "../utils/mocks/MockERC20.sol";
import {WaterfallTestHelper} from "./WaterfallTestHelper.t.sol";

contract WaterfallModuleFactoryTest is WaterfallTestHelper, Test {


event CreateWaterfallModule(
address indexed waterfallModule,
address token,
address nonWaterfallRecipient,
address[] trancheRecipient,
uint256 trancheThreshold
);

WaterfallModuleFactory waterfallFactoryModule;
MockERC20 mERC20;

address public nonWaterfallRecipient;
address[] public recipients;
uint256 public threshold;

function setUp() public {
mERC20 = new MockERC20("Test Token", "TOK", 18);
mERC20.mint(type(uint256).max);

waterfallFactoryModule = new WaterfallModuleFactory();

nonWaterfallRecipient = makeAddr("nonWaterfallRecipient");
recipients = generateTrancheRecipients(2, 10);
threshold = ETH_STAKE;
}

function testCan_createWaterfallModules() public {
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);

nonWaterfallRecipient = address(0);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);
}


function testCan_emitOnCreate() public {
// don't check deploy address
vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
ETH_ADDRESS,
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

// don't check deploy address
vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
address(mERC20),
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);

nonWaterfallRecipient = address(0);

// don't check deploy address
vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
ETH_ADDRESS,
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

// don't check deploy address
vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
address(mERC20),
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);
}

function testCannot_createWithTooFewRecipients() public {
(recipients, threshold) = generateTranches(1, 1);
recipients = generateTrancheRecipients(1, 1);

vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__Recipients.selector
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

recipients = generateTrancheRecipients(3, 10);
vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__Recipients.selector
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);
}

function testCannot_createWithInvalidThreshold() public {
recipients = generateTrancheRecipients(2, 2);
threshold = 0;

vm.expectRevert(
WaterfallModuleFactory
.InvalidWaterfall__ZeroThreshold
.selector
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

vm.expectRevert(
abi.encodeWithSelector(WaterfallModuleFactory
.InvalidWaterfall__ThresholdTooLarge
.selector,
type(uint128).max
)
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, type(uint128).max
);
}


/// -----------------------------------------------------------------------
/// Fuzzing Tests
/// ----------------------------------------------------------------------

function testFuzzCan_createWaterfallModules(
address _nonWaterfallRecipient,
uint256 recipientsSeed,
uint256 thresholdSeed
) public {
nonWaterfallRecipient = _nonWaterfallRecipient;

(recipients, threshold) = generateTranches(recipientsSeed, thresholdSeed);

vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
ETH_ADDRESS,
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

vm.expectEmit(false, true, true, true);
emit CreateWaterfallModule(
address(0xdead),
address(mERC20),
nonWaterfallRecipient,
recipients,
threshold
);
waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);
}


function testFuzzCannot_CreateWithInvalidFewRecipients(
uint8 _numRecipeints,
uint256 _receipientSeed
) public {
vm.assume(_numRecipeints != 2);
recipients = generateTrancheRecipients(_numRecipeints, _receipientSeed);

vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__Recipients.selector
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__Recipients.selector
);

waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);
}

function testFuzzCannot_CreateWithZeroThreshold(
uint256 _receipientSeed
) public {
threshold = 0;
recipients = generateTrancheRecipients(2, _receipientSeed);

vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__ZeroThreshold.selector
);
waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);

vm.expectRevert(
WaterfallModuleFactory.InvalidWaterfall__ZeroThreshold.selector
);

waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);
}

function testFuzzCannot_CreateWithLargeThreshold(
uint256 _receipientSeed,
uint256 _threshold
) public {
vm.assume(_threshold > type(uint96).max);

threshold = _threshold;
recipients = generateTrancheRecipients(2, _receipientSeed);

vm.expectRevert(
abi.encodeWithSelector(WaterfallModuleFactory
.InvalidWaterfall__ThresholdTooLarge
.selector,
_threshold
)
);

waterfallFactoryModule.createWaterfallModule(
ETH_ADDRESS, nonWaterfallRecipient, recipients, threshold
);


vm.expectRevert(
abi.encodeWithSelector(WaterfallModuleFactory
.InvalidWaterfall__ThresholdTooLarge
.selector,
_threshold
)
);

waterfallFactoryModule.createWaterfallModule(
address(mERC20), nonWaterfallRecipient, recipients, threshold
);

}


}
Loading
Loading