estimate_sell_received_amount
Documentation for eth_defi.uniswap_v3.price.estimate_sell_received_amount function.
- estimate_sell_received_amount(uniswap, base_token_address, quote_token_address, quantity, target_pair_fee, *, slippage=0, intermediate_token_address=None, intermediate_pair_fee=None, block_identifier=None, verbose=False)
Estimate how much we receive for selling a certain base token amount.
See example in
eth_defi.uniswap_v3.price.- Parameters
quantity (decimal.Decimal | int) – How much of the base token we want to buy
uniswap (eth_defi.uniswap_v3.deployment.UniswapV3Deployment) – Uniswap v3 deployment
base_token_address (Union[eth_typing.evm.HexAddress, str]) – Base token address of the trading pair
quote_token_address (Union[eth_typing.evm.HexAddress, str]) – Quote token address of the trading pair
target_pair_fee (int) – Trading fee of the target pair in raw format
slippage (float) – Slippage express in bps. The amount will be estimated for the maximum slippage.
block_identifier (int | None) – A specific block to estimate price
verbose (bool) – If True, return more debug info
intermediate_token_address (Optional[eth_typing.evm.HexAddress]) –
intermediate_pair_fee (int | None) –
- Returns
Expected quote token amount to receive
- Raises
TokenDetailError – If we have an issue with ERC-20 contracts
- Return type