ExchangeRouter

The ExchangeRouter is the primary entry point for user interactions with the HertzFlow protocol.

Overview

ExchangeRouter handles:

• Creating deposits and withdrawals

• Creating and managing orders

• Creating and managing shifts

• Claiming fees and collateral

• Token transfers

• External calls for integrations

Functions

Deposits

cancelDeposit

Cancel a pending deposit.

function cancelDeposit(bytes32 key) external payable;

createDeposit

Create a deposit request to add liquidity.

function createDeposit(IDepositUtils.CreateDepositParams params) external payable returns (bytes32);

simulateExecuteDeposit

Simulate a deposit execution.

function simulateExecuteDeposit(
    bytes32 key,
    OracleUtils.SimulatePricesParams simulatedOracleParams
) external payable;

simulateExecuteLatestDeposit

Simulate execution of the latest deposit.

function simulateExecuteLatestDeposit(OracleUtils.SimulatePricesParams simulatedOracleParams) external payable;

Withdrawals

cancelWithdrawal

Cancel a pending withdrawal.

function cancelWithdrawal(bytes32 key) external payable;

createWithdrawal

Create a withdrawal request to remove liquidity.

function createWithdrawal(IWithdrawalUtils.CreateWithdrawalParams params) external payable returns (bytes32);

executeAtomicWithdrawal

Execute a withdrawal atomically (without keeper).

function executeAtomicWithdrawal(
    IWithdrawalUtils.CreateWithdrawalParams params,
    OracleUtils.SetPricesParams oracleParams
) external payable;

simulateExecuteLatestWithdrawal

Simulate execution of the latest withdrawal.

function simulateExecuteLatestWithdrawal(
    OracleUtils.SimulatePricesParams simulatedOracleParams,
    ISwapPricingUtils.SwapPricingType swapPricingType
) external payable;

simulateExecuteWithdrawal

Simulate a withdrawal execution.

function simulateExecuteWithdrawal(
    bytes32 key,
    OracleUtils.SimulatePricesParams simulatedOracleParams,
    ISwapPricingUtils.SwapPricingType swapPricingType
) external payable;

Shifts

cancelShift

Cancel a pending shift.

function cancelShift(bytes32 key) external payable;

createShift

Create a shift request to move liquidity between markets.

function createShift(IShiftUtils.CreateShiftParams params) external payable returns (bytes32);

simulateExecuteLatestShift

Simulate execution of the latest shift.

function simulateExecuteLatestShift(OracleUtils.SimulatePricesParams simulatedOracleParams) external payable;

simulateExecuteShift

Simulate a shift execution.

function simulateExecuteShift(
    bytes32 key,
    OracleUtils.SimulatePricesParams simulatedOracleParams
) external payable;

Orders

cancelOrder

Cancel a pending order.

function cancelOrder(bytes32 key) external payable;

createOrder

Create a new order (swap, increase, or decrease position).

function createOrder(IBaseOrderUtils.CreateOrderParams params) external payable returns (bytes32);

simulateExecuteLatestOrder

Simulate execution of the latest order.

function simulateExecuteLatestOrder(OracleUtils.SimulatePricesParams simulatedOracleParams) external payable;

simulateExecuteOrder

Simulate an order execution.

function simulateExecuteOrder(
    bytes32 key,
    OracleUtils.SimulatePricesParams simulatedOracleParams
) external payable;

updateOrder

Update a pending order.

function updateOrder(
    bytes32 key,
    uint256 sizeDeltaUsd,
    uint256 acceptablePrice,
    uint256 triggerPrice,
    uint256 minOutputAmount,
    uint256 validFromTime,
    bool autoCancel
) external payable;

Token Transfers

sendNativeToken

Transfer native tokens to a receiver.

function sendNativeToken(
    address receiver,
    uint256 amount
) external payable;

sendTokens

Transfer ERC20 tokens from the caller to a receiver.

function sendTokens(
    address token,
    address receiver,
    uint256 amount
) external payable;

sendWnt

Transfer wrapped native tokens (WNT) to a receiver.

function sendWnt(
    address receiver,
    uint256 amount
) external payable;

Claims

claimAffiliateRewards

Claim affiliate rewards.

function claimAffiliateRewards(
    address[] markets,
    address[] tokens,
    address receiver
) external payable returns (uint256[]);

claimCollateral

Claim collateral from capped price impact.

function claimCollateral(
    address[] markets,
    address[] tokens,
    uint256[] timeKeys,
    address receiver
) external payable returns (uint256[]);

claimFundingFees

Claim accumulated funding fees.

function claimFundingFees(
    address[] markets,
    address[] tokens,
    address receiver
) external payable returns (uint256[]);

claimUiFees

Claim UI fees.

function claimUiFees(
    address[] markets,
    address[] tokens,
    address receiver
) external payable returns (uint256[]);

External Calls

makeExternalCalls

Perform external calls (e.g., swaps via aggregators) before protocol actions.

function makeExternalCalls(
    address[] externalCallTargets,
    bytes[] externalCallDataList,
    address[] refundTokens,
    address[] refundReceivers
) external payable;

Settings

setSavedCallbackContract

Set a saved callback contract for liquidations and ADLs.

function setSavedCallbackContract(
    address market,
    address callbackContract
) external payable;

setUiFeeFactor

Set the UI fee factor for the caller.

function setUiFeeFactor(uint256 uiFeeFactor) external payable;

Multicall

multicall

Execute multiple calls in a single transaction (inherited from PayableMulticall).

function multicall(bytes[] data) external payable returns (bytes[]);

View Functions

dataStore

Get the DataStore contract address.

function dataStore() external view returns (DataStore);

depositHandler

Get the DepositHandler contract address.

function depositHandler() external view returns (IDepositHandler);

eventEmitter

Get the EventEmitter contract address.

function eventEmitter() external view returns (EventEmitter);

externalHandler

Get the ExternalHandler contract address.

function externalHandler() external view returns (IExternalHandler);

orderHandler

Get the OrderHandler contract address.

function orderHandler() external view returns (IOrderHandler);

roleStore

Get the RoleStore contract address.

function roleStore() external view returns (RoleStore);

router

Get the Router contract address.

function router() external view returns (Router);

shiftHandler

Get the ShiftHandler contract address.

function shiftHandler() external view returns (IShiftHandler);

withdrawalHandler

Get the WithdrawalHandler contract address.

function withdrawalHandler() external view returns (IWithdrawalHandler);

---

Notes

This documentation was auto-generated from the contract ABI.