Run smart contract function

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
(Example)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
'''$defi contract run''' is a function that runs a specified function on a smart contract.
+
'''$run smart contract function''' is a function in UBot Studio that allows you to execute a function on a specific smart contract on a specified blockchain chain.
 
+
Designed for enterprise users, this function is particularly useful for interacting with DeFi protocols on Avalanche and Binance Smart Chain.
+
 
+
== User Level ==
+
 
+
This function is exclusively available for enterprise users.
+
  
 
== Parameters ==
 
== Parameters ==
  
'''Chain:''' The blockchain where the smart contract is located. The options are "Avalanche" or "BinanceSmartChain".  
+
'''Chain:''' The blockchain on which the smart contract resides.
  
'''Contract Address:''' The address of the smart contract.
+
'''Contract Address:''' The address of the smart contract that contains the function you want to execute.  
  
'''Function Name:''' The specific function that you want to run on the smart contract.
+
'''Function Name:''' The name of the function you want to run on the smart contract.
  
'''Parameters:''' Additional parameters to be included when running the function on the smart contract.
+
'''Parameters:''' The parameters for the function, if any. They should be written as a list in either yaml or json format. for instance, using json format, parameters might look like:
 +
<pre>
 +
[1,2,3]
 +
</pre>
 +
In yaml format, the same parameters would look like:
 +
<pre>
 +
- 1
 +
- 2
 +
- 3
 +
</pre>
  
== Return Value ==  
+
== Return Value ==
  
This function returns a string value that represents the output of the function that's run on the smart contract.
+
This function returns the result of the function executed, either as plain text, or as a yaml object.
  
 
== Example ==
 
== Example ==
  
 
<pre>
 
<pre>
define areacode
+
config defi wallet("your private key")
ui text msg("Function Output: {$defi contract run("BinanceSmartChain", "0x...", "swapExactETHForTokens", "['500', '0x...', '0x...', '1600396754']")}")
+
log object($run smart contract function("BinanceSmartChain", "0x1234abcd5678efgh9012ijkl34mn56op7890qrstu", "balanceOf", "[0xabcdef123456ghijklm789012nopqr3456stuvwx89]"))
 
</pre>
 
</pre>
  
In this example, the function "swapExactETHForTokens" is run on a smart contract located on the Binance Smart Chain. The smart contract address, function name, and parameters have been anonymized for security reasons. Replace these with your actual details.
+
Please replace "your private key" with your actual DeFi wallet's private key. Also, change the contract address with the contract address of the token you're checking the balance of. Change the address in the parameters list to be your wallet address.
 +
 
 +
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 above example gets the "balanceOf" function result for the specified wallet address on a specific smart contract in the Binance Smart Chain.

Latest revision as of 20:15, 4 July 2023

$run smart contract function is a function in UBot Studio that allows you to execute a function on a specific smart contract on a specified blockchain chain.

[edit] Parameters

Chain: The blockchain on which the smart contract resides.

Contract Address: The address of the smart contract that contains the function you want to execute.

Function Name: The name of the function you want to run on the smart contract.

Parameters: The parameters for the function, if any. They should be written as a list in either yaml or json format. for instance, using json format, parameters might look like:

[1,2,3]

In yaml format, the same parameters would look like:

- 1
- 2
- 3

[edit] Return Value

This function returns the result of the function executed, either as plain text, or as a yaml object.

[edit] Example

config defi wallet("your private key")
log object($run smart contract function("BinanceSmartChain", "0x1234abcd5678efgh9012ijkl34mn56op7890qrstu", "balanceOf", "[0xabcdef123456ghijklm789012nopqr3456stuvwx89]"))

Please replace "your private key" with your actual DeFi wallet's private key. Also, change the contract address with the contract address of the token you're checking the balance of. Change the address in the parameters list to be your wallet address.

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 above example gets the "balanceOf" function result for the specified wallet address on a specific smart contract in the Binance Smart Chain.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox