LiquidityResult

Documentation for eth_defi.uniswap_v2.liquidity.LiquidityResult Python class.

class LiquidityResult

Bases: object

Sampled liquidity on Uniswap v2 pool.

Reserves are returned in raw token amounts.

Attributes summary

Methods summary

__init__(pair_contract, token0, token1, ...)
get_liquidity_for_token(token_address)	Get liquidity value of a given pair token.

__init__(pair_contract, token0, token1, token0_reserve, token1_reserve, block_number)

Parameters

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

• token0 (eth_typing.evm.HexAddress) –

• token1 (eth_typing.evm.HexAddress) –

• token0_reserve (int) –

• token1_reserve (int) –

• block_number (int) –

Return type

None

get_liquidity_for_token(token_address)

Get liquidity value of a given pair token.

Because Uniswap liquidity tuple can be either order.

Raise

UnmatchedToken

Parameters

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

Return type

int