Periphery Contracts

ShibaSwap v2’s periphery contracts provide user-friendly interfaces for interacting with the core protocol. These contracts handle complex operations like position management, routing, and simplified interactions.

Non-fungible Position Manager

The Non-fungible Position Manager (NFPM) is an ERC-721 contract that represents liquidity positions as NFTs. It provides a user-friendly interface for creating, managing, and interacting with concentrated liquidity positions.

Overview

Each liquidity position is represented as a unique NFT with metadata including token pair, fee tier, tick range, and liquidity amount.

Core Functions

mint

function mint(MintParams calldata params) external payable returns (
    uint256 tokenId,
    uint128 liquidity,
    uint256 amount0,
    uint256 amount1
)

Creates a new liquidity position and mints an NFT representing it.

address

required

First token in the pair

address

required

Second token in the pair

uint24

required

Fee tier for the pool

int24

required

Lower tick boundary of the position

int24

required

Upper tick boundary of the position

uint256

required

Desired amount of token0

uint256

required

Desired amount of token1

uint256

required

Minimum amount of token0 to accept

uint256

required

Minimum amount of token1 to accept

address

required

Address to receive the NFT

uint256

required

Unix timestamp deadline

uint256

required

Unique identifier for the position NFT

uint128

required

Amount of liquidity created

uint256

required

Amount of token0 used

uint256

required

Amount of token1 used

increaseLiquidity

function increaseLiquidity(IncreaseLiquidityParams calldata params) external payable returns (
    uint128 liquidity,
    uint256 amount0,
    uint256 amount1
)

Adds more liquidity to an existing position.

uint256

required

ID of the position to increase liquidity for

uint256

required

Desired amount of token0 to add

uint256

required

Desired amount of token1 to add

uint256

required

Minimum amount of token0 to accept

uint256

required

Minimum amount of token1 to accept

uint256

required

Unix timestamp deadline

decreaseLiquidity

function decreaseLiquidity(DecreaseLiquidityParams calldata params) external payable returns (
    uint256 amount0,
    uint256 amount1
)

Removes liquidity from a position.

uint256

required

ID of the position to decrease liquidity for

uint128

required

Amount of liquidity to remove

uint256

required

Minimum amount of token0 to receive

uint256

required

Minimum amount of token1 to receive

uint256

required

Unix timestamp deadline

collect

function collect(CollectParams calldata params) external payable returns (
    uint256 amount0,
    uint256 amount1
)

Collects accumulated fees from a position.

uint256

required

ID of the position to collect fees from

address

required

Address to receive the collected fees

uint128

required

Maximum amount of token0 to collect

uint128

required

Maximum amount of token1 to collect

burn

function burn(uint256 tokenId) external payable

Burns an NFT position and removes all liquidity.

uint256

required

ID of the position to burn

Burning a position will permanently remove all liquidity and fees. Make sure to collect fees first.

Position Information

positions

function positions(uint256 tokenId) external view returns (
    uint96 nonce,
    address operator,
    address token0,
    address token1,
    uint24 fee,
    int24 tickLower,
    int24 tickUpper,
    uint128 liquidity,
    uint256 feeGrowthInside0LastX128,
    uint256 feeGrowthInside1LastX128,
    uint128 tokensOwed0,
    uint128 tokensOwed1
)

Returns detailed information about a position.

uint256

required

ID of the position to query

uint96

required

Position nonce for replay protection

address

required

Address authorized to manage the position

address

required

First token in the pair

address

required

Second token in the pair

uint24

required

Fee tier of the pool

int24

required

Lower tick boundary

int24

required

Upper tick boundary

uint128

required

Current liquidity amount

uint256

required

Last fee growth for token0

uint256

required

Last fee growth for token1

uint128

required

Unclaimed token0 fees

uint128

required

Unclaimed token1 fees

Router Contract

The Router contract provides simplified interfaces for common operations like swaps and liquidity management.

Swap Functions

exactInputSingle

function exactInputSingle(ExactInputSingleParams calldata params) external payable returns (uint256 amountOut)

Executes a single-hop swap with exact input amount.

address

required

Input token address

address

required

Output token address

uint24

required

Fee tier of the pool

address

required

Address to receive output tokens

uint256

required

Unix timestamp deadline

uint256

required

Exact input amount

uint256

required

Minimum output amount

uint160

required

Price limit for the swap

exactInput

function exactInput(ExactInputParams calldata params) external payable returns (uint256 amountOut)

Executes a multi-hop swap with exact input amount.

bytes

required

Encoded path for the swap

address

required

Address to receive output tokens

uint256

required

Unix timestamp deadline

uint256

required

Exact input amount

uint256

required

Minimum output amount

exactOutputSingle

function exactOutputSingle(ExactOutputSingleParams calldata params) external payable returns (uint256 amountIn)

Executes a single-hop swap with exact output amount.

address

required

Input token address

address

required

Output token address

uint24

required

Fee tier of the pool

address

required

Address to receive output tokens

