package harmonymessage

Get desktop application:
View/edit binary Protocol Buffers messages

Client is the service used for any client-facing requests.

• rpc Process (Message, Response)

  harmonymessage.proto:8

  message Message

  harmonymessage.proto:40

  This is universal message for all communication protocols. There are different Requests for different message types. As we introduce a new type of message just add a new MessageType and new type of request in Message. The request field will be either one of the structure corresponding to the MessageType type.

  • ServiceType service_type = 1

  • MessageType type = 2

  • bytes signature = 3

  • oneof request

    • StakingRequest staking = 4

    • ConsensusRequest consensus = 5

    • DrandRequest drand = 6

    • ViewChangeRequest viewchange = 7

    • LotteryRequest lottery_request = 8

      Refactor this later after demo.

    • LastSignPowerBroadcast last_sign_power = 9

  message Response

  harmonymessage.proto:55

  • ServiceType service_type = 1

  • MessageType type = 2

  • oneof response

    • LotteryResponse lottery_response = 3

Used in: Message

• uint64 view_id = 1

• uint64 block_num = 2

• uint32 shard_id = 3

• bytes block_hash = 4

• bytes block = 5

• bytes sender_pubkey = 6

• bytes payload = 7

• bytes sender_pubkey_bitmap = 8

Used in: Message

• uint32 shard_id = 1

• bytes sender_pubkey = 2

• bytes block_hash = 3

• bytes payload = 4

Used in: Message

• int64 prepare = 1

• int64 commit = 2

• int64 change = 3

• bytes sender_pubkey = 4

• uint32 shard_id = 5

Used in: Message

• LotteryRequest.Type type = 1

• string private_key = 2

• int64 amount = 3

Used in: LotteryRequest

• ENTER = 0

• RESULT = 1

• PICK_WINNER = 2

Used in: Response

• repeated string players = 2

• repeated string balances = 3

MessageType indicates what is the type of this message.

Used in: Message, Response

• NEWNODE_BEACON_STAKING = 0

• ANNOUNCE = 1

• PREPARE = 2

• PREPARED = 3

• COMMIT = 4

• COMMITTED = 5

• VIEWCHANGE = 6

• NEWVIEW = 7

• DRAND_INIT = 10

• DRAND_COMMIT = 11

• LOTTERY_REQUEST = 12

  it should be either ENTER or GETPLAYERS but it will be removed later.

• LAST_SIGN_POWER = 13

ServiceType indicates which service used to generate this message.

Used in: Message, Response

• CONSENSUS = 0

• STAKING = 1

• DRAND = 2

• CLIENT_SUPPORT = 3

Staking Request from new node to beacon node.

Used in: Message

• bytes transaction = 1

• string node_id = 2

Used in: Message

• uint64 view_id = 1

• uint64 block_num = 2

• uint32 shard_id = 3

• bytes sender_pubkey = 4

• bytes leader_pubkey = 5

• bytes payload = 6

  message payload: either m1 type or m2 type

• bytes viewchange_sig = 7

  signature on payload

• bytes viewid_sig = 8

  signature on view_id

• bytes m2_aggsigs = 9

  below is for newview message only only need 1 valid m1 type message which is in payload

  m2: |nil|

• bytes m2_bitmap = 10

• bytes m3_aggsigs = 11

  m3: |viewID|

• bytes m3_bitmap = 12

• bytes prepared_block = 13