Class NodeGraph

Hierarchy

  • CreateDestroyStartStop
    • NodeGraph

Constructors

constructor

Properties

[initLock] db keyRing logger nodeBucketLimit nodeGraphBucketsDbPath nodeGraphDbPath nodeGraphLastUpdatedDbPath nodeGraphMetaDbPath nodeIdBits space

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener bucketIndex destroy dispatchEvent getBucket getBucketMeta getBucketMetaProp getBuckets getClosestNodes getNode getNodes getOldestNode lockBucket removeEventListener resetBuckets setBucketMetaProp setNode setupSpace start stop unsetNode createNodeGraph

Constructors

constructor

  • Parameters

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

    Returns NodeGraph

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected db

db: DB

Protected keyRing

keyRing: KeyRing

Protected logger

logger: Logger

Readonly nodeBucketLimit

nodeBucketLimit: number = 20

Max number of nodes in each k-bucket

Protected nodeGraphBucketsDbPath

nodeGraphBucketsDbPath: readonly (string | Buffer)[]

Protected nodeGraphDbPath

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

Protected nodeGraphLastUpdatedDbPath

nodeGraphLastUpdatedDbPath: readonly (string | Buffer)[]

Protected nodeGraphMetaDbPath

nodeGraphMetaDbPath: readonly (string | Buffer)[]

Readonly nodeIdBits

nodeIdBits: number

Bit size of the NodeIds This equals the number of buckets

Protected space

space: NodeGraphSpace

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[running]

  • get [running](): boolean

  • Returns boolean

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

Methods

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

bucketIndex

  • 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

    Returns [number, string]

destroy

  • Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

getBucket

  • Gets a bucket The bucket's node IDs is sorted lexicographically by default Alternatively you can acquire them sorted by lastUpdated timestamp or by distance to the own NodeId

    Parameters

    • bucketIndex: number
    • sort: "nodeId" | "lastUpdated" | "distance" = 'nodeId'
    • order: "asc" | "desc" = 'asc'
    • Optional tran: DBTransaction

    Returns Promise<NodeBucket>

getBucketMeta

getBucketMetaProp

getBuckets

  • 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, lastUpdated asc NodeBucketIndex desc, lastUpdated desc

    Parameters

    • sort: "nodeId" | "lastUpdated" | "distance" = 'nodeId'
    • order: "asc" | "desc" = 'asc'
    • Optional tran: DBTransaction

    Returns AsyncGenerator<[number, NodeBucket], any, unknown>

getClosestNodes

  • Finds the set of nodes (of size k) known by the current node (i.e. in its buckets' database) that have the smallest distance to the target node (i.e. are closest to the target node). i.e. FIND_NODE RPC from Kademlia spec

    Used by the RPC service.

    Parameters

    • nodeId: NodeId

      the node ID to find other nodes closest to it

    • limit: number = ...

      the number of the closest nodes to return (by default, returns according to the maximum number of nodes per bucket)

    • Optional tran: DBTransaction

    Returns Promise<NodeBucket>

    a mapping containing exactly k nodeIds -> nodeAddresses (unless the current node has less than k nodes in all of its buckets, in which case it returns all nodes it has knowledge of)

getNode

getNodes

  • Get all nodes. Nodes are always sorted by NodeBucketIndex first Then secondly by the node IDs The order parameter applies to both, for example possible sorts: NodeBucketIndex asc, NodeID asc NodeBucketIndex desc, NodeId desc

    Parameters

    • order: "asc" | "desc" = 'asc'
    • Optional tran: DBTransaction

    Returns AsyncGenerator<[NodeId, NodeData], any, unknown>

getOldestNode

  • Parameters

    • bucketIndex: number
    • limit: number = 1
    • Optional tran: DBTransaction

    Returns Promise<NodeId[]>

lockBucket

  • Parameters

    • bucketIndex: number
    • tran: DBTransaction

    Returns Promise<void>

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

resetBuckets

  • Parameters

    • nodeIdOwn: NodeId
    • Optional tran: DBTransaction

    Returns Promise<void>

Protected setBucketMetaProp

  • Sets a bucket meta property This is protected because users cannot directly manipulate bucket meta

    Type Parameters

    • Key extends "count"

    Parameters

    • bucketIndex: number
    • key: Key
    • value: NodeBucketMeta[Key]
    • tran: DBTransaction

    Returns Promise<void>

setNode

  • Will add a node to the node graph and increment the bucket count. If the node already existed it will be updated.

    Parameters

    • nodeId: NodeId

      NodeId to add to the NodeGraph

    • nodeAddress: NodeAddress

      Address information to add

    • Optional tran: DBTransaction

    Returns Promise<void>

Protected setupSpace

  • 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.refreshBuckets

    Parameters

    • tran: DBTransaction

    Returns Promise<NodeGraphSpace>

start

  • Parameters

    • __namedParameters: {
          fresh?: boolean;
      } = {}
      • Optional fresh?: boolean

    Returns Promise<void>

stop

unsetNode

Static createNodeGraph

  • Parameters

    • __namedParameters: {
          db: DB;
          fresh?: boolean;
          keyRing: KeyRing;
          logger?: Logger;
          nodeIdBits?: number;
      }
      • db: DB
      • Optional fresh?: boolean
      • keyRing: KeyRing
      • Optional logger?: Logger
      • Optional nodeIdBits?: number

    Returns Promise<NodeGraph>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc