blockexplorer.proto
path blockexplorer/api/v1/blockexplorer.proto
package blockexplorer.api.v1
Messages
GetTransactionRequest
| Name | Type | Description |
|---|---|---|
hash | string | Hash of the transaction |
GetTransactionResponse
| Name | Type | Description |
|---|---|---|
transaction | Transaction | Transaction corresponding to the hash |
InfoRequest
node information
| Name | Type | Description |
|---|
InfoResponse
| Name | Type | Description |
|---|---|---|
version | string | Semver formatted version of the data node |
commit_hash | string | Commit hash from which the data node was built |
ListTransactionsRequest
| Name | Type | Description |
|---|---|---|
limit | uint32 | Number of transactions to be returned from the blockchain. This is deprecated, use first and last instead. |
before | string | Optional cursor to paginate the request |
after | string | Optional cursor to paginate the request |
filters | ListTransactionsRequest.FiltersEntry | Filters to apply to the request |
cmd_types | string | Transaction command types filter, for listing transactions with specified command types |
exclude_cmd_types | string | Transaction command types exclusion filter, for listing all the transactions except the ones with specified command types |
parties | string | Party IDs filter, can be sender or receiver |
first | uint32 | Number of transactions to be returned from the blockchain. Use in conjunction with the `after` cursor to paginate forwards. On its own, this will return the first `first` transactions. |
last | uint32 | Number of transactions to be returned from the blockchain. Use in conjunction with the `before` cursor to paginate backwards. On its own, this will return the last `last` transactions. |
ListTransactionsRequest.FiltersEntry
| Name | Type | Description |
|---|---|---|
key | string | |
value | string |
ListTransactionsResponse
| Name | Type | Description |
|---|---|---|
transactions | Transaction | Transaction corresponding to the specific request and filters |
Transaction
| Name | Type | Description |
|---|---|---|
block | uint64 | Height of the block the transaction was found in |
index | uint32 | Index of the transaction in the block |
hash | string | Hash of the transaction |
submitter | string | Vega public key of the transaction's submitter |
type | string | Type of transaction |
code | uint32 | Results code of the transaction. 0 indicates the transaction was successful |
cursor | string | Cursor for this transaction. This is used for paginating results |
command | vega.commands.v1.InputData | Actual command of the transaction |
signature | vega.commands.v1.Signature | Signature generated by the submitter for the transaction |
error | string | Optional error happening when processing / checking the transaction This should be set if error code is not 0 |
Services
BlockExplorerService
GetTransaction
| Method | GetTransaction |
|---|---|
| Request | GetTransactionRequest |
| Response | GetTransactionResponse |
| Description | Get transaction Get a transaction from the Vega blockchain |
ListTransactions
| Method | ListTransactions |
|---|---|
| Request | ListTransactionsRequest |
| Response | ListTransactionsResponse |
| Description | List transactions List transactions from the Vega blockchain |
Info
| Method | Info |
|---|---|
| Request | InfoRequest |
| Response | InfoResponse |
| Description | Info Get information about the block explorer. Response contains a semver formatted version of the data node and the commit hash, from which the block explorer was built |