NodeConfiguration is the message containing the configuration of the node and the network that it is a part of.

Generated

from message v1.NodeConfiguration

Hierarchy

Constructors

Properties

addressIPv4: string = ""

AddressIPv4 is the IPv4 address of the node.

Generated

from field: string addressIPv4 = 4;

addressIPv6: string = ""

AddressIPv6 is the IPv6 address of the node.

Generated

from field: string addressIPv6 = 5;

domain: string = ""

Domain is the domain of the network.

Generated

from field: string domain = 6;

id: string = ""

ID is the ID of the node.

Generated

from field: string id = 1;

networkIPv4: string = ""

NetworkIPv4 is the IPv4 network that the node is a part of.

Generated

from field: string networkIPv4 = 2;

networkIPv6: string = ""

NetworkIPv6 is the IPv6 network that the node is a part of.

Generated

from field: string networkIPv6 = 3;

privateKey: Uint8Array = ...

PrivateKey is the private key of the node.

Generated

from field: bytes privateKey = 7;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "v1.NodeConfiguration" = "v1.NodeConfiguration"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns NodeConfiguration

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns NodeConfiguration

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns NodeConfiguration

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<NodeConfiguration>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Generated using TypeDoc