@xyo-network/bridge-pub-sub

v5.3.30

Published

7 days ago

Primary SDK for using XYO Protocol 2.0

0High
0Medium
0Low

xyo

@xyo-network/bridge-pub-sub

[![npm][npm-badge]][npm-link] [![license][license-badge]][license-link]

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

modules

### packages

  ### bridge

    ### packages

      ### pub-sub

        ### .temp-typedoc

          ### classes

            ### <a id="AbstractModuleHost"></a>AbstractModuleHost

@xyo-network/bridge-pub-sub

Extends

Base<TParams>

Extended by

AsyncQueryBusModuleHost

Type Parameters

TParams

TParams extends ModuleHostParams = ModuleHostParams

Constructors

Constructor

new AbstractModuleHost<TParams>(params): AbstractModuleHost<TParams>;

Parameters

params

BaseParams<TParams>

Returns

AbstractModuleHost<TParams>

Inherited from

Base<TParams>.constructor

Methods

start()

abstract start(): Promisable<void>;

Returns

Promisable<void>

stop()

abstract stop(): Promisable<void>;

Returns

Promisable<void>

            ### <a id="AsyncQueryBusClient"></a>AsyncQueryBusClient

@xyo-network/bridge-pub-sub

Extends

AsyncQueryBusBase<TParams>

Type Parameters

TParams

TParams extends AsyncQueryBusClientParams = AsyncQueryBusClientParams

Constructors

Constructor

new AsyncQueryBusClient<TParams>(params): AsyncQueryBusClient<TParams>;

Parameters

params

TParams

Returns

AsyncQueryBusClient<TParams>

Overrides

AsyncQueryBusBase<TParams>.constructor

Properties

_lastState?

protected optional _lastState?: LRUCache<BrandedAddress, Sequence, unknown>;

Inherited from

AsyncQueryBusHost._lastState

_targetConfigs

protected _targetConfigs: Record<Address, ModuleConfig> = {};

Inherited from

AsyncQueryBusBase._targetConfigs

_targetQueries

protected _targetQueries: Record<Address, string[]> = {};

Inherited from

AsyncQueryBusHost._targetQueries

_queryCache?

protected optional _queryCache?: LRUCache<BrandedHash, "pending" | ModuleQueryResult, unknown>;

Accessors

config

Get Signature

get config(): TParams["config"];

Returns

TParams["config"]

Inherited from

AsyncQueryBusBase.config

pollFrequency

Get Signature

get pollFrequency(): number;

Returns

number

Inherited from

AsyncQueryBusBase.pollFrequency

rootModule

Get Signature

get rootModule(): ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;

Returns

ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Inherited from

AsyncQueryBusBase.rootModule

lastState

Get Signature

get protected lastState(): LRUCache<BrandedAddress, Sequence>;

A cache of the last offset of the Diviner process per address

Returns

LRUCache<BrandedAddress, Sequence>

Inherited from

AsyncQueryBusBase.lastState

queryCacheConfig

Get Signature

get queryCacheConfig(): Options<BrandedHash, "pending" | ModuleQueryResult, unknown>;

Returns

Options<BrandedHash, "pending" | ModuleQueryResult, unknown>

started

Get Signature

get started(): boolean;

Returns

boolean

queryCache

Get Signature

get protected queryCache(): LRUCache<BrandedHash, "pending" | ModuleQueryResult>;

A cache of queries that have been issued

Returns

LRUCache<BrandedHash, "pending" | ModuleQueryResult>

Methods

queriesArchivist()

queriesArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AsyncQueryBusBase.queriesArchivist

queriesDiviner()

queriesDiviner(): Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, UnsignedQueryBoundWitness, DivinerModuleEventData>>;

Returns

Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, UnsignedQueryBoundWitness, DivinerModuleEventData>>

Inherited from

AsyncQueryBusBase.queriesDiviner

responsesArchivist()

responsesArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AsyncQueryBusBase.responsesArchivist

responsesDiviner()

responsesDiviner(): Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, {
  schema: "network.xyo.boundwitness" & object;
  addresses: Lowercase<string> & object & object[];
  payload_hashes: BrandedHash[];
  payload_schemas: BrandedSchema<string>[];
  previous_hashes: (BrandedHash | null)[];
  $destination?: Lowercase<string> & object & object;
  $sourceQuery?: BrandedHash;
  $signatures: (BrandedHex | null)[];
}, DivinerModuleEventData>>;

