Skip to content

Commit

Permalink
Updates Eigenlayer integration (#114)
Browse files Browse the repository at this point in the history 
* chore: change split to owr

* chore: fix comments

* chore: change eigenlayer pod splitter to owr

* chore: add withdrawal address; add owr and split integration tests

* chore: apply forge fmt

* chore: add natspec comment

* chore: add additional test cases

* chore: fix eigenlayertestbase name

* chore: fix path

* chore: fix path 2
  • Loading branch information
@samparsky
samparsky authored Feb 19, 2024
1 parent 45ceb17 commit 1524e5a
Show file tree
Hide file tree
Showing 7 changed files with 706 additions and 567 deletions.
1 change: 1 addition & 0 deletions foundry.toml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[profile.default]
src = 'src'
test = 'src/test'
out = 'out'
libs = ['lib']
remappings = [
Expand Down
308 changes: 145 additions & 163 deletions src/eigenlayer/ObolEigenLayerPodController.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,173 +4,155 @@ pragma solidity 0.8.19;
import {SafeTransferLib} from "solmate/utils/SafeTransferLib.sol";
import {ERC20} from "solmate/tokens/ERC20.sol";
import {Ownable} from "solady/auth/Ownable.sol";
import {
IEigenLayerUtils,
IEigenPodManager,
IDelayedWithdrawalRouter
} from "../interfaces/IEigenLayer.sol";

import {IEigenLayerUtils, IEigenPodManager, IDelayedWithdrawalRouter} from "../interfaces/IEigenLayer.sol";

/// @title ObolEigenLayerPodController
/// @author Obol Labs
/// @notice A contract for controlling an Eigenpod and withdrawing the balance into an Obol Split
/// @dev The address returned should be used as the EigenPodController address
contract ObolEigenLayerPodController {

/// @dev returned on failed call
error CallFailed(bytes data);
/// @dev If Invalid fee setup
error Invalid_FeeSetup();
/// @dev user unauthorized
error Unauthorized();
/// @dev contract already initialized
error AlreadyInitialized();

/// @dev Emiited on intialize
event Initialized(address eigenPod, address owner);

/// -----------------------------------------------------------------------
/// libraries
/// -----------------------------------------------------------------------
using SafeTransferLib for address;
using SafeTransferLib for ERC20;

uint256 internal constant PERCENTAGE_SCALE = 1e5;

/// -----------------------------------------------------------------------
/// storage - immutables
/// -----------------------------------------------------------------------

/// @notice address of Eigenlayer delegation manager
/// @dev This is the address of the delegation manager transparent proxy
address public immutable eigenLayerDelegationManager;

/// @notice address of EigenLayerPod Manager
/// @dev this is the pod manager transparent proxy
IEigenPodManager public immutable eigenLayerPodManager;

/// @notice address of delay withdrawal router
IDelayedWithdrawalRouter public immutable delayedWithdrawalRouter;

/// @notice fee address
address public immutable feeRecipient;

/// @notice fee share. Represented as an integer from 1->10000 (100%)
uint256 public immutable feeShare;

/// -----------------------------------------------------------------------
/// storage
/// -----------------------------------------------------------------------

/// @notice address of deployed Eigen pod
address public eigenPod;

/// @notice address of a splitter
address public split;

/// @notice address of owner
address public owner;


modifier onlyOwner() {
if (msg.sender != owner) {
revert Unauthorized();
}
_;
}

constructor(
address recipient,
uint256 share,
address delegationManager,
address eigenPodManager,
address withdrawalRouter
) {
if (recipient != address(0) && share == 0) revert Invalid_FeeSetup();

feeRecipient = recipient;
feeShare = share;
eigenLayerDelegationManager = delegationManager;
eigenLayerPodManager = IEigenPodManager(eigenPodManager);
delayedWithdrawalRouter = IDelayedWithdrawalRouter(withdrawalRouter);
/// @dev returned on failed call
error CallFailed(bytes data);
/// @dev If Invalid fee setup
error Invalid_FeeSetup();
/// @dev Invalid fee share
error Invalid_FeeShare();
/// @dev user unauthorized
error Unauthorized();
/// @dev contract already initialized
error AlreadyInitialized();

/// @dev Emiited on intialize
event Initialized(address eigenPod, address owner);

/// -----------------------------------------------------------------------
/// libraries
/// -----------------------------------------------------------------------
using SafeTransferLib for address;
using SafeTransferLib for ERC20;

uint256 internal constant PERCENTAGE_SCALE = 1e5;

/// -----------------------------------------------------------------------
/// storage - immutables
/// -----------------------------------------------------------------------

/// @notice address of Eigenlayer delegation manager
/// @dev This is the address of the delegation manager transparent proxy
address public immutable eigenLayerDelegationManager;

/// @notice address of EigenLayerPod Manager
/// @dev this is the pod manager transparent proxy
IEigenPodManager public immutable eigenLayerPodManager;

/// @notice address of delay withdrawal router
IDelayedWithdrawalRouter public immutable delayedWithdrawalRouter;

/// @notice fee address
address public immutable feeRecipient;

/// @notice fee share. Represented as an integer from 1->10000 (100%)
uint256 public immutable feeShare;

/// -----------------------------------------------------------------------
/// storage
/// -----------------------------------------------------------------------

/// @notice address of deployed Eigen pod
address public eigenPod;

/// @notice address of a withdrawalAddress
address public withdrawalAddress;

/// @notice address of owner
address public owner;

modifier onlyOwner() {
if (msg.sender != owner) revert Unauthorized();
_;
}

constructor(
address recipient,
uint256 share,
address delegationManager,
address eigenPodManager,
address withdrawalRouter
) {
if (recipient != address(0) && share == 0) revert Invalid_FeeSetup();
if (share > PERCENTAGE_SCALE) revert Invalid_FeeShare();

feeRecipient = recipient;
feeShare = share;
eigenLayerDelegationManager = delegationManager;
eigenLayerPodManager = IEigenPodManager(eigenPodManager);
delayedWithdrawalRouter = IDelayedWithdrawalRouter(withdrawalRouter);
}

/// @dev Enables contract to receive ETH
// defined on the clone implementation
// receive() external payable {}

/// @notice initializes the controller
/// @param _owner address of the controller owner
/// @param _withdrawalAddress address to receive funds
function initialize(address _owner, address _withdrawalAddress) external {
if (owner != address(0)) revert AlreadyInitialized();

eigenPod = eigenLayerPodManager.createPod();
owner = _owner;
withdrawalAddress = _withdrawalAddress;

emit Initialized(eigenPod, _owner);
}

/// @notice Call the eigenPod contract
/// @param data to call eigenPod contract
function callEigenPod(bytes calldata data) external payable onlyOwner {
_executeCall(address(eigenPod), msg.value, data);
}

/// @notice Call the Eigenlayer delegation Manager contract
/// @param data to call eigenPod contract
function callDelegationManager(bytes calldata data) external payable onlyOwner {
_executeCall(address(eigenLayerDelegationManager), msg.value, data);
}

/// @notice Call the Eigenlayer Manager contract
/// @param data to call contract
function callEigenPodManager(bytes calldata data) external payable onlyOwner {
_executeCall(address(eigenLayerPodManager), msg.value, data);
}

/// @notice Withdraw funds from the delayed withdrawal router
/// @param numberOfDelayedWithdrawalsToClaim number of claims
function claimDelayedWithdrawals(uint256 numberOfDelayedWithdrawalsToClaim) external {
delayedWithdrawalRouter.claimDelayedWithdrawals(address(this), numberOfDelayedWithdrawalsToClaim);

// transfer eth to withdrawalAddress
uint256 balance = address(this).balance;
if (feeShare > 0) {
uint256 fee = (balance * feeShare) / PERCENTAGE_SCALE;
feeRecipient.safeTransferETH(fee);
withdrawalAddress.safeTransferETH(balance -= fee);
} else {
withdrawalAddress.safeTransferETH(balance);
}

/// @dev Enables contract to receive ETH
// defined on the clone implementation
// receive() external payable {}

/// @notice initializes the controller
/// @param _owner address of the controller owner
/// @param splitter address of splitter
function initialize(address _owner, address splitter) external {
if (owner != address(0)) revert AlreadyInitialized();

eigenPod = eigenLayerPodManager.createPod();
owner = _owner;
split = splitter;

emit Initialized(eigenPod, _owner);
}

/// @notice Call the eigenPod contract
/// @param data to call eigenPod contract
function callEigenPod(
bytes calldata data
) external payable onlyOwner {
_executeCall(address(eigenPod), msg.value, data);
}

/// @notice Call the Eigenlayer delegation Manager contract
/// @param data to call eigenPod contract
function callDelegationManager(
bytes calldata data
) external payable onlyOwner {
_executeCall(address(eigenLayerDelegationManager), msg.value, data);
}

/// @notice Call the Eigenlayer Manager contract
/// @param data to call contract
function callEigenPodManager(
bytes calldata data
) external payable onlyOwner {
_executeCall(address(eigenLayerPodManager), msg.value, data);
}

/// @notice Withdraw funds from the delayed withdrawal router
/// @param numberOfDelayedWithdrawalsToClaim number of claims
function claimDelayedWithdrawals(uint256 numberOfDelayedWithdrawalsToClaim)
external
{
delayedWithdrawalRouter.claimDelayedWithdrawals(
address(this),
numberOfDelayedWithdrawalsToClaim
);

// transfer eth to split
uint256 balance = address(this).balance;
if (feeShare > 0) {
uint256 fee = (balance * feeShare) / PERCENTAGE_SCALE;
feeRecipient.safeTransferETH(fee);
split.safeTransferETH(balance -= fee);
} else {
split.safeTransferETH(address(this).balance);
}
}

/// @notice Rescue stuck tokens by sending them to the split contract.
/// @param token address of token
/// @param amount amount of token to rescue
function rescueFunds(address token, uint256 amount) external {
if (amount > 0) ERC20(token).safeTransfer(split, amount);
}

/// @notice Execute a low level call
/// @param to address to execute call
/// @param value amount of ETH to send with call
/// @param data bytes array to execute
function _executeCall(address to, uint256 value, bytes memory data) internal {
(bool success,) = address(to).call{value: value}(data);
if (!success) revert CallFailed(data);
}

}
}

/// @notice Rescue stuck tokens by sending them to the split contract.
/// @param token address of token
/// @param amount amount of token to rescue
function rescueFunds(address token, uint256 amount) external {
if (amount > 0) ERC20(token).safeTransfer(withdrawalAddress, amount);
}

/// @notice Execute a low level call
/// @param to address to execute call
/// @param value amount of ETH to send with call
/// @param data bytes array to execute
function _executeCall(address to, uint256 value, bytes memory data) internal {
(bool success,) = address(to).call{value: value}(data);
if (!success) revert CallFailed(data);
}
}
Loading

0 comments on commit 1524e5a

Please sign in to comment.