uint256

required

Unix timestamp deadline

uint256

required

Exact output amount

uint256

required

Maximum input amount

uint160

required

Price limit for the swap

exactOutput

function exactOutput(ExactOutputParams calldata params) external payable returns (uint256 amountIn)

Executes a multi-hop swap with exact output amount.

bytes

required

Encoded path for the swap (in reverse order)

address

required

Address to receive output tokens

uint256

required

Unix timestamp deadline

uint256

required

Exact output amount

uint256

required

Maximum input amount

Liquidity Management Functions

mint

function mint(MintParams calldata params) external payable returns (
    uint256 tokenId,
    uint128 liquidity,
    uint256 amount0,
    uint256 amount1
)

Creates a new liquidity position through the router.

increaseLiquidity

function increaseLiquidity(IncreaseLiquidityParams calldata params) external payable returns (
    uint128 liquidity,
    uint256 amount0,
    uint256 amount1
)

Increases liquidity for an existing position through the router.

decreaseLiquidity

function decreaseLiquidity(DecreaseLiquidityParams calldata params) external payable returns (
    uint256 amount0,
    uint256 amount1
)

Decreases liquidity for an existing position through the router.

collect

function collect(CollectParams calldata params) external payable returns (
    uint256 amount0,
    uint256 amount1
)

Collects fees from a position through the router.

Interfaces

INonfungiblePositionManager

interface INonfungiblePositionManager {
    struct MintParams {
        address token0;
        address token1;
        uint24 fee;
        int24 tickLower;
        int24 tickUpper;
        uint256 amount0Desired;
        uint256 amount1Desired;
        uint256 amount0Min;
        uint256 amount1Min;
        address recipient;
        uint256 deadline;
    }
    
    struct IncreaseLiquidityParams {
        uint256 tokenId;
        uint256 amount0Desired;
        uint256 amount1Desired;
        uint256 amount0Min;
        uint256 amount1Min;
        uint256 deadline;
    }
    
    struct DecreaseLiquidityParams {
        uint256 tokenId;
        uint128 liquidity;
        uint256 amount0Min;
        uint256 amount1Min;
        uint256 deadline;
    }
    
    struct CollectParams {
        uint256 tokenId;
        address recipient;
        uint128 amount0Max;
        uint128 amount1Max;
    }
    
    function mint(MintParams calldata params) external payable returns (
        uint256 tokenId,
        uint128 liquidity,
        uint256 amount0,
        uint256 amount1
    );
    
    function increaseLiquidity(IncreaseLiquidityParams calldata params) external payable returns (
        uint128 liquidity,
        uint256 amount0,
        uint256 amount1
    );
    
    function decreaseLiquidity(DecreaseLiquidityParams calldata params) external payable returns (
        uint256 amount0,
        uint256 amount1
    );
    
    function collect(CollectParams calldata params) external payable returns (
        uint256 amount0,
        uint256 amount1
    );
    
    function burn(uint256 tokenId) external payable;
    
    function positions(uint256 tokenId) external view returns (
        uint96 nonce,
        address operator,
        address token0,
        address token1,
        uint24 fee,
        int24 tickLower,
        int24 tickUpper,
        uint128 liquidity,
        uint256 feeGrowthInside0LastX128,
        uint256 feeGrowthInside1LastX128,
        uint128 tokensOwed0,
        uint128 tokensOwed1
    );
}

ISwapRouter

interface ISwapRouter {
    struct ExactInputSingleParams {
        address tokenIn;
        address tokenOut;
        uint24 fee;
        address recipient;
        uint256 deadline;
        uint256 amountIn;
        uint256 amountOutMinimum;
        uint160 sqrtPriceLimitX96;
    }
    
    struct ExactInputParams {
        bytes path;
        address recipient;
        uint256 deadline;
        uint256 amountIn;
        uint256 amountOutMinimum;
    }
    
    struct ExactOutputSingleParams {
        address tokenIn;
        address tokenOut;
        uint24 fee;
        address recipient;
        uint256 deadline;
        uint256 amountOut;
        uint256 amountInMaximum;
        uint160 sqrtPriceLimitX96;
    }
    
    struct ExactOutputParams {
        bytes path;
        address recipient;
        uint256 deadline;
        uint256 amountOut;
        uint256 amountInMaximum;
    }
    
    function exactInputSingle(ExactInputSingleParams calldata params) external payable returns (uint256 amountOut);
    
    function exactInput(ExactInputParams calldata params) external payable returns (uint256 amountOut);
    
    function exactOutputSingle(ExactOutputSingleParams calldata params) external payable returns (uint256 amountIn);
    
    function exactOutput(ExactOutputParams calldata params) external payable returns (uint256 amountIn);
}

Usage Examples

Creating a Position

// Mint a new liquidity position
INonfungiblePositionManager nfpm = INonfungiblePositionManager(NFPM_ADDRESS);

