Class RegisteredNodeEndpointData

A single service endpoint published by a RegisteredNodeData.

Inheritance
object
RegisteredNodeEndpointData
Inherited Members
Namespace: Hiero.Mirror
Assembly: Hiero.dll
Syntax
[Experimental("HIERO001", UrlFormat = "https://github.com/bugbytesinc/Hiero/blob/main/docs/blocknode-client-plan.md")]
public class RegisteredNodeEndpointData

Properties

| Edit this page View Source

BlockNode

The block-node service descriptor when this endpoint serves the
Block Node APIs; 

null

for other endpoint kinds.

Declaration
[JsonPropertyName("block_node")]
public RegisteredBlockNodeEndpointData? BlockNode { get; set; }
Property Value
Type Description
RegisteredBlockNodeEndpointData
| Edit this page View Source

DomainName

The DNS domain name of the service, if published by name. Exactly one of DomainName or IpAddress is populated.

Declaration
[JsonPropertyName("domain_name")]
public string? DomainName { get; set; }
Property Value
Type Description
string
| Edit this page View Source

GeneralService

The general-service descriptor when this endpoint is a
<code>GENERAL_SERVICE</code>; 

null

for other endpoint kinds.

Declaration
[JsonPropertyName("general_service")]
public RegisteredGeneralServiceEndpointData? GeneralService { get; set; }
Property Value
Type Description
RegisteredGeneralServiceEndpointData
| Edit this page View Source

IpAddress

The IP address of the service, if published by address.

Declaration
[JsonPropertyName("ip_address")]
public string? IpAddress { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Port

The port the service listens on.

Declaration
[JsonPropertyName("port")]
public int Port { get; set; }
Property Value
Type Description
int
| Edit this page View Source

RequiresTls

Whether connecting to this endpoint requires TLS.

Declaration
[JsonPropertyName("requires_tls")]
public bool RequiresTls { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Type

The kind of service this endpoint provides — one of BLOCK_NODE, MIRROR_NODE, RPC_RELAY or GENERAL_SERVICE, the values RegisteredNodeTypeFilter filters on.

Declaration
[JsonPropertyName("type")]
public string? Type { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ToUri()

Builds the gRPC URI for this endpoint, using https when TLS is required and http otherwise.

Declaration
public Uri? ToUri()
Returns
Type Description
Uri 
The endpoint's URI, or 

null

when the endpoint publishes neither a domain name nor an IP address.
Remarks

IPv6 addresses are bracketed as the URI syntax requires, so an endpoint published as ::1 yields http://[::1]:40840.