Get liquidity pool value

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
'''$defi liquidity pool value''' is a function that calculates the value of your investment in a liquidity pool on a specific decentralized exchange, shown in USD.
+
'''$get liquidity pool value''' is a function that returns the value, in USD, that you have currently invested in a specific liquidity pool on a decentralized exchange.
 
+
This function is extremely useful for enterprise users who are providing liquidity on decentralized exchanges and want to know the current value of their investment.
+
 
+
== User Level ==
+
 
+
This function is exclusively available for enterprise users.
+
  
 
== Parameters ==
 
== Parameters ==
  
'''Exchange:''' The decentralized exchange where your liquidity pool is located.
+
'''Exchange:''' The decentralized exchange where the liquidity pool resides.
  
'''Token A ID:''' The ID of the first token in the liquidity pool.
+
'''Token A ID''' and '''Token B ID:''' The pair of tokens involved in the liquidity pool for which you want to check your investment value. This can be the token's symbol or the contract address.
  
'''Token B ID:''' The ID of the second token in the liquidity pool.
+
== Return Value ==
  
== Return Value ==
+
This function returns the dollar value of your current investment in the specified liquidity pool.
 
+
This function returns a string value which is the current value of your liquidity pool investment in USD.
+
  
 
== Example ==
 
== Example ==
  
 
<pre>
 
<pre>
define areacode
+
ui console view
ui text msg("Your investment value in USDT/ETH on Uniswap is: {$defi liquidity pool value("Uniswap", "USDT", "ETH")}")
+
config defi wallet("your private key")
 +
log("Liquidity Pool Investment Value: ${$get liquidity pool value("PancakeSwap", "ETH", "DAI")}")
 
</pre>
 
</pre>
  
In this example, the function is calculating the current value of your investment in the USDT/ETH liquidity pool on Uniswap in USD, and then displaying that value in the UI.
+
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 investment value in USD that you have in the ETH-DAI pool on PancakeSwap.
 +
 
 +
Example Output:
 +
 
 +
<blockquote>
 +
<p>Liquidity Pool Investment Value: $1500.00</p>
 +
</blockquote>

Latest revision as of 01:39, 5 July 2023

$get liquidity pool value is a function that returns the value, in USD, that you have currently invested in a specific liquidity pool on a decentralized exchange.

[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 investment value. This can be the token's symbol or the contract address.

[edit] Return Value

This function returns the dollar value of your current investment in the specified liquidity pool.

[edit] Example

ui console view
config defi wallet("your private key")
log("Liquidity Pool Investment Value: ${$get liquidity pool value("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 investment value in USD that you have in the ETH-DAI pool on PancakeSwap.

Example Output:

Liquidity Pool Investment Value: $1500.00

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox