POSTsui_getTransactionBlock

Sui Mainnethttps://sui-mainnet.nodit.io/

Return the transaction response object.

Request Body
idintegerrequired
jsonrpcstringrequired
methodstringrequired
paramsoneOf[]required
params[0]string

A transaction will have a (unique) digest.

Responses
jsonrpcstring
idinteger
balanceChangesarraynull
checkpointstring
confirmedLocalExecutionbooleannull
digeststringrequired

A transaction will have a (unique) digest.

effectsoneOf
object 1object
abortErrorobject
error_codeinteger,null (uint64)
functionstringnull
lineinteger,null (uint16)
module_idstringnull
createdobject[]

ObjectRef and owner of new objects created.

owneroneOfrequired
object 1object
AddressOwnerstringrequired

Hex string encoding.

object 2object
ObjectOwnerstringrequired

Hex string encoding.

object 3object
Sharedobjectrequired
string 4string (enum)
object 5object
ConsensusAddressOwnerobjectrequired
referenceobjectrequired
digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

deletedobject[]

Object Refs of objects now deleted (the old refs).

digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

dependenciesstring[]

The set of transaction digests this transaction depends on.

eventsDigeststring

A representation of a 32 byte digest

executedEpochstringrequired

The epoch when this transaction was executed.

gasObjectobjectrequired

The updated gas object reference. Have a dedicated field for convenient access. It's also included in mutated.

owneroneOfrequired
object 1object
AddressOwnerstringrequired

Hex string encoding.

object 2object
ObjectOwnerstringrequired

Hex string encoding.

object 3object
Sharedobjectrequired
string 4string (enum)
object 5object
ConsensusAddressOwnerobjectrequired
referenceobjectrequired
digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

gasUsedobjectrequired

Summary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: storage_cost: it is the charge of storage at the time the transaction is executed. The cost of storage is the number of bytes of the objects being mutated multiplied by a variable storage cost per byte storage_rebate: this is the amount a user gets back when manipulating an object. The storage_rebate is the storage_cost for an object minus fees. non_refundable_storage_fee: not all the value of the object storage cost is given back to user and there is a small fraction that is kept by the system. This value tracks that charge.

When looking at a gas cost summary the amount charged to the user is computation_cost + storage_cost - storage_rebate and that is the amount that is deducted from the gas coins. non_refundable_storage_fee is collected from the objects being mutated/deleted and it is tracked by the system in storage funds.

Objects deleted, including the older versions of objects mutated, have the storage field on the objects added up to a pool of "potential rebate". This rebate then is reduced by the "nonrefundable rate" such that: potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee

computationCoststringrequired

Cost of computation/execution

nonRefundableStorageFeestringrequired

The fee for the rebate. The portion of the storage rebate kept by the system.

storageCoststringrequired

Storage cost, it's the sum of all storage cost for all objects created or mutated.

storageRebatestringrequired

The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.

messageVersionstring (enum)required
modifiedAtVersionsobject[]

The version that every modified (mutated or deleted) object had before it was modified by this transaction.

objectIdstringrequired

Hex string encoding.

sequenceNumberinteger (uint64)required
mutatedobject[]

ObjectRef and owner of mutated objects, including gas object.

owneroneOfrequired
object 1object
AddressOwnerstringrequired

Hex string encoding.

object 2object
ObjectOwnerstringrequired

Hex string encoding.

object 3object
Sharedobjectrequired
string 4string (enum)
object 5object
ConsensusAddressOwnerobjectrequired
referenceobjectrequired
digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

sharedObjectsobject[]

The object references of the shared objects used in this transaction. Empty if no shared objects were used.

digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

statusoneOfrequired

The status of the execution

object 1object
statusstring (enum)required
object 2object
errorstringrequired
statusstring (enum)required
transactionDigeststringrequired

The transaction digest

unwrappedobject[]

ObjectRef and owner of objects that are unwrapped in this transaction. Unwrapped objects are objects that were wrapped into other objects in the past, and just got extracted out.

owneroneOfrequired
object 1object
AddressOwnerstringrequired

Hex string encoding.

object 2object
ObjectOwnerstringrequired

Hex string encoding.

object 3object
Sharedobjectrequired
string 4string (enum)
object 5object
ConsensusAddressOwnerobjectrequired
referenceobjectrequired
digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

unwrappedThenDeletedobject[]

Object refs of objects previously wrapped in other objects but now deleted.

digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

wrappedobject[]

Object refs of objects now wrapped in other objects.

digeststringrequired

Base64 string representing the object digest

objectIdstringrequired

Hex code as string representing the object id

versioninteger (uint64)required

Object version.

errorsstring[]
eventsarraynull
objectChangesarraynull
rawEffectsinteger (uint8)[]
rawTransactionstring

BCS encoded [SenderSignedData] that includes input object references returns empty array if show_raw_transaction is false

timestampMsstring
transactionobject
dataoneOfrequired
object 1object
gasDataobjectrequired
budgetstringrequired
ownerstringrequired

Hex string encoding.

paymentobject[]required
pricestringrequired
messageVersionstring (enum)required
senderstringrequired

Hex string encoding.

transactiononeOfrequired
object 1object
computation_chargestringrequired
epochstringrequired
epoch_start_timestamp_msstringrequired
kindstring (enum)required
storage_chargestringrequired
storage_rebatestringrequired
object 2object
kindstring (enum)required
objectsstring[]required
object 3object
commit_timestamp_msstringrequired
epochstringrequired
kindstring (enum)required
roundstringrequired
object 4object
inputsoneOf[]required

Input objects or primitive values

object 1oneOf
object 2object
kindstring (enum)required
transactionsoneOf[]required

The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.

object 1object
object 2object
object 3object
object 4object
object 5object
object 6object
object 7object
object 5object
epochstringrequired
kindstring (enum)required
new_active_jwksobject[]required
roundstringrequired
object 6object
epochstringrequired
kindstring (enum)required
random_bytesinteger (uint8)[]required
randomness_roundstringrequired
object 7object
kindstring (enum)required
transactionsoneOf[]required
string 1string (enum)
object 2object
object 3object
object 4object
object 5object
object 8object
commit_timestamp_msstringrequired
consensus_commit_digeststringrequired

A representation of a 32 byte digest

epochstringrequired
kindstring (enum)required
roundstringrequired
object 9object
commit_timestamp_msstringrequired
consensus_commit_digeststringrequired

A representation of a 32 byte digest

consensus_determined_version_assignmentsoneOfrequired

Uses an enum to allow for future expansion of the ConsensusDeterminedVersionAssignments.

object 1object
object 2object
epochstringrequired
kindstring (enum)required
roundstringrequired
sub_dag_indexstring
object 10object
additional_state_digeststringrequired

A representation of a 32 byte digest

commit_timestamp_msstringrequired
consensus_commit_digeststringrequired

A representation of a 32 byte digest

consensus_determined_version_assignmentsoneOfrequired

Uses an enum to allow for future expansion of the ConsensusDeterminedVersionAssignments.

object 1object
object 2object
epochstringrequired
kindstring (enum)required
roundstringrequired
sub_dag_indexstring
object 11object
inputsoneOf[]required

Input objects or primitive values

object 1oneOf
object 2object
kindstring (enum)required
transactionsoneOf[]required

The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.

object 1object
object 2object
object 3object
object 4object
object 5object
object 6object
object 7object
txSignaturesoneOf[]required
object 1object
MultiSigobjectrequired

The struct that contains signatures and public keys necessary for authenticating a MultiSig.

bitmapinteger (uint16)required

A bitmap that indicates the position of which public key the signature should be authenticated with.

multisig_pkobjectrequired

The public key encoded with each public key with its signature scheme used along with the corresponding weight.

sigsoneOf[]required

The plain signature encoded with signature scheme.

object 1object
object 2object
object 3object
object 4object
object 5object
object 2object
MultiSigLegacyobjectrequired

Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary for authenticating a MultiSigLegacy.

bitmapstringrequired

A bitmap that indicates the position of which public key the signature should be authenticated with.

multisig_pkobjectrequired

The public key encoded with each public key with its signature scheme used along with the corresponding weight.

sigsoneOf[]required

The plain signature encoded with signature scheme.

object 1object
object 2object
object 3object
object 4object
object 5object
object 3object
SignatureoneOfrequired
object 1object
Ed25519SuiSignaturestringrequired

Base64 encoding

object 2object
Secp256k1SuiSignaturestringrequired

Base64 encoding

object 3object
Secp256r1SuiSignaturestringrequired

Base64 encoding

object 4object
ZkLoginAuthenticatorobjectrequired

An zk login authenticator with all the necessary fields.

inputsobjectrequired

All inputs required for the zk login proof verification and other public inputs.

maxEpochinteger (uint64)required
userSignatureoneOfrequired
object 1object
object 2object
object 3object
object 5object
PasskeyAuthenticatorobjectrequired

An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].

authenticator_datainteger (uint8)[]required

