uniswap_v3.pool

Documentation for eth_defi.uniswap_v3.pool Python module.

Uniswap v3 pool data.

Functions

fetch_pool_details(web3, pool_contact_address)	Resolve Uniswap v3 pool information.
get_raw_fee_from_pool_address(web3, ...)	Get the swap fee for a pool, given the pool contract address

Classes

PoolDetails

Uniswap v3 trading pool info.

class PoolDetails

Bases: object

Uniswap v3 trading pool info.

See fetch_pool_details() on how to construct.

address: eth_typing.evm.HexAddress

Pool address

token0: eth_defi.token.TokenDetails

One pair of tokens

token1: eth_defi.token.TokenDetails

One pair of tokens

raw_fee: int

Pool fee as expressed in smart contracts (100*bps) e.g. 0.3% = 30bps so raw_fee = 3000

fee: float

Pool fee as % multiplier, 1 = 100%

pool: web3.contract.contract.Contract

Pool contract proxy

get_fee_bps()

Return pool fee in Basis Points

Return type

int

convert_price_to_human(tick, reverse_token_order=False)

Convert the price obtained through

Example:

Parameters

• tick (int) – Logarithmic tick from the Uniswap pool

• reverse_token_order – For natural base - quote token order. If set, assume quote token is token0.

Return type

decimal.Decimal

__init__(address, token0, token1, raw_fee, fee, pool)

Parameters

• address (eth_typing.evm.HexAddress) –

• token0 (eth_defi.token.TokenDetails) –

• token1 (eth_defi.token.TokenDetails) –

• raw_fee (int) –

• fee (float) –

• pool (web3.contract.contract.Contract) –

Return type

None

fetch_pool_details(web3, pool_contact_address)

Resolve Uniswap v3 pool information.

Parameters

pool_contact_address (Union[str, eth_typing.evm.HexAddress]) –

Return type

eth_defi.uniswap_v3.pool.PoolDetails

get_raw_fee_from_pool_address(web3, pool_contract_address)

Get the swap fee for a pool, given the pool contract address

Parameters

• web3 – Web3 instance

• pool_contract_address (eth_typing.evm.HexAddress) – Address of pool contract

Returns

Swap fee expressed as uint24