package remote
Get desktop application:
View/edit binary Protocol Buffers messages
service BridgeBackend
bor.proto:10rpc BorEvents (, )
bor.proto:16rpc BorTxnLookup (, )
bor.proto:14rpc Version (, )
bor.proto:12Version returns the service version number
service ETHBACKEND
ethbackend.proto:11rpc AAValidation (, )
ethbackend.proto:77message
ethbackend.proto:270optional tx = 1
message
ethbackend.proto:274bool valid = 1
rpc AddPeer (, )
ethbackend.proto:62rpc AddTrustedPeer (, )
ethbackend.proto:66rpc Block (, )
ethbackend.proto:41High-level method - can read block from db, snapshots or apply any other logic it doesn't provide consistency Request fields are optional - it's ok to request block only by hash or only by number
message
ethbackend.proto:210uint64 block_height = 2
optional block_hash = 3
message
ethbackend.proto:215bytes block_rlp = 1
bytes senders = 2
rpc BlockForTxNum (, )
ethbackend.proto:79message
ethbackend.proto:278uint64 txnum = 1
message
ethbackend.proto:282uint64 block_number = 1
bool present = 2
rpc BorEvents (, )
ethbackend.proto:75rpc BorTxnLookup (, )
ethbackend.proto:73High-level method - can read block body (only storage metadata) from db, snapshots or apply any other logic
message
ethbackend.proto:147uint64 blockNumber = 1
message
ethbackend.proto:151bytes body = 1
rpc CanonicalHash (, )
ethbackend.proto:47High-level method - can find block hash by block number
message
ethbackend.proto:131uint64 block_number = 1
message
ethbackend.proto:135optional hash = 1
rpc ClientVersion (, )
ethbackend.proto:28ClientVersion returns the Ethereum client version string using node name convention (e.g. TurboGeth/v2021.03.2-alpha/Linux).
message
ethbackend.proto:127(message has no fields)
message
ethbackend.proto:129string node_name = 1
rpc Etherbase (, )
ethbackend.proto:12message
ethbackend.proto:97(message has no fields)
message
ethbackend.proto:99optional address = 1
rpc HeaderNumber (, )
ethbackend.proto:50High-level method - can find block number by block hash
message
ethbackend.proto:139optional hash = 1
message
ethbackend.proto:143optional uint64 number = 1
message
ethbackend.proto:287uint64 block_num = 1
rpc NetPeerCount (, )
ethbackend.proto:16message
ethbackend.proto:119(message has no fields)
message
ethbackend.proto:121uint64 count = 1
rpc NetVersion (, )
ethbackend.proto:14message
ethbackend.proto:101(message has no fields)
message
ethbackend.proto:103uint64 id = 1
rpc NodeInfo (, )
ethbackend.proto:57NodeInfo collects and returns NodeInfo from all running sentry instances.
message
ethbackend.proto:229uint32 limit = 1
message
ethbackend.proto:241repeated nodes_info = 1
rpc Peers (, )
ethbackend.proto:60Peers collects and returns peers information from all running sentry instances.
message
ethbackend.proto:245repeated peers = 1
rpc PendingBlock (, )
ethbackend.proto:71PendingBlock returns latest built block.
message
ethbackend.proto:257bytes block_rlp = 1
rpc ProtocolVersion (, )
ethbackend.proto:25ProtocolVersion returns the Ethereum protocol version number (e.g. 66 for ETH66).
message
ethbackend.proto:123(message has no fields)
message
ethbackend.proto:125uint64 id = 1
rpc RemovePeer (, )
ethbackend.proto:64rpc RemoveTrustedPeer (, )
ethbackend.proto:68rpc SetHead (, )
ethbackend.proto:83message
ethbackend.proto:291uint64 block_number = 1
message
ethbackend.proto:295bool success = 1
rpc Subscribe (, stream )
ethbackend.proto:30message
ethbackend.proto:155Event type = 1
message
ethbackend.proto:159Event type = 1
bytes data = 2
serialized data
rpc SubscribeLogs (stream , stream )
ethbackend.proto:33Only one subscription is needed to serve all the users, LogsFilterRequest allows to dynamically modifying the subscription
message
ethbackend.proto:164bool all_addresses = 1
repeated addresses = 2
bool all_topics = 3
repeated topics = 4
rpc SubscribeReceipts (stream , stream )
ethbackend.proto:36Only one subscription is needed to serve all the users, ReceiptsFilterRequest allows to dynamically modifying the subscription
message
ethbackend.proto:183bool all_transactions = 1
repeated transaction_hashes = 2
message
ethbackend.proto:188optional block_hash = 1
uint64 block_number = 2
optional transaction_hash = 3
uint64 transaction_index = 4
uint32 type = 5
uint64 status = 6
uint64 cumulative_gas_used = 7
uint64 gas_used = 8
optional contract_address = 9
bytes logs_bloom = 10
repeated logs = 11
optional from = 12
optional to = 13
uint32 tx_type = 14
optional base_fee = 15
uint64 block_time = 16
uint64 excess_blob_gas = 17
uint64 blob_gas_used = 18
optional blob_gas_price = 19
rpc Syncing (, )
ethbackend.proto:22Syncing returns a data object detailing the status of the sync process
message
ethbackend.proto:105uint64 last_new_block_seen = 1
uint64 frozen_blocks = 2
uint64 current_block = 3
bool syncing = 4
repeated stages = 5
rpc TxnLookup (, )
ethbackend.proto:54High-level method - can find block number by txn hash it doesn't provide consistency
message
ethbackend.proto:220optional txn_hash = 1
message
ethbackend.proto:224uint64 block_number = 1
uint64 tx_number = 2
rpc Version (, )
ethbackend.proto:19Version returns the service version number
service HeimdallBackend
bor.proto:19rpc Producers (, )
bor.proto:23message
bor.proto:45uint64 block_num = 1
message
bor.proto:49optional proposer = 1
repeated validators = 2
rpc Version (, )
bor.proto:21Version returns the service version number
service KV
kv.proto:34Provides methods to access key-value data
rpc CurrentDomainVersion (, )
kv.proto:68message
kv.proto:327uint64 tx_id = 1
uint32 domain = 2
message
kv.proto:332uint64 major = 1
uint64 minor = 2
rpc GetLatest (, )
kv.proto:60Temporal methods
can return latest value or as of given timestamp
message
kv.proto:203Temporal methods
uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
bytes k = 3
uint64 ts = 4
bytes k2 = 5
bool latest = 6
if true, then `ts` ignored and return latest state (without history lookup)
message
kv.proto:214bytes v = 1
bool ok = 2
rpc HasPrefix (, )
kv.proto:66message
kv.proto:306uint64 tx_id = 1
string table = 2
bytes prefix = 3
message
kv.proto:312bytes first_key = 1
bytes first_val = 2
bool has_prefix = 3
rpc HistoryRange (, )
kv.proto:64message
kv.proto:252uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
sint64 from_ts = 4
-1 means Inf
sint64 to_ts = 5
-1 means Inf
bool order_ascend = 6
sint64 limit = 7
<= 0 means no limit
int32 page_size = 8
pagination params
<= 0 means server will choose
string page_token = 9
rpc HistorySeek (, )
kv.proto:61message
kv.proto:219uint64 tx_id = 1
returned by .Tx()
string table = 2
bytes k = 3
uint64 ts = 4
message
kv.proto:226bytes v = 1
bool ok = 2
rpc HistoryStartFrom (, )
kv.proto:67message
kv.proto:318uint32 domain = 1
uint64 tx_id = 2
returned by .Tx()
message
kv.proto:323uint64 start_from = 1
rpc IndexRange (, )
kv.proto:63message
kv.proto:230uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
bytes k = 3
sint64 from_ts = 4
-1 means Inf
sint64 to_ts = 5
-1 means Inf
bool order_ascend = 6
sint64 limit = 7
<= 0 means no limit
int32 page_size = 8
pagination params
<= 0 means server will choose
string page_token = 9
message
kv.proto:246repeated uint64 timestamps = 1
TODO: it can be a bitmap
string next_page_token = 2
rpc Range (, )
kv.proto:54Range [from, to) Range(from, nil) means [from, EndOfTable) Range(nil, to) means [StartOfTable, to) If orderAscend=false server expecting `from`<`to`. Example: Range("B", "A")
rpc Stream(RangeReq) returns (stream Pairs);
message
kv.proto:170uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
bytes from_prefix = 3
bytes to_prefix = 4
bool order_ascend = 5
sint64 limit = 6
<= 0 means no limit
int32 page_size = 7
pagination params
<= 0 means server will choose
string page_token = 8
rpc RangeAsOf (, )
kv.proto:65message
kv.proto:267uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
bytes from_key = 3
nil means Inf
bytes to_key = 4
nil means Inf
uint64 ts = 5
bool latest = 6
if true, then `ts` ignored and return latest state (without history lookup)
bool order_ascend = 7
sint64 limit = 8
<= 0 means no limit
int32 page_size = 9
pagination params
<= 0 means server will choose
string page_token = 10
rpc Sequence (, )
kv.proto:57message
kv.proto:190`kv.Sequence` method
uint64 tx_id = 1
returned by .Tx()
string table = 2
query params
message
kv.proto:197uint64 value = 1
rpc Snapshots (, )
kv.proto:48Snapshots returns list of current snapshot files. Then client can just open all of them.
message
kv.proto:162(message has no fields)
message
kv.proto:165repeated string blocks_files = 1
repeated string history_files = 2
rpc StateChanges (, stream )
kv.proto:45message
kv.proto:157bool with_storage = 1
bool with_transactions = 2
message
kv.proto:138StateChangeBatch - list of StateDiff done in one DB transaction
uint64 state_version_id = 1
mdbx's tx.ID() - id of write transaction in db - where this changes happened
repeated change_batch = 2
uint64 pending_block_base_fee = 3
BaseFee of the next block to be produced
uint64 block_gas_limit = 4
GasLimit of the latest block - proxy for the gas limit of the next block to be produced
uint64 finalized_block = 5
uint64 pending_blob_fee_per_gas = 6
Base Blob Fee for the next block to be produced
rpc StepSize (, )
kv.proto:69message
kv.proto:337uint64 tx_id = 1
message
kv.proto:341uint64 step = 1
rpc Tx (stream , stream )
kv.proto:43Tx exposes read-only transactions for the key-value store When tx open, client must receive 1 message from server with txID When cursor open, client must receive 1 message from server with cursorID Then only client can initiate messages from server
message
kv.proto:94Op op = 1
string bucket_name = 2
uint32 cursor = 3
bytes k = 4
bytes v = 5
message
kv.proto:102bytes k = 1
bytes v = 2
uint32 cursor_id = 3
send once after new cursor open
uint64 view_id = 4
return once after tx open. mdbx's tx.ViewID() - id of write transaction in db
uint64 tx_id = 5
return once after tx open. internal identifier - use it in other methods - to achieve consistent DB view (to read data from same DB tx on server).
rpc Version (, )
kv.proto:36Version returns the service version number
message
kv.proto:123Used in:
optional address = 1
uint64 incarnation = 2
Action action = 3
bytes data = 4
nil if there is no UPSERT in action
bytes code = 5
nil if there is no CODE in action
repeated storage_changes = 6
enum Action
kv.proto:110Used in:
STORAGE = 0
Change only in the storage
UPSERT = 1
Change of balance or nonce (and optionally storage)
CODE = 2
Change of code (and optionally storage)
UPSERT_CODE = 3
Change in (balance or nonce) and code (and optionally storage)
REMOVE = 4
Account is deleted
message
ethbackend.proto:249Used as response type in: ETHBACKEND.AddPeer, ETHBACKEND.AddTrustedPeer
bool success = 1
message
ethbackend.proto:233Used as request type in: ETHBACKEND.AddPeer, ETHBACKEND.AddTrustedPeer
string url = 1
message
bor.proto:40Used as response type in: BridgeBackend.BorEvents, ETHBACKEND.BorEvents
string state_receiver_contract_address = 1
repeated bytes event_rlps = 2
message
bor.proto:35Used as request type in: BridgeBackend.BorEvents, ETHBACKEND.BorEvents
uint64 block_num = 1
optional block_hash = 2
message
bor.proto:30Used as response type in: BridgeBackend.BorTxnLookup, ETHBACKEND.BorTxnLookup
bool present = 1
uint64 block_number = 2
message
bor.proto:26Used as request type in: BridgeBackend.BorTxnLookup, ETHBACKEND.BorTxnLookup
optional bor_tx_hash = 1
Used in:
FORWARD = 0
UNWIND = 1
message
ethbackend.proto:261repeated hashes = 1
message
ethbackend.proto:265uint64 start = 1
uint64 count = 2
Used in: ,
HEADER = 0
PENDING_LOGS = 1
PENDING_BLOCK = 2
NEW_SNAPSHOT = 3
NEW_SNAPSHOT - one or many new snapshots (of snapshot sync) were created, client need to close old file descriptors and open new (on new segments), then server can remove old files
message
kv.proto:301sint64 next_time_stamp = 1
sint64 limit = 2
enum Op
kv.proto:72Used in:
FIRST = 0
FIRST_DUP = 1
SEEK = 2
SEEK_BOTH = 3
CURRENT = 4
LAST = 6
LAST_DUP = 7
NEXT = 8
NEXT_DUP = 9
NEXT_NO_DUP = 11
PREV = 12
PREV_DUP = 13
PREV_NO_DUP = 14
SEEK_EXACT = 15
SEEK_BOTH_EXACT = 16
OPEN = 30
CLOSE = 31
OPEN_DUP_SORT = 32
message
kv.proto:285Used as response type in: KV.HistoryRange, KV.Range, KV.RangeAsOf
repeated bytes keys = 1
TODO: replace by lengtsh+arena? Anyway on server we need copy (serialization happening outside tx)
repeated bytes values = 2
string next_page_token = 3
uint32 estimateTotal = 3; // send once after stream creation
message
kv.proto:297bytes next_key = 1
sint64 limit = 2
message
ethbackend.proto:253Used as response type in: ETHBACKEND.RemovePeer, ETHBACKEND.RemoveTrustedPeer
bool success = 1
message
ethbackend.proto:237Used as request type in: ETHBACKEND.RemovePeer, ETHBACKEND.RemoveTrustedPeer
string url = 1
message
kv.proto:148StateChange - changes done by 1 block or by 1 unwind
Used in:
Direction direction = 1
uint64 block_height = 2
optional block_hash = 3
repeated changes = 4
repeated bytes txs = 5
enable by withTransactions=true
uint64 block_time = 6
message
kv.proto:118Used in:
optional location = 1
bytes data = 2
message
ethbackend.proto:171Used as response type in: ETHBACKEND.SubscribeLogs
Used as field type in:
optional address = 1
optional block_hash = 2
uint64 block_number = 3
bytes data = 4
uint64 log_index = 5
repeated topics = 6
optional transaction_hash = 7
uint64 transaction_index = 8
bool removed = 9
message
ethbackend.proto:111Used in:
string stage_name = 1
uint64 block_number = 2
message
bor.proto:54Used in:
uint64 id = 1
optional address = 2
int64 voting_power = 3
int64 proposer_priority = 4