package com.hedera.mirror.api.proto

Get desktop application:
View/edit binary Protocol Buffers messages

* The Mirror Service provides the ability to query a stream of Hedera Consensus Service (HCS) messages for an HCS Topic via a specific (possibly open-ended) time range.

• rpc subscribeTopic (ConsensusTopicQuery, stream ConsensusTopicResponse)

  consensus_service.proto:99

  message ConsensusTopicQuery

  consensus_service.proto:36

  • optional proto.TopicID topicID = 1

    * A required topic ID to retrieve messages for.

  • optional proto.Timestamp consensusStartTime = 2

    * Include messages which reached consensus on or after this time. Defaults to current time if not set.

  • optional proto.Timestamp consensusEndTime = 3

    * Include messages which reached consensus before this time. If not set it will receive indefinitely.

  • uint64 limit = 4

    * The maximum number of messages to receive before stopping. If not set or set to zero it will return messages indefinitely.

  message ConsensusTopicResponse

  consensus_service.proto:61

  • optional proto.Timestamp consensusTimestamp = 1

    * The time at which the transaction reached consensus

  • bytes message = 2

    * The message body originally in the ConsensusSubmitMessageTransactionBody. Message size will be less than 6KiB.

  • bytes runningHash = 3

    * The running hash (SHA384) of every message.

  • uint64 sequenceNumber = 4

    * Starts at 1 for first submitted message. Incremented on each submitted message.

  • uint64 runningHashVersion = 5

    * Version of the SHA-384 digest used to update the running hash.

  • optional proto.ConsensusMessageChunkInfo chunkInfo = 6

    * Optional information of the current chunk in a fragmented message.

* Provides cross network APIs like address book queries

• rpc getNodes (AddressBookQuery, stream proto.NodeAddress)

  mirror_network_service.proto:55

  Query for an address book and return its nodes. The nodes are returned in ascending order by node ID. The response is not guaranteed to be a byte-for-byte equivalent to the NodeAddress in the Hedera file on the network since it is reconstructed from a normalized database table.

  message AddressBookQuery

  mirror_network_service.proto:34

  * Request object to query an address book for its list of nodes

  • optional proto.FileID file_id = 1

    * The ID of the address book file on the network. Can be either 0.0.101 or 0.0.102.

  • int32 limit = 2

    * The maximum number of node addresses to receive before stopping. If not set or set to zero it will return all node addresses in the database.