Class RegisteredNodeDataExtensions

Extension methods for querying the HIP-1137 registered-node registry from the mirror node.

Inheritance

object

RegisteredNodeDataExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero.Mirror

Assembly: Hiero.dll

Syntax

[Experimental("HIERO001", UrlFormat = "https://github.com/bugbytesinc/Hiero/blob/main/docs/blocknode-client-plan.md")]
public static class RegisteredNodeDataExtensions

Methods

GetRegisteredBlockNodesAsync(MirrorRestClient, params IMirrorQueryParameter[])

Enumerates registered block nodes — a convenience over GetRegisteredNodesAsync(MirrorRestClient, CancellationToken, params IMirrorQueryParameter[]) that applies BlockNode.

Declaration

public static IAsyncEnumerable<RegisteredNodeData> GetRegisteredBlockNodesAsync(this MirrorRestClient client, params IMirrorQueryParameter[] filters)

Parameters

Type	Name	Description
MirrorRestClient	client	Mirror Rest Client to use for the request.
IMirrorQueryParameter[]	filters	Additional query parameters (the block-node type filter is applied automatically).

Returns

Type	Description
IAsyncEnumerable<RegisteredNodeData>	An async enumerable of registered block-node records.

GetRegisteredBlockNodesAsync(MirrorRestClient, CancellationToken, params IMirrorQueryParameter[])

Enumerates registered block nodes — a convenience over GetRegisteredNodesAsync(MirrorRestClient, CancellationToken, params IMirrorQueryParameter[]) that applies BlockNode.

Declaration

public static IAsyncEnumerable<RegisteredNodeData> GetRegisteredBlockNodesAsync(this MirrorRestClient client, CancellationToken cancellationToken, params IMirrorQueryParameter[] filters)

Parameters

Type	Name	Description
MirrorRestClient	client	Mirror Rest Client to use for the request.
CancellationToken	cancellationToken	Token that cancels the enumeration, including a page request in flight. WithCancellation on the result works as well.
IMirrorQueryParameter[]	filters	Additional query parameters (the block-node type filter is applied automatically).

Returns

Type	Description
IAsyncEnumerable<RegisteredNodeData>	An async enumerable of registered block-node records.

GetRegisteredNodesAsync(MirrorRestClient, params IMirrorQueryParameter[])

Enumerates registered nodes from /api/v1/network/registered-nodes. Narrow by kind with RegisteredNodeTypeFilter or by id with RegisteredNodeIdFilter.

Declaration

public static IAsyncEnumerable<RegisteredNodeData> GetRegisteredNodesAsync(this MirrorRestClient client, params IMirrorQueryParameter[] filters)

Parameters

Type	Name	Description
MirrorRestClient	client	Mirror Rest Client to use for the request.
IMirrorQueryParameter[]	filters	Additional query parameters. The endpoint supports RegisteredNodeTypeFilter, RegisteredNodeIdFilter, PageLimit, and OrderBy.

Returns

Type	Description
IAsyncEnumerable<RegisteredNodeData>	An async enumerable of registered-node records.

GetRegisteredNodesAsync(MirrorRestClient, CancellationToken, params IMirrorQueryParameter[])

Enumerates registered nodes from /api/v1/network/registered-nodes. Narrow by kind with RegisteredNodeTypeFilter or by id with RegisteredNodeIdFilter.

Declaration

public static IAsyncEnumerable<RegisteredNodeData> GetRegisteredNodesAsync(this MirrorRestClient client, CancellationToken cancellationToken, params IMirrorQueryParameter[] filters)

Parameters

Type	Name	Description
MirrorRestClient	client	Mirror Rest Client to use for the request.
CancellationToken	cancellationToken	Token that cancels the enumeration, including a page request in flight. WithCancellation on the result works as well.
IMirrorQueryParameter[]	filters	Additional query parameters. The endpoint supports RegisteredNodeTypeFilter, RegisteredNodeIdFilter, PageLimit, and OrderBy.

Returns

Type	Description
IAsyncEnumerable<RegisteredNodeData>	An async enumerable of registered-node records.