Class Discovery

Hierarchy

CreateDestroyStartStop
- Discovery

Constructors

constructor

new Discovery(__namedParameters): Discovery
Parameters
- __namedParameters: {
      db: DB;
      discoverVertexTimeout: number;
      gestaltGraph: GestaltGraph;
      identitiesManager: IdentitiesManager;
      keyRing: KeyRing;
      logger: Logger;
      nodeManager: NodeManager;
      taskManager: TaskManager;
  }
  - db: DB
  - discoverVertexTimeout: number
  - gestaltGraph: GestaltGraph
  - identitiesManager: IdentitiesManager
  - keyRing: KeyRing
  - logger: Logger
  - nodeManager: NodeManager
  - taskManager: TaskManager
Returns Discovery
Inherited from CreateDestroyStartStop.constructor
- Defined in src/discovery/Discovery.ts:146

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Protected` discoverVertexHandler

discoverVertexHandler: TaskHandler = ...

`Readonly` discoverVertexHandlerId

discoverVertexHandlerId: TaskHandlerId = ...

`Protected` discoverVertexTimeout

discoverVertexTimeout: number

`Protected` gestaltGraph

gestaltGraph: GestaltGraph

`Protected` identitiesManager

identitiesManager: IdentitiesManager

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` nodeManager

nodeManager: NodeManager

`Protected` taskManager

taskManager: TaskManager

`Protected` visitedVertices

visitedVertices: Set<GestaltIdEncoded> = ...

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from 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.[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.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from 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.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from 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.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from 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.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/discovery/Discovery.ts:216

dispatchEvent

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

`Protected` getIdentityInfo

getIdentityInfo(providerId, identityId, ctx): Promise<undefined | IdentityData>
Helper function to retrieve the IdentityInfo of an identity on a provider. All claims in the returned IdentityInfo are verified by the node it claims to link to. Returns undefined if no identity info to be retrieved (either no provider or identity data found).
Parameters
- providerId: ProviderId
- identityId: IdentityId
- ctx: Partial<ContextTimedInput>
Returns Promise<undefined | IdentityData>
- Defined in src/discovery/Discovery.ts:623

`Protected` hasDiscoveryTasks

hasDiscoveryTasks(): Promise<number>
Simple check for whether there are existing discovery tasks. Returns the number of tasks to avoid boolean blindness.

Returns Promise<number>
- Defined in src/discovery/Discovery.ts:551

`Protected` processIdentity

processIdentity(id, ctx): Promise<void>
Parameters
- id: ProviderIdentityId
- ctx: ContextTimed
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:472

`Protected` processNode

processNode(nodeId, ctx): Promise<void>
Parameters
- nodeId: NodeId
- ctx: ContextTimed
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:275

`Protected` processVertex

processVertex(vertex, ctx?): PromiseCancellable<void>
Parameters
- vertex: GestaltIdEncoded
- Optional ctx: Partial<ContextTimed>
Returns PromiseCancellable<void>
- Defined in src/discovery/Discovery.ts:252

queueDiscoveryByIdentity

queueDiscoveryByIdentity(providerId, identityId): Promise<void>
Queues an identity for discovery. Internally calls pushKeyToDiscoveryQueue.
Parameters
- providerId: ProviderId
- identityId: IdentityId
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:239

queueDiscoveryByNode

queueDiscoveryByNode(nodeId): Promise<void>
Queues a node for discovery. Internally calls pushKeyToDiscoveryQueue.
Parameters
- nodeId: NodeId
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:230

removeEventListener

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

`Protected` scheduleDiscoveryForVertex

scheduleDiscoveryForVertex(vertex, tran?): any
Creates a task that to discover a vertex. Will not create a new task if an existing task for the vertex exists.
Parameters
- vertex: GestaltId
- Optional tran: DBTransaction
Returns any
- Defined in src/discovery/Discovery.ts:566

start

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

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/discovery/Discovery.ts:196

`Protected` verifyIdentityClaims

verifyIdentityClaims(providerId, identityId): Promise<Record<ProviderIdentityClaimId, SignedClaim<ClaimLinkIdentity>>>
Helper function to retrieve and verify the claims of an identity on a given provider. Connects with each node the identity claims to be linked with, and verifies the claim with the public key of the node.
Parameters
- providerId: ProviderId
- identityId: IdentityId
Returns Promise<Record<ProviderIdentityClaimId, SignedClaim<ClaimLinkIdentity>>>
- Defined in src/discovery/Discovery.ts:657

waitForDiscoveryTasks

waitForDiscoveryTasks(): Promise<number>
Will resolve once all existing discovery tasks have finished. Returns the number of existing tasks that were awaited.

Returns Promise<number>
- Defined in src/discovery/Discovery.ts:535

`Static` createDiscovery

createDiscovery(__namedParameters): Promise<Discovery>
Parameters
- __namedParameters: {
      db: DB;
      discoverVertexTimeout?: number;
      fresh?: boolean;
      gestaltGraph: GestaltGraph;
      identitiesManager: IdentitiesManager;
      keyRing: KeyRing;
      logger?: Logger;
      nodeManager: NodeManager;
      taskManager: TaskManager;
  }
  - db: DB
  - Optional discoverVertexTimeout?: number
  - Optional fresh?: boolean
  - gestaltGraph: GestaltGraph
  - identitiesManager: IdentitiesManager
  - keyRing: KeyRing
  - Optional logger?: Logger
  - nodeManager: NodeManager
  - taskManager: TaskManager
Returns Promise<Discovery>
- Defined in src/discovery/Discovery.ts:71

Class Discovery

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; discoverVertexTimeout: number; gestaltGraph: GestaltGraph; identitiesManager: IdentitiesManager; keyRing: KeyRing; logger: Logger; nodeManager: NodeManager; taskManager: TaskManager; }

db: DB

discoverVertexTimeout: number

gestaltGraph: GestaltGraph

identitiesManager: IdentitiesManager

keyRing: KeyRing

logger: Logger

nodeManager: NodeManager

taskManager: TaskManager

Returns Discovery

Properties

Readonly [initLock]

Protected db

Protected discoverVertexHandler

Readonly discoverVertexHandlerId

Protected discoverVertexTimeout

Protected gestaltGraph

Protected identitiesManager

Protected keyRing

Protected logger

Protected nodeManager

Protected taskManager

Protected visitedVertices

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

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

Protected getIdentityInfo

Parameters

providerId: ProviderId

identityId: IdentityId

ctx: Partial<ContextTimedInput>

Returns Promise<undefined | IdentityData>

Protected hasDiscoveryTasks

Returns Promise<number>

Protected processIdentity

Parameters

id: ProviderIdentityId

ctx: ContextTimed

Returns Promise<void>

Protected processNode

__namedParameters: {
db: DB;
discoverVertexTimeout: number;
gestaltGraph: GestaltGraph;
identitiesManager: IdentitiesManager;
keyRing: KeyRing;
logger: Logger;
nodeManager: NodeManager;
taskManager: TaskManager;
}

`Readonly` [initLock]

`Protected` db

`Protected` discoverVertexHandler

`Readonly` discoverVertexHandlerId

`Protected` discoverVertexTimeout

`Protected` gestaltGraph

`Protected` identitiesManager

`Protected` keyRing

`Protected` logger

`Protected` nodeManager

`Protected` taskManager

`Protected` visitedVertices

`Optional` options: boolean | AddEventListenerOptions

`Protected` getIdentityInfo

`Protected` hasDiscoveryTasks

`Protected` processIdentity

`Protected` processNode

`Protected` processVertex

`Optional` ctx: Partial<ContextTimed>

`Optional` options: boolean | EventListenerOptions

`Protected` scheduleDiscoveryForVertex

`Optional` tran: DBTransaction

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

`Optional` fresh?: boolean

`Protected` verifyIdentityClaims

`Static` createDiscovery

__namedParameters: {
db: DB;
discoverVertexTimeout?: number;
fresh?: boolean;
gestaltGraph: GestaltGraph;
identitiesManager: IdentitiesManager;
keyRing: KeyRing;
logger?: Logger;
nodeManager: NodeManager;
taskManager: TaskManager;
}

`Optional` discoverVertexTimeout?: number

`Optional` fresh?: boolean

`Optional` logger?: Logger