Router

Overview

The Router.sol allows for complex transaction sequences to be executed in a single transaction. It inherits from Dispatcher.sol and IERC3156FlashBorrower. It primarily handles the execution of a sequence of commands, including flash loans within Spectra Principal Tokens.

Router Methods

execute

Handles the execution of command sequence.

function execute(
        bytes calldata commands,
        bytes[] calldata inputs
) external payable

execute

Processes a batch of commands before a specified deadline. This method checks for deadline and then forwards the call to execute().

function execute(
        bytes calldata commands,
        bytes[] calldata inputs,
        uint256 deadline
) external payable

View Methods

previewRate

Simulates encoded commands along with provided inputs, and return the resulting rate.

function previewRate(
        bytes calldata commands,
        bytes[] calldata inputs
) external view returns (uint256 output)

previewSpotRate

Simulates encoded commands along with provided inputs, and return the resulting spot rate.

function previewSpotRate(
        bytes calldata commands,
        bytes[] calldata inputs
    ) external view returns (uint256 output)

onFlashLoan

Implements the flash loan callback, handling the loan repayment and potential shortfall from the original sender.

function onFlashLoan(
        address initiator,
        address token,
        uint256 amount,
        uint256 fee,
        bytes calldata data
    ) external returns (bytes32)

Conforms to EIP-3156 standards.

Dispatcher

The Dispatcher.sol is an abstract contract that facilitates a variety of financial operations, including token transfers, swaps, and flash loans. Each command has specific input requirements and functionalities.

TRANSFER_FROM Command

Transfers the specified amount of the ERC20 token from the message sender (msgSender) to the contract itself. It's crucial for security that the transfer originates only from the message sender.

TRANSFER_FROM_WITH_PERMIT Command

Transfers the specified amount of the ERC20 token from the message sender (msgSender) to the contract itself using the EIP-2612 signed approvals.

TRANSFER Command

Transfers a specified amount of the ERC20 token from the contract to the provided recipient address. If a special value indicating the contract's entire balance is provided, it transfers the entire token balance of the contract to the recipient.

CURVE_SWAP Command

Executes a token swap using a Curve finance pool. The command involves specifying the tokens within the pool to swap, the amount to swap, and the minimum acceptable amount for the output token, ensuring slippage protection.

WRAP_VAULT_IN_4626_ADAPTER Command

Wraps shares of an interest-bearing vault into an ERC4626 compliant wrapper (Spectra4626Wrapper.wrap()). The operation deposits the interest-bearing vault shares into a Spectra4626Wrapper instance and transfers the resulting wrapper shares to the specified recipient.

UNWRAP_VAULT_FROM_4626_ADAPTER Command

Unwraps shares of an interest-bearing vault from an ERC4626 wrapper (Spectra4626Wrapper.unwrap()). The operation redeems shares of an Spectra4626Wrapper instance and transfers the resulting vault shares to the specified recipient.

DEPOSIT_ASSET_IN_IBT Command

Deposits the specified amount of an underlying ERC20 token into an ERC4626 compliant tokenized vault (ERC4626.deposit()). The operation deposits the underlying token into the 4626 vault and transfers the resulting vault shares to the specified recipient.

DEPOSIT_ASSET_IN_PT Command

Deposits the specified amount of an underlying ERC20 token in the PT (deposit()).

DEPOSIT_IBT_IN_PT Command

Deposits the specified amount of an IBT token in the PT (depositIBT()).

REDEEM_IBT_FOR_ASSET Command

Redeems the specified amount of the ERC4626 vault shares for the underlying token (ERC4626.redeem()). The withdrawn tokens are then transferred to the specified recipient.

REDEEM_PT_FOR_ASSET Command

Redeems the specified amount of PT shares for the underlying token (redeem()).

REDEEM_PT_FOR_IBT Command

Redeems the specified amount of PT share for the associated IBT token (redeemForIBT()).

FLASH_LOAN Command

Facilitates a flash loan transaction. It enables borrowing of a specified amount of an ERC20 token from a lender, with the requirement that it is returned within the same transaction, along with any agreed-upon fees.

ASSERT_MIN_BALANCE Command

Checks if the specified token balance of an owner's address is at least the provided minimum value. If the balance is below the minimum, the command reverts the entire transaction.

CURVE_SPLIT_IBT_LIQUIDITY Command

Split the input IBT amount into IBT for the pool and to deposit in the Principal Token. Add liquidity to the pool with the resulting PT and the split IBT amounts.

CURVE_ADD_LIQUIDITY Command

Add liquidity to the Curve pool specifying each token amount in input and the minimum amount of LP token to mint (slippage protection).

CURVE_REMOVE_LIQUIDITY Command

Remove liquidity from Curve pool specifying the amount lps of LP tokens to burn and the minum amount of liquidity to withdraw for each token (slippage protection).

CURVE_REMOVE_LIQUIDITY_ONE_COIN Command

Remove liquidity from Curve pool by withdrawing a single coin. The user specify the amount lps of LP tokens to burn and the minimum amount of liquidity to withdraw for the chosen token (slippage protection).