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:85

  (message has no fields)

  message PingResponse

  execution.proto:87

  (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:91

  • bytes block_id = 1

  • bytes address = 2

  message GetAccountAtBlockIDResponse

  execution.proto:96

  • 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:102

  • bytes block_id = 1

  • bytes script = 2

  • repeated bytes arguments = 3

  message ExecuteScriptAtBlockIDResponse

  execution.proto:108

  • 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:125

  • string type = 1

  • repeated bytes block_ids = 2

  message GetEventsForBlockIDsResponse

  execution.proto:115

  • 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:132

  • 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:137

  • 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:150

  • bytes block_id = 1

  message GetTransactionResultsResponse

  execution.proto:154

  • repeated GetTransactionResultResponse transaction_results = 1

  • entities.EventEncodingVersion event_encoding_version = 2

• rpc GetTransactionErrorMessage (GetTransactionErrorMessageRequest, GetTransactionErrorMessageResponse)

  execution.proto:54

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

  message GetTransactionErrorMessageRequest

  execution.proto:159

  • bytes block_id = 1

  • bytes transaction_id = 2

• rpc GetTransactionErrorMessageByIndex (GetTransactionErrorMessageByIndexRequest, GetTransactionErrorMessageResponse)

  execution.proto:58

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

  message GetTransactionErrorMessageByIndexRequest

  execution.proto:164

  • bytes block_id = 1

  • uint32 index = 2

• rpc GetTransactionErrorMessagesByBlockID (GetTransactionErrorMessagesByBlockIDRequest, GetTransactionErrorMessagesResponse)

  execution.proto:63

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

  message GetTransactionErrorMessagesByBlockIDRequest

  execution.proto:174

  • bytes block_id = 1

  message GetTransactionErrorMessagesResponse

  execution.proto:178

  • repeated GetTransactionErrorMessagesResponse.Result results = 1

• rpc GetRegisterAtBlockID (GetRegisterAtBlockIDRequest, GetRegisterAtBlockIDResponse)

  execution.proto:70

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

  message GetRegisterAtBlockIDRequest

  execution.proto:189

  • bytes block_id = 1

  • bytes register_owner = 2

  • bytes register_key = 4

    bytes register_controller = 3; @deprecated

  message GetRegisterAtBlockIDResponse

  execution.proto:197

  • bytes value = 1

• rpc GetLatestBlockHeader (GetLatestBlockHeaderRequest, BlockHeaderResponse)

  execution.proto:76

  GetLatestBlockHeader gets the latest sealed or unsealed block header.

  message GetLatestBlockHeaderRequest

  execution.proto:203

  • bool is_sealed = 1

• rpc GetBlockHeaderByID (GetBlockHeaderByIDRequest, BlockHeaderResponse)

  execution.proto:79

  GetBlockHeaderByID gets a block header by ID.

  message GetBlockHeaderByIDRequest

  execution.proto:207

  • bytes id = 1

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

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