INonfungiblePositionManager.MintParams memory params = INonfungiblePositionManager.MintParams({
    token0: SHIB_ADDRESS,
    token1: WETH_ADDRESS,
    fee: 3000,
    tickLower: -1000,
    tickUpper: 1000,
    amount0Desired: 1000000 * 10**18, // 1M SHIB
    amount1Desired: 1 * 10**18,       // 1 WETH
    amount0Min: 0,
    amount1Min: 0,
    recipient: msg.sender,
    deadline: block.timestamp + 1200
});

(uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1) = nfpm.mint(params);

Executing a Swap

// Single-hop swap
ISwapRouter router = ISwapRouter(ROUTER_ADDRESS);

ISwapRouter.ExactInputSingleParams memory params = ISwapRouter.ExactInputSingleParams({
    tokenIn: SHIB_ADDRESS,
    tokenOut: WETH_ADDRESS,
    fee: 3000,
    recipient: msg.sender,
    deadline: block.timestamp + 1200,
    amountIn: 1000000 * 10**18, // 1M SHIB
    amountOutMinimum: 0,
    sqrtPriceLimitX96: 0
});

uint256 amountOut = router.exactInputSingle(params);

Managing Positions

// Increase liquidity
INonfungiblePositionManager.IncreaseLiquidityParams memory params = INonfungiblePositionManager.IncreaseLiquidityParams({
    tokenId: tokenId,
    amount0Desired: 500000 * 10**18, // 500K SHIB
    amount1Desired: 0.5 * 10**18,    // 0.5 WETH
    amount0Min: 0,
    amount1Min: 0,
    deadline: block.timestamp + 1200
});

(uint128 liquidity, uint256 amount0, uint256 amount1) = nfpm.increaseLiquidity(params);

// Collect fees
INonfungiblePositionManager.CollectParams memory collectParams = INonfungiblePositionManager.CollectParams({
    tokenId: tokenId,
    recipient: msg.sender,
    amount0Max: type(uint128).max,
    amount1Max: type(uint128).max
});

(uint256 amount0, uint256 amount1) = nfpm.collect(collectParams);

Best Practices

Always check position ownership

Verify you own the position before performing operations.

Use positions(tokenId).operator to check ownership.

Set appropriate deadlines

Use reasonable deadlines to prevent transaction failures.

Too short deadlines may cause transactions to revert.

Handle slippage properly

Set minimum amounts to protect against price movements.

Use the SDK to calculate expected amounts and set appropriate minimums.

Collect fees regularly

Collect accumulated fees to maximize returns.

Regular fee collection helps compound your earnings.

Error Handling

Position Errors

NOT_AUTHORIZED: Caller is not authorized to manage the position
POSITION_NOT_FOUND: Position does not exist
INSUFFICIENT_LIQUIDITY: Not enough liquidity to remove
INVALID_TICK_RANGE: Tick range is invalid

Swap Errors

EXCESSIVE_INPUT_AMOUNT: Input amount exceeds maximum
INSUFFICIENT_OUTPUT_AMOUNT: Output amount below minimum
EXPIRED: Transaction deadline has passed
PRICE_LIMIT_EXCEEDED: Price limit exceeded during swap

Approval Errors

INSUFFICIENT_ALLOWANCE: Token approval insufficient
TRANSFER_FAILED: Token transfer failed
INSUFFICIENT_BALANCE: Insufficient token balance

Introduction

Shibaswap-v1

Shibaswap-v2

Non-fungible Position Manager

Overview

Core Functions

mint

increaseLiquidity

decreaseLiquidity

collect

burn

Position Information

positions

Router Contract

Swap Functions

exactInputSingle

exactInput

exactOutputSingle

exactOutput

Liquidity Management Functions

mint

increaseLiquidity

decreaseLiquidity

collect

Interfaces

INonfungiblePositionManager

ISwapRouter

Usage Examples

Creating a Position

Executing a Swap

Managing Positions

Best Practices

Error Handling

​Non-fungible Position Manager

​Overview

​Core Functions

​mint

​increaseLiquidity

​decreaseLiquidity

​collect

​burn

​Position Information

​positions

​Router Contract

​Swap Functions

​exactInputSingle

​exactInput

​exactOutputSingle

​exactOutput

​Liquidity Management Functions

​mint

​increaseLiquidity

​decreaseLiquidity

​collect

​Interfaces

​INonfungiblePositionManager

​ISwapRouter

​Usage Examples

​Creating a Position

​Executing a Swap

​Managing Positions

​Best Practices

​Error Handling

Non-fungible Position Manager

Overview

Core Functions

mint

increaseLiquidity

decreaseLiquidity

collect

burn

Position Information

positions

Router Contract

Swap Functions

exactInputSingle

exactInput

exactOutputSingle

exactOutput

Liquidity Management Functions

mint

increaseLiquidity

decreaseLiquidity

collect

Interfaces

INonfungiblePositionManager

ISwapRouter

Usage Examples

Creating a Position

Executing a Swap

Managing Positions

Best Practices

Error Handling