il
- Model
- Chart
Calculates Impermanent Loss in a custom liquidity pool
Source Code: [link]
openbb.crypto.tools.il(price_changeA: float, price_changeB: float, proportion: float, initial_pool_value: float)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| price_changeA | float | price change of crypto A in percentage | None | False |
| price_changeB | float | price change of crypto B in percentage | None | False |
| proportion | float | percentage of first token in pool | None | False |
| initial_pool_value | float | initial value that pool contains | None | False |
Returns
| Type | Description |
|---|---|
| Tuple[pd.DataFrame, str] | - pd.DataFrame: dataframe with results - str: narrative version of results |
Displays Impermanent Loss in a custom liquidity pool
Source Code: [link]
openbb.crypto.tools.il_chart(price_changeA: int, price_changeB: int, proportion: int, initial_pool_value: int, narrative: bool = False, export: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| price_changeA | float | price change of crypto A in percentage | None | False |
| price_changeB | float | price change of crypto B in percentage | None | False |
| proportion | float | percentage of first token in pool | None | False |
| initial_pool_value | float | initial value that pool contains | None | False |
| narrative | str | display narrative version instead of dataframe | False | True |
| export | str | Export dataframe data to csv,json,xlsx file | True |
Returns
This function does not return anything