/callReadFunctionForStellarSmartContract

1 min

POST

Evaluates a smart contract function call by performing a dry run using eth_call.

This allows you to test contract interactions and retrieve return values without executing an actual transaction or spending gas. Useful for testing contract state changes and validating parameters before sending actual transactions.

-------------------- Request --------------------

      callReadFunctionForStellarSmartContract(
              contract_address="CCOZ5XDWPXVYLIUCLK2YKW5RXPOWINDB2FIQBM5JUXAWLMQW5RRMELNF",
              function_name="execute",
              parameters_fields_types_and_values=[
                  ["address", "GBCT2KLG4F4Y7A53KITD4WAM4QW5P5BPBQAFPTUEQWXIROVQU3TNEICW"]
              ],
              structs="((id,u32),(name,string),(tags,symbol[]))"
      ):


-------------------- Response --------------------

{
  "FunctionData": {
      "ApprovalRequestStatus": 3,
      "CoinType": "DOT",
      "Transactions": [
          {
              "AmountToTransfer": "1000000",
              "DestinationAddress": "5CBy...Jtf"
          }
      ]
  },
  "Meta": {
      "AccessToken": "f192762c...",
      "Destination": "045bd19d...",
      "Source": "6f8fd2e8...",
      "Time": "2024-09-29 20:48:21.158"
        }
    }

account_idintegerInternal MPC account identifier that will sign the authorization (the "Hot" signer).

contract_addressstringTarget contract address (C-address, StrKey starting with 'C…').

max_feeintegerMaximum fee to use for building/simulating the transaction that computes the authorization.

function_namestringContract function to invoke (symbol), e.g. "execute".

parameters_fields_types_and_valuesarrayArgument list for the function. Each element describes one SCVal argument. Typical shapes we accept: <ul> <li><code>["address", "<G…|C…>"]</code></li> <li><code>["u32", "123"]</code>, <code>["i128", "-42"]</code></li> <li><code>["symbol", "transfer"]</code></li> <li><code>["string", "hello"]</code></li> <li><code>["bytes", "0x…"]</code>, <code>["bytes32", "0x…"]</code></li> <li>Composite types like <code>["vec<u64>", [ "1","2","3" ]]</code></li> <li>Maps as <code>["map<symbol,u128>", [[["symbol","USD"],["u128","1000"]], …]]</code> For complex/named structs, provide the <code>structs</code> mapping below.</li> </ul>

structsstring(Optional) Schema for user-defined structs used inside parameters. Example: { "MyStruct": [ ["symbol","code"], ["u128","amount"] ] }

specificFromAddressstringThe specific deposit address to send from. Cannot be used if the account is defined as an Omnibus account.

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/callReadFunctionForStellarSmartContract?account_id=1&contract_address=CCOZ5XDWPXVYLIUCLK2YKW5RXPOWINDB2FIQBM5JUXAWLMQW5RRMELNF&max_fee=4000000&function_name=execute&parameters_fields_types_and_values=array&structs=None' \
     --header 'accept: application/json'