Get started building your first Thru program now! 🚧 Pre-release documentation. Content subject to change, or may be inaccurate. 🚧
API Reference
gRPC API
REST API
- Overview
- POSTSubmit a new transaction to the cluster.
- POSTSubmit multiple transactions to the cluster in batch.
- POSTSubmit a transaction and track its execution status. Returns a stream of status updates starting with RECEIVED, then ACCEPTED, followed by consensus and execution updates, closing after the transaction is executed.
- POST
Get started building your first Thru program now! 🚧 Pre-release documentation. Content subject to change, or may be inaccurate. 🚧
CommandService
Submit a transaction and track its execution status. Returns a stream of status updates starting with RECEIVED, then ACCEPTED, followed by consensus and execution updates, closing after the transaction is executed.
POST
/
v1
/
transactions
/
track
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
{
"result": {
"status": "SUBMISSION_STATUS_UNSPECIFIED",
"signature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED",
"executionResult": {
"consumedComputeUnits": 123,
"consumedMemoryUnits": 123,
"consumedStateUnits": 123,
"userErrorCode": "<string>",
"vmError": "TRANSACTION_VM_EXECUTE_SUCCESS",
"executionResult": "<string>",
"pagesUsed": 123,
"eventsCount": 123,
"eventsSize": 123,
"readwriteAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"readonlyAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"events": [
{
"eventId": "<string>",
"callIdx": 123,
"programIdx": 123,
"program": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"payload": "aSDinaTvuI8gbWludGxpZnk="
}
]
}
},
"error": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}Body
application/json
SendAndTrackTxnRequest submits a transaction and tracks its execution.
SendAndTrackTxnRequest submits a transaction and tracks its execution.
Response
A successful response.(streaming responses)
SendAndTrackTxnResponse streams transaction status updates.
Show child attributes
Show child attributes
SubmissionStatus represents the status of a transaction in the submission pipeline.
- SUBMISSION_STATUS_UNSPECIFIED: Submission status is unspecified (default value).
- SUBMISSION_STATUS_RECEIVED: Transaction has been received by the gRPC server.
- SUBMISSION_STATUS_ACCEPTED: Transaction has been accepted by the forwarder via UDS.
Available options:
SUBMISSION_STATUS_UNSPECIFIED, SUBMISSION_STATUS_RECEIVED, SUBMISSION_STATUS_ACCEPTED ConsensusStatus represents the minimum consensus level a resource has achieved when returned by the service.
- CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
- CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
- CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
- CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
- CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
- CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED, CONSENSUS_STATUS_OBSERVED, CONSENSUS_STATUS_INCLUDED, CONSENSUS_STATUS_FINALIZED, CONSENSUS_STATUS_LOCALLY_EXECUTED, CONSENSUS_STATUS_CLUSTER_EXECUTED TransactionExecutionResult captures execution outcomes.
Show child attributes
Show child attributes
TransactionVmError enumerates runtime error codes returned by the executor.
- TRANSACTION_VM_EXECUTE_SUCCESS: TN_RUNTIME_TXN_EXECUTE_SUCCESS
- TRANSACTION_VM_ERROR_INVALID_FORMAT: TN_RUNTIME_TXN_ERR_INVALID_FORMAT
- TRANSACTION_VM_ERROR_INVALID_VERSION: TN_RUNTIME_TXN_ERR_INVALID_VERSION
- TRANSACTION_VM_ERROR_INVALID_FLAGS: TN_RUNTIME_TXN_ERR_INVALID_FLAGS
- TRANSACTION_VM_ERROR_INVALID_SIGNATURE: TN_RUNTIME_TXN_ERR_INVALID_SIGNATURE
- TRANSACTION_VM_ERROR_DUPLICATE_ACCOUNT: TN_RUNTIME_TXN_ERR_DUPLICATE_ACCOUNT
- TRANSACTION_VM_ERROR_UNSORTED_ACCOUNTS: TN_RUNTIME_TXN_ERR_UNSORTED_ACCOUNTS
- TRANSACTION_VM_ERROR_UNSORTED_READWRITE_ACCOUNTS: TN_RUNTIME_TXN_ERR_UNSORTED_READWRITE_ACCOUNTS
- TRANSACTION_VM_ERROR_UNSORTED_READONLY_ACCOUNTS: TN_RUNTIME_TXN_ERR_UNSORTED_READONLY_ACCOUNTS
- TRANSACTION_VM_ERROR_ACCOUNT_COUNT_LIMIT_EXCEEDED: TN_RUNTIME_TXN_ERR_ACCOUNT_COUNT_LIMIT_EXCEEDED
- TRANSACTION_VM_ERROR_NONCE_TOO_LOW: TN_RUNTIME_TXN_ERR_NONCE_TOO_LOW
- TRANSACTION_VM_ERROR_NONCE_TOO_HIGH: TN_RUNTIME_TXN_ERR_NONCE_TOO_HIGH
- TRANSACTION_VM_ERROR_INSUFFICIENT_FEE_PAYER_BALANCE: TN_RUNTIME_TXN_ERR_INSUFFICIENT_FEE_PAYER_BALANCE
- TRANSACTION_VM_ERROR_FEE_PAYER_ACCOUNT_DOES_NOT_EXIST: TN_RUNTIME_TXN_ERR_FEE_PAYER_ACCOUNT_DOES_NOT_EXIST
- TRANSACTION_VM_ERROR_NOT_LIVE_YET: TN_RUNTIME_TXN_ERR_NOT_LIVE_YET
- TRANSACTION_VM_ERROR_EXPIRED: TN_RUNTIME_TXN_ERR_EXPIRED
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_STATE_PROOF
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_TYPE: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_STATE_PROOF_TYPE
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_SLOT: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_STATE_PROOF_SLOT
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_ACCOUNT_OWNER: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_ACCOUNT_OWNER
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_OWNER: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_OWNER
- TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_META_DATA_SZ: TN_RUNTIME_TXN_ERR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_META_DATA_SZ
- TRANSACTION_VM_ERROR_VM_FAILED: TN_RUNTIME_TXN_ERR_VM_FAILED
- TRANSACTION_VM_ERROR_INVALID_PROGRAM_ACCOUNT: TN_RUNTIME_TXN_ERR_INVALID_PROGRAM_ACCOUNT
- TRANSACTION_VM_ERROR_VM_REVERT: TN_RUNTIME_TXN_ERR_VM_REVERT
- TRANSACTION_VM_ERROR_CU_EXHAUSTED: TN_RUNTIME_TXN_ERR_CU_EXHAUSTED
- TRANSACTION_VM_ERROR_SU_EXHAUSTED: TN_RUNTIME_TXN_ERR_SU_EXHAUSTED
Available options:
TRANSACTION_VM_EXECUTE_SUCCESS, TRANSACTION_VM_ERROR_INVALID_FORMAT, TRANSACTION_VM_ERROR_INVALID_VERSION, TRANSACTION_VM_ERROR_INVALID_FLAGS, TRANSACTION_VM_ERROR_INVALID_SIGNATURE, TRANSACTION_VM_ERROR_DUPLICATE_ACCOUNT, TRANSACTION_VM_ERROR_UNSORTED_ACCOUNTS, TRANSACTION_VM_ERROR_UNSORTED_READWRITE_ACCOUNTS, TRANSACTION_VM_ERROR_UNSORTED_READONLY_ACCOUNTS, TRANSACTION_VM_ERROR_ACCOUNT_COUNT_LIMIT_EXCEEDED, TRANSACTION_VM_ERROR_NONCE_TOO_LOW, TRANSACTION_VM_ERROR_NONCE_TOO_HIGH, TRANSACTION_VM_ERROR_INSUFFICIENT_FEE_PAYER_BALANCE, TRANSACTION_VM_ERROR_FEE_PAYER_ACCOUNT_DOES_NOT_EXIST, TRANSACTION_VM_ERROR_NOT_LIVE_YET, TRANSACTION_VM_ERROR_EXPIRED, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_TYPE, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_SLOT, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_ACCOUNT_OWNER, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_OWNER, TRANSACTION_VM_ERROR_INVALID_FEE_PAYER_STATE_PROOF_ACCOUNT_META_DATA_SZ, TRANSACTION_VM_ERROR_VM_FAILED, TRANSACTION_VM_ERROR_INVALID_PROGRAM_ACCOUNT, TRANSACTION_VM_ERROR_VM_REVERT, TRANSACTION_VM_ERROR_CU_EXHAUSTED, TRANSACTION_VM_ERROR_SU_EXHAUSTED Show child attributes
Show child attributes
Was this page helpful?
⌘I
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
{
"result": {
"status": "SUBMISSION_STATUS_UNSPECIFIED",
"signature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED",
"executionResult": {
"consumedComputeUnits": 123,
"consumedMemoryUnits": 123,
"consumedStateUnits": 123,
"userErrorCode": "<string>",
"vmError": "TRANSACTION_VM_EXECUTE_SUCCESS",
"executionResult": "<string>",
"pagesUsed": 123,
"eventsCount": 123,
"eventsSize": 123,
"readwriteAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"readonlyAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"events": [
{
"eventId": "<string>",
"callIdx": 123,
"programIdx": 123,
"program": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"payload": "aSDinaTvuI8gbWludGxpZnk="
}
]
}
},
"error": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}