Skip to content

Protocol Documentation

Table of Contents

Top

node/rpc/block.proto

BalanceReply

Field Type Label Description
balance uint64 Reply contains the balance queried

BalanceRequest

Field Type Label Description
address bytes Balance Request takes the address for query

BlockByIDReply

Field Type Label Description
block API.Block

BlockByIDRequest

Field Type Label Description
hash bytes

BlockHeightReply

Field Type Label Description
nextHeight uint64

BlockHeightRequest

Field Type Label Description
address bytes
getNext bool

DelegateReply

Field Type Label Description
delegateAddress bytes

DelegateRequest

Field Type Label Description
address bytes

Empty

PendingBlockReply

Field Type Label Description
blocks API.Block repeated

TXByIDReply

Field Type Label Description
transaction API.Transaction

TXByIDRequest

Field Type Label Description
transactionID bytes

TXByIndexReply

Field Type Label Description
transaction API.Transaction

TXByIndexRequest

Field Type Label Description
height uint64
index uint64

UnacknowledgedTXReply

Field Type Label Description
transactions API.Transaction repeated

VotingPowerReply

Field Type Label Description
power uint32

VotingPowerRequest

Field Type Label Description
address bytes
getActive bool

BlockService

Method Name Request Type Response Type Description
GetBalance BalanceRequest BalanceReply GetBalance accepts BalanceRequests and returns BalanceReplies
GetBlockHeight BlockHeightRequest BlockHeightReply GetNextBlockHeight uses an address to get the latest block index to then return the next index
GetVotingPower VotingPowerRequest VotingPowerReply GetVotingPower uses an address to get the voting power of an account
GetBlockByID BlockByIDRequest BlockByIDReply GetBlockByID uses the hash of a block to get the data
GetDelegate DelegateRequest DelegateReply GetDelegate uses an account address to return a address of the delegate
GetPendingBlocks Empty PendingBlockReply GetPendingBlocks gets all blocks that havent been processed
GetUnacknowledgedTX Empty UnacknowledgedTXReply GetUnacknowledgedTX gets a number of how many transactions are unacknowledged
GetTXByID TXByIDRequest TXByIDReply GetTXByID uses a transaction ID to get a transaction
GetTXByIndex TXByIndexRequest TXByIndexReply GetTXByIndex uses an index for inside a block to return a transaction

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)