package flow.execution

Get desktop application:
View/edit binary Protocol Buffers messages

ExecutionAPI is the API provided by the execution nodes.

• rpc Ping (PingRequest, PingResponse)

  execution.proto:16

  Ping is used to check if the access node is alive and healthy.

  message PingRequest

  execution.proto:104

  (message has no fields)

  message PingResponse

  execution.proto:106

  (message has no fields)

• rpc GetAccountAtBlockID (GetAccountAtBlockIDRequest, GetAccountAtBlockIDResponse)

  execution.proto:21

  GetAccountAtBlockID gets an account by address at the given block ID

  message GetAccountAtBlockIDRequest

  execution.proto:110

  • bytes block_id = 1

  • bytes address = 2

  message GetAccountAtBlockIDResponse

  execution.proto:115

  • optional entities.Account account = 1

• rpc ExecuteScriptAtBlockID (ExecuteScriptAtBlockIDRequest, ExecuteScriptAtBlockIDResponse)

  execution.proto:28

  ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

  message ExecuteScriptAtBlockIDRequest

  execution.proto:121

  • bytes block_id = 1

  • bytes script = 2

  • repeated bytes arguments = 3

  message ExecuteScriptAtBlockIDResponse

  execution.proto:127

  • bytes value = 1

  • uint64 computation_usage = 2

• rpc GetEventsForBlockIDs (GetEventsForBlockIDsRequest, GetEventsForBlockIDsResponse)

  execution.proto:35

  GetEventsForBlockIDs retrieves events for all the specified block IDs that have the given type

  message GetEventsForBlockIDsRequest

  execution.proto:144

  • string type = 1

  • repeated bytes block_ids = 2

  message GetEventsForBlockIDsResponse

  execution.proto:134

  • repeated GetEventsForBlockIDsResponse.Result results = 1

  • entities.EventEncodingVersion event_encoding_version = 2

• rpc GetTransactionResult (GetTransactionResultRequest, GetTransactionResultResponse)

  execution.proto:41

  GetTransactionResult gets the result of a transaction.

  message GetTransactionResultRequest

  execution.proto:151

  • bytes block_id = 1

  • bytes transaction_id = 2

• rpc GetTransactionResultByIndex (GetTransactionByIndexRequest, GetTransactionResultResponse)

  execution.proto:45

  GetTransactionResultByIndex gets the result of a transaction at the index.

  message GetTransactionByIndexRequest

  execution.proto:156

  • bytes block_id = 1

  • uint32 index = 2

• rpc GetTransactionResultsByBlockID (GetTransactionsByBlockIDRequest, GetTransactionResultsResponse)

  execution.proto:50

  GetTransactionResultByIndex gets the results of all transactions in the block ordered by transaction index.

  message GetTransactionsByBlockIDRequest

  execution.proto:169

  • bytes block_id = 1

  message GetTransactionResultsResponse

  execution.proto:173

  • repeated GetTransactionResultResponse transaction_results = 1

  • entities.EventEncodingVersion event_encoding_version = 2

• rpc GetTransactionErrorMessage (GetTransactionErrorMessageRequest, GetTransactionErrorMessageResponse)

  execution.proto:55

  GetTransactionErrorMessage gets the error messages of a failed transaction by id.

  message GetTransactionErrorMessageRequest

  execution.proto:178

  • bytes block_id = 1

  • bytes transaction_id = 2

• rpc GetTransactionErrorMessageByIndex (GetTransactionErrorMessageByIndexRequest, GetTransactionErrorMessageResponse)

  execution.proto:60

  GetTransactionErrorMessageByIndex gets the error messages of a failed transaction at the index.

  message GetTransactionErrorMessageByIndexRequest

  execution.proto:183

  • bytes block_id = 1

  • uint32 index = 2

• rpc GetTransactionErrorMessagesByBlockID (GetTransactionErrorMessagesByBlockIDRequest, GetTransactionErrorMessagesResponse)

  execution.proto:66

  GetTransactionErrorMessagesByBlockID gets the error messages of all failed transactions in the block ordered by transaction index.

  message GetTransactionErrorMessagesByBlockIDRequest

  execution.proto:193

  • bytes block_id = 1

  message GetTransactionErrorMessagesResponse

  execution.proto:197

  • repeated GetTransactionErrorMessagesResponse.Result results = 1