authenticatorData is a bytearray that encodes Authenticator Data structure returned by the authenticator attestation response as is.

client_data_jsonstringrequired

clientDataJSON contains a JSON-compatible UTF-8 encoded string of the client data which is passed to the authenticator by the client during the authentication request (see CollectedClientData)

X-API-KEY
RequestCU30
cURL
curl -X POST "https://sui-mainnet.nodit.io/" \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "sui_getTransactionBlock",
  "params": [
    "Hay2tj3GcDYcE3AMHrej5WDsHGPVAYsegcubixLUvXUF",
    {
      "showInput": true,
      "showRawInput": false,
      "showEffects": true,
      "showEvents": true,
      "showObjectChanges": false,
      "showBalanceChanges": false,
      "showRawEffects": false
    }
  ]
}'
Response
Example · 200
{
  "jsonrpc": "2.0",
  "result": {
    "digest": "Hay2tj3GcDYcE3AMHrej5WDsHGPVAYsegcubixLUvXUF",
    "transaction": {
      "data": {
        "messageVersion": "v1",
        "transaction": {
          "kind": "ProgrammableTransaction",
          "inputs": [
            {
              "type": "pure",
              "valueType": "address",
              "value": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
            },
            {
              "type": "object",
              "objectType": "immOrOwnedObject",
              "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
              "version": "2",
              "digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN"
            }
          ],
          "transactions": [
            {
              "TransferObjects": [
                [
                  {
                    "Input": 1
                  }
                ],
                {
                  "Input": 0
                }
              ]
            }
          ]
        },
        "sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
        "gasData": {
          "payment": [
            {
              "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
              "version": 2,
              "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
            }
          ],
          "owner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
          "price": "10",
          "budget": "100000"
        }
      },
      "txSignatures": [
        "AMU7cJTEsJ5WoVlKZ2zsVuGMk9linDuNqLV9eGIIrqarP2x4R9riuvmmMgXfdxMm7jTzYxbHrsDNMwlxpTbbFghtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA=="
      ]
    },
    "rawTransaction": "AQAAAAAAAgAggZbQSLem0EyO3IlXnYb9P8kMUvmhTGuBK5T+YTxbzrsBAF7rHUSeJRYWbVfXH96xVNDcns23swBX0KkyaEysNSzcAgAAAAAAAAAg43+UGkUe+CCaD7+/G1SbK7Jrjq7giJUUbfJ7w88mEMEBAQEBAQABAACCF5xX1Ylbq/tlXNYujohqUzNLXnvpvmWOt1nMNeP8ZgEaPomAKdAk7sHUTGr14vrN7YTQO1NzUU8W49ZuAAgQUQIAAAAAAAAAIGS7c6HtWLLBiwy/N3eS4gbmuA1NXupk4ucFY7FYkCbEghecV9WJW6v7ZVzWLo6IalMzS1576b5ljrdZzDXj/GYKAAAAAAAAAKCGAQAAAAAAAAFhAMU7cJTEsJ5WoVlKZ2zsVuGMk9linDuNqLV9eGIIrqarP2x4R9riuvmmMgXfdxMm7jTzYxbHrsDNMwlxpTbbFghtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA==",
    "effects": {
      "messageVersion": "v1",
      "status": {
        "status": "success"
      },
      "executedEpoch": "0",
      "gasUsed": {
        "computationCost": "100",
        "storageCost": "100",
        "storageRebate": "10",
        "nonRefundableStorageFee": "0"
      },
      "transactionDigest": "6AyFnAuKAKCqm1cD94EyGzBqJCDDJ716ojjmsKF2rqoi",
      "mutated": [
        {
          "owner": {
            "AddressOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66"
          },
          "reference": {
            "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
            "version": 2,
            "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
          }
        },
        {
          "owner": {
            "AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
          },
          "reference": {
            "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
            "version": 2,
            "digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN"
          }
        }
      ],
      "gasObject": {
        "owner": {
          "ObjectOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66"
        },
        "reference": {
          "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
          "version": 2,
          "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
        }
      },
      "eventsDigest": "9BQobwxQvJ1JxSXNn8v8htZPTu8FEzJJGgcD4kgLUuMd"
    },
    "objectChanges": [
      {
        "type": "transferred",
        "sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
        "recipient": {
          "AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
        },
        "objectType": "0x2::example::Object",
        "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
        "version": "2",
        "digest": "64UQ3a7m1mjWuzgyGoH8RnMyPGDN4XYTC9dS4qiSfdK4"
      }
    ]
  },
  "id": 1
}