Get farm balance

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
'''$lp farm balance''' is a function that retrieves the balance of Liquidity Provider (LP) tokens staked in a specified yield farm.
+
'''$get farm balance''' is a function that returns the balance of LP (Liquidity Provider) tokens you have staked in a specific yield farm.
 
+
This function is beneficial for getting to know the number of LP tokens you have staked in a particular farm on a decentralized exchange.
+
  
 
== Parameters ==
 
== Parameters ==
  
'''Farm:''' The yield farm for which you want to check your staked LP tokens. The available farms will be dependent on the "FarmNames" list set in your environment.
+
'''Farm:''' The yield farm for which you want to check your LP token balance.
  
 
== Return Value ==
 
== Return Value ==
This function returns a string denoting the number of LP tokens staked in the specified yield farm.
+
 
 +
This function returns the total number of LP tokens you have staked in the chosen yield farm.
  
 
== Example ==
 
== Example ==
 +
 
<pre>
 
<pre>
log("LP tokens staked in PancakeSwap farm: {$lp farm balance("PancakeSwap")}")
+
config defi wallet("your private key")
 +
log("Farm Balance: {$get farm balance("PancakeSwap Farm")}")
 
</pre>
 
</pre>
  
The output will display the number of LP tokens you have staked in the specified yield 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 on PancakeSwap.
  
 
Example Output:
 
Example Output:
 +
 
<blockquote>
 
<blockquote>
<p>LP tokens staked in PancakeSwap farm: 10</p>
+
<p>Farm Balance: 50</p>
 
</blockquote>
 
</blockquote>
  
The actual balance will vary depending on the number of LP tokens you have staked in the farm.
+
Knowing your staked balance in a farm allows you to track your investment and assist decisions on when to withdraw or add more LP tokens for yield farming. Be aware that LP token values can fluctuate based on the current state of the farm and market conditions.

Revision as of 20:05, 4 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.

Parameters

Farm: The yield farm for which you want to check your LP token balance.

Return Value

This function returns the total number of LP tokens you have staked in the chosen yield farm.

Example

config defi wallet("your private key")
log("Farm Balance: {$get farm balance("PancakeSwap 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 on PancakeSwap.

Example Output:

Farm Balance: 50

Knowing your staked balance in a farm allows you to track your investment and assist decisions on when to withdraw or add more LP tokens for yield farming. Be aware that LP token values can fluctuate based on the current state of the farm and market conditions.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox