Class CreateRegisteredNodeParams

Transaction Parameters for registering a new node (block node, etc.) in the HIP-1137 on-chain registered-node registry.

Inheritance

object

TransactionParams

TransactionParams<RegisteredNodeReceipt>

CreateRegisteredNodeParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

[Experimental("HIERO001", UrlFormat = "https://github.com/bugbytesinc/Hiero/blob/main/docs/blocknode-client-plan.md")]
public sealed class CreateRegisteredNodeParams : TransactionParams<RegisteredNodeReceipt>

Remarks

On mainnet, creating a registered node is currently restricted to privileged payer accounts. The receipt carries the network-assigned RegisteredNodeId that later update and delete transactions require, and that discovery (GetRegisteredNodesAsync) surfaces.

Properties

AdminKey

The administrative key authorized to update or delete this registration. This key must sign this transaction. This field is REQUIRED.

Declaration

public Endorsement AdminKey { get; set; }

Property Value

Type	Description
Endorsement

CancellationToken

Optional cancellation token. Cancelling stops the client waiting; it cannot recall a transaction already sent. Cancelled after the send, the outcome is unknown: settle it by its transaction id on a mirror node rather than resubmitting it.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Description

A short description of the node. Must not exceed 100 bytes when encoded as UTF-8. This field is OPTIONAL.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
string

Endpoints

The service endpoints this node publishes. Must contain between 1 and 50 entries. This field is REQUIRED.

Declaration

public IReadOnlyList<RegisteredNodeEndpoint> Endpoints { get; set; }

Property Value

Type	Description
IReadOnlyList<RegisteredNodeEndpoint>

Signatory

Additional private key, keys or signing callback method required to authorize this transaction. Must include the key matching AdminKey and, where required, a privileged payer.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory