Class Discovery

Hierarchy

CreateDestroyStartStop
- Discovery

Index

Constructors

Properties

[initLock] checkRediscoveryHandler checkRediscoveryHandlerId db discoverVertexHandler discoverVertexHandlerId discoverVertexTimeoutTime gestaltGraph identitiesManager keyRing logger nodeManager rediscoverCheckIntervalTime rediscoverSkipTime rediscoverVertexThresholdTime staleVertexThresholdTime taskManager

Accessors

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

Constructors

constructor

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

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` checkRediscoveryHandler

checkRediscoveryHandler: TaskHandler = ...

This handler is run periodically to check if nodes are ready to be rediscovered

`Readonly` checkRediscoveryHandlerId

checkRediscoveryHandlerId: TaskHandlerId = ...

`Protected` db

db: DB

`Protected` discoverVertexHandler

discoverVertexHandler: TaskHandler = ...

`Readonly` discoverVertexHandlerId

discoverVertexHandlerId: TaskHandlerId = ...

`Protected` discoverVertexTimeoutTime

discoverVertexTimeoutTime: number

`Protected` gestaltGraph

gestaltGraph: GestaltGraph

`Protected` identitiesManager

identitiesManager: IdentitiesManager

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` nodeManager

nodeManager: NodeManager

`Protected` rediscoverCheckIntervalTime

rediscoverCheckIntervalTime: number

Interval delay used when checking for nodes to rediscover

`Protected` rediscoverSkipTime

rediscoverSkipTime: number

The time since a vertex has been processed where re processing will be skipped

`Protected` rediscoverVertexThresholdTime

rediscoverVertexThresholdTime: number

The threshold used when deciding to rediscover a vertex based on how long ago it was processed

`Protected` staleVertexThresholdTime

staleVertexThresholdTime: number

The time threshold for

`Protected` taskManager

taskManager: TaskManager

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

checkRediscovery

checkRediscovery(lastProcessedCutoffTime, tran?, ctx?): Promise<void>
Checks previously discovered vertices for ones to be re-added back on to the queue
Parameters
- lastProcessedCutoffTime: number
- Optional tran: DBTransaction
- Optional ctx: Partial<ContextTimedInput>
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:1037

destroy

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

dispatchEvent

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

getDiscoveryQueue

getDiscoveryQueue(tran?): AsyncGenerator<DiscoveryQueueInfo, void, void>
This returns the discovery queue
Parameters
- Optional tran: DBTransaction
Returns AsyncGenerator<DiscoveryQueueInfo, void, void>
- Defined in src/discovery/Discovery.ts:367

`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:880

`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:770

`Protected` processClaimLinkIdentity

processClaimLinkIdentity(signedClaim, nodeId, lastProcessedCutoffTime?, ctx): Promise<void>
Parameters
- signedClaim: SignedClaim<ClaimLinkIdentity>
- nodeId: NodeId
- lastProcessedCutoffTime: number = ...
- ctx: ContextTimed
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:556

`Protected` processClaimLinkNode

processClaimLinkNode(signedClaim, nodeId, lastProcessedCutoffTime?): Promise<void>
Parameters
- signedClaim: SignedClaim<ClaimLinkNode>
- nodeId: NodeId
- lastProcessedCutoffTime: number = ...
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:491

`Protected` processIdentity

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

`Protected` processNode

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

`Protected` processVertex

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

`Protected` processedTimeGreaterThan

processedTimeGreaterThan(vertex, time, tran?): Promise<boolean>
Returns true if the vertex was processed after the given time
Parameters
- vertex: GestaltId
- time: number
- Optional tran: DBTransaction
Returns Promise<boolean>
- Defined in src/discovery/Discovery.ts:1138

queueDiscoveryByIdentity

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

queueDiscoveryByNode

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

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, delay?, lastProcessedCutoffTime?, parent?, ignoreActive?, tran?): Promise<void>
Creates a task that to discover a vertex. Will not create a new task if an existing task for the vertex exists.

