Quick start

Important

This section is in TBD status. Please use automatically generated documentation: uniswap.

Or you could read the source code: https://github.com/valentinmk/uniswap-v3

Installation

TBD

Main classes

Models

Models described in uniswap.v3.models.

UniswapV3

class uniswap.v3.main.UniswapV3(client: EtherClient)[source]

Main class to interact with Uniswap v3 smart contracts.

Parameters:

client (EtherClient) – EtherClient Client

Return type:

UniswapV3

property factory: Factory

retrieve the Factory contract.

Return type:

Factory

Type:

Factory

get_pool(token0: ChecksumAddress, token1: ChecksumAddress, fee: int) → Pool[source]

Return the Pool contract wrapper.

Please refer official documentation: https://docs.uniswap.org/contracts/v3/reference/core/UniswapV3Pool

Parameters:

  • token0 (ChecksumAddress) – Token0 contract address

  • token1 (ChecksumAddress) – Token1 contract address

  • fee (int) – Fee of the pool

Return type:

Pool

static is_fee_valid(fee: int) → bool[source]

Return the Pool contract wrapper. Please refer official documentation:

Parameters:

fee (int) – Fee

Return type:

bool

property multicall2: Multicall2

Helper for Multicall2 smart contract.

property nft_position_manager: NonfungiblePositionManager

Helper to Non-fungible position manager smart contract.

property quoter: Quoter

Quoter smart contract.

Type:

Quoter

property swap_router: SwapRouter

Helper to SwapRouter smart contract.

property swap_router_02: SwapRouter02

Helper to SwapRouter02 smart contract.