TurbineSettler

Git Source

Inherits: ITurbineSettler, AccessControl, Pausable, IUnlockCallback

State Variables

PERMIT2_CONTRACT

IPermit2 public constant PERMIT2_CONTRACT = IPermit2(PERMIT2)

UNIV4_POOL_MANAGER_CONTRACT

IPoolManager public constant UNIV4_POOL_MANAGER_CONTRACT = IPoolManager(UNIV4_POOL_MANAGER)

PAUSER_ROLE

bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE")

UNPAUSER_ROLE

bytes32 public constant UNPAUSER_ROLE = keccak256("UNPAUSER_ROLE")

CALL_DATA_EXECUTION_GAS_LIMIT

uint256 private constant CALL_DATA_EXECUTION_GAS_LIMIT = 200000

turbineSigner

Address that signs the settlement solutions

address public immutable turbineSigner

feeWithdrawer

Address authorized to withdraw accumulated fees

address public feeWithdrawer

turbineLiquidityRouter

Contract that handles liquidity provisions and removals

ITurbineLiquidityRouter public immutable turbineLiquidityRouter

executedSellAmounts

Executed settled sell amounts of orders

mapping(bytes32 orderHash => uint256 executedSellAmount) public executedSellAmounts

Functions

constructor

---------------------------- 🛠️ CONSTRUCTOR ----------------------------- ///

constructor(address _turbineSigner, address _maintainer, address _turbineLiquidityRouter) ;

onlyTurbineSigner

Restricts function access to the turbine signer only

modifier onlyTurbineSigner() ;

_onlyTurbineSigner

function _onlyTurbineSigner() internal view;

onlyFeeWithdrawer

Restricts function access to the fee withdrawer only

modifier onlyFeeWithdrawer() ;

_onlyFeeWithdrawer

function _onlyFeeWithdrawer() internal view;

pause

------------------------ 🌐 EXTERNAL METHODS ------------------------- ///

Pauses the contract

function pause() external onlyRole(PAUSER_ROLE);

unpause

Unpauses the contract

function unpause() external onlyRole(UNPAUSER_ROLE);

renounceAdmin

Renounces the caller's admin role

Can only be called by an admin. If multiple admins exist, other admins retain their roles.

function renounceAdmin() external onlyRole(DEFAULT_ADMIN_ROLE);

updateFeeWithdrawer

Updates the fee withdrawer address

Only callable by the admin

function updateFeeWithdrawer(address newFeeWithdrawer) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

Name	Type	Description
newFeeWithdrawer	address	The new fee withdrawer address

sweepFees

Sweeps all available balance of specified tokens to a specified recipient

Only callable by the fee withdrawer

function sweepFees(address[] calldata tokens, address to) external onlyFeeWithdrawer;

Parameters

Name	Type	Description
tokens	address[]	The addresses of the tokens to sweep
to	address	The address to send the swept fees to

executeLiquidityActionsAndSettlement

Executes liquidity actions and a batch settlement

function executeLiquidityActionsAndSettlement(
    AddLiquidityAppliedAction[] calldata addLiquidityActions,
    RemoveLiquidityAppliedAction[] calldata removeLiquidityOffchainActions,
    RemoveLiquidityIntentHash[] calldata removeLiquidityOnchainActions,
    BatchSettlement calldata settlement,
    uint256 targetBlockNumber,
    uint256 batchId
) external onlyTurbineSigner whenNotPaused;

Parameters

Name	Type	Description
addLiquidityActions	AddLiquidityAppliedAction[]	The liquidity actions to add liquidity
removeLiquidityOffchainActions	RemoveLiquidityAppliedAction[]	The offchain-applied liquidity actions to remove liquidity
removeLiquidityOnchainActions	RemoveLiquidityIntentHash[]	Intent hashes for onchain liquidity removals
settlement	BatchSettlement	The settlement to execute
targetBlockNumber	uint256	The block number at which the settlement is valid
batchId	uint256	The unique identifier for this settlement batch

unlockCallback

Take loans, fill orders, repay the loans

This function is called by the UniV4PoolManager contract.

function unlockCallback(bytes calldata data) external override returns (bytes memory);

batchExecutedSellAmounts

Returns the cumulative executed sell amount for a batch of orders over all settlements

function batchExecutedSellAmounts(bytes32[] calldata orderHashes) external view returns (uint256[] memory);

Parameters

Name	Type	Description
orderHashes	bytes32[]	The hashes of the orders

Returns

Name	Type	Description
<none>	uint256[]	The executed sell amounts

getTurbineLiquidityRouter

Returns the address of the TurbineLiquidityRouter

Return type is address to avoid unnecessary imports

function getTurbineLiquidityRouter() external view returns (address);

Returns

Name	Type	Description
<none>	address	The address of the TurbineLiquidityRouter

getTurbineHook

Returns the address of the TurbineHook (via the TurbineLiquidityRouter)

Return type is address to avoid unnecessary imports

function getTurbineHook() external view returns (address);

Returns

Name	Type	Description
<none>	address	The address of the TurbineHook

_executeBatchSettlement

------------------------- 🛠️ INTERNAL METHODS ------------------------- ///

Execute a settlement, potentially taking flashloans

function _executeBatchSettlement(BatchSettlement calldata settlement) internal;

_executeSmartOrderSwaps

Executes smart orders

function _executeSmartOrderSwaps(SmartOrderExecution[] memory swaps) internal;

_executeDEXSwaps

Executes DEX pool swaps

function _executeDEXSwaps(DEXSwap[] memory swaps) internal;

_executeTurbinePoolExecutions

Execute Turbine pool executions

function _executeTurbinePoolExecutions(TurbinePoolExecution[] memory executions) internal;

_receiveSellTokens

function _receiveSellTokens(LimitOrderExecution[] memory swaps) internal;

_sendBuyTokens

function _sendBuyTokens(LimitOrderExecution[] memory swaps, ReceivedTokenAmount[] memory tokenAmounts) internal;

_computeReceivedTokenAmounts

function _computeReceivedTokenAmounts(
    BatchSettlement memory settlement,
    uint256[] memory initialBalances
) internal view returns (ReceivedTokenAmount[] memory);

_executeSmartOrderSwap

Execute swaps on external contracts

This is used both to execute smart orders and to execute swaps on liquidity pools. These two cases are almost identical, but they might diverge in the future. We may decide later to merge them.

function _executeSmartOrderSwap(SmartOrderExecution memory swap) internal returns (uint256);

Parameters

Name	Type	Description
swap	SmartOrderExecution	The swap to execute.

Returns

Name	Type	Description
<none>	uint256	Returns the received sell amount from this smart order execution.

_executeDEXSwap

Execute a swap on a DEX pool

We don't check for amounts transferred because we do these checks at a token level

function _executeDEXSwap(DEXSwap memory swap) internal returns (uint256);

Parameters

Name	Type	Description
swap	DEXSwap	The swap to execute.