npm.io
5.3.30 • Published 6 months ago

@xyo-network/abstract-witness

Licence
LGPL-3.0-only
Version
5.3.30
Deps
3
Size
60 kB
Vulns
0
Weekly
1.5K
SummaryDependencyVersions

logo

@xyo-network/abstract-witness

npm license

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

  ### witness

    ### packages

      ### abstract

        ### .temp-typedoc

          ### classes

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

@xyo-network/abstract-witness

Extends

  • AbstractModuleInstance<TParams, TEventData>

Type Parameters

TParams

TParams extends WitnessParams = WitnessParams

TIn

TIn extends Payload = Payload

TOut

TOut extends Payload = Payload

TEventData

TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>

Implements

  • CustomWitnessInstance<TParams, TIn, TOut, TEventData>

Constructors

Constructor
new AbstractWitness<TParams, TIn, TOut, TEventData>(key, params): AbstractWitness<TParams, TIn, TOut, TEventData>;
Parameters
key

unknown

params

Partial<TParams & RequiredCreatableParams>

Returns

AbstractWitness<TParams, TIn, TOut, TEventData>

Inherited from
AbstractModuleInstance<TParams, TEventData>.constructor

Properties

configSchemas
readonly static configSchemas: Schema[];
Overrides
AbstractModuleInstance.configSchemas
defaultConfigSchema
readonly static defaultConfigSchema: Schema = WitnessConfigSchema;
Overrides
AbstractModuleInstance.defaultConfigSchema
uniqueName
readonly static uniqueName: string;
Overrides
AbstractModuleInstance.uniqueName
allowRandomAccount
readonly static allowRandomAccount: boolean;
Inherited from
AbstractModuleInstance.allowRandomAccount
defaultLogger
static defaultLogger: Logger;
Inherited from
AbstractModuleInstance.defaultLogger
enableLazyLoad
static enableLazyLoad: boolean;
Inherited from
AbstractModuleInstance.enableLazyLoad
labels
readonly static labels: Labels;
Inherited from
AbstractModuleInstance.labels
privateConstructorKey
protected static privateConstructorKey: string;
Inherited from
AbstractModuleInstance.privateConstructorKey
_account
protected _account: AccountInstance | undefined;
Inherited from
AbstractModuleInstance._account
_cachedManifests
protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
Inherited from
AbstractModuleInstance._cachedManifests
_globalReentrancyMutex
protected _globalReentrancyMutex: Mutex | undefined;
Inherited from
AbstractModuleInstance._globalReentrancyMutex
_lastError?
protected optional _lastError?: ModuleDetailsError;
Inherited from
AbstractModuleInstance._lastError
_moduleConfigQueryValidator
protected _moduleConfigQueryValidator: Queryable | undefined;
Inherited from
AbstractModuleInstance._moduleConfigQueryValidator
_supportedQueryValidator
protected _supportedQueryValidator: Queryable | undefined;
Inherited from
AbstractModuleInstance._supportedQueryValidator
useNewResolver
readonly static useNewResolver: false = false;
Inherited from
AbstractModuleInstance.useNewResolver

Accessors

queries
Get Signature
get queries(): Schema[];
Returns

Schema[]

Implementation of
CustomWitnessInstance.queries
Overrides
AbstractModuleInstance.queries
account
Get Signature
get account(): AccountInstance;
Returns

AccountInstance

Implementation of
CustomWitnessInstance.account
Inherited from
AbstractModuleInstance.account
additionalSigners
Get Signature
get additionalSigners(): AccountInstance[];
Returns

AccountInstance[]

Inherited from
AbstractModuleInstance.additionalSigners
address
Get Signature
get address(): Lowercase<string> & object & object;
Returns

Lowercase<string> & object & object

Implementation of
CustomWitnessInstance.address
Inherited from
AbstractModuleInstance.address
allowAnonymous
Get Signature
get allowAnonymous(): boolean;
Returns

boolean

Inherited from
AbstractModuleInstance.allowAnonymous
allowNameResolution
Get Signature
get allowNameResolution(): boolean;
Returns

boolean

Inherited from
AbstractModuleInstance.allowNameResolution
archiving
Get Signature
get archiving(): 
  | {
  archivists?: ModuleIdentifier[];
  queries?: Schema[];
}
  | undefined;
Returns

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

Inherited from
AbstractModuleInstance.archiving
archivist
Get Signature
get archivist(): ModuleIdentifier | undefined;
Returns

ModuleIdentifier | undefined

Inherited from
AbstractModuleInstance.archivist
config
Get Signature
get config(): TParams["config"] & object;
Returns

TParams["config"] & object

Implementation of
CustomWitnessInstance.config
Inherited from
AbstractModuleInstance.config
dead
Get Signature
get dead(): boolean;
Returns

boolean

Inherited from
AbstractModuleInstance.dead
ephemeralQueryAccountEnabled
Get Signature
get ephemeralQueryAccountEnabled(): boolean;
Returns

boolean

Inherited from
AbstractModuleInstance.ephemeralQueryAccountEnabled
globalReentrancyMutex
Get Signature
get globalReentrancyMutex(): Mutex | undefined;
Returns

Mutex | undefined

Inherited from
AbstractModuleInstance.globalReentrancyMutex
id
Get Signature
get id(): string;

The name (if specified) or address of the module

Returns

string

Implementation of
CustomWitnessInstance.id
Inherited from
AbstractModuleInstance.id
logger
Get Signature
get logger(): Logger | undefined;
Returns

Logger | undefined

Inherited from
AbstractModuleInstance.logger
priority
Get Signature
get priority(): 2;
Returns

2

Implementation of
CustomWitnessInstance.priority
Inherited from
AbstractModuleInstance.priority
reentrancy
Get Signature
get reentrancy(): 
  | {
  action: "skip" | "wait";
  scope: "global";
}
  | undefined;
Returns

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

Inherited from
AbstractModuleInstance.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
AbstractModuleInstance.statusReporter
timestamp
Get Signature
get timestamp(): boolean;
Returns

boolean

Inherited from
AbstractModuleInstance.timestamp
moduleConfigQueryValidator
Get Signature
get protected moduleConfigQueryValidator(): Queryable;
Returns

Queryable

Inherited from
AbstractModuleInstance.moduleConfigQueryValidator
supportedQueryValidator
Get Signature
get protected supportedQueryValidator(): Queryable;
Returns

Queryable

Inherited from
AbstractModuleInstance.supportedQueryValidator
downResolver
Get Signature
get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from
AbstractModuleInstance.downResolver
modName
Get Signature
get modName(): string | undefined;
Returns

string | undefined

Implementation of
CustomWitnessInstance.modName
Inherited from
AbstractModuleInstance.modName
moduleIdentifierTransformers
Get Signature
get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
Returns

ModuleIdentifierTransformer[]

Inherited from
AbstractModuleInstance.moduleIdentifierTransformers
privateResolver
Get Signature
get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from
AbstractModuleInstance.privateResolver
root
Get Signature
get root(): this;
Returns

this

Inherited from
AbstractModuleInstance.root
timeBudget
Get Signature
get timeBudget(): number | undefined;
Returns

number | undefined

Inherited from
AbstractModuleInstance.timeBudget
upResolver
Get Signature
get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from
AbstractModuleInstance.upResolver

Methods

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

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

observe()
observe(inPayloads?): Promise<WithoutPrivateStorageMeta<TOut>[]>;

Function

observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality

Parameters
inPayloads?

TIn[]

Returns

Promise<WithoutPrivateStorageMeta<TOut>[]>

Implementation of
CustomWitnessInstance.observe
observeQuery()
observeQuery(payloads?, account?): Promise<ModuleQueryResult<TOut>>;
Parameters
payloads?