Returns

Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, { schema: "network.xyo.boundwitness" & object; addresses: Lowercase<string> & object & object[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: Lowercase<string> & object & object; $sourceQuery?: BrandedHash; $signatures: (BrandedHex | null)[]; }, DivinerModuleEventData>>

Inherited from

AsyncQueryBusBase.responsesDiviner

commitState()

protected commitState(address, nextState): Promise<void>;

Commit the internal state of the process. This is similar to a transaction completion in a database and should only be called when results have been successfully persisted to the appropriate external stores.

Parameters

address

BrandedAddress

The module address to commit the state for

nextState

Sequence

The state to commit

Returns

Promise<void>

Inherited from

AsyncQueryBusBase.commitState

retrieveState()

protected retrieveState(address): Promise<Sequence>;

Retrieves the last state of the process. Used to recover state after preemptions, reboots, etc.

Parameters

address

BrandedAddress

Returns

Promise<Sequence>

Inherited from

AsyncQueryBusBase.retrieveState

listeningAddresses()

listeningAddresses(): Generator<BrandedHash, void, unknown> | undefined;

Returns

Generator<BrandedHash, void, unknown> | undefined

send()

send(
   address, 
   query, 
payloads?): Promise<ModuleQueryResult>;

Parameters

address

BrandedAddress

query

UnsignedQueryBoundWitness

payloads?

Payload[]

Returns

Promise<ModuleQueryResult>

            ### <a id="AsyncQueryBusHost"></a>AsyncQueryBusHost

@xyo-network/bridge-pub-sub

Extends

AsyncQueryBusBase<TParams>

Type Parameters

TParams

TParams extends AsyncQueryBusHostParams = AsyncQueryBusHostParams

Constructors

Constructor

new AsyncQueryBusHost<TParams>(params): AsyncQueryBusHost<TParams>;

Parameters

params

TParams

Returns

AsyncQueryBusHost<TParams>

Overrides

AsyncQueryBusBase<TParams>.constructor

Properties

_lastState?

protected optional _lastState?: LRUCache<BrandedAddress, Sequence, unknown>;

Inherited from

AsyncQueryBusBase._lastState

_targetConfigs

protected _targetConfigs: Record<Address, ModuleConfig> = {};

Inherited from

AsyncQueryBusBase._targetConfigs

_targetQueries

protected _targetQueries: Record<Address, string[]> = {};

Inherited from

AsyncQueryBusBase._targetQueries

_exposedAddresses

protected _exposedAddresses: Set<BrandedAddress>;

Accessors

config

Get Signature

get config(): TParams["config"];

Returns

TParams["config"]

Inherited from

AsyncQueryBusBase.config

pollFrequency

Get Signature

get pollFrequency(): number;

Returns

number

Inherited from

AsyncQueryBusBase.pollFrequency

rootModule

Get Signature

get rootModule(): ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;

Returns

ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Inherited from

AsyncQueryBusBase.rootModule

lastState

Get Signature

get protected lastState(): LRUCache<BrandedAddress, Sequence>;

A cache of the last offset of the Diviner process per address

Returns

LRUCache<BrandedAddress, Sequence>

Inherited from

AsyncQueryBusBase.lastState

exposedAddresses

Get Signature

get exposedAddresses(): Set<BrandedAddress>;

Returns

Set<BrandedAddress>

idlePollFrequency

Get Signature

get idlePollFrequency(): number;

Returns

number

idleThreshold

Get Signature

get idleThreshold(): number;

Returns

number

perAddressBatchQueryLimit

Get Signature

get perAddressBatchQueryLimit(): number;

Returns

number

started

Get Signature

get started(): boolean;

Returns

boolean

Methods

queriesArchivist()

queriesArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AsyncQueryBusBase.queriesArchivist

queriesDiviner()

queriesDiviner(): Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, UnsignedQueryBoundWitness, DivinerModuleEventData>>;

Returns

Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, UnsignedQueryBoundWitness, DivinerModuleEventData>>

Inherited from

AsyncQueryBusBase.queriesDiviner

responsesArchivist()

responsesArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AsyncQueryBusBase.responsesArchivist

responsesDiviner()

responsesDiviner(): Promise<DivinerInstance<BoundWitnessDivinerParams, BoundWitnessDivinerQueryPayload, {
  schema: "network.xyo.boundwitness" & object;
  addresses: Lowercase<string> & object & object[];
  payload_hashes: BrandedHash[];
  payload_schemas: BrandedSchema<string>[];
  previous_hashes: (BrandedHash | null)[];
  $destination?: Lowercase<string> & object & object;
  $sourceQuery?: BrandedHash;
  $signatures: (BrandedHex | null)[];
}, DivinerModuleEventData>>;

Returns

Inherited from

AsyncQueryBusBase.responsesDiviner

commitState()

protected commitState(address, nextState): Promise<void>;

Parameters

address

BrandedAddress

The module address to commit the state for

nextState

Sequence

The state to commit

Returns

Promise<void>

Inherited from

AsyncQueryBusBase.commitState

retrieveState()

protected retrieveState(address): Promise<Sequence>;

Retrieves the last state of the process. Used to recover state after preemptions, reboots, etc.

Parameters

address

BrandedAddress

Returns

Promise<Sequence>

Inherited from

AsyncQueryBusBase.retrieveState

expose()

expose(mod, options?): 
  | ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>
  | undefined;

Parameters

mod

ModuleInstance

options?

ExposeOptions

Returns

| ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> | undefined

listeningModules()

listeningModules(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

start()

start(): void;

Returns

void

stop()

stop(): void;

Returns

void

unexpose()

unexpose(id, validate?): Promise<
  | ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>>
| undefined>;

Parameters

id

ModuleIdentifier

validate?

boolean = true

Returns

Promise< | ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>> | undefined>

callLocalModule()

protected callLocalModule(localModule, query): Promise<void>;

Parameters

localModule

ModuleInstance

query

WithStorageMeta<UnsignedQueryBoundWitness>

Returns

Promise<void>

findQueriesToAddress()

protected findQueriesToAddress(address): Promise<WithStorageMeta<UnsignedQueryBoundWitness>[] | undefined>;

Finds unprocessed commands addressed to the supplied address

Parameters

address

BrandedAddress

The address to find commands for

Returns

Promise<WithStorageMeta<UnsignedQueryBoundWitness>[] | undefined>

            ### <a id="AsyncQueryBusModuleHost"></a>AsyncQueryBusModuleHost

@xyo-network/bridge-pub-sub

Extends

AbstractModuleHost<AsyncQueryBusModuleHostParams>

Constructors

Constructor

new AsyncQueryBusModuleHost(params): AsyncQueryBusModuleHost;

Parameters

params

AsyncQueryBusModuleHostParams

Returns

AsyncQueryBusModuleHost

Overrides

AbstractModuleHost.constructor

Methods

start()

start(): Promise<void>;

Returns

Promise<void>

Overrides

AbstractModuleHost.start

stop()

stop(): void;

Returns

void

Overrides

AbstractModuleHost.stop

            ### <a id="AsyncQueryBusModuleProxy"></a>AsyncQueryBusModuleProxy

@xyo-network/bridge-pub-sub

Extends

AbstractModuleProxy<TWrappedModule, AsyncQueryBusModuleProxyParams & TWrappedModule["params"]>

Type Parameters

TWrappedModule

TWrappedModule extends ModuleInstance = ModuleInstance

Constructors

Constructor

new AsyncQueryBusModuleProxy<TWrappedModule>(key, params): AsyncQueryBusModuleProxy<TWrappedModule>;

Parameters

key

unknown

params

Partial<TParams & RequiredCreatableParams>

Returns

AsyncQueryBusModuleProxy<TWrappedModule>

Inherited from

AbstractModuleProxy<TWrappedModule, AsyncQueryBusModuleProxyParams & TWrappedModule['params']>.constructor

Properties

requiredQueries

readonly static requiredQueries: string[];

Inherited from

AbstractModuleProxy.requiredQueries

_config?

protected optional _config?: TWrappedModule["config"];

Inherited from

AbstractModuleProxy._config

_publicChildren?

protected optional _publicChildren?: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];

Inherited from

AbstractModuleProxy._publicChildren

_state

protected _state: Payload[] | undefined;

Inherited from

AbstractModuleProxy._state

_stateInProcess

protected _stateInProcess: boolean;

Inherited from

AbstractModuleProxy._stateInProcess

allowRandomAccount

readonly static allowRandomAccount: boolean;

Inherited from

AbstractModuleProxy.allowRandomAccount

configSchemas

readonly static configSchemas: Schema[];

Inherited from

AbstractModuleProxy.configSchemas

defaultConfigSchema

readonly static defaultConfigSchema: Schema;

Inherited from

AbstractModuleProxy.defaultConfigSchema

defaultLogger

static defaultLogger: Logger;

Inherited from

AbstractModuleProxy.defaultLogger

enableLazyLoad

static enableLazyLoad: boolean;

Inherited from

AbstractModuleProxy.enableLazyLoad

labels

readonly static labels: Labels;

Inherited from

AbstractModuleProxy.labels

privateConstructorKey

protected static privateConstructorKey: string;

Inherited from

AbstractModuleProxy.privateConstructorKey

_account

protected _account: AccountInstance | undefined;

Inherited from

PubSubBridge._account

_cachedManifests

protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;

Inherited from

PubSubBridge._cachedManifests

_globalReentrancyMutex

protected _globalReentrancyMutex: Mutex | undefined;

Inherited from

PubSubBridge._globalReentrancyMutex

_lastError?

protected optional _lastError?: ModuleDetailsError;

Inherited from

PubSubBridge._lastError

_moduleConfigQueryValidator

protected _moduleConfigQueryValidator: Queryable | undefined;

Inherited from

PubSubBridge._moduleConfigQueryValidator

_supportedQueryValidator

protected _supportedQueryValidator: Queryable | undefined;

Inherited from

PubSubBridge._supportedQueryValidator

uniqueName

readonly static uniqueName: string;

Inherited from

AbstractModuleProxy.uniqueName

useNewResolver

readonly static useNewResolver: false = false;

Inherited from

AbstractModuleProxy.useNewResolver

Accessors

address

Get Signature

get address(): Lowercase<string> & object & object;

Returns

Lowercase<string> & object & object

Inherited from

AbstractModuleProxy.address

archiving

Get Signature

get archiving(): 
  | {
  archivists?: ModuleIdentifier[];
  queries?: Schema[];
}
  | undefined;

Returns

| { archivists?: ModuleIdentifier[]; queries?: Schema[]; } | undefined

Inherited from

AbstractModuleProxy.archiving

config

Get Signature

get config(): TWrappedModule["config"] & object;

Returns

TWrappedModule["config"] & object

Inherited from

AbstractModuleProxy.config

queries

Get Signature

get queries(): Schema[];

Returns

Schema[]

Inherited from

AbstractModuleProxy.queries

id

Get Signature

get id(): ModuleIdentifier;

Returns

ModuleIdentifier

Overrides

AbstractModuleProxy.id

modName

Get Signature

get modName(): string | undefined;

Returns

string | undefined

Overrides

AbstractModuleProxy.modName

account

Get Signature

get account(): AccountInstance;

Returns

AccountInstance

Inherited from

AbstractModuleProxy.account

additionalSigners

Get Signature

get additionalSigners(): AccountInstance[];

Returns

AccountInstance[]

Inherited from

AbstractModuleProxy.additionalSigners

allowAnonymous

Get Signature

get allowAnonymous(): boolean;

Returns

boolean

Inherited from

AbstractModuleProxy.allowAnonymous

allowNameResolution

Get Signature

get allowNameResolution(): boolean;

Returns

boolean

Inherited from

AbstractModuleProxy.allowNameResolution

archivist

Get Signature

get archivist(): ModuleIdentifier | undefined;

Returns

ModuleIdentifier | undefined

Inherited from

AbstractModuleProxy.archivist

dead

Get Signature

get dead(): boolean;

Returns

boolean

Inherited from

AbstractModuleProxy.dead

ephemeralQueryAccountEnabled

Get Signature

get ephemeralQueryAccountEnabled(): boolean;

Returns

boolean

Inherited from

AbstractModuleProxy.ephemeralQueryAccountEnabled

globalReentrancyMutex

Get Signature

get globalReentrancyMutex(): Mutex | undefined;

Returns

Mutex | undefined

Inherited from

AbstractModuleProxy.globalReentrancyMutex

logger

Get Signature

get logger(): Logger | undefined;

Returns

Logger | undefined

Inherited from

AbstractModuleProxy.logger

priority

Get Signature

get priority(): 2;

Returns

2

Inherited from

AbstractModuleProxy.priority

reentrancy

Get Signature

get reentrancy(): 
  | {
  action: "skip" | "wait";
  scope: "global";
}
  | undefined;

Returns

| { action: "skip" | "wait"; scope: "global"; } | undefined

Inherited from

AbstractModuleProxy.reentrancy

statusReporter

Get Signature

get statusReporter(): 
  | ModuleStatusReporter & CreatableStatusReporter<void>
  | undefined;

The status reporter used to broadcast lifecycle changes.

Returns

| ModuleStatusReporter & CreatableStatusReporter<void> | undefined

Inherited from

AbstractModuleProxy.statusReporter

timestamp

Get Signature

get timestamp(): boolean;

Returns

boolean

Inherited from

AbstractModuleProxy.timestamp

moduleConfigQueryValidator

Get Signature

get protected moduleConfigQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractModuleProxy.moduleConfigQueryValidator

supportedQueryValidator

Get Signature

get protected supportedQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractModuleProxy.supportedQueryValidator

downResolver

Get Signature

get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractModuleProxy.downResolver

moduleIdentifierTransformers

Get Signature

get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];

Returns

ModuleIdentifierTransformer[]

Inherited from

AbstractModuleProxy.moduleIdentifierTransformers

privateResolver

Get Signature

get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractModuleProxy.privateResolver

root

Get Signature

get root(): this;

Returns

this

Inherited from

AbstractModuleProxy.root

timeBudget

Get Signature

get timeBudget(): number | undefined;

Returns

number | undefined

Inherited from

AbstractModuleProxy.timeBudget

upResolver

Get Signature

get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractModuleProxy.upResolver

Methods

hasRequiredQueries()

static hasRequiredQueries(mod): boolean;

Parameters

mod

QueryableModule

Returns

boolean

Inherited from

AbstractModuleProxy.hasRequiredQueries

isAllowedSchema()

static isAllowedSchema(schema): boolean;

Parameters

schema

Schema

Returns

boolean

Inherited from

AbstractModuleProxy.isAllowedSchema

missingRequiredQueries()

static missingRequiredQueries(mod): string[];

Parameters

mod

QueryableModule

Returns

string[]

Inherited from

AbstractModuleProxy.missingRequiredQueries

paramsHandler()

static paramsHandler<T>(inParams?): Promise<T["params"]>;

Type Parameters

T

T extends AttachableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

inParams?

Partial<T["params"]>

