Get farm balance
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | '''$ | + | '''$get farm balance''' is a function that returns the balance of LP (Liquidity Provider) tokens you have staked in a specific yield farm. |
| − | + | ||
| − | + | ||
== Parameters == | == Parameters == | ||
| − | '''Farm:''' The yield farm | + | '''Farm:''' The yield farm from where you want to claim your rewards. If the farm you want isn't in the list, you can find it and get it added to the list via the '''$find farm by tokens''' function. |
== Return Value == | == Return Value == | ||
| − | This function returns | + | |
| + | This function returns the total number of LP tokens you have staked in the chosen yield farm. | ||
== Example == | == Example == | ||
| + | |||
<pre> | <pre> | ||
| − | log(" | + | ui console view |
| + | config defi wallet("your private key") | ||
| + | log("Farm Balance: {$get farm balance("DOGE_WBNB_Farm")}") | ||
</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 staked LP tokens you have in the specified farm. | ||
Example Output: | Example Output: | ||
| + | |||
<blockquote> | <blockquote> | ||
| − | <p> | + | <p>Farm Balance: 50</p> |
</blockquote> | </blockquote> | ||
| − | |||
| − | |||
Latest revision as of 00:12, 5 July 2023
$get farm balance is a function that returns the balance of LP (Liquidity Provider) tokens you have staked in a specific yield farm.
[edit] Parameters
Farm: The yield farm from where you want to claim your rewards. If the farm you want isn't in the list, you can find it and get it added to the list via the $find farm by tokens function.
[edit] Return Value
This function returns the total number of LP tokens you have staked in the chosen yield farm.
[edit] Example
ui console view
config defi wallet("your private key")
log("Farm Balance: {$get farm balance("DOGE_WBNB_Farm")}")
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 staked LP tokens you have in the specified farm.
Example Output:
Farm Balance: 50
