Class NodeGraph

Hierarchy

CreateDestroyStartStop
- NodeGraph

Constructors

constructor

new NodeGraph(__namedParameters): NodeGraph
Parameters
- __namedParameters: {
      db: DB;
      keyRing: KeyRing;
      logger: Logger;
      nodeBucketLimit: number;
      nodeContactAddressLimit: number;
      nodeIdBits: number;
  }
  - db: DB
  - keyRing: KeyRing
  - logger: Logger
  - nodeBucketLimit: number
  - nodeContactAddressLimit: number
  - nodeIdBits: number
Returns NodeGraph
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/nodes/NodeGraph.ts:124

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Readonly` nodeBucketLimit

nodeBucketLimit: number

Max number of nodes in each bucket.

`Readonly` nodeContactAddressLimit

nodeContactAddressLimit: number

Max number of nodeContactAddresses for each node.

`Protected` nodeGraphBucketsDbPath

nodeGraphBucketsDbPath: readonly (string | Buffer)[]

Buckets stores lexi(NodeBucketIndex)/NodeId/nodeContactAddress -> NodeContactAddressData.

nodeContactAddress are canoncialized to be consistent.

`Protected` nodeGraphConnectedDbPath

nodeGraphConnectedDbPath: readonly (string | Buffer)[]

Last updated stores lexi(NodeBucketIndex)/"time"/lexi(connectedTime)/nodeId -> nodeId. lexi(NodeBucketIndex)/"nodeId"/nodeId -> lexi(connectedTime).

`Protected` nodeGraphDbPath

nodeGraphDbPath: readonly (string | Buffer)[] = ...

`Protected` nodeGraphMetaDbPath

nodeGraphMetaDbPath: readonly (string | Buffer)[]

Meta stores the keyof NodeBucketMeta -> NodeBucketMeta[keyof NodeBucketMeta].

`Readonly` nodeIdBits

nodeIdBits: number

Bit size of the node IDs. This is also the total number of buckets.

`Protected` space

space: NodeGraphSpace

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

bucketIndex

bucketIndex(nodeId): [number, string]
Derive the bucket index of the k-buckets from the new NodeId The bucket key is the string encoded version of bucket index that preserves lexicographic order
Parameters
- nodeId: NodeId
Returns [number, string]
- Defined in src/nodes/NodeGraph.ts:211

`Protected` delConnectedTime

delConnectedTime(nodeId, tran): Promise<void>
Deletes the connectedTime for a NodeId
Parameters
- nodeId: NodeId
- tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:570

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/nodes/NodeGraph.ts:181

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getBucket

getBucket(bucketIndex, sort?, order?, limit?, tran?, ctx?): Promise<NodeBucket>
Gets a bucket.

The bucket's node IDs is sorted lexicographically by default Alternatively you can acquire them sorted by connected timestamp or by distance to the own NodeId.
Parameters
- bucketIndex: number
- Optional sort: "nodeId" | "connected" | "distance"
- Optional order: "asc" | "desc"
- Optional limit: number
  
  Limit the number of nodes returned, note that -1 means no limit, but Infinity means 0.
- Optional tran: DBTransaction
- Optional ctx: Partial<ContextTimedInput>
Returns Promise<NodeBucket>
- Defined in src/nodes/NodeGraph.ts:626

getBucketMeta

getBucketMeta(bucketIndex, tran?): Promise<NodeBucketMeta>
Get a bucket meta POJO. This will provide default values for missing properties.
Parameters
- bucketIndex: number
- Optional tran: DBTransaction
Returns Promise<NodeBucketMeta>
- Defined in src/nodes/NodeGraph.ts:832

getBucketMetaProp

getBucketMetaProp<Key>(bucketIndex, key, tran?): Promise<NodeBucketMeta[Key]>
Get a single bucket meta property. This will provide default values for missing properties.
Type Parameters
- Key extends "count"
Parameters
- bucketIndex: number
- key: Key
- Optional tran: DBTransaction
Returns Promise<NodeBucketMeta[Key]>
- Defined in src/nodes/NodeGraph.ts:866

getBuckets

getBuckets(sort?, order?, tran?): AsyncGenerator<[number, NodeBucket], any, unknown>
Gets all buckets. Buckets are always sorted by NodeBucketIndex first Then secondly by the sort parameter The order parameter applies to both, for example possible sorts: NodeBucketIndex asc, NodeID asc NodeBucketIndex desc, NodeId desc NodeBucketIndex asc, distance asc NodeBucketIndex desc, distance desc NodeBucketIndex asc, connected asc NodeBucketIndex desc, connected desc
Parameters
- sort: "nodeId" | "connected" | "distance" = 'nodeId'
- order: "asc" | "desc" = 'asc'
- Optional tran: DBTransaction
Returns AsyncGenerator<[number, NodeBucket], any, unknown>
- Defined in src/nodes/NodeGraph.ts:709

getClosestNodes

getClosestNodes(nodeId, limit?, tran?, ctx?): Promise<NodeBucket>
Gets the closest nodes (closest based on Kademlia XOR operator) to a given node ID. The returned results will be sorted by distance in ascending order. If the given node ID already exists in the node graph, then it will be the first result.
Parameters
- nodeId: NodeId
- Optional limit: number
  
  Defaults to the bucket limit.
- Optional tran: DBTransaction
- Optional ctx: Partial<ContextTimedInput>
Returns Promise<NodeBucket>
The NodeBucket which could have less than limit nodes if the node graph has less than the requested limit.
- Defined in src/nodes/NodeGraph.ts:909

getConnectedTime

getConnectedTime(nodeId, tran?): any
Gets the connectedTime for a node
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns any
- Defined in src/nodes/NodeGraph.ts:589

getNodeContact

getNodeContact(nodeId, tran?, ctx?): Promise<undefined | NodeContact>
Get a single NodeContact
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
- Optional ctx: Partial<ContextTimedInput>
Returns Promise<undefined | NodeContact>
- Defined in src/nodes/NodeGraph.ts:242

getNodeContactAddressData

getNodeContactAddressData(nodeId, nodeAddress, tran?): Promise<undefined | NodeContactAddressData>
Get a single NodeContactAddressData.
Parameters
- nodeId: NodeId
- nodeAddress: NodeAddress | NodeContactAddress
- Optional tran: DBTransaction
Returns Promise<undefined | NodeContactAddressData>
- Defined in src/nodes/NodeGraph.ts:313

getNodeContacts

getNodeContacts(order?, tran?): AsyncGenerator<[NodeId, NodeContact], any, unknown>
Get all NodeContact.

Results are sorted by NodeBucketIndex then NodeId then NodeContactAddress. The order parameter applies to both, for example: NodeBucketIndex asc, NodeID asc, NodeContactAddress asc NodeBucketIndex desc, NodeId desc, NodeContactAddress desc
Parameters
- order: "asc" | "desc" = 'asc'
- Optional tran: DBTransaction
Returns AsyncGenerator<[NodeId, NodeContact], any, unknown>
- Defined in src/nodes/NodeGraph.ts:291

lockBucket

lockBucket(bucketIndex, tran, ctx?): Promise<void>
Locks the bucket index for exclusive operations. This allows you to sequence operations for any bucket.
Parameters
- bucketIndex: number
- tran: DBTransaction
- Optional ctx: ContextTimed
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:225

nodesTotal

nodesTotal(tran?): Promise<number>
Returns to total number of nodes in the NodeGraph
Parameters
- Optional tran: DBTransaction
Returns Promise<number>
- Defined in src/nodes/NodeGraph.ts:1045

`Protected` purgeAddresses

purgeAddresses(nodeId, num, tran?): Promise<void>
This utility will clean out the oldest addresses until a set amount remain
Parameters
- nodeId: NodeId
- num: number
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:1056

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

resetBuckets

resetBuckets(tran?): Promise<void>
Resets the bucket according to the new node ID. Run this after new node ID is generated via renewal or reset.
Parameters
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:739

`Protected` setBucketMetaProp

setBucketMetaProp<Key>(bucketIndex, key, value, tran): Promise<void>
Sets a single bucket meta property. Bucket meta properties cannot be mutated outside.
Type Parameters
- Key extends "count"
Parameters
- bucketIndex: number
- key: Key
- value: NodeBucketMeta[Key]
- tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:1027

`Protected` setConnectedTime

setConnectedTime(nodeId, connectedTime, tran, path?): Promise<void>
Sets the connectedTime for a NodeId, replaces the old value if it exists
Parameters
- nodeId: NodeId
- connectedTime: number
- tran: DBTransaction
- path: readonly (string | Buffer)[] = ...
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:535

setNodeContact

setNodeContact(nodeId, nodeContact, tran?): Promise<void>
Sets a single NodeContact for a NodeId. This replaces the entire NodeContact for the NodeId. This will increment the bucket count if it is a new NodeID.
Parameters
- nodeId: NodeId
- nodeContact: NodeContact
- Optional tran: DBTransaction
Returns Promise<void>

Throws
If the bucket is full.
- Defined in src/nodes/NodeGraph.ts:346

setNodeContactAddressData

setNodeContactAddressData(nodeId, nodeAddress, nodeContactAddressData, tran?): Promise<void>
Sets a single NodeContactAddressData for a NodeId. This will increment the bucket count if it is a new NodeID.
Parameters
- nodeId: NodeId
- nodeAddress: NodeAddress | NodeContactAddress
- nodeContactAddressData: NodeContactAddressData
- Optional tran: DBTransaction
Returns Promise<void>

Throws
If the bucket is full.
- Defined in src/nodes/NodeGraph.ts:396

`Protected` setupSpace

setupSpace(tran): Promise<NodeGraphSpace>
Sets up the space key The space string is suffixed to the buckets and meta sublevels This is used to allow swapping of sublevels when remapping buckets during this.resetBuckets
Parameters
- tran: DBTransaction
Returns Promise<NodeGraphSpace>
- Defined in src/nodes/NodeGraph.ts:193

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/nodes/NodeGraph.ts:147

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/nodes/NodeGraph.ts:176

unsetNodeContact

unsetNodeContact(nodeId, tran?): Promise<void>
Unsets a NodeId record. It will decrement the bucket count if it existed.
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:450

unsetNodeContactAddress

unsetNodeContactAddress(nodeId, nodeAddress, tran?): Promise<void>
Parameters
- nodeId: NodeId
- nodeAddress: NodeAddress | NodeContactAddress
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/nodes/NodeGraph.ts:477

`Static` createNodeGraph

createNodeGraph(__namedParameters): Promise<NodeGraph>
Parameters
- __namedParameters: {
      db: DB;
      fresh?: boolean;
      keyRing: KeyRing;
      logger?: Logger;
      nodeBucketLimit?: number;
      nodeContactAddressLimit?: number;
      nodeIdBits?: number;
  }
  - db: DB
  - Optional fresh?: boolean
  - keyRing: KeyRing
  - Optional logger?: Logger
  - Optional nodeBucketLimit?: number
  - Optional nodeContactAddressLimit?: number
  - Optional nodeIdBits?: number
Returns Promise<NodeGraph>
- Defined in src/nodes/NodeGraph.ts:54

Class NodeGraph

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; keyRing: KeyRing; logger: Logger; nodeBucketLimit: number; nodeContactAddressLimit: number; nodeIdBits: number; }

db: DB

keyRing: KeyRing

logger: Logger

nodeBucketLimit: number

nodeContactAddressLimit: number

nodeIdBits: number

Returns NodeGraph

Properties

Readonly [initLock]

Protected db

Protected keyRing

Protected logger

Readonly nodeBucketLimit

Readonly nodeContactAddressLimit

Protected nodeGraphBucketsDbPath

Protected nodeGraphConnectedDbPath

Protected nodeGraphDbPath

Protected nodeGraphMetaDbPath

Readonly nodeIdBits

Protected space

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

bucketIndex

Parameters

nodeId: NodeId

Returns [number, string]

Protected delConnectedTime

Parameters

nodeId: NodeId

tran: DBTransaction

Returns Promise<void>

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getBucket

Parameters

bucketIndex: number

Optional sort: "nodeId" | "connected" | "distance"

Optional order: "asc" | "desc"

Optional limit: number

Optional tran: DBTransaction

__namedParameters: {
db: DB;
keyRing: KeyRing;
logger: Logger;
nodeBucketLimit: number;
nodeContactAddressLimit: number;
nodeIdBits: number;
}

`Readonly` [initLock]

`Protected` db

`Protected` keyRing

`Protected` logger

`Readonly` nodeBucketLimit

`Readonly` nodeContactAddressLimit

`Protected` nodeGraphBucketsDbPath

`Protected` nodeGraphConnectedDbPath

`Protected` nodeGraphDbPath

`Protected` nodeGraphMetaDbPath

`Readonly` nodeIdBits

`Protected` space

`Optional` options: boolean | AddEventListenerOptions

`Protected` delConnectedTime

`Optional` sort: "nodeId" | "connected" | "distance"

`Optional` order: "asc" | "desc"

`Optional` limit: number

`Optional` tran: DBTransaction

`Optional` ctx: Partial<ContextTimedInput>

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` limit: number

`Optional` tran: DBTransaction

`Optional` ctx: Partial<ContextTimedInput>

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` ctx: Partial<ContextTimedInput>

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` ctx: ContextTimed

`Optional` tran: DBTransaction

`Protected` purgeAddresses

`Optional` tran: DBTransaction