Protocol Documentation¶
Table of Contents¶
koinos/rpc/contract_meta_store/contract_meta_store_rpc.proto¶
contract_meta_store_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
get_contract_meta |
contract_meta_store_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
get_contract_meta |
get_contract_meta_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
meta |
koinos/rpc/rpc.proto¶
koinos/rpc/transaction_store/transaction_store_rpc.proto¶
get_transactions_by_id_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
transactions |
repeated |
transaction_store_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
get_transactions_by_id |
transaction_store_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
get_transactions_by_id |
koinos/rpc/chain/chain_rpc.proto¶
chain_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
submit_block |
|||
submit_transaction |
|||
get_head_info |
|||
get_chain_id |
|||
get_fork_heads |
|||
read_contract |
|||
get_account_nonce |
|||
get_account_rc |
|||
get_resource_limits |
chain_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
submit_block |
|||
submit_transaction |
|||
get_head_info |
|||
get_chain_id |
|||
get_fork_heads |
|||
read_contract |
|||
get_account_nonce |
|||
get_account_rc |
|||
get_resource_limits |
get_chain_id_request¶
get_fork_heads_request¶
get_fork_heads_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
last_irreversible_block |
|||
fork_heads |
repeated |
get_head_info_request¶
get_head_info_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
head_topology |
|||
last_irreversible_block |
|||
head_state_merkle_root |
|||
head_block_time |
get_resource_limits_request¶
get_resource_limits_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
resource_limit_data |
submit_transaction_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
transaction |
|||
broadcast |
submit_transaction_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
receipt |
koinos/rpc/block_store/block_store_rpc.proto¶
add_block_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
block_to_add |
|||
receipt_to_add |
add_block_response¶
block_store_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
get_blocks_by_id |
|||
get_blocks_by_height |
|||
add_block |
|||
get_highest_block |
block_store_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
get_blocks_by_id |
|||
get_blocks_by_height |
|||
add_block |
|||
get_highest_block |
get_blocks_by_height_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
head_block_id |
|||
ancestor_start_height |
|||
num_blocks |
|||
return_block |
|||
return_receipt |
get_blocks_by_height_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
block_items |
repeated |
get_blocks_by_id_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
block_ids |
repeated |
||
return_block |
|||
return_receipt |
get_blocks_by_id_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
block_items |
repeated |
get_highest_block_request¶
koinos/rpc/p2p/p2p_rpc.proto¶
get_gossip_status_request¶
p2p_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
get_gossip_status |
p2p_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
get_gossip_status |
koinos/rpc/mempool/mempool_rpc.proto¶
check_pending_account_resources_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
payer |
|||
max_payer_rc |
|||
rc_limit |
get_pending_transactions_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
pending_transactions |
repeated |
mempool_request¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
check_pending_account_resources |
|||
get_pending_transactions |
mempool_response¶
Field |
Type |
Label |
Description |
---|---|---|---|
reserved |
|||
error |
|||
check_pending_account_resources |
|||
get_pending_transactions |
pending_transaction¶
Field |
Type |
Label |
Description |
---|---|---|---|
transaction |
|||
disk_storage_used |
|||
network_bandwidth_used |
|||
compute_bandwidth_used |
Scalar Value Types¶
.proto Type |
Notes |
C++ |
Java |
Python |
Go |
C# |
PHP |
Ruby |
---|---|---|---|---|---|---|---|---|
double |
double |
float |
float64 |
double |
float |
Float |
||
float |
float |
float |
float32 |
float |
float |
Float |
||
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
|
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
|
Uses variable-length encoding. |
uint32 |
int |
int/long |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
|
Uses variable-length encoding. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum or Fixnum (as required) |
|
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
|
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
|
Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
uint32 |
int |
int |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
|
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum |
|
Always four bytes. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
|
Always eight bytes. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
|
bool |
boolean |
boolean |
bool |
bool |
boolean |
TrueClass/FalseClass |
||
A string must always contain UTF-8 encoded or 7-bit ASCII text. |
string |
String |
str/unicode |
string |
string |
string |
String (UTF-8) |
|
May contain any arbitrary sequence of bytes. |
string |
ByteString |
str |
[]byte |
ByteString |
string |
String (ASCII-8BIT) |