Skip to main content
Version: pre-release (v0.79)

Check transaction

POST 
/transaction/check

Send a signed transaction containing a command to the network to be checked, but not added to the chain's mempool. This is useful for checking the validity of a potential transaction before submitting it.

Request​

Body

required
    tx object

    Transaction containing a command to be checked on the network, and not added to the chain's mempool.

    address string

    Hex-encoded address of the sender. Not supported yet.

    inputData byte

    Protobuf message of type InputData marshalled into bytes. If the transaction version is V3 or higher then this bytes string must be prepended with chain_id_as_byes + \0.

    pow object

    Proof-of-work containing the random transaction ID used by the client and the nonce.

    nonce uint64

    Number which, combined with the transaction identifier, will produce a hash with the required number of leading zeros to be accepted by the network.

    tid string

    Unique transaction identifier used to seed the proof-of-work hash.

    pubKey string

    Hex-encoded public key of the sender.

    signature object

    Signature of the input data field, signed by the sender of this transaction.

    algo string

    Algorithm used to create the signature.

    value string

    Hex encoded bytes of the signature.

    version int64

    Version of the algorithm used to create the signature.

    version v1TxVersion (string)

    Possible values: [TX_VERSION_UNSPECIFIED, TX_VERSION_V2, TX_VERSION_V3]

    Default value: TX_VERSION_UNSPECIFIED

    Version of the transaction.

Responses​

A successful response.

Schema
    info string

    Unused.

    code int64

    Error code to indicate the category of failure if the transaction was not successfully checked.

    data string

    Further details for why the transaction was not successfully submitted.

    gasUsed int64

    Unused.

    gasWanted int64

    Amount of space in a block that the transaction will fill. This does not relate to any monetary cost for submitting the transaction.

    log string

    Further details for the underlying consensus layer of the result of the transaction.

    success boolean

    Whether or not the transaction passed the submission checks.

Loading...