NxraDEXAdapter

Git Source

Extends: BaseAdapter

The NxraDEXAdapter is designed to interact with the Nexera Exchange.

This adapter enables users to harness the power of Nexera On-chain Limit Order Book DEX features and integrate them into their financial strategies.

Enums

OperateOperation

Defines the actions available for interacting with Nexera DEX:

• MAKE: Make a new order
• TAKE_EXACT_TAKE: Allocate a specific quantity of take Tokens within predefined limits
• TAKE_EXACT_MAKE: Acquire a specific quantity of make Tokens within predefined limits
• CANCEL: Cancel orders and refund the order maker

enum OperateOperation {
    MAKE, 
    TAKE_EXACT_TAKE,
    TAKE_EXACT_MAKE,
    CANCEL
}

Structs

OperateExtraData

Used to indicate the appropriate action of an Operate Operation.

struct OperateExtraData {
    OperateOperation operateOperation;
    bytes operationData;
    bool fromBalance;
}

Members

MakeData

Defines the necessary data for invoking the make function of the Nexera DEX. It encapsulates the necessary data for making a new order in the Exchange.

Note: This structure serves as the non-encoded operation data within the broader OperateExtraData struct.

struct MakeData {
    IERC20 makeToken; 
    IERC20 takeToken;
    uint256 makeAmount; 
    uint256 takeAmount;
    uint32 estimatedSortOrderId;
    uint256 maxInsertIterations;
    uint256 maxTakeIterations;
    bool toBalance;
}

Members

TakeExactData

Defines the necessary data for invoking the takeExactTake & takeExactMake functions of the Nexera DEX. It encapsulates the necessary data required to acquire or allocate tokens from/to the Exchange.

Note: This structure serves as the non-encoded operation data within the broader OperateExtraData struct.

struct TakeExactData {
    IERC20 makeToken;
    IERC20 takeToken;
    uint256 maxAmount;
    uint256 minAmount;
    uint256 maxMakePrice;
    uint256 maxTakePrice;
    uint256 maxIterations;
    address receiver;
    bool toBalance;
}

Members

CancelData

Defines the necessary data for invoking the cancel function of the Nexera DEX. It encapsulates the necessary data required for cancelling orders that have been placed to the Exchange.

Note: This structure serves as the non-encoded operation data within the broader OperateExtraData struct.

struct CancelData {
    bytes ids;
    bool toBalance;
}

Members

Layout

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

struct Layout {
    IExchange exchange;
}

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.NxraDEXAdapter string literal
• The address of this contract (NxraDEXAdapter)

constructor();

Functions

initialize

Initializes the Adapter.

function initialize(bytes calldata initData_) external override;

Parameters

_deposit

Internal function for handling Deposit Operations.

This function is responsible for depositing tokens into the Nexera DEX, via invoking its deposit method.

Called by executeAction function.

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

Parameters

_withdraw

Internal function for handling Withdraw Operations.

This function is responsible for withdrawing tokens from the Nexera DEX, via invoking its withdraw method.

Called by executeAction function.

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

Parameters

_operate

Internal function for handling Operate Operations.

This function is used for interacting with the Nexera DEX.

Called by executeAction function.

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

Parameters

_collect

This function always raises the OPERATION_NOT_SUPPORTED error, as Collect is not an action supported within the Nexera DEX.

Called by executeAction function.

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

_swap

This function always raises the OPERATION_NOT_SUPPORTED error, as Swap is not an action supported within the Nexera DEX.

Called by executeAction function.

function _swap(
    IAdapter.TokenAmount[] calldata,
    IAdapter.TokenAmount[] calldata,
    bytes calldata
) internal virtual override;

_make

Places a new order in the Nexera DEX, using its make method. It transfers the necessary funds from the caller's balance into the respective market escrow.

Called by _operate function.

function _make(bytes memory operationData) internal;

Parameters

_takeExactTake

Spends a specified amount of take tokens within predefined limits for executing a market order, acquiring make tokens at the prevailing market price.

Called by _operate function.

function _takeExactTake(bytes memory operationData) internal;

Parameters

_takeExactMake

Acquire a specified amount of make tokens within predefined limits for executing a market order, spending take tokens at the prevailing market price.

Called by _operate function.

function _takeExactMake(bytes memory operationData) internal;

Parameters

_cancel

Cancels the specified placed orders in the Nexera DEX and refunds the respective order maker, using the cancel method of the Exchange.

Called by _operate function.

function _cancel(bytes memory operationData) internal;

Parameters

layout

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

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