package flow.access
Get desktop application:
View/edit binary Protocol Buffers messages
service AccessAPI
access.proto:18AccessAPI is the public-facing API provided by access nodes.
ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.
message
access.proto:268uint64 block_height = 1
bytes script = 2
repeated bytes arguments = 3
ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.
message
access.proto:262bytes block_id = 1
bytes script = 2
repeated bytes arguments = 3
ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.
message
access.proto:257bytes script = 1
repeated bytes arguments = 2
rpc GetAccount (, )
access.proto:76GetAccount is an alias for GetAccountAtLatestBlock. Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.
message
access.proto:234bytes address = 1
message
access.proto:238optional account = 1
GetAccountAtBlockHeight gets an account by address at the given block height
message
access.proto:250bytes address = 1
uint64 block_height = 2
GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.
message
access.proto:242bytes address = 1
rpc GetBlockByHeight (, )
access.proto:42GetBlockByHeight gets a full block by height.
message
access.proto:168uint64 height = 1
bool full_block_response = 2
rpc GetBlockByID (, )
access.proto:40GetBlockByID gets a full block by ID.
message
access.proto:163bytes id = 1
bool full_block_response = 2
GetBlockHeaderByHeight gets a block header by height.
message
access.proto:148uint64 height = 1
rpc GetBlockHeaderByID (, )
access.proto:28GetBlockHeaderByID gets a block header by ID.
message
access.proto:144bytes id = 1
rpc GetCollectionByID (, )
access.proto:47GetCollectionByID gets a collection by ID.
message
access.proto:179bytes id = 1
message
access.proto:183optional collection = 1
rpc GetEventsForBlockIDs (, )
access.proto:110GetEventsForBlockIDs retrieves events for the specified block IDs and event type.
message
access.proto:286string type = 1
repeated bytes block_ids = 2
GetEventsForHeightRange retrieves events emitted within the specified block range.
message
access.proto:280string type = 1
uint64 start_height = 2
uint64 end_height = 3
GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change
message
access.proto:319bytes block_id = 1
message
access.proto:323optional execution_result = 1
rpc GetLatestBlock (, )
access.proto:38GetLatestBlock gets the full payload of the latest sealed or unsealed block.
message
access.proto:158bool is_sealed = 1
bool full_block_response = 2
rpc GetLatestBlockHeader (, )
access.proto:25GetLatestBlockHeader gets the latest sealed or unsealed block header.
message
access.proto:140bool is_sealed = 1
GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.
message
access.proto:311(message has no fields)
message
access.proto:313bytes serializedSnapshot = 1
rpc GetNetworkParameters (, )
access.proto:116GetNetworkParameters retrieves the Flow network details
message
access.proto:303(message has no fields)
message
access.proto:305string chain_id = 1
rpc GetTransaction (, )
access.proto:54GetTransaction gets a transaction by ID.
message
access.proto:218optional transaction = 1
rpc GetTransactionResult (, )
access.proto:56GetTransactionResult gets the result of a transaction.
GetTransactionResultByIndex gets the result of a transaction at a specified block and index
message
access.proto:201bytes block_id = 1
uint32 index = 2
GetTransactionResultsByBlockID gets all the transaction results for a specified block
message
access.proto:210repeated transaction_results = 1
GetTransactionsByBlockID gets all the transactions for a specified block
message
access.proto:214repeated transactions = 1
rpc Ping (, )
access.proto:20Ping is used to check if the access node is alive and healthy.
message
access.proto:134(message has no fields)
message
access.proto:136(message has no fields)
rpc SendTransaction (, )
access.proto:52SendTransaction submits a transaction to the network.
message
access.proto:189optional transaction = 1
message
access.proto:193bytes id = 1
message
access.proto:246Used as response type in: AccessAPI.GetAccountAtBlockHeight, AccessAPI.GetAccountAtLatestBlock
optional account = 1
message
access.proto:152Used as response type in: AccessAPI.GetBlockHeaderByHeight, AccessAPI.GetBlockHeaderByID, AccessAPI.GetLatestBlockHeader
optional block = 1
message
access.proto:173Used as response type in: AccessAPI.GetBlockByHeight, AccessAPI.GetBlockByID, AccessAPI.GetLatestBlock
optional block = 1
message
access.proto:291Used as response type in: AccessAPI.GetEventsForBlockIDs, AccessAPI.GetEventsForHeightRange
repeated results = 1
message
access.proto:292Used in:
bytes block_id = 1
uint64 block_height = 2
repeated events = 3
optional block_timestamp = 4
message
access.proto:274Used as response type in: AccessAPI.ExecuteScriptAtBlockHeight, AccessAPI.ExecuteScriptAtBlockID, AccessAPI.ExecuteScriptAtLatestBlock
bytes value = 1
message
access.proto:197Used as request type in: AccessAPI.GetTransaction, AccessAPI.GetTransactionResult
bytes id = 1
message
access.proto:206Used as request type in: AccessAPI.GetTransactionResultsByBlockID, AccessAPI.GetTransactionsByBlockID
bytes block_id = 1
message
access.proto:222Used as response type in: AccessAPI.GetTransactionResult, AccessAPI.GetTransactionResultByIndex
Used as field type in:
entities.TransactionStatus status = 1
uint32 status_code = 2
string error_message = 3
repeated events = 4
bytes block_id = 5
bytes transaction_id = 6
bytes collection_id = 7