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

    Interface EnableTransactionWaitAndSimulationArgs

    Options of a submission.

    • enableTransactionSimulation: simulate the transaction before it is submitted. A simulation with a status other than Success throws SupraSimulationFailedError (SupraGasUnitPriceBelowMinimumError when the gas unit price is below the node's minimum) and the transaction is not submitted. When the transaction's number is ahead of the chain's behind transactions that this client submitted, the simulation is made with the sender's sequence number on the chain and the transaction is submitted with its own, as for the max gas estimate (see OptionalTransactionPayloadArgs); a failed read of the account during that check is thrown. Default false.
    • enableWaitForTransaction: wait until the transaction has a final status. A final status other than Success throws SupraTransactionFailedError, unless checkSuccess is false; no final status within waitTimeoutMs throws SupraTransactionTimeoutError. When the submission request timed out, failed before the node answered or was answered with a 5xx status other than 503, the wait is for the hash derived before the submission, and no final status within waitTimeoutMs throws SupraSubmissionOutcomeUnknownError. Default false.
    • checkSuccess: with enableWaitForTransaction, throw SupraTransactionFailedError for a final status other than Success. When false, the transaction is returned whatever its final status. Default true.
    • waitTimeoutMs: with enableWaitForTransaction, the longest time to wait for a final status, in milliseconds. Default waitTimeoutMs of SupraConfig, else DEFAULT_TXN_WAIT_TIMEOUT_MS (60000).
    interface EnableTransactionWaitAndSimulationArgs {
        enableWaitForTransaction?: boolean;
        enableTransactionSimulation?: boolean;
        checkSuccess?: boolean;
        waitTimeoutMs?: number;
    }
    Index
    enableWaitForTransaction?: boolean
    enableTransactionSimulation?: boolean
    checkSuccess?: boolean
    waitTimeoutMs?: number