Skip to content

Commit

Permalink
ObolCollector implementation (#116)
Browse files Browse the repository at this point in the history 
* feat: add obol collector impl

* feat: stakewise split - wip

* feat: stakewise tests

* chore: forge fmt

* chore: add obol collector implementation and tests

* chore(test): update fuzz test implementation

* chore: passed vaultToken for stakewise implementation

* feat: ethersfi split implementation

* chore: file rename

* chore: renamed EthersFi to EtherFi

* chore: base split implementation

* chore: ran formatter on Base contracts

* feat: base split & split factory implementation + refactoring

* chore: fixed tests

---------

Co-authored-by: cosminobol <[email protected]>
  • Loading branch information
@samparsky @cosminobol
samparsky and cosminobol authored Mar 27, 2024
1 parent 432294f commit 29de65a
Show file tree
Hide file tree
Showing 35 changed files with 1,179 additions and 482 deletions.
1 change: 1 addition & 0 deletions foundry.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ fs_permissions = [{ access = "read-write", path = "./"}]
[rpc_endpoints]
goerli = "${GOERLI_RPC_URL}"
mainnet = "${MAINNET_RPC_URL}"
sepolia = "${SEPOLIA_RPC_URL}"
# See more config options https://github.com/gakonst/foundry/tree/master/config

[fmt]
Expand Down
14 changes: 4 additions & 10 deletions script/OWRFactoryScript.s.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,13 @@ import "forge-std/Script.sol";
import {OptimisticWithdrawalRecipientFactory} from "src/owr/OptimisticWithdrawalRecipientFactory.sol";

contract OWRFactoryScript is Script {
function run(
string memory _name,
address _ensReverseRegistrar,
address _ensOwner
) external {
function run(string memory _name, address _ensReverseRegistrar, address _ensOwner) external {
uint256 privKey = vm.envUint("PRIVATE_KEY");

vm.startBroadcast(privKey);

new OptimisticWithdrawalRecipientFactory{salt: keccak256("obol.owrFactory.v1")}(
_name,
_ensReverseRegistrar,
_ensOwner
_name, _ensReverseRegistrar, _ensOwner
);

vm.stopBroadcast();
Expand Down
249 changes: 120 additions & 129 deletions script/ObolLidoSetupScript.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,23 @@ pragma solidity 0.8.19;

import "forge-std/Script.sol";
import {ISplitMain, SplitConfiguration} from "src/interfaces/ISplitMain.sol";
import { ObolLidoSplitFactory } from "src/lido/ObolLidoSplitFactory.sol";

import {ObolLidoSplitFactory} from "src/lido/ObolLidoSplitFactory.sol";

/// @title ObolLidoScript
/// @author Obol
/// @notice Creates Split and ObolLidoSplit Adddresses
///
/// @dev Takes a json file following the format defined at ./data/lido-data-sample.json
/// @dev Takes a json file following the format defined at ./data/lido-data-sample.json
/// and deploys split and ObolLido split contracts.
///
/// It outputs the result of the script to "./result.json"
///
/// NOTE: It's COMPULSORY the json file supplied follows the arrangement format defined
/// in the sample file else the json parse will fail.
/// NOTE: It's COMPULSORY the json file supplied follows the arrangement format defined
/// in the sample file else the json parse will fail.
///
///
/// To Run
///
///
/// Step 1 fill in the appropriate details for env vars
/// > cp .env.deployment .env
///
Expand All @@ -29,136 +28,128 @@ import { ObolLidoSplitFactory } from "src/lido/ObolLidoSplitFactory.sol";
///
/// Step 3 Run forge script to simulate the execution of the transaction
///
/// > forge script script/ObolLidoSetupScript.sol:ObolLidoSetupScript --fork-url $RPC_URL -vvvv --sig "run(string,address,address)" "<PATH_TO_JSON_FILE e.g. ./script/data/lido-data-sample.json>" $SPLITMAIN $OBOL_LIDO_SPLIT_FACTORY
/// > forge script script/ObolLidoSetupScript.sol:ObolLidoSetupScript --fork-url $RPC_URL -vvvv --sig
/// "run(string,address,address)" "<PATH_TO_JSON_FILE e.g. ./script/data/lido-data-sample.json>" $SPLITMAIN
/// $OBOL_LIDO_SPLIT_FACTORY
///
/// add --broadcast flag to broadcast to the public blockchain


contract ObolLidoSetupScript is Script {

/// @dev invalid split accounts configuration
error InvalidSplit__TooFewAccounts(uint256 accountsLength);
/// @notice Array lengths of accounts & percentAllocations don't match
/// (`accountsLength` != `allocationsLength`)
/// @param accountsLength Length of accounts array
/// @param allocationsLength Length of percentAllocations array
error InvalidSplit__AccountsAndAllocationsMismatch(uint256 accountsLength, uint256 allocationsLength);
/// @notice Invalid percentAllocations sum `allocationsSum` must equal
/// `PERCENTAGE_SCALE`
/// @param allocationsSum Sum of percentAllocations array
error InvalidSplit__InvalidAllocationsSum(uint32 allocationsSum);
/// @notice Invalid accounts ordering at `index`
/// @param index Index of out-of-order account
error InvalidSplit__AccountsOutOfOrder(uint256 index);
/// @notice Invalid percentAllocation of zero at `index`
/// @param index Index of zero percentAllocation
error InvalidSplit__AllocationMustBePositive(uint256 index);
/// @notice Invalid distributorFee `distributorFee` cannot be greater than
/// 10% (1e5)
/// @param distributorFee Invalid distributorFee amount
error InvalidSplit__InvalidDistributorFee(uint32 distributorFee);
/// @notice Array of accounts size
/// @param size acounts size
error InvalidSplit__TooManyAccounts(uint256 size);

uint256 internal constant PERCENTAGE_SCALE = 1e6;
uint256 internal constant MAX_DISTRIBUTOR_FEE = 1e5;


struct JsonSplitConfiguration {
address[] accounts;
address controller;
uint32 distributorFee;
uint32[] percentAllocations;
/// @dev invalid split accounts configuration
error InvalidSplit__TooFewAccounts(uint256 accountsLength);
/// @notice Array lengths of accounts & percentAllocations don't match
/// (`accountsLength` != `allocationsLength`)
/// @param accountsLength Length of accounts array
/// @param allocationsLength Length of percentAllocations array
error InvalidSplit__AccountsAndAllocationsMismatch(uint256 accountsLength, uint256 allocationsLength);
/// @notice Invalid percentAllocations sum `allocationsSum` must equal
/// `PERCENTAGE_SCALE`
/// @param allocationsSum Sum of percentAllocations array
error InvalidSplit__InvalidAllocationsSum(uint32 allocationsSum);
/// @notice Invalid accounts ordering at `index`
/// @param index Index of out-of-order account
error InvalidSplit__AccountsOutOfOrder(uint256 index);
/// @notice Invalid percentAllocation of zero at `index`
/// @param index Index of zero percentAllocation
error InvalidSplit__AllocationMustBePositive(uint256 index);
/// @notice Invalid distributorFee `distributorFee` cannot be greater than
/// 10% (1e5)
/// @param distributorFee Invalid distributorFee amount
error InvalidSplit__InvalidDistributorFee(uint32 distributorFee);
/// @notice Array of accounts size
/// @param size acounts size
error InvalidSplit__TooManyAccounts(uint256 size);

uint256 internal constant PERCENTAGE_SCALE = 1e6;
uint256 internal constant MAX_DISTRIBUTOR_FEE = 1e5;

struct JsonSplitConfiguration {
address[] accounts;
address controller;
uint32 distributorFee;
uint32[] percentAllocations;
}

function run(string memory jsonFilePath, address splitMain, address obolLidoSplitFactory) external {
uint256 privKey = vm.envUint("PRIVATE_KEY");

string memory file = vm.readFile(jsonFilePath);
bytes memory parsedJson = vm.parseJson(file);
JsonSplitConfiguration[] memory configuration = abi.decode(parsedJson, (JsonSplitConfiguration[]));
_validateInputJson(configuration);

// deploy the split and obol script
string memory jsonKey = "lidoObolDeploy";
string memory finalJSON;

for (uint256 j = 0; j < configuration.length; j++) {
string memory objKey = vm.toString(j);
// deploy split
JsonSplitConfiguration memory currentConfiguration = configuration[j];

vm.startBroadcast(privKey);

address split = ISplitMain(splitMain).createSplit(
currentConfiguration.accounts,
currentConfiguration.percentAllocations,
currentConfiguration.distributorFee,
currentConfiguration.controller
);

// create obol split
address obolLidoSplitAdress = ObolLidoSplitFactory(obolLidoSplitFactory).createCollector(address(0), split);

vm.stopBroadcast();

vm.serializeAddress(objKey, "splitAddress", split);
string memory repsonse = vm.serializeAddress(objKey, "obolLidoSplitAddress", obolLidoSplitAdress);

finalJSON = vm.serializeString(jsonKey, objKey, repsonse);
}

function run(
string memory jsonFilePath,
address splitMain,
address obolLidoSplitFactory
) external {
uint256 privKey = vm.envUint("PRIVATE_KEY");

string memory file = vm.readFile(jsonFilePath);
bytes memory parsedJson = vm.parseJson(file);
JsonSplitConfiguration[] memory configuration = abi.decode(parsedJson, (JsonSplitConfiguration[]));
_validateInputJson(configuration);

// deploy the split and obol script
string memory jsonKey = "lidoObolDeploy";
string memory finalJSON;

for (uint256 j = 0; j < configuration.length; j++) {
string memory objKey = vm.toString(j);
// deploy split
JsonSplitConfiguration memory currentConfiguration = configuration[j];

vm.startBroadcast(privKey);

address split = ISplitMain(splitMain).createSplit(
currentConfiguration.accounts,
currentConfiguration.percentAllocations,
currentConfiguration.distributorFee,
currentConfiguration.controller
);

// create obol split
address obolLidoSplitAdress = ObolLidoSplitFactory(obolLidoSplitFactory).createSplit(
split
);

vm.stopBroadcast();

vm.serializeAddress(objKey, "splitAddress", split);
string memory repsonse = vm.serializeAddress(objKey, "obolLidoSplitAddress", obolLidoSplitAdress);

finalJSON = vm.serializeString(
jsonKey,
objKey,
repsonse
);
}

vm.writeJson(finalJSON, "./result.json");
}
vm.writeJson(finalJSON, "./result.json");
}

function _validateInputJson(JsonSplitConfiguration[] memory configuration) internal pure {
for (uint256 i = 0; i < configuration.length; i++) {
address[] memory splitAddresses = configuration[i].accounts;
uint32[] memory percents = configuration[i].percentAllocations;
uint32 distributorFee = configuration[i].distributorFee;
_validSplit(splitAddresses, percents, distributorFee);
}
function _validateInputJson(JsonSplitConfiguration[] memory configuration) internal pure {
for (uint256 i = 0; i < configuration.length; i++) {
address[] memory splitAddresses = configuration[i].accounts;
uint32[] memory percents = configuration[i].percentAllocations;
uint32 distributorFee = configuration[i].distributorFee;
_validSplit(splitAddresses, percents, distributorFee);
}
}

function _validSplit(address[] memory accounts, uint32[] memory percentAllocations, uint32 distributorFee)
internal
pure
{
if (accounts.length < 2) revert InvalidSplit__TooFewAccounts(accounts.length);
if (accounts.length != percentAllocations.length) {
revert InvalidSplit__AccountsAndAllocationsMismatch(accounts.length, percentAllocations.length);
}
// _getSum should overflow if any percentAllocation[i] < 0
if (_getSum(percentAllocations) != PERCENTAGE_SCALE) {
revert InvalidSplit__InvalidAllocationsSum(_getSum(percentAllocations));
}
unchecked {
// overflow should be impossible in for-loop index
// cache accounts length to save gas
uint256 loopLength = accounts.length - 1;
for (uint256 i = 0; i < loopLength; ++i) {
// overflow should be impossible in array access math
if (accounts[i] >= accounts[i + 1]) revert InvalidSplit__AccountsOutOfOrder(i);
if (percentAllocations[i] == uint32(0)) revert InvalidSplit__AllocationMustBePositive(i);
}
// overflow should be impossible in array access math with validated
// equal array lengths
if (percentAllocations[loopLength] == uint32(0)) revert InvalidSplit__AllocationMustBePositive(loopLength);
}
if (distributorFee > MAX_DISTRIBUTOR_FEE) revert InvalidSplit__InvalidDistributorFee(distributorFee);
}

function _validSplit(address[] memory accounts, uint32[] memory percentAllocations, uint32 distributorFee) internal pure {
if (accounts.length < 2) revert InvalidSplit__TooFewAccounts(accounts.length);
if (accounts.length != percentAllocations.length) {
revert InvalidSplit__AccountsAndAllocationsMismatch(accounts.length, percentAllocations.length);
}
// _getSum should overflow if any percentAllocation[i] < 0
if (_getSum(percentAllocations) != PERCENTAGE_SCALE) {
revert InvalidSplit__InvalidAllocationsSum(_getSum(percentAllocations));
}
unchecked {
// overflow should be impossible in for-loop index
// cache accounts length to save gas
uint256 loopLength = accounts.length - 1;
for (uint256 i = 0; i < loopLength; ++i) {
// overflow should be impossible in array access math
if (accounts[i] >= accounts[i + 1]) revert InvalidSplit__AccountsOutOfOrder(i);
if (percentAllocations[i] == uint32(0)) revert InvalidSplit__AllocationMustBePositive(i);
}
// overflow should be impossible in array access math with validated
// equal array lengths
if (percentAllocations[loopLength] == uint32(0)) revert InvalidSplit__AllocationMustBePositive(loopLength);
}
if (distributorFee > MAX_DISTRIBUTOR_FEE) revert InvalidSplit__InvalidDistributorFee(distributorFee);
}

function _getSum(uint32[] memory percents) internal pure returns (uint32 sum) {
for (uint32 i = 0; i < percents.length; i++) {
sum += percents[i];
}
function _getSum(uint32[] memory percents) internal pure returns (uint32 sum) {
for (uint32 i = 0; i < percents.length; i++) {
sum += percents[i];
}
}
}
}
28 changes: 9 additions & 19 deletions script/ObolLidoSplitFactoryScript.s.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,15 @@ import {ObolLidoSplitFactory} from "src/lido/ObolLidoSplitFactory.sol";
import {ERC20} from "solmate/tokens/ERC20.sol";

contract ObolLidoSplitFactoryScript is Script {
function run(
address _feeRecipient,
uint256 _feeShare,
address _stETH,
address _wstETH
) external {
uint256 privKey = vm.envUint("PRIVATE_KEY");
vm.startBroadcast(privKey);

ERC20 stETH = ERC20(_stETH);
ERC20 wstETH = ERC20(_wstETH);
function run(address _feeRecipient, uint256 _feeShare, address _stETH, address _wstETH) external {
uint256 privKey = vm.envUint("PRIVATE_KEY");
vm.startBroadcast(privKey);

new ObolLidoSplitFactory{salt: keccak256("obol.lidoSplitFactory.v1")}(
_feeRecipient,
_feeShare,
stETH,
wstETH
);
ERC20 stETH = ERC20(_stETH);
ERC20 wstETH = ERC20(_wstETH);

vm.stopBroadcast();
}
new ObolLidoSplitFactory{salt: keccak256("obol.lidoSplitFactory.v1")}(_feeRecipient, _feeShare, stETH, wstETH);

vm.stopBroadcast();
}
}
Loading

0 comments on commit 29de65a

Please sign in to comment.