Class Node

Index

Constructors

Properties

baseToken config ledger log networkAddress stats switch timing isInstance Kind

Methods

addHeapToLedger addToLedger copy gc invokeHeapBlocks recvMessageFromPeer run sendMessage stop sync getDefaultConfig main

Constructors

constructor

new Node(configOrNode: Node | NodeConfig): Node
Parameters
- configOrNode: Node | NodeConfig
Returns Node

Properties

`Readonly`baseToken

baseToken: TokenAddress

config

config: NodeConfig

ledger

ledger: Ledger

log

log: {
debug: (from: string, ...message: any[]) => void;
error: (from: string, ...message: any[]) => void;
} = ...

`Readonly`networkAddress

networkAddress: NetworkAddress

stats

stats: Stats

switch

switch: P2PSwitch

timing

timing: RequestTiming

`Static`isInstance

isInstance: (obj: any, strict?: boolean) => obj is Node = ...

`Static`Kind

Kind: typeof NodeKind = NodeKind

Methods

addHeapToLedger

addHeapToLedger(
blockPrevHashes?: BlockHash[],
broadcast?: boolean,
): Promise<null | BlockHash[]>
Parameters
- OptionalblockPrevHashes: BlockHash[]
- broadcast: boolean = true
Returns Promise<null | BlockHash[]>

addToLedger

addToLedger(votesAndBlocks: VoteStaple, broadcast?: boolean): Promise<boolean>
Parameters
- votesAndBlocks: VoteStaple
- broadcast: boolean = true
Returns Promise<boolean>

copy

copy(): Node
Returns Node

gc

gc(timeout?: number): Promise<void>
Parameters
- timeout: number = 280000
Returns Promise<void>

invokeHeapBlocks

invokeHeapBlocks(blockPrevHashes: BlockHash[]): Promise<void>
Parameters
- blockPrevHashes: BlockHash[]
Returns Promise<void>

recvMessageFromPeer

recvMessageFromPeer(
    from: P2PConnection,
    id: string,
    type: string,
    data: any,
    ttl?: number,
): Promise<boolean>
Parameters
- from: P2PConnection
- id: string
- type: string
- data: any
- Optionalttl: number
Returns Promise<boolean>

run

run(): Promise<void>
Returns Promise<void>

sendMessage

sendMessage(
    id: string,
    type: string,
    data: any,
    ttl?: number,
    exclude?: (string | P2PConnection)[],
): Promise<boolean>
Parameters
- id: string
- type: string
- data: any
- Optionalttl: number
- Optionalexclude: (string | P2PConnection)[]
Returns Promise<boolean>

stop

stop(): Promise<void>
Returns Promise<void>

sync

sync(): Promise<void>
Returns Promise<void>

`Static`getDefaultConfig

getDefaultConfig(
network: "production" | "staging" | "beta" | "test" | "dev",
): Omit<NodeConfig, "stats" | "ledger">
Parameters
- network: "production" | "staging" | "beta" | "test" | "dev"
Returns Omit<NodeConfig, "stats" | "ledger">

`Static`main

main(config: NodeConfig): void
Parameters
- config: NodeConfig
Returns void