The task can be scheduled with an optional delay. If the task already exists then the delay will be updated
Parameters
- vertex: GestaltId
- Optional delay: number
- Optional lastProcessedCutoffTime: number
- Optional parent: GestaltId
- ignoreActive: boolean = false
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/discovery/Discovery.ts:788

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:268

stop

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

`Protected` verifyIdentityClaims

verifyIdentityClaims(providerId, identityId, providerPaginationToken, ctx): Promise<{
identityClaims: Record<ProviderIdentityClaimId, SignedClaim<ClaimLinkIdentity>>;
lastProviderPaginationToken?: ProviderPaginationToken;
}>
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.

This method never throws if ctx has aborted, opting instead to return early with a lastProviderPaginationToken so that the caller can process the partially requested Claims as well as resume progress when calling again.
Parameters
- providerId: ProviderId
- identityId: IdentityId
- providerPaginationToken: undefined | ProviderPaginationToken
- ctx: ContextTimed
Returns Promise<{
identityClaims: Record<ProviderIdentityClaimId, SignedClaim<ClaimLinkIdentity>>;
lastProviderPaginationToken?: ProviderPaginationToken;
}>
- Defined in src/discovery/Discovery.ts:918

waitForDiscoveryTasks

waitForDiscoveryTasks(scheduled?): Promise<number>
Will resolve once all existing discovery tasks have finished. Returns the number of existing tasks that were awaited.
Parameters
- scheduled: boolean = false
Returns Promise<number>
- Defined in src/discovery/Discovery.ts:749

`Static` createDiscovery

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

Class Discovery

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

db: DB

discoverVertexTimeoutTime: number

gestaltGraph: GestaltGraph

identitiesManager: IdentitiesManager

keyRing: KeyRing

logger: Logger

nodeManager: NodeManager

rediscoverCheckIntervalTime: number

rediscoverSkipTime: number

rediscoverVertexDelayTime: number

staleVertexThresholdTime: number

taskManager: TaskManager

Returns Discovery

Properties

Readonly [initLock]

Protected checkRediscoveryHandler

Readonly checkRediscoveryHandlerId

Protected db

Protected discoverVertexHandler

Readonly discoverVertexHandlerId

Protected discoverVertexTimeoutTime

Protected gestaltGraph

Protected identitiesManager

Protected keyRing

Protected logger

Protected nodeManager

Protected rediscoverCheckIntervalTime

Protected rediscoverSkipTime

Protected rediscoverVertexThresholdTime

Protected staleVertexThresholdTime

Protected taskManager

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

checkRediscovery

Parameters

lastProcessedCutoffTime: number

Optional tran: DBTransaction

Optional ctx: Partial<ContextTimedInput>

Returns Promise<void>

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

`Readonly` [initLock]

`Protected` checkRediscoveryHandler

`Readonly` checkRediscoveryHandlerId

`Protected` db

`Protected` discoverVertexHandler

`Readonly` discoverVertexHandlerId

`Protected` discoverVertexTimeoutTime

`Protected` gestaltGraph

`Protected` identitiesManager

`Protected` keyRing

`Protected` logger

`Protected` nodeManager

`Protected` rediscoverCheckIntervalTime

`Protected` rediscoverSkipTime

`Protected` rediscoverVertexThresholdTime

`Protected` staleVertexThresholdTime

`Protected` taskManager

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` ctx: Partial<ContextTimedInput>

`Optional` tran: DBTransaction

`Protected` getIdentityInfo

`Protected` hasDiscoveryTasks

`Protected` processClaimLinkIdentity

`Protected` processClaimLinkNode

`Protected` processIdentity

`Protected` processNode

`Protected` processVertex

`Optional` lastProcessedCutoffTime: number

`Optional` ctx: Partial<ContextTimed>

`Protected` processedTimeGreaterThan

`Optional` tran: DBTransaction

`Optional` lastProcessedCutoffTime: number

`Optional` lastProcessedCutoffTime: number

`Optional` options: boolean | EventListenerOptions

`Protected` scheduleDiscoveryForVertex