Get liquidity pool balance
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | '''$ | + | '''$get liquidity pool balance''' is a function that returns the number of LP (Liquidity Provider) tokens you have from a specific liquidity pool on a decentralized exchange. |
| − | + | LP tokens are given when you invest into a liquidity pool. They represent your share or stake in the pool. | |
== Parameters == | == Parameters == | ||
| − | '''Exchange:''' The decentralized exchange where the liquidity pool resides | + | '''Exchange:''' The decentralized exchange where the liquidity pool resides. |
| − | '''Token A ID''' and '''Token B ID:''' The pair of tokens involved in the liquidity pool for which you want to check your LP | + | '''Token A ID''' and '''Token B ID:''' The pair of tokens involved in the liquidity pool for which you want to check your LP token balance. These can be the coin symbol, or the contract address. |
== Return Value == | == Return Value == | ||
| − | This function returns | + | |
| + | This function returns the number of LP tokens you currently hold from the specified liquidity pool. | ||
== Example == | == Example == | ||
| + | |||
<pre> | <pre> | ||
| − | log("LP | + | ui console view |
| + | config defi wallet("your private key") | ||
| + | log("LP Token Balance: {$get liquidity pool balance("PancakeSwap", "ETH", "DAI")}") | ||
</pre> | </pre> | ||
| − | The | + | Please replace "your private key" with your actual DeFi wallet's private key. |
| + | |||
| + | Be mindful when you are handling your private key. It's a sensitive piece of data that allows full control over your funds in your DeFi wallet. Therefore, never share this key publicly or with anyone. | ||
| + | |||
| + | The example command will return the current number of LP tokens you hold in the ETH-DAI pool on PancakeSwap. | ||
Example Output: | Example Output: | ||
| + | |||
<blockquote> | <blockquote> | ||
| − | <p>LP | + | <p>LP Token Balance: 10</p> |
</blockquote> | </blockquote> | ||
| − | |||
| − | |||
Latest revision as of 01:36, 5 July 2023
$get liquidity pool balance is a function that returns the number of LP (Liquidity Provider) tokens you have from a specific liquidity pool on a decentralized exchange.
LP tokens are given when you invest into a liquidity pool. They represent your share or stake in the pool.
[edit] Parameters
Exchange: The decentralized exchange where the liquidity pool resides.
Token A ID and Token B ID: The pair of tokens involved in the liquidity pool for which you want to check your LP token balance. These can be the coin symbol, or the contract address.
[edit] Return Value
This function returns the number of LP tokens you currently hold from the specified liquidity pool.
[edit] Example
ui console view
config defi wallet("your private key")
log("LP Token Balance: {$get liquidity pool balance("PancakeSwap", "ETH", "DAI")}")
Please replace "your private key" with your actual DeFi wallet's private key.
Be mindful when you are handling your private key. It's a sensitive piece of data that allows full control over your funds in your DeFi wallet. Therefore, never share this key publicly or with anyone.
The example command will return the current number of LP tokens you hold in the ETH-DAI pool on PancakeSwap.
Example Output:
LP Token Balance: 10
