package com.hedera.hapi.node.state.addressbook
Get desktop application:
View/edit binary Protocol Buffers messages
message
node.proto:23* A single address book node in the network state. Each node in the network address book SHALL represent a single actual consensus node that is eligible to participate in network consensus. Address book nodes SHALL NOT be _globally_ uniquely identified. A given node is only valid within a single realm and shard combination, so the identifier for a network node SHALL only be unique within a single realm and shard combination.
uint64 node_id = 1
* A consensus node identifier. <p> Node identifiers SHALL be globally unique for a given ledger.
optional account_id = 2
* An account identifier. <p> This account SHALL be owned by the entity responsible for the node.<br/> This account SHALL be charged transaction fees for any transactions that are submitted to the network by this node and fail due diligence checks.<br/> This account SHALL be paid the node portion of transaction fees for transactions submitted by this node.
string description = 3
* A short description of the node. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
repeated gossip_endpoint = 4
* A list of service endpoints for gossip. <p> These endpoints SHALL represent the published endpoints to which other consensus nodes may _gossip_ transactions.<br/> If the network configuration value `gossipFqdnRestricted` is set, then all endpoints in this list SHALL supply only IP address.<br/> If the network configuration value `gossipFqdnRestricted` is _not_ set, then endpoints in this list MAY supply either IP address or FQDN, but SHALL NOT supply both values for the same endpoint.<br/> This list SHALL NOT be empty.<br/> This list SHALL NOT contain more than `10` entries.<br/> The first two entries in this list SHALL be the endpoints published to all consensus nodes.<br/> All other entries SHALL be reserved for future use.
repeated service_endpoint = 5
* A list of service endpoints for client calls. <p> These endpoints SHALL represent the published endpoints to which clients may submit transactions.<br/> These endpoints SHALL specify a port.<br/> Endpoints in this list MAY supply either IP address or FQDN, but SHALL NOT supply both values for the same endpoint.<br/> This list SHALL NOT be empty.<br/> This list SHALL NOT contain more than `8` entries.
bytes gossip_ca_certificate = 6
* A certificate used to sign gossip events. <p> This value SHALL be a certificate of a type permitted for gossip signatures.<br/> This value SHALL be the DER encoding of the certificate presented.<br/> This field is REQUIRED and MUST NOT be empty.
bytes grpc_certificate_hash = 7
* A hash of the node gRPC certificate. <p> This value MAY be used to verify the certificate presented by the node during TLS negotiation for gRPC.<br/> This value SHALL be a SHA-384 hash.<br/> The TLS certificate to be hashed SHALL first be in PEM format and SHALL be encoded with UTF-8 NFKD encoding to a stream of bytes provided to the hash algorithm.<br/> This field is OPTIONAL.
uint64 weight = 8
* A consensus weight. <p> Each node SHALL have a weight in consensus calculations.<br/> The consensus weight of a node SHALL be calculated based on the amount of HBAR staked to that node.<br/> Consensus SHALL be calculated based on agreement of greater than `2/3` of the total `weight` value of all nodes on the network. <p> This field is deprecated and SHALL NOT be used when RosterLifecycle is enabled.
bool deleted = 9
* A flag indicating this node is deleted. <p> If this field is set, then this node SHALL NOT be included in the next update of the network address book.<br/> If this field is set, then this node SHALL be immutable and SHALL NOT be modified.<br/> If this field is set, then any `nodeUpdate` transaction to modify this node SHALL fail.
optional admin_key = 10
* An administrative key controlled by the node operator. <p> This key MUST sign each transaction to update this node.<br/> This field MUST contain a valid `Key` value.<br/> This field is REQUIRED and MUST NOT be set to an empty `KeyList`.
bool decline_reward = 11
* A flag indicating this node declines node rewards distributed at the end of staking period. <p> If this field is set, then this node SHALL NOT receive any node rewards distributed at the end of the staking period.
optional grpc_proxy_endpoint = 12
* A web proxy for gRPC from non-gRPC clients. <p> This endpoint SHALL be a Fully Qualified Domain Name (FQDN) using the HTTPS protocol, and SHALL support gRPC-Web for use by browser-based clients.<br/> This endpoint MUST be signed by a trusted certificate authority.<br/> This endpoint MUST use a valid port and SHALL be reachable over TLS.<br/> This field MAY be omitted if the node does not support gRPC-Web access.<br/> This field MUST be updated if the gRPC-Web endpoint changes.<br/> This field SHALL enable frontend clients to avoid hard-coded proxy endpoints.
repeated uint64 associated_registered_node = 13
* A list of registered nodes operated by the same entity as this node.<br/> This value may contain a list of "registered nodes" (as described in HIP-1137) that are operated by the same entity that operates this consensus node. <p> This field is OPTIONAL and MAY be empty.<br/> This field MUST NOT contain more than twenty(20) entries.<br/> Every entry in this list MUST be a valid `registered_node_id` for a current registered node.
message
registered_node.proto:22* A single registered node in the network state. Each registered node in the network state SHALL represent a single non-consensus node that is registered on the network. Registered node identifiers SHALL only be unique within a single realm and shard combination.
uint64 registered_node_id = 1
* A registered node identifier. <p> This value SHALL be set.<br/> This value SHALL be unique within a given network.<br/> This value SHALL NOT match any consensus node ID in the same network. <p> A given value for `registered_node_id` MUST be unique within a given shard or realm.<br/> A given value for `registered_node_id` MUST NOT be reused, even if the corresponding entry is later deleted.
optional admin_key = 2
* An administrative key controlled by the node operator. <p> This key MUST sign each transaction to update this node.<br/> This field SHALL contain a valid `Key` value.<br/> This field SHALL NOT be set to an empty `KeyList`.<br/> It is RECOMMENDED that this key be composed of one or more unique public keys that are not associated with any network account.<br/> This key MAY be a complex key containing `KeyList` or `ThresholdKey` elements, but SHOULD NOT be a contract ID key.
string description = 3
* A short description of the node. <p> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
repeated service_endpoint = 4
* A list of service endpoints for client calls. <p> These endpoints SHALL represent the published endpoints to which clients may submit requests.<br/> One Registered Node MAY expose endpoints for multiple service types.<br/> This list SHALL NOT be empty.<br/> This list SHALL NOT contain more than `50` entries.