UniswapAdapter

Git Source

Extends: BaseAdapter

The UniswapAdapter is designed to interact with the Uniswap V3 Protocol.

This adapter enables users to harness the power of Uniswap v3 trading capabilities and integrate them into their financial strategies.

Structs

DepositExtraData

Used to provide the necessary data when performing a Deposit operation.

struct DepositExtraData {
    uint256 tokenId;
    uint24 fee;
    int24 tickLower;
    int24 tickUpper;
}

Members

WithdrawExtraData

Used to provide the necessary data when performing a Withdraw operation.

struct WithdrawExtraData {
    uint256 tokenId;
    uint128 percentageToWithdraw;
}

Members

SwapExtraData

Used to provide the necessary data when performing a Swap operation.

struct SwapExtraData {
    uint24 fee;
    uint160 sqrtPriceLimitX96;
}

Members

InitializeData

Defines the necessary data for initializing the Adapter.

struct InitializeData {
    INonfungiblePositionManager nonfungiblePositionManager;
    ISwapRouter swapRouter;
    address nativeToken;
}

Members

Layout

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

struct Layout {
    INonfungiblePositionManager nonfungiblePositionManager;
    ISwapRouter swapRouter;
 
    address nativeToken;
}

Members

State Variables

STORAGE_SLOT

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

bytes32 internal immutable STORAGE_SLOT;

PERCENTAGE

Constant value representing 100% for percentages.

Arguments that refer to percentages are formatted with respect to PERCENTAGE value.

uint128 private constant PERCENTAGE = 10000;

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

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 either minting a new NFT LP token or adding liquidity to an existing NFT LP token via interacting with Uniswap's:

• TransferHelper library
• NonfungiblePositionManager contract

Called by executeAction function.

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

Parameters

_withdraw

Internal function for handling Withdraw Operations.

This function is responsible for facilitating withdrawals of liquidity from a NFT LP position. It processes the specified output tokens and verifies the expected input tokens, ensuring accurate and secure withdrawal operations.

Called by executeAction function.

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

Parameters

_decreaseLiquidity

Internal helper function for decreasing liquidity for a specific NFT LP position (Withdraw Operation).

This function internally interacts with Uniswap's:

• NonfungiblePositionManager contract

Called by _withdraw function.

function _decreaseLiquidity(
    WithdrawExtraData memory withdrawExtraData,
    IAdapter.TokenAmount[] calldata expectedIn,
    uint128 liquidity
) internal returns (uint256, uint256);

Parameters

Returns

_swap

Internal function for handling Swap Operations.

This function is responsible for executing token swaps with specified trade settings via interacting with Uniswap's:

• SwapRouter contract
• TransferHelper library
• NonfungiblePositionManager contract

Called by executeAction function.

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

Parameters

_collect

Internal function for handling Collect Operations.

This function is responsible for collecting fees owed to a specific position associated with an NFT LP token via interacting with Uniswap's:

• NonfungiblePositionManager contract

Called by executeAction function.

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

Parameters

_operate

This function always raises the OPERATION_NOT_SUPPORTED error, as Operate is not an action supported within the Uniswap v3 protocol.

Called by executeAction function.

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

_checkAddresses

Internal helper function used for address validation within Withdraw and Collect Operations.

This function interacts with Uniswap's:

• NonfungiblePositionManager contract

Called by _withdraw and _collect functions.

function _checkAddresses(uint256 tokenId, IAdapter.TokenAmount[] memory expectedIn) internal view;

Parameters

_requireValidInAndOutForSwap

Checks the validity of input (expectedIn) and output (out) parameters for a Swap operation.

It ensures that there is only one token to send and one token to receive, and that the token addresses are not invalid.

Called by _swap function.

function _requireValidInAndOutForSwap(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn
) private pure;

Parameters

_requireValidInAndOutForDepositAndWithdraw

Checks the validity of input (expectedIn) and output (out) parameters for both Deposit and Withdraw operations.

It ensures that there are two token compositions to send and receive, and it verifies that the token addresses are valid and consistent between the input and output.

Called by _deposit and _withdraw functions.

function _requireValidInAndOutForDepositAndWithdraw(
    IAdapter.TokenAmount[] calldata out,
    IAdapter.TokenAmount[] calldata expectedIn
) private pure;

Parameters

layout

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

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