Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NodeInfo

The node info structure describes basic information of a node.

Hierarchy

  • NodeInfo

Index

Constructors

Properties

Constructors

constructor

  • new NodeInfo(publicKey: string, networkGenerationHashSeed: string, port: number, networkIdentifier: NetworkType, version: number, roles: RoleType[], host: string, friendlyName: string, nodePublicKey?: undefined | string): NodeInfo

  • Parameters

    • publicKey: string
    • networkGenerationHashSeed: string
    • port: number
    • networkIdentifier: NetworkType
    • version: number
    • roles: RoleType[]
    • host: string
    • friendlyName: string
    • Optional nodePublicKey: undefined | string

    Returns NodeInfo

Properties

Readonly friendlyName

friendlyName: string

The name of the node.

Readonly host

host: string

The IP address of the endpoint.

Readonly networkGenerationHashSeed

networkGenerationHashSeed: string

The network generation hash seed

Readonly networkIdentifier

networkIdentifier: NetworkType

The network identifier.

Optional Readonly nodePublicKey

nodePublicKey: undefined | string

Readonly port

port: number

The port used for the communication.

Readonly publicKey

publicKey: string

The public key used to identify the node.

Readonly roles

roles: RoleType[]

The roles of the application.

Readonly version

version: number

The version of the application.

Generated using TypeDoc