Returns

Promise<T["params"]>

Inherited from

AbstractModuleProxy.paramsHandler

addressPreviousHash()

addressPreviousHash(): Promise<AddressPreviousHashPayload>;

Returns

Promise<AddressPreviousHashPayload>

Inherited from

AbstractModuleProxy.addressPreviousHash

childAddressByName()

childAddressByName(name): BrandedAddress | undefined;

Parameters

name

string

Returns

BrandedAddress | undefined

Inherited from

AbstractModuleProxy.childAddressByName

childAddressMap()

childAddressMap(): Promise<Record<BrandedAddress, string | null>>;

Returns

Promise<Record<BrandedAddress, string | null>>

Inherited from

AbstractModuleProxy.childAddressMap

createHandler()

createHandler(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractModuleProxy.createHandler

manifest()

manifest(maxDepth?): Promise<ModuleManifestPayload>;

Parameters

maxDepth?

number

Returns

Promise<ModuleManifestPayload>

Inherited from

AbstractModuleProxy.manifest

moduleAddress()

moduleAddress(): Promise<AddressPreviousHashPayload[]>;

Returns

Promise<AddressPreviousHashPayload[]>

Inherited from

AbstractModuleProxy.moduleAddress

previousHash()

previousHash(): Promise<string | undefined>;

Returns

Promise<string | undefined>

Inherited from

AbstractModuleProxy.previousHash

query()

query<T>(query, payloads?): Promise<ModuleQueryResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

Parameters

query

T

payloads?

Payload[]

Returns

Promise<ModuleQueryResult>

Inherited from

AbstractModuleProxy.query

queryHandler()

queryHandler<T>(
   _query, 
   _payloads?, 
_queryConfig?): Promise<ModuleQueryHandlerResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

Parameters

_query

T

_payloads?

Payload[]

_queryConfig?

TWrappedModule["params"]["config"]

Returns

Promise<ModuleQueryHandlerResult>

Inherited from

AbstractModuleProxy.queryHandler

queryable()

queryable<T>(
   _query, 
   _payloads?, 
_queryConfig?): Promise<boolean>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

Parameters

_query

T

_payloads?

Payload[]

_queryConfig?

TWrappedModule["params"]["config"]

Returns

Promise<boolean>

Inherited from

AbstractModuleProxy.queryable

resolveArchivingArchivists()

resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;

Returns

Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>

Inherited from

AbstractModuleProxy.resolveArchivingArchivists

setConfig()

setConfig(config): void;

Parameters

config

TWrappedModule["params"]["config"]

Returns

void

Inherited from

AbstractModuleProxy.setConfig

setState()

setState(state): void;

Parameters

state

Payload[]

Returns

void

Inherited from

AbstractModuleProxy.setState

state()

state(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Inherited from

AbstractModuleProxy.state

filterErrors()

protected filterErrors(result): ModuleError[];

Parameters

result

ModuleQueryResult

Returns

ModuleError[]

Inherited from

AbstractModuleProxy.filterErrors

startHandler()

protected startHandler(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractModuleProxy.startHandler

createHandler()

static createHandler<T>(inInstance): Promise<T & AbstractModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;

Type Parameters

T

T extends CreatableInstance<CreatableParams, EventData>

Parameters

inInstance

T

Returns

Promise<T & AbstractModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>

Overrides

AbstractModuleProxy.createHandler

proxyQueryHandler()

proxyQueryHandler<T>(query, payloads?): Promise<ModuleQueryResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

Parameters

query

T

payloads?

Payload[]

Returns

Promise<ModuleQueryResult>

Overrides

AbstractModuleProxy.proxyQueryHandler

publicChildren()

publicChildren(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Overrides

AbstractModuleProxy.publicChildren

resolve()

Call Signature

resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractModuleProxy.resolve

Call Signature

resolve<T>(all, options?): Promise<T[]>;

Type Parameters

T

T extends ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> = ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

all

"*"

options?

ModuleFilterOptions<T>

Returns

Promise<T[]>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractModuleProxy.resolve

Call Signature

resolve<T>(id, options?): Promise<T | undefined>;

Type Parameters

T

Parameters

id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractModuleProxy.resolve

_getRootFunction()

static _getRootFunction(funcName): any;

Parameters

funcName

string

Returns

any

Inherited from

AbstractModuleProxy._getRootFunction

_noOverride()

static _noOverride(functionName): void;

Parameters

functionName

string

Returns

void

Inherited from

AbstractModuleProxy._noOverride

determineAccount()

static determineAccount(params): Promise<AccountInstance>;

Parameters

params

account?

AccountInstance | "random"

accountPath?

string

wallet?

WalletInstance

Returns

Promise<AccountInstance>

Inherited from

AbstractModuleProxy.determineAccount

factory()

static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;

Type Parameters

TModule

TModule extends CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

this

CreatableModule<TModule>

params?

Partial<TModule["params"]>

Returns

CreatableModuleFactory<TModule>

Inherited from

AbstractModuleProxy.factory

_getRootFunction()

_getRootFunction(funcName): any;

Parameters

funcName

string

Returns

any

Inherited from

AbstractModuleProxy._getRootFunction

busy()

busy<R>(closure): Promise<R>;

Type Parameters

R

R

Parameters

closure

() => Promise<R>

Returns

Promise<R>

Inherited from

AbstractModuleProxy.busy

emit()

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;

Emits an event, invoking all registered listeners concurrently.

Type Parameters

TEventName

TEventName extends string | number | symbol = keyof TWrappedModule["eventData"]

TEventArgs

TEventArgs extends EventArgs = TWrappedModule["eventData"][TEventName]

Parameters

eventName

TEventName

The event to emit.

eventArgs

TEventArgs

The data to pass to listeners.

Returns

Promise<void>

Inherited from

AbstractModuleProxy.emit

isSupportedQuery()

isSupportedQuery(query, assert?): boolean;

Parameters

query

Schema

assert?

string | boolean

Returns

boolean

Inherited from

AbstractModuleProxy.isSupportedQuery

_checkDead()

protected _checkDead(): void;

Returns

void

Inherited from

AbstractModuleProxy._checkDead

archivistInstance()

Call Signature

protected archivistInstance(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AbstractModuleProxy.archivistInstance

Call Signature

protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;

Parameters

required

true

Returns

Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>

Inherited from

AbstractModuleProxy.archivistInstance

bindHashes()

protected bindHashes(
   hashes, 
   schema, 
account?): PromiseEx<unknown, AccountInstance>;

Parameters

hashes

BrandedHash[]

schema

Schema[]

account?

AccountInstance

Returns

PromiseEx<unknown, AccountInstance>

Inherited from

AbstractModuleProxy.bindHashes

bindHashesInternal()

protected bindHashesInternal(
   hashes, 
   schema, 
   account?): Promise<{
  schema: "network.xyo.boundwitness" & object;
  addresses: Lowercase<string> & object & object[];
  payload_hashes: BrandedHash[];
  payload_schemas: BrandedSchema<string>[];
  previous_hashes: (BrandedHash | null)[];
  $destination?: Lowercase<string> & object & object;
  $sourceQuery?: BrandedHash;
  $signatures: (BrandedHex | null)[];
}>;

Parameters

hashes

BrandedHash[]

schema

Schema[]

account?

AccountInstance

Returns

Promise<{ schema: "network.xyo.boundwitness" & object; addresses: Lowercase<string> & object & object[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: Lowercase<string> & object & object; $sourceQuery?: BrandedHash; $signatures: (BrandedHex | null)[]; }>

Inherited from

AbstractModuleProxy.bindHashesInternal

bindQuery()

protected bindQuery<T>(
   query, 
   payloads?, 
   account?, 
additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads?

Payload[]

account?

AccountInstance

additionalSigners?

AccountInstance[]

Returns

PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>

Inherited from

AbstractModuleProxy.bindQuery

bindQueryInternal()

protected bindQueryInternal<T>(
   query, 
   payloads?, 
   account?, 
additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads?

Payload[]

account?

AccountInstance

additionalSigners?

AccountInstance[]

Returns

Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>

Inherited from

AbstractModuleProxy.bindQueryInternal

bindQueryResult()

protected bindQueryResult<T>(
   query, 
   payloads, 
   additionalWitnesses?, 
errors?): Promise<ModuleQueryResult>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads

Payload[]

additionalWitnesses?

AccountInstance[]

errors?

ModuleError[]

Returns

Promise<ModuleQueryResult>

Inherited from

AbstractModuleProxy.bindQueryResult

generateConfigAndAddress()

protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;

Parameters

_maxDepth?

number

Returns

Promisable<Payload[]>

Inherited from

AbstractModuleProxy.generateConfigAndAddress

generateDescribe()

protected generateDescribe(): Promise<ModuleDescriptionPayload>;

Returns

Promise<ModuleDescriptionPayload>

Inherited from

AbstractModuleProxy.generateDescribe

getArchivist()

protected getArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Deprecated

use archivistInstance() instead

Inherited from

AbstractModuleProxy.getArchivist

isAllowedArchivingQuery()

protected isAllowedArchivingQuery(schema): boolean;

Parameters

schema

Schema

Returns

boolean

Inherited from

AbstractModuleProxy.isAllowedArchivingQuery

moduleAddressHandler()

protected moduleAddressHandler(): Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;

Returns

Promisable<(AddressPreviousHashPayload | AddressPayload)[]>

Inherited from

AbstractModuleProxy.moduleAddressHandler

stateHandler()

protected stateHandler(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Inherited from

AbstractModuleProxy.stateHandler

stopHandler()

protected stopHandler(): Promise<void>;

Override in subclasses to define stop behavior. Throw an error on failure.

Returns

Promise<void>

Inherited from

AbstractModuleProxy.stopHandler

subscribeHandler()

protected subscribeHandler(): void;

Returns

void

Inherited from

AbstractModuleProxy.subscribeHandler

validateConfig()

protected validateConfig(config?, parents?): boolean;

Parameters

config?

unknown

parents?

string[]

Returns

boolean

Inherited from

AbstractModuleProxy.validateConfig

addParent()

addParent(mod): void;

Parameters

mod

ModuleInstance

Returns

void

Inherited from

AbstractModuleProxy.addParent

certifyParents()

certifyParents(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Inherited from

AbstractModuleProxy.certifyParents

manifestQuery()

manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;

Parameters

account

AccountInstance

maxDepth?

number

Returns

Promise<ModuleQueryResult<ModuleManifestPayload>>

Inherited from

AbstractModuleProxy.manifestQuery

parents()

parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;

Returns

Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>

Inherited from

AbstractModuleProxy.parents

privateChildren()

privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Inherited from

AbstractModuleProxy.privateChildren

removeParent()

removeParent(address): void;

Parameters

address

BrandedAddress

Returns

void

Inherited from

AbstractModuleProxy.removeParent

resolveIdentifier()

resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;

Parameters

id

ModuleIdentifier

options?

ObjectFilterOptions<AnyObject>

Returns

Promise<BrandedAddress | undefined>

Inherited from

AbstractModuleProxy.resolveIdentifier

resolvePrivate()

Call Signature

resolvePrivate<T>(all, options?): Promise<T[]>;

Type Parameters

T

Parameters

all

"*"

options?

ModuleFilterOptions<T>

Returns

Promise<T[]>

Inherited from

AbstractModuleProxy.resolvePrivate

Call Signature

resolvePrivate<T>(id, options?): Promise<T | undefined>;

Type Parameters

T

Parameters

id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Inherited from

AbstractModuleProxy.resolvePrivate

siblings()

siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Inherited from

AbstractModuleProxy.siblings

stateQuery()

stateQuery(account): Promise<ModuleQueryResult>;

Parameters

account

AccountInstance

Returns

Promise<ModuleQueryResult>

Inherited from

AbstractModuleProxy.stateQuery

subscribe()

subscribe(_queryAccount?): void;

Parameters

_queryAccount?

AccountInstance

Returns

void

Inherited from

AbstractModuleProxy.subscribe

manifestHandler()

protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;

Parameters

maxDepth?

number

_ignoreAddresses?

BrandedAddress[]

Returns

Promise<ModuleManifestPayload>

Inherited from

AbstractModuleProxy.manifestHandler

sendQuery()

protected sendQuery<T, P, R>(
   queryPayload, 
   payloads?, 
account?): Promise<R[]>;

Type Parameters

T

T extends Query

P

P extends Payload = Payload

R

R extends Payload = Payload

Parameters

queryPayload

T

payloads?

P[]

account?

AccountInstance

Returns

Promise<R[]>

Inherited from

AbstractModuleProxy.sendQuery

sendQueryRaw()

protected sendQueryRaw<T, P, R>(
   queryPayload, 
   payloads?, 
account?): Promise<ModuleQueryResult<R>>;

Type Parameters

T

T extends Query

P

P extends Payload = Payload

R

R extends Payload = Payload

Parameters

queryPayload

T

payloads?

P[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult<R>>

Inherited from

AbstractModuleProxy.sendQueryRaw

storeToArchivists()

protected storeToArchivists(payloads): Promise<Payload[]>;

Parameters

payloads

Payload[]

Returns

Promise<Payload[]>

Inherited from

AbstractModuleProxy.storeToArchivists

            ### <a id="PubSubBridge"></a>PubSubBridge

@xyo-network/bridge-pub-sub

Extends

AbstractBridge<TParams>

Type Parameters

TParams

TParams extends PubSubBridgeParams = PubSubBridgeParams

Implements

BridgeModule<TParams>

Constructors

Constructor

new PubSubBridge<TParams>(key, params): PubSubBridge<TParams>;

Parameters

key

unknown

params

Partial<TParams & RequiredCreatableParams>

Returns

PubSubBridge<TParams>

Inherited from

AbstractBridge<TParams>.constructor

Properties

uniqueName

readonly static uniqueName: string;

Inherited from

AbstractBridge.uniqueName

_roots?

protected optional _roots?: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];

Inherited from

AbstractBridge._roots

configSchemas

readonly static configSchemas: Schema[];

Overrides

AbstractBridge.configSchemas

defaultConfigSchema

readonly static defaultConfigSchema: Schema = PubSubBridgeConfigSchema;

Overrides

AbstractBridge.defaultConfigSchema

_configRootAddress

protected _configRootAddress: BrandedAddress;

_configStateStoreArchivist

protected _configStateStoreArchivist: string = '';

_configStateStoreBoundWitnessDiviner

protected _configStateStoreBoundWitnessDiviner: string = '';

_exposedAddresses

protected _exposedAddresses: BrandedAddress[] = [];

_lastState?

protected optional _lastState?: LRUCache<string, number, unknown>;

allowRandomAccount

readonly static allowRandomAccount: boolean;

Inherited from

AbstractBridge.allowRandomAccount

defaultLogger

static defaultLogger: Logger;

Inherited from

AbstractBridge.defaultLogger

enableLazyLoad

static enableLazyLoad: boolean;

Inherited from

AbstractBridge.enableLazyLoad

labels

readonly static labels: Labels;

Inherited from

AbstractBridge.labels

privateConstructorKey

protected static privateConstructorKey: string;

Inherited from

AbstractBridge.privateConstructorKey

_account

protected _account: AccountInstance | undefined;

Inherited from

AbstractBridge._account

_cachedManifests

protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;

Inherited from

AbstractBridge._cachedManifests

_globalReentrancyMutex

protected _globalReentrancyMutex: Mutex | undefined;

Inherited from

AbstractBridge._globalReentrancyMutex

_lastError?

protected optional _lastError?: ModuleDetailsError;

Inherited from

AbstractBridge._lastError

_moduleConfigQueryValidator

protected _moduleConfigQueryValidator: Queryable | undefined;

Inherited from

AbstractBridge._moduleConfigQueryValidator

_supportedQueryValidator

protected _supportedQueryValidator: Queryable | undefined;

Inherited from

AbstractBridge._supportedQueryValidator

useNewResolver

readonly static useNewResolver: false = false;

Inherited from

AbstractBridge.useNewResolver

Accessors

allowNameResolution

Get Signature

get allowNameResolution(): boolean;

Returns

boolean

Inherited from

AbstractBridge.allowNameResolution

discoverRoots

Get Signature

get discoverRoots(): false | "start" | "lazy";

Returns

false | "start" | "lazy"

Inherited from

AbstractBridge.discoverRoots

queries

Get Signature

get queries(): Schema[];

Returns

Schema[]

Implementation of

BridgeModule.queries

Inherited from

AbstractBridge.queries

resolver

Get Signature

get resolver(): PubSubBridgeModuleResolver;

Returns

PubSubBridgeModuleResolver

Overrides

AbstractBridge.resolver

moduleName

Get Signature

get protected moduleName(): string;

Returns

string

account

Get Signature

get account(): AccountInstance;

Returns

AccountInstance

Inherited from

AbstractBridge.account

additionalSigners

Get Signature

get additionalSigners(): AccountInstance[];

Returns

AccountInstance[]

Inherited from

AbstractBridge.additionalSigners

address

Get Signature

get address(): Lowercase<string> & object & object;

Returns

Lowercase<string> & object & object

Implementation of

BridgeModule.address

Inherited from

AbstractBridge.address

allowAnonymous

Get Signature

get allowAnonymous(): boolean;

Returns

boolean

Inherited from

AbstractBridge.allowAnonymous

archiving

Get Signature

get archiving(): 
  | {
  archivists?: ModuleIdentifier[];
  queries?: Schema[];
}
  | undefined;

Returns

| { archivists?: ModuleIdentifier[]; queries?: Schema[]; } | undefined

Inherited from

AbstractBridge.archiving

archivist

Get Signature

get archivist(): ModuleIdentifier | undefined;

Returns

ModuleIdentifier | undefined

Inherited from

AbstractBridge.archivist

config

Get Signature

get config(): TParams["config"] & object;

Returns

TParams["config"] & object

Implementation of

BridgeModule.config

Inherited from

AbstractBridge.config

dead

Get Signature

get dead(): boolean;

Returns

boolean

Inherited from

AbstractBridge.dead

ephemeralQueryAccountEnabled

Get Signature

get ephemeralQueryAccountEnabled(): boolean;

Returns

boolean

Inherited from

AbstractBridge.ephemeralQueryAccountEnabled

globalReentrancyMutex

Get Signature

get globalReentrancyMutex(): Mutex | undefined;

Returns

Mutex | undefined

Inherited from

AbstractBridge.globalReentrancyMutex

id

Get Signature

get id(): string;

The name (if specified) or address of the module

Returns

string

Implementation of

BridgeModule.id

Inherited from

AbstractBridge.id

logger

Get Signature

get logger(): Logger | undefined;

Returns

Logger | undefined

Inherited from

AbstractBridge.logger

priority

Get Signature

get priority(): 2;

Returns

2

Inherited from

AbstractBridge.priority

reentrancy

Get Signature

get reentrancy(): 
  | {
  action: "skip" | "wait";
  scope: "global";
}
  | undefined;

Returns

| { action: "skip" | "wait"; scope: "global"; } | undefined

Inherited from

AbstractBridge.reentrancy

statusReporter

Get Signature

get statusReporter(): 
  | ModuleStatusReporter & CreatableStatusReporter<void>
  | undefined;

The status reporter used to broadcast lifecycle changes.

Returns

| ModuleStatusReporter & CreatableStatusReporter<void> | undefined

Inherited from

AbstractBridge.statusReporter

timestamp

Get Signature

get timestamp(): boolean;

Returns

boolean

Inherited from

AbstractBridge.timestamp

moduleConfigQueryValidator

Get Signature

get protected moduleConfigQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractBridge.moduleConfigQueryValidator

supportedQueryValidator

Get Signature

get protected supportedQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractBridge.supportedQueryValidator

downResolver

Get Signature

get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractBridge.downResolver

modName

Get Signature

get modName(): string | undefined;

Returns

string | undefined

Implementation of

BridgeModule.modName

Inherited from

AbstractBridge.modName

moduleIdentifierTransformers

Get Signature

get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];

Returns

ModuleIdentifierTransformer[]

Inherited from

AbstractBridge.moduleIdentifierTransformers

privateResolver

Get Signature

get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractBridge.privateResolver

root

Get Signature

get root(): this;

Returns

this

Inherited from

AbstractBridge.root

timeBudget

Get Signature

get timeBudget(): number | undefined;

Returns

number | undefined

Inherited from

AbstractBridge.timeBudget

upResolver

Get Signature

get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractBridge.upResolver

Methods

expose()

expose(id, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Parameters

id

ModuleIdentifier

options?

BridgeExposeOptions

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Inherited from

AbstractBridge.expose

exposed()

exposed(): Promise<BrandedAddress[]>;

Returns

Promise<BrandedAddress[]>

Inherited from

AbstractBridge.exposed

unexpose()

unexpose(id, options?): Promise<BrandedAddress[]>;

Parameters

id

ModuleIdentifier

options?

BridgeUnexposeOptions

Returns

Promise<BrandedAddress[]>

Inherited from

AbstractBridge.unexpose

queryHandler()

protected queryHandler<T>(query, payloads?): Promise<ModuleQueryHandlerResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

Parameters

query

T

payloads?

Payload[]

Returns

Promise<ModuleQueryHandlerResult>

Inherited from

AbstractBridge.queryHandler

resolveArchivingArchivists()

protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;

Returns

Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>

Inherited from

AbstractBridge.resolveArchivingArchivists

connect()

connect(id, maxDepth?): Promise<BrandedAddress | undefined>;

Parameters

id

ModuleIdentifier

maxDepth?

number = 5

Returns

Promise<BrandedAddress | undefined>

disconnect()

disconnect(id): Promise<BrandedAddress | undefined>;

Parameters

id

ModuleIdentifier

Returns

Promise<BrandedAddress | undefined>

exposeChild()

exposeChild(mod, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Parameters

mod

ModuleInstance

options?

BridgeExposeOptions

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

exposeHandler()

exposeHandler(address, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Parameters

address

BrandedAddress

options?

BridgeExposeOptions

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Overrides

AbstractBridge.exposeHandler

exposedHandler()

exposedHandler(): BrandedAddress[];

Returns

BrandedAddress[]

Overrides

AbstractBridge.exposedHandler

getRoots()

getRoots(force?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Parameters

force?

boolean

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Overrides

AbstractBridge.getRoots

resolve()

Call Signature

resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractBridge.resolve

Call Signature

resolve<T>(all, options?): Promise<T[]>;

Type Parameters

T

Parameters

all

"*"

options?

ModuleFilterOptions<T>

Returns

Promise<T[]>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractBridge.resolve

Call Signature

resolve<T>(id, options?): Promise<T | undefined>;

Type Parameters

T

Parameters

id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Deprecated

do not pass undefined. If trying to get all, pass '*'

Overrides

AbstractBridge.resolve

startHandler()

startHandler(): Promise<void>;

Returns

Promise<void>

Overrides

AbstractBridge.startHandler

unexposeHandler()

unexposeHandler(id, options?): Promise<ModuleInstance<

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@xyo-network/bridge-pub-sub

Install

License

Reference

packages

modules

Extends

Extended by

Type Parameters

TParams

Constructors

Constructor

Parameters

params

Returns

Inherited from

Methods

start()

Returns

stop()

Returns

Extends

Type Parameters

TParams

Constructors

Constructor

Parameters

params

Returns

Overrides

Properties

_lastState?

Inherited from

_targetConfigs

Inherited from

_targetQueries

Inherited from

_queryCache?

Accessors

config

Get Signature

Returns

Inherited from

pollFrequency

Get Signature

Returns

Inherited from

rootModule

Get Signature

Returns

Inherited from

lastState

Get Signature

Returns

Inherited from

queryCacheConfig

Get Signature

Returns

started

Get Signature

Returns

queryCache

Get Signature

Returns

Methods

queriesArchivist()

Returns

Inherited from

queriesDiviner()

Returns

Inherited from

responsesArchivist()

Returns

Inherited from