supra-ts-sdk - v2.0.0
    Preparing search index...

    Class Simulate

    The Simulate class provides methods for simulating transactions on the Supra network.

    Index
    • The constructor function takes a NetworkConfig object as a parameter and assigns it to the networkInformation property.

      Parameters

      • networkInformation: NetworkConfig

        A NetworkConfig object that contains information about the network on which the Supra client is running.

      Returns Simulate

      import { SupraClient,Network } from "supra-ts-sdk";

      const supra = new SupraClient({ network: Network.TESTNET });
    • Simulate a transaction using the provided transaction payload. The request carries a copy of the payload with zero signatures; args.sendTxPayload is not modified.

      Parameters

      Returns Promise<TransactionResponse>

      Transaction simulation result, whose status is Success

      SupraSimulationFailedError when the simulated status is Fail, PendingAfterExecution (validation failed, for example SENDING_ACCOUNT_DOES_NOT_EXIST or SEQUENCE_NUMBER_TOO_NEW) or Invalid; the error carries the simulated transaction and its vm_status

      SupraGasUnitPriceBelowMinimumError instead when the status is Invalid because the gas unit price is below the node's minimum (GAS_UNIT_PRICE_BELOW_MIN_BOUND); the SupraSimulationFailedError is its cause

      import { BCS, Network, SupraAccount, SupraClient } from "supra-ts-sdk";

      const supra = new SupraClient({ network: Network.TESTNET });
      const account = new SupraAccount(); // an account that holds SUPRA

      async function runExample() {
      const rawTxn = supra.transaction.build.rawTxnObject({
      senderAddress: account.address(),
      senderSequenceNumber: (await supra.account.getAccountInfo({ accountAddress: account.address() })).sequence_number,
      function: "0x1::supra_account::transfer",
      functionTypeArgs: [],
      functionArgs: [new SupraAccount().address().toUint8Array(), BCS.bcsSerializeUint64(10000n)],
      optionalTransactionPayloadArgs: { gasUnitPrice: await supra.getEstimatedGasUnitPrice() },
      });
      const sendTxPayload = await supra.transaction.build.sendTxnPayload({ senderAccount: account, rawTxn });

      const response = await supra.transaction.simulate.simple({ sendTxPayload });
      console.log(response.status, response.output);
      }
      runExample().catch(console.error);
    • Simulate a transaction using the provided Serialized raw transaction data

      Parameters

      • args: {
            txAuthenticator: MoveInnerAuthenticator;
            serializedRawTransaction: Uint8Array;
        }
        • txAuthenticator: MoveInnerAuthenticator

          Transaction authenticator

        • serializedRawTransaction: Uint8Array

          Serialized raw transaction data

      Returns Promise<TransactionResponse>

      Transaction simulation result, whose status is Success

      SupraSimulationFailedError when the simulated status is not Success, as for Simulate.simple

      SupraGasUnitPriceBelowMinimumError when the gas unit price is below the node's minimum, as for Simulate.simple

      import { BCS, Network, SupraAccount, SupraClient } from "supra-ts-sdk";

      const supra = new SupraClient({ network: Network.TESTNET });
      const account = new SupraAccount(); // an account that holds SUPRA

      async function runExample() {
      const rawTxn = supra.transaction.build.rawTxnObject({
      senderAddress: account.address(),
      senderSequenceNumber: (await supra.account.getAccountInfo({ accountAddress: account.address() })).sequence_number,
      function: "0x1::supra_account::transfer",
      functionTypeArgs: [],
      functionArgs: [new SupraAccount().address().toUint8Array(), BCS.bcsSerializeUint64(10000n)],
      optionalTransactionPayloadArgs: { gasUnitPrice: await supra.getEstimatedGasUnitPrice() },
      });

      const response = await supra.transaction.simulate.serialized({
      txAuthenticator: { Ed25519: { public_key: account.pubKey().toString(), signature: "0x" + "00".repeat(64) } },
      serializedRawTransaction: BCS.bcsToBytes(rawTxn),
      });
      console.log(response.status, response.output);
      }
      runExample().catch(console.error);
    • Beta

      Simulates a transaction with POST /rpc/v4/transactions/simulate and returns it together with the changes it would make to Move state and the value each changed state key held before it. Use it to see what a transaction does that emits no event (stake::set_delegated_voter, a third-party module's writes) before signing it. Simulate.simple is unchanged and keeps calling /rpc/v3.

      Needs a node from supra_node_v12.0.0 for the state-change fields. Mainnet and Testnet nodes of supra_node_v11.7.x answer this route as /rpc/v3 does, with the transaction and its output only: the call succeeds and state_height, changes, prior_values, omitted, omitted_counts and changes_truncated are absent from the result. Check changes !== undefined before reading them.

      The request carries a copy of the payload with zero signatures; args.sendTxPayload is not modified. The node bounds the size of changes and prior_values (rest_limits.simulate.max_state_changes_bytes, 1 MiB by default) and spends it on the signers' own resources first, then other resources, table items and modules last. A state key that does not fit is left out of both and listed in omitted; changes_truncated is then true.

      Preview: wraps an API added in supra_node_v12.0.0, which may change until that release reaches Testnet.

      Parameters

      Returns Promise<TransactionSimulationV4>

      The simulated transaction, whose status is Success, with state_height (the last block whose state the simulation ran against), changes, prior_values (keyed by each change's state_key_hash, null for a key that held no value), omitted, omitted_counts and changes_truncated

      SupraSimulationFailedError when the simulated status is not Success, as for Simulate.simple; its transaction carries the state-change fields the node reported

      SupraGasUnitPriceBelowMinimumError when the gas unit price is below the node's minimum, as for Simulate.simple

      When the node answers HTTP 404 for the route

      import { BCS, Network, SupraAccount, SupraClient } from "supra-ts-sdk";

      const supra = new SupraClient({ network: Network.DEVNET });
      const account = new SupraAccount(); // an account that holds SUPRA

      async function runExample() {
      const rawTxn = supra.transaction.build.rawTxnObject({
      senderAddress: account.address(),
      senderSequenceNumber: (await supra.account.getAccountInfo({ accountAddress: account.address() })).sequence_number,
      function: "0x1::supra_account::transfer",
      functionTypeArgs: [],
      functionArgs: [new SupraAccount().address().toUint8Array(), BCS.bcsSerializeUint64(10000n)],
      optionalTransactionPayloadArgs: { gasUnitPrice: await supra.getEstimatedGasUnitPrice() },
      });
      const sendTxPayload = await supra.transaction.build.sendTxnPayload({ senderAccount: account, rawTxn });

      const response = await supra.transaction.simulate.withStateChanges({ sendTxPayload });
      for (const change of response.changes ?? []) {
      console.log(change.type, change.state_key_hash);
      }
      console.log(response.changes_truncated, response.state_height);
      }
      runExample().catch(console.error);