TIn[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult<TOut>>

Implementation of
CustomWitnessInstance.observeQuery
queryHandler()
protected queryHandler<T, TConfig>(
   query, 
   payloads?, 
queryConfig?): Promise<ModuleQueryHandlerResult>;

Function

queryHandler Calls observe for an observe query. Override to support additional queries.

Type Parameters
T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters
query

T

payloads?

Payload[]

queryConfig?

TConfig

Returns

Promise<ModuleQueryHandlerResult>

Overrides
AbstractModuleInstance.queryHandler
observeHandler()
abstract protected observeHandler(payloads?): Promisable<TOut[]>;

Function

observeHandler Implement or override to add custom functionality to a witness

Parameters
payloads?

TIn[]

Returns

Promisable<TOut[]>

_getRootFunction()
static _getRootFunction(funcName): any;
Parameters
funcName

string

Returns

any

Inherited from
AbstractModuleInstance._getRootFunction
_noOverride()
static _noOverride(functionName): void;
Parameters
functionName

string

Returns

void

Inherited from
AbstractModuleInstance._noOverride
createHandler()
static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;

Static hook called during creation to perform additional initialization. Override in subclasses to customize post-construction setup.

Type Parameters
T

T extends CreatableInstance<CreatableParams, EventData>

Parameters
inInstance

T

Returns

Promise<T & AbstractModule<any, any>>

The instance, potentially modified

Inherited from
AbstractModuleInstance.createHandler
determineAccount()
static determineAccount(params): Promise<AccountInstance>;
Parameters
params
account?

AccountInstance | "random"

accountPath?

string

wallet?

WalletInstance

Returns

Promise<AccountInstance>

Inherited from
AbstractModuleInstance.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
AbstractModuleInstance.factory
isAllowedSchema()
static isAllowedSchema(schema): boolean;
Parameters
schema

Schema

Returns

boolean

Inherited from
AbstractModuleInstance.isAllowedSchema
paramsHandler()
static paramsHandler<T>(inParams?): Promise<T["params"]>;

Static hook called during creation to validate and transform params. Override in subclasses to add default values or validation.

Type Parameters
T

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

Parameters
inParams?

Partial<T["params"]>

Returns

Promise<T["params"]>

The processed params ready for construction

Inherited from
AbstractModuleInstance.paramsHandler
_getRootFunction()
_getRootFunction(funcName): any;
Parameters
funcName

string

Returns

any

Inherited from
AbstractModuleInstance._getRootFunction
busy()
busy<R>(closure): Promise<R>;
Type Parameters
R

R

Parameters
closure

() => Promise<R>

Returns

Promise<R>

Inherited from
AbstractModuleInstance.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 TEventData

TEventArgs

TEventArgs extends EventArgs = TEventData[TEventName]

Parameters
eventName

TEventName

The event to emit.

eventArgs

TEventArgs

The data to pass to listeners.

Returns

Promise<void>

Implementation of
CustomWitnessInstance.emit
Inherited from
AbstractModuleInstance.emit
isSupportedQuery()
isSupportedQuery(query, assert?): boolean;
Parameters
query

Schema

assert?

string | boolean

Returns

boolean

Inherited from
AbstractModuleInstance.isSupportedQuery
previousHash()
previousHash(): Promisable<string | undefined>;
Returns

Promisable<string | undefined>

Implementation of
CustomWitnessInstance.previousHash
Inherited from
AbstractModuleInstance.previousHash
query()
query<T, TConfig>(
   query, 
   payloads?, 
queryConfig?): Promise<ModuleQueryResult>;
Type Parameters
T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters
query

T

payloads?

Payload[]

queryConfig?

TConfig

Returns

Promise<ModuleQueryResult>

Implementation of
CustomWitnessInstance.query
Inherited from
AbstractModuleInstance.query
queryable()
queryable<T, TConfig>(
   query, 
   payloads?, 
queryConfig?): Promise<boolean>;
Type Parameters
T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters
query

T

payloads?

Payload[]

queryConfig?

TConfig

Returns

Promise<boolean>

Implementation of
CustomWitnessInstance.queryable
Inherited from
AbstractModuleInstance.queryable
_checkDead()
protected _checkDead(): void;
Returns

void

Inherited from
AbstractModuleInstance._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
AbstractModuleInstance.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
AbstractModuleInstance.archivistInstance
bindHashes()
protected bindHashes(
   hashes, 
   schema, 
account?): PromiseEx<unknown, AccountInstance>;
Parameters
hashes

BrandedHash[]

schema

Schema[]

account?

AccountInstance

Returns

PromiseEx<unknown, AccountInstance>

Inherited from
AbstractModuleInstance.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
AbstractModuleInstance.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
AbstractModuleInstance.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
AbstractModuleInstance.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
AbstractModuleInstance.bindQueryResult
generateConfigAndAddress()
protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
Parameters
_maxDepth?

number

Returns

Promisable<Payload[]>

Inherited from
AbstractModuleInstance.generateConfigAndAddress
generateDescribe()
protected generateDescribe(): Promise<ModuleDescriptionPayload>;
Returns

Promise<ModuleDescriptionPayload>

Inherited from
AbstractModuleInstance.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
AbstractModuleInstance.getArchivist
isAllowedArchivingQuery()
protected isAllowedArchivingQuery(schema): boolean;
Parameters
schema

Schema

Returns

boolean

Inherited from
AbstractModuleInstance.isAllowedArchivingQuery
moduleAddressHandler()
protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
Returns

Promisable<(AddressPayload | AddressPreviousHashPayload)[]>

Inherited from
AbstractModuleInstance.moduleAddressHandler
stateHandler()
protected stateHandler(): Promise<Payload[]>;
Returns

Promise<Payload[]>

Inherited from
AbstractModuleInstance.stateHandler
stopHandler()
protected stopHandler(): Promise<void>;

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

Returns

Promise<void>

Inherited from
AbstractModuleInstance.stopHandler
subscribeHandler()
protected subscribeHandler(): void;
Returns

void

Inherited from
AbstractModuleInstance.subscribeHandler
validateConfig()
protected validateConfig(config?, parents?): boolean;
Parameters
config?

unknown

parents?

string[]

Returns

boolean

Inherited from
AbstractModuleInstance.validateConfig
addParent()
addParent(mod): void;
Parameters
mod

ModuleInstance

Returns

void

Implementation of
CustomWitnessInstance.addParent
Inherited from
AbstractModuleInstance.addParent
certifyParents()
certifyParents(): Promise<Payload[]>;
Returns

Promise<Payload[]>

Inherited from
AbstractModuleInstance.certifyParents
createHandler()
createHandler(): Promise<void>;
Returns

Promise<void>

Inherited from
AbstractModuleInstance.createHandler
manifest()
manifest(maxDepth?): Promise<ModuleManifestPayload>;
Parameters
maxDepth?

number

Returns

Promise<ModuleManifestPayload>

Implementation of
CustomWitnessInstance.manifest
Inherited from
AbstractModuleInstance.manifest
manifestQuery()
manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
Parameters
account

AccountInstance

maxDepth?

number

Returns

Promise<ModuleQueryResult<ModuleManifestPayload>>

Implementation of
CustomWitnessInstance.manifestQuery
Inherited from
AbstractModuleInstance.manifestQuery
moduleAddress()
moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
Returns

Promise<(AddressPayload | AddressPreviousHashPayload)[]>

Implementation of
CustomWitnessInstance.moduleAddress
Inherited from
AbstractModuleInstance.moduleAddress
parents()
parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
Returns

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

Implementation of
CustomWitnessInstance.parents
Inherited from
AbstractModuleInstance.parents
privateChildren()
privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
Returns

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

Implementation of
CustomWitnessInstance.privateChildren
Inherited from
AbstractModuleInstance.privateChildren
publicChildren()
publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
Returns

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

Implementation of
CustomWitnessInstance.publicChildren
Inherited from
AbstractModuleInstance.publicChildren
removeParent()
removeParent(address): void;
Parameters
address

BrandedAddress

Returns

void

Implementation of
CustomWitnessInstance.removeParent
Inherited from
AbstractModuleInstance.removeParent
resolve()
Call Signature
resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
Returns

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

Implementation of
CustomWitnessInstance.resolve
Inherited from
AbstractModuleInstance.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[]>

Implementation of
CustomWitnessInstance.resolve
Inherited from
AbstractModuleInstance.resolve
Call Signature
resolve<T>(id, options?): Promise<T | undefined>;
Type Parameters
T

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

Parameters
id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Implementation of
CustomWitnessInstance.resolve
Inherited from
AbstractModuleInstance.resolve
resolveIdentifier()
resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
Parameters
id

ModuleIdentifier

options?

ObjectFilterOptions<AnyObject>

Returns

Promise<BrandedAddress | undefined>

Inherited from
AbstractModuleInstance.resolveIdentifier
resolvePrivate()
Call Signature
resolvePrivate<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[]>

Implementation of
CustomWitnessInstance.resolvePrivate
Inherited from
AbstractModuleInstance.resolvePrivate
Call Signature
resolvePrivate<T>(id, options?): Promise<T | undefined>;
Type Parameters
T

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

Parameters
id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Implementation of
CustomWitnessInstance.resolvePrivate
Inherited from
AbstractModuleInstance.resolvePrivate
siblings()
siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
Returns

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

Implementation of
CustomWitnessInstance.siblings
Inherited from
AbstractModuleInstance.siblings
state()
state(): Promise<Payload[]>;
Returns

Promise<Payload[]>

Implementation of
CustomWitnessInstance.state
Inherited from
AbstractModuleInstance.state
stateQuery()
stateQuery(account): Promise<ModuleQueryResult>;
Parameters
account

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of
CustomWitnessInstance.stateQuery
Inherited from
AbstractModuleInstance.stateQuery
subscribe()
subscribe(_queryAccount?): void;
Parameters
_queryAccount?

AccountInstance

Returns

void

Inherited from
AbstractModuleInstance.subscribe
manifestHandler()
protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
Parameters
maxDepth?

number

_ignoreAddresses?

BrandedAddress[]

Returns

Promise<ModuleManifestPayload>

Inherited from
AbstractModuleInstance.manifestHandler
resolveArchivingArchivists()
protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
Returns

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

Inherited from
AbstractModuleInstance.resolveArchivingArchivists
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
AbstractModuleInstance.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
AbstractModuleInstance.sendQueryRaw
startHandler()
protected startHandler(): Promise<void>;
Returns

Promise<void>

Inherited from
AbstractModuleInstance.startHandler
storeToArchivists()
protected storeToArchivists(payloads): Promise<Payload[]>;
Parameters
payloads

Payload[]

Returns

Promise<Payload[]>

Inherited from
AbstractModuleInstance.storeToArchivists