ConvexAdapter

Git Source

Extends: BaseAdapter

Custom Errors

WRONG_BOOSTER_ADDRESS

Raised when zero address is provided for Booster in the initialize function.

error WRONG_BOOSTER_ADDRESS();

WRONG_TOKEN_COUNT

Raised when the length of expectedIn & out parameters, defining token compositions, do not match the expected length required for an operation.

error WRONG_TOKEN_COUNT();

WRONG_TOKEN_ADDRESS

Raised when an invalid address is provided for a token.

error WRONG_TOKEN_ADDRESS();

WRONG_TOKEN_AMOUNT

Raised when the amount specified in input or output token compositions is wrong with respect to the requested operation.

error WRONG_TOKEN_AMOUNT();

UNKNOWN_OPERATE_OPERATION

Raised when an enum key not defined in OperateOperation is provided as the operation code for _operate function.

error UNKNOWN_OPERATE_OPERATION();

Enums

OperateOperation

Defines the actions available with respect to Operate Operations:

• STAKE: Stake a convex tokenized deposit
• UNSTAKE: Unstake to a convex tokenized deposit

enum OperateOperation{ STAKE, UNSTAKE }

Structs

DepositExtraData

Defines the necessary data required for performing deposit actions.

struct DepositExtraData {
    uint256 poolId;
    bool stake;
}

Members

WithdrawExtraData

Defines the necessary data required for performing withdraw actions.

struct WithdrawExtraData {
    uint256 poolId;
    bool claimRewards;
}

Members

CollectExtraData

Defines the necessary data required for performing collect actions.

struct CollectExtraData {
    uint256 poolId;
}

Members

OperateExtraData

Used to indicate the appropriate action of an Operate Operation.

struct OperateExtraData {
    OperateOperation operateOperation;
    uint256 poolId;
    bool claimRewards;
}

Members

Layout

Used to store crucial data for the Adapter's functionality in a specific storage slot.

struct Layout {
    IBooster booster;
}

Members

State Variables

STORAGE_SLOT

Unique identifier for the storage slot where the Layout struct is stored.

bytes32 internal immutable STORAGE_SLOT;

Constructor

Sets the value of the STORAGE_SLOT state variable.

The value is computed as the keccak256 hash of the abi encoding of:

• The Nexera-FI.ConvexAdapter string literal
• The address of this contract (ConvexAdapter)

constructor();

Functions

initialize

Initializes the Adapter.

function initialize(bytes calldata initData_) external override;

Parameters

_swap

This function always raises the OPERATION_NOT_SUPPORTED error, as SWAP is not an action supported within Convex.

Called by executeAction function.

function _swap(
    IAdapter.TokenAmount[] calldata /*out*/,
    IAdapter.TokenAmount[] calldata /*expectedIn*/,
    bytes calldata /*extraData*/
) internal virtual override;

_deposit

Internal function for handling Deposit Operations.

This function is responsible for depositing LP tokens of a protocol (e.g. Curve) to Convex.

Called by executeAction function.

function _deposit(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    bytes calldata extraData
) internal virtual override;

Parameters

_withdraw

Internal function for handling Withdraw Operations.

This function is responsible for withdrawing LP tokens of an underlying protocol (e.g. Curve) from Convex.

Called by executeAction function.

function _withdraw(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    bytes calldata extraData
) internal virtual override;

Parameters

_collect

Internal function for handling Collect Operations.

This function is responsible for collecting rewards from staked tokenized liquidity.

Called by executeAction function.

function _collect(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    bytes calldata extraData
) internal virtual override;

Parameters

_operate

Internal function for handling Operate Operations.

This function is used for:

• Staking a convex tokenized deposit
• Unstaking to a convex tokenized deposit

Called by executeAction function.

function _operate(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    bytes calldata extraData
) internal virtual override;

Parameters

_stake

Internal helper function for staking a convex tokenized deposit, by invoking the stake function of the respective Convex Reward contract.

Called by _operate function.

function _stake(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    uint256 poolId    
) internal virtual;

Parameters

_unstake

Internal helper function for unstaking to a convex tokenized deposit, by invoking the withdraw function of the respective Convex Reward contract.

Called by _operate function.

function _unstake(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn,
    uint256 poolId,
    bool claimRewards   
) internal virtual;

Parameters

layout

Retrieves a reference to the Layout struct stored at the storage slot specified by STORAGE_SLOT.

function layout() internal view returns (Layout storage l);