Skip to content

Protocol Documentation

Table of Contents

Top

node/rpc/node_admin.proto

GetBlockPoolSizeReply

Field Type Label Description
length uint64

GetChainReply

Field Type Label Description
current_chain string

GetLogsReply

Field Type Label Description
logs string repeated

GetLogsRequest

Field Type Label Description
since uint64

GetModeReply

Field Type Label Description
current_mode Mode

GetNodeNameReply

Field Type Label Description
name string

GetNodeStatusReply

Field Type Label Description
status Status

GetPeersResponse

Field Type Label Description
peers Peer repeated

GetPendingBlocksReply

Field Type Label Description
blocks API.Block repeated

GetVersionResponse

Field Type Label Description
version string

Peer

Field Type Label Description
ip string
prime bool

SetModeRequest

Field Type Label Description
mode Mode

SetNodeNameRequest

Field Type Label Description
new_name string

UpgradeNodeRequest

Field Type Label Description
version string

Mode

Name Number Description
PRIME 0 prime delegates
VALIDATING 1 non-prime delegates
OBSERVER 2 non-interacting node
LIGHT 3 node without the full transaction history

Status

Name Number Description
RUNNING 0
OUT_OF_SYNC 1
WAITING_FOR_PEERS 2
STARTING 3

NodeAdmin

Method Name Request Type Response Type Description
GetMode .API.Empty GetModeReply
SetMode SetModeRequest .API.Empty
GetLogs GetLogsRequest GetLogsReply
GetChain .API.Empty GetChainReply
GetPeers .API.Empty GetPeersResponse
GetVersion .API.Empty GetVersionResponse
GetNodeName .API.Empty GetNodeNameReply
SetNodeName SetNodeNameRequest .API.Empty
UpgradeNode UpgradeNodeRequest .API.Empty
GetNodeStatus .API.Empty GetNodeStatusReply
GetPendingBlocks .API.Empty GetPendingBlocksReply
GetBlockPoolSize .API.Empty GetBlockPoolSizeReply

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 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)
int64 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
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 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)
sint64 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
fixed32 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)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)