Get desktop application:
View/edit binary Protocol Buffers messages
RPCs available to interact with the ZXC Ledger. The gRPC API mimics the JSON API. Refer to zxcl.org for documentation
Get account info for an account on the ZXC Ledger.
A request to get info about an account. Next field: 6
The address to get info about.
Which ledger to use to retrieve data. If this field is not set, the server will use the open ledger. The open ledger includes data that is not validated or final. To retrieve the most up to date and validated data, use SHORTCUT_VALIDATED
Response to GetAccountInfo RPC Next field: 6
Get the fee for a transaction on the ZXC Ledger.
A request for the current transaction fee on the ledger. Next field: 1
(message has no fields)
Response to a GetFee RPC Next field: 8
Submit a signed transaction to the ZXC Ledger.
A request to submit the signed transaction to the ledger. Next field: 3
The signed transaction to submit.
A response when a signed transaction is submitted to the ledger. Next field: 5
Code indicating the preliminary result of the transaction.
Numeric code indicating the preliminary result of the transaction, directly correlated to engine_result.
Human-readable explanation of the transaction's preliminary result.
32 bytes
Get the status of a transaction
Next field: 4
hash of the transaction. 32 bytes ATTN: this is in binary, not hex. The JSON API accepts a hex string for a transaction hash, but here we need that hex string converted into its binary form. Each pair of hex characters should be converted into its corresponding byte. For example, the 4 character hex string "00FF" should be converted to a 2 byte array: [0, 255]
if true, return data in binary format. defaults to false
If the transaction was not found, server will report whether the entire specified range was searched. The value is contained in the error message. The error message is of the form: "txn not found. searched_all = [true,false]" If the transaction was found, this parameter is ignored.
Get all validated transactions associated with a given account
Next field: 8
What ledger to include results from. Specifying a not yet validated ledger results in an error. Not specifying a ledger uses the entire range of validated ledgers available to the server. Note, this parameter acts as a filter, and can only reduce the number of results. Specifying a single ledger will return only transactions from that ledger. This includes specifying a ledger with a Shortcut. For example, specifying SHORTCUT_VALIDATED will result in only transactions that were part of the most recently validated ledger being returned. Specifying a range of ledgers results in only transactions that were included in a ledger within the specified range being returned.
Return results as binary blobs. Defaults to false.
If set to true, returns values indexed by older ledger first. Default to false.
Limit the number of results. Server may choose a lower limit. If this value is 0, the limit is ignored and the number of results returned is determined by the server
Marker to resume where previous request left off Used for pagination
Next field: 8
Used in:
, , , , , , , ,A representation of an account address Next field: 2
Used in:
, , , , , , , , , ,base58 encoding of an account
Next field: 3
Used in:
Next field: 15
Used in:
,Next field: 8
Used in:
Used in:
,32 bytes
Next field: 6
Used in:
32 bytes
Next field: 4
Used in:
Next field: 2
Used in:
,32 bytes
Next field: 3
Used in:
Used in:
, , , , , , ,Note, CurrencyAmount is a oneof, that can represent an ZXC drops amount or an Issued Currency amount. However, in some transaction types/ledger objects, this value can only be in drops. For instance, the Amount field of a Payment transaction can be specified in ZXC drops or an Issued Currency amount, but the Amount field of a PaymentChannelClaim transaction can only be an ZXC drops amount.
Used in:
,Used in:
, , ,Used in:
in drops
Used in:
32 btes
Used in:
Used in:
, , ,time in seconds since Ripple epoch
Used in:
,32 bytes
Next field: 14
Used in:
Next field: 2
Used in:
Next field: 4
Used in:
Next field: 6
Used in:
Used in:
,32 bytes
Used in:
Used in:
time in seconds since Ripple epoch
Used in:
, ,Next field: 2
Used in:
Next field: 3
Used in:
, , ,3 character ASCII code
160 bit currency code. 20 bytes
Next field: 3
Used in:
, , , , , , , , ,Used in:
time in seconds since Ripple epoch
Next field: 2
Used in:
Used in:
,Used in:
Next field: 3
Used in:
Next field: 7
Used in:
Used in:
, , , , , , ,Used in:
,Used in:
, , , , , , ,Next field: 11
Used in:
Next field: 3
Used in:
Used in:
,Used in:
,Next field: 14
Used in:
Next field: 3
Used in:
Next field: 7
Used in:
Next field: 5
Used in:
Used in:
, , , , ,time in seconds since Ripple epoch
Next field: 5
Used in:
Next field: 5
Used in:
Next field: 6
Used in:
Used in:
,time in seconds since Ripple epoch
Used in:
Used in:
, , , , , , , , , , , , ,Used in:
Next field: 9
Used as response type in: ZXCLedgerAPIService.GetTransaction
Used as field type in:
Variable length
Sequence number of ledger that contains this transaction
32 bytes
whether the ledger has been validated
metadata about the transaction
Variable length
Used in:
32 bytes
Used in:
Used in:
Used in:
Used in:
Used in:
32 bytes
Used in:
Used in:
Used in:
, ,32 bytes
A representation of an amount of issued currency. Next field: 4
Used in:
The currency used to value the amount.
The value of the amount. 8 bytes
Unique account address of the entity issuing the currency.
Used in:
, ,Next field: 14
Used in:
Next field: 4
Used in:
Next field: 14
Used in:
, ,Next field: 3
Used in:
,Note, if ledger_index_min is non-zero and ledger_index_max is 0, the software will use the max validated ledger in place of ledger_index_max
Next field: 4
Used in:
,32 bytes
Next field: 4
Used in:
Used in:
Used in:
Used in:
Used in:
Used in:
Next field: 3
Used in:
,Next field: 4
Used in:
Used in:
Used in:
Used in:
Used in:
,Next field: 5
Used in:
index in ledger
result code indicating whether the transaction succeeded or failed
Next field: 5
Used in:
Next field: 5
Used in:
Next field: 12
Used in:
Next field: 2
Used in:
Next field: 5
Used in:
Used in:
, , ,Used in:
, ,Used in:
Used in:
, , , , ,Next field: 13
Used in:
Next field: 8
Used in:
Next field: 2
Used in:
Next field: 4
Used in:
Next field: 6
Used in:
Next field: 7
Used in:
Next field: 4
Used in:
Used in:
Used in:
, , , , , , , ,32 bytes
Used in:
, , , , , , , ,Used in:
, , ,Used in:
Used in:
Aggregate data about queued transactions Next field: 7
Used in:
Data about a single queued transaction Next field: 7
Used in:
Used in:
Used in:
,Used in:
in drops
Used in:
in drops
Next field: 13
Used in:
Used in:
32 bytes
Used in:
, ,Used in:
, , , ,Used in:
Next field: 2
Used in:
Used in:
,Next field: 4
Used in:
Next field: 3
Used in:
,Next field: 8
Used in:
,Used in:
Next field: 3
Used in:
Used in:
,Used in:
is actually uint16
Used in:
,Used in:
, , ,Used in:
,Used in:
Used in:
20 bytes
Used in:
,Used in:
Used in:
20 bytes
Used in:
,is actually uint8
A message encompassing all transaction types Next field: 30
Used in:
Data specific to the type of transaction
Next field: 3
Used in:
,category of the transaction result
full result string, i.e. tesSUCCESS
Next field: 7
Used in:
Claimed cost only
Failure
Local error
Malformed transaction
Retry
Success
Used in:
,Used in:
,Next field: 4
Used in:
Used in:
Used in:
Used in:
A representation of an amount of ZXC. Next field: 2
Used in:
, , , ,