LagoonTokenCompatibilityData

Documentation for eth_defi.erc_4626.vault_protocol.lagoon.lagoon_compatibility.LagoonTokenCompatibilityData Python class.

class LagoonTokenCompatibilityData

Bases: object

Was an ERC-20 compatible with Lagoon Vault?

• Vault can buy and sell the token

• Only applicable to Uniswap v2 kind AMMs

Attributes summary

cached	Did we res
estimate_sell_received
revert_reason	Revert reason we captured
sell_block_number
sell_result
created_at
token_address	What was the base address of the token
pair_address
path	Used routing path
tokens
available_liquidity
minimum_liquidity_threshold
buy_block_number
estimate_buy_received
buy_amount_raw
buy_result
buy_real_received

Methods summary

__init__(created_at, token_address, ...[, ...])
get_base_token_address()
get_base_token_symbol()
get_quote_token_symbol()
get_round_trip_cost()	Get round trip cost in percents.
has_liquidity()
is_buy_success()	Was the buy operation successful?
is_compatible()	Is the token compatible with Lagoon Vault?
is_sell_success()	Was the sell operation successful?
is_stablecoin_quoted()
pformat()	Diagnostics dump for debug

token_address: str

What was the base address of the token

path: list[str]

Used routing path

revert_reason: Optional[str] = None

Revert reason we captured

cached: bool = False

Did we res

is_compatible()

Is the token compatible with Lagoon Vault?

Return type

bool

is_buy_success()

Was the buy operation successful?

Return type

bool

is_sell_success()

Was the sell operation successful?

Return type

bool

get_round_trip_cost()

Get round trip cost in percents.

E.g. 0.005 means we paid 50 bps

Returns

Round trip cost in percents or None if not avail

Return type

Optional[float]

pformat()

Diagnostics dump for debug

Return type

str

__init__(created_at, token_address, pair_address, path, tokens, available_liquidity, minimum_liquidity_threshold, buy_block_number, estimate_buy_received, buy_amount_raw, buy_result, buy_real_received, sell_block_number=None, estimate_sell_received=None, sell_result=None, revert_reason=None, cached=False)

Parameters

• created_at (datetime.datetime) –

• token_address (str) –

• pair_address (str) –

• path (list[str]) –

• tokens (list[str]) –

• available_liquidity (decimal.Decimal) –

• minimum_liquidity_threshold (decimal.Decimal) –

• buy_block_number (int) –

• estimate_buy_received (int) –

• buy_amount_raw (int) –

• buy_result (Optional[eth_defi.trade.TradeSuccess]) –

• buy_real_received (int) –

• sell_block_number (Optional[int]) –

• estimate_sell_received (Optional[int]) –

• sell_result (Optional[eth_defi.trade.TradeSuccess]) –

• revert_reason (Optional[str]) –

• cached (bool) –

Return type

None