• rpc GetRegisterAtBlockID (GetRegisterAtBlockIDRequest, GetRegisterAtBlockIDResponse)

  execution.proto:74

  GetRegisterAtBlockID collects a register at the block with the given ID (if available).

  message GetRegisterAtBlockIDRequest

  execution.proto:208

  • bytes block_id = 1

  • bytes register_owner = 2

  • bytes register_key = 4

    bytes register_controller = 3; @deprecated

  message GetRegisterAtBlockIDResponse

  execution.proto:216

  • bytes value = 1

• rpc GetLatestBlockHeader (GetLatestBlockHeaderRequest, BlockHeaderResponse)

  execution.proto:80

  GetLatestBlockHeader gets the latest sealed or unsealed block header.

  message GetLatestBlockHeaderRequest

  execution.proto:222

  • bool is_sealed = 1

• rpc GetBlockHeaderByID (GetBlockHeaderByIDRequest, BlockHeaderResponse)

  execution.proto:84

  GetBlockHeaderByID gets a block header by ID.

  message GetBlockHeaderByIDRequest

  execution.proto:226

  • bytes id = 1

• rpc GetTransactionExecutionMetricsAfter (GetTransactionExecutionMetricsAfterRequest, GetTransactionExecutionMetricsAfterResponse)

  execution.proto:97

  GetTransactionExecutionMetricsAfter gets the transaction execution metrics for blocks after the given block height. The blocks will be sorted by descending block height. If no data is available for the given block height, the response will be empty. The execution node will only store metrics for a limited number of blocks,  so the request may return an empty response if the requested block height is too far in the past. Errors: - No errors are expected.

  message GetTransactionExecutionMetricsAfterRequest

  execution.proto:236

  The request for GetTransactionExecutionMetricsAfter

  • uint64 block_height = 1

    Block height after which to get transaction execution metrics. this block height will not be included in the response.

  message GetTransactionExecutionMetricsAfterResponse

  execution.proto:248

  The response for GetTransactionExecutionMetricsAfter The response contains the execution metrics for transactions in each block after the requested block height (block_height + 1). The execution node only keeps a limited number of blocks in memory, so the response may not contain metrics for all blocks. Only finalized and executed blocks will be in the response. The blocks are sorted by block height in descending order.

  • repeated GetTransactionExecutionMetricsAfterResponse.Result results = 1

    a list of results for each block sorted by block height in descending order

Used as response type in: ExecutionAPI.GetBlockHeaderByID, ExecutionAPI.GetLatestBlockHeader

• optional entities.BlockHeader block = 1

Used in: GetEventsForBlockIDsResponse

• bytes block_id = 1

• uint64 block_height = 2

• repeated entities.Event events = 3

Used as response type in: ExecutionAPI.GetTransactionErrorMessage, ExecutionAPI.GetTransactionErrorMessageByIndex

• bytes transaction_id = 1

• string error_message = 2

Used in: GetTransactionErrorMessagesResponse

• bytes transaction_id = 1

• uint32 index = 2

• string error_message = 3

the execution effort weight of a computation kind

Used in: Transaction

• uint64 kind = 1

  computation kind id

• uint64 weight = 2

  the weight of the computation kind

the data for one block

Used in: GetTransactionExecutionMetricsAfterResponse

• uint64 block_height = 1

  the block height of the block

• repeated Transaction transactions = 2

  the list of transactions in the block

the data for one transaction

Used in: Result

• bytes transaction_id = 1

  the transaction id

• uint64 execution_time = 2

  the execution time of the transaction in nanoseconds

• repeated ExecutionEffortWeight execution_effort_weights = 3

  the execution effort weights of the transaction

Used as response type in: ExecutionAPI.GetTransactionResult, ExecutionAPI.GetTransactionResultByIndex

Used as field type in: GetTransactionResultsResponse

• uint32 status_code = 1

• string error_message = 2

• repeated entities.Event events = 3

• entities.EventEncodingVersion event_encoding_version = 4

• uint64 computation_usage = 5