API Transcript

Example

API Transcript Example

Execution Lifecycle Messages

root message

This root message is the first entry recorded in the execution transcript. It contains key information such as the execution ID, the timestamp of when the task requester initiated the execution, and the hash representing all the messages contained within the transcript.

Property
Description
Possible values

executionId

Current execution ID

Text

transcript

List of all the messages generated during the API Task execution

Array of data

timestamp

Transcript query request timestamp. The moment when the task-requester calls the transcript query endpoint.

Number

msgHash

Transcript Hash

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

api_task_created

The api_task_created message is added to the transcript when the Truebit platform receives a new execution request from the task requester. It contains key information such as the execution ID, the original message sent by the requester (stored in the message field), and all data is signed by the Truebit Verify Hub.

Property
Description
Possible values

type

Message type

api_task_created

executionId

Current execution ID

Text

message

Original message received from the Task Requester

see below "dispatch_api_task"

msgHash

Current Message Hash

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

publickey

Truebit Verify Hub public key

Text

sequencerAddress

Truebit Verify Hub Address

Text

timestamp

task_created message created timestamp

Number

Original message sent by the Task Requester: dispatch_api_task

Property
Description
Values

type

Message type

dispatch_api_task

taskId

API Task ID

Text

executionId

Current execution ID

Text

msgHash

Current message Hash

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

executionTimeout

Execution time out

number

ledgerName

Current ledger in usage

['avalanche']

blockHash

Current block hash

Text

blockNumber

Current block number

Number

chainId

Unique ID for blockchain identification

Number

taskRegistryContractAddress

Task registration Smart contract Address

Text

taskAuthorizationContractAddress

Task Authorization Contract Address

Text

taskRequesterAddress

Task Requester Address. This address will pay for the task execution

Text

taskPath

Provided path for task execution. It must contain the namespace and taskname

Text

taskVersion

Provided version Task for execution

Number

senderAddress

Truebit Verify Hub address

Text

input

API Task Input parameters

path: Endpoint Path method: {POST, GET} body: Body endpoint values

api_outcome

The api_outcome message is recorded in the transcript once Truebit Verify Hub receives a response from the TEE. It includes key information such as the execution ID, the original message from the TEE (stored in the message field), and all data is signed by the Truebit Verify Hub.

Property
Description
Values

type

Message type

api_outcome

executionId

Current execution ID

Text

message

Original message received from the TEE

see below "api_fetcher_outcome"

msgHash

Current message Hash

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

sequencerAddress

Truebit Verify Hub address

Text

timestamp

Message sent timestamp

Number

Original message sent by the Task Requester: api_fetcher_outcome

Property
Description
Values

type

Message type

api_fetcher_outcome

executionId

Current execution ID

Text

senderAddress

Truebit Verify Hub address

Text

bodyResponse

TEE response

see below "bodyResponse" message

msgHash

Current message Hash

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

tlsHandshakeHash

TLS handshake information hash

Text

status

API execution status

{Failed, Success, Running}

totalTransferredBytes

Bytes transferred during the API execution.

  • request: Total bytes transferred in the Request

  • response: Total bytes transferred in the Response.

Information stored within the bodyResponse message

attestation

document

The base64-encoded signed quote (Nitro attestation report) — this is the root of trust

documentHash

SHA-256 of the binary document

enclave.moduleId

Identifies the specific enclave that generated the quote.

enclave.nonce

Prevents replay attacks (each task gets unique nonce).

enclave.userData

Should contain task-specific data (e.g., hash of input parameters, task ID).

platform.PCR0

Enclave image hash — proves which code was loaded.

platform.PCR3

Hash of the enclave image file (EIF). This proves exactly what code ran in the enclave.

platform.PCR4

Hash of the kernel and bootstrap configuration. Ensures the enclave environment itself wasn't tampered with.

timestamp

Proves when the attestation was generated

execution_completed

The execution_completed message is logged into the transcript once the entire execution process has been completed or a timeout has occurred (whichever happens first).

Property
Description
Values

type

Message type

execution_completed

executionId

Current execution ID

Text

transcriptHash

Execution lifecycle messages hash.

Text

status

Final execution status

["ReadyForInvoice", "Error"]

errorDetails

Only present if there was an error during the execution.

The details of any error thrown by the protocol or its services

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

signerAddress

Truebit Verify Hub address

Text

timestamp

Message sent timestamp

unixTimestamp

Execution Complete Statuses

Status
Description

ReadyForInvoice

The API was executed, so the protocol is ready to process the execution's invoices

Error

There was an error during the API execution. Please check the errorDetails field.

execution_metadata
Property
Description
Values

type

Message type

execution_metadata

executionId

Current execution ID

Text

message

Truebit Protocol version

Array of ["version"]

msgHash

Hash that represents the message

Text

signature

Truebit Verify Hub signature

v: Text r: Text s: Text

timestamp

Message sent timestamp

unixTimestamp

PreviousNon-Consensus TranscriptNextInvoice Transcript

Last updated

Was this helpful?