Class MemoryBoundWitnessDiviner<TParams, TIn, TOut>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

_account _cachedManifests _globalReentrancyMutex _lastError? _started _startPromise eventData moduleConfigQueryValidator supportedQueryValidator allowRandomAccount configSchemas defaultConfigSchema defaultLogger enableLazyLoad globalInstances globalInstancesCountHistory labels privateConstructorKey targetSchema uniqueName useNewResolver

Accessors

account additionalSigners address allowAnonymous allowNameResolution archiving archivist config dead downResolver ephemeralQueryAccountEnabled globalReentrancyMutex id logger modName moduleIdentifierTransformers params priority privateResolver queries reentrancy root status timestamp upResolver historyInterval historyTime maxGcFrequency maxHistoryDepth

Methods

_checkDead _getRootFunction _noOverride addParent archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy certifyParents clearListeners divine divineHandler divineQuery emit emitSerial generateConfigAndAddress generateDescribe getArchivist isAllowedArchivingQuery listenerCount manifest manifestHandler manifestQuery moduleAddress moduleAddressHandler off offAny on onAny once parents previousHash privateChildren publicChildren query queryable queryHandler removeParent resolve resolveArchivingArchivists resolveIdentifier resolvePrivate sendQuery sendQueryRaw siblings start started startHandler state stateHandler stateQuery stop stopHandler storeToArchivists subscribe subscribeHandler validateConfig _getRootFunction _noOverride create determineAccount factory gc instanceCount instanceCounts startHistory stopHistory

Constructors

constructor

  • new MemoryBoundWitnessDiviner<
        TParams extends
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<BoundWitnessDivinerConfig<Payload>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: AccountInstance[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<void, void>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: AccountInstance[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<void, void>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } = BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<BoundWitnessDivinerConfig<Payload>>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        TIn extends
            BoundWitnessDivinerQueryPayload = BoundWitnessDivinerQueryPayload,
        TOut extends BoundWitness = BoundWitness,
    >(
        privateConstructorKey: string,
        params: TParams,
        account: AccountInstance,
    ): MemoryBoundWitnessDiviner<TParams, TIn, TOut>

    Type Parameters

    • TParams extends BaseParamsFields & {
          account?: AccountInstance | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<BoundWitnessDivinerConfig<Payload>>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<void, void>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
          publicChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<void, void>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
      } = BaseParamsFields & {
          account?: AccountInstance | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<BoundWitnessDivinerConfig<Payload>>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<void, void>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
          publicChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<void, void>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
      }
    • TIn extends BoundWitnessDivinerQueryPayload = BoundWitnessDivinerQueryPayload
    • TOut extends BoundWitness = BoundWitness

    Parameters

    Returns MemoryBoundWitnessDiviner<TParams, TIn, TOut>

Properties

Protected_account

_account: AccountInstance

Protected_cachedManifests

_cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>

Protected_globalReentrancyMutex

_globalReentrancyMutex: undefined | Mutex

Protected Optional_lastError

_lastError?: ModuleDetailsError

Protected_started

_started: undefined | Promisable<boolean>

Protected_startPromise

_startPromise: undefined | Promisable<boolean>

eventData

eventData: DivinerModuleEventData

Protected ReadonlymoduleConfigQueryValidator

moduleConfigQueryValidator: Queryable

Protected ReadonlysupportedQueryValidator

supportedQueryValidator: Queryable

Static ReadonlyallowRandomAccount

allowRandomAccount: boolean

Static ReadonlyconfigSchemas

configSchemas: string[]

Static ReadonlydefaultConfigSchema

defaultConfigSchema: string

StaticdefaultLogger

defaultLogger: Logger

StaticenableLazyLoad

enableLazyLoad: boolean

Static ReadonlyglobalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

Static ReadonlyglobalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

Static Readonlylabels

labels: Labels

Protected StaticprivateConstructorKey

privateConstructorKey: string

Static ReadonlytargetSchema

targetSchema: string

Static ReadonlyuniqueName

uniqueName: string

Static ReadonlyuseNewResolver

useNewResolver: false

Accessors

account

  • get account(): AccountInstance

    Returns AccountInstance

additionalSigners

  • get additionalSigners(): AccountInstance[]

    Returns AccountInstance[]

address

  • get address(): Lowercase<string>

    Returns Lowercase<string>

allowAnonymous

  • get allowAnonymous(): boolean

    Returns boolean

allowNameResolution

  • get allowNameResolution(): boolean

    Returns boolean

archiving

  • get archiving(): undefined | { archivists?: string[]; queries?: string[] }

    Returns undefined | { archivists?: string[]; queries?: string[] }

archivist

  • get archivist(): undefined | string

    Returns undefined | string

config

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

    Returns TParams["config"]

dead

  • get dead(): boolean

    Returns boolean

downResolver

ephemeralQueryAccountEnabled

  • get ephemeralQueryAccountEnabled(): boolean

    Returns boolean

globalReentrancyMutex

  • get globalReentrancyMutex(): undefined | Mutex

    Returns undefined | Mutex

id

  • get id(): string

    Returns string

logger

  • get logger(): Logger

    Returns Logger

modName

  • get modName(): undefined | string

    Returns undefined | string

moduleIdentifierTransformers

params

  • get params(): TParams

    Returns TParams

priority

  • get priority(): 2

    Returns 2

privateResolver

queries

  • get queries(): string[]

    Returns string[]

reentrancy

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

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

root

  • get root(): this

    Returns this

status

  • get status(): ModuleStatus

    Returns ModuleStatus

  • set status(value: ModuleStatus): void

    Parameters

    Returns void

timestamp

  • get timestamp(): boolean

    Returns boolean

upResolver

StatichistoryInterval

  • get historyInterval(): number

    Returns number

  • set historyInterval(value: number): void

    Parameters

    • value: number

    Returns void

StatichistoryTime

  • get historyTime(): number

    Returns number

  • set historyTime(value: number): void

    Parameters

    • value: number

    Returns void

StaticmaxGcFrequency

  • get maxGcFrequency(): number

    Returns number

  • set maxGcFrequency(value: number): void

    Parameters

    • value: number

    Returns void

StaticmaxHistoryDepth

  • get maxHistoryDepth(): number

    Returns number

Methods

Protected_checkDead

  • _checkDead(): void

    Returns void

_getRootFunction

  • _getRootFunction(funcName: string): any

    Parameters

    • funcName: string

    Returns any

Protected_noOverride

  • _noOverride(functionName: string): void

    Parameters

    • functionName: string

    Returns void

addParent

ProtectedarchivistInstance

  • archivistInstance(): Promise<
        | undefined
        | ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

    Returns Promise<
        | undefined
        | ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

  • archivistInstance(
        required: true,
    ): Promise<
        ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: (...)[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: (...)[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: (...)[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: (...)[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

    Parameters

    • required: true

    Returns Promise<
        ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: (...)[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: (...)[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: (...)[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: (...)[];
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

ProtectedbindHashes

ProtectedbindHashesInternal

ProtectedbindQuery

ProtectedbindQueryInternal

ProtectedbindQueryResult

busy

  • busy<R>(closure: () => Promise<R>): Promise<R>

    Type Parameters

    • R

    Parameters

    • closure: () => Promise<R>

    Returns Promise<R>

certifyParents

clearListeners

  • clearListeners(
        eventNames: string | number | symbol | (string | number | symbol)[],
    ): void

    Parameters

    • eventNames: string | number | symbol | (string | number | symbol)[]

    Returns void

divine

  • divine(
        payloads?: TIn[],
        retryConfigIn?: RetryConfigWithComplete<unknown>,
    ): Promise<DivinerDivineResult<TOut>[]>

    Parameters

    • Optionalpayloads: TIn[]
    • OptionalretryConfigIn: RetryConfigWithComplete<unknown>

    Returns Promise<DivinerDivineResult<TOut>[]>

ProtecteddivineHandler

divineQuery

emit

  • emit<
        TEventName extends string
        | number
        | symbol = string | number | symbol,
        TEventArgs extends
            EventArgs = DivinerModuleEventData<
            DivinerInstance<
                TParams,
                TIn,
                TOut,
                DivinerModuleEventData<
                    ModuleInstance<
                        BaseParamsFields & {
                            account?: AccountInstance
                            | "random";
                            additionalSigners?: AccountInstance[];
                            addToResolvers?: boolean;
                            allowNameResolution?: boolean;
                            config: AnyConfigSchema<ModuleConfig<void, void>>;
                            ephemeralQueryAccountEnabled?: boolean;
                            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                            privateChildren?: (
                                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                            )[];
                            publicChildren?: (
                                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                            )[];
                        },
                        ModuleEventData<object>,
                    >,
                    Payload,
                    Payload,
                >,
            >,
            TIn,
            TOut,
        >[TEventName],
    >(
        eventName: TEventName,
        eventArgs: TEventArgs,
    ): Promise<void>

    Type Parameters

    • TEventName extends string | number | symbol = string | number | symbol
    • TEventArgs extends EventArgs = DivinerModuleEventData<
          DivinerInstance<
              TParams,
              TIn,
              TOut,
              DivinerModuleEventData<
                  ModuleInstance<
                      BaseParamsFields & {
                          account?: AccountInstance
                          | "random";
                          additionalSigners?: AccountInstance[];
                          addToResolvers?: boolean;
                          allowNameResolution?: boolean;
                          config: AnyConfigSchema<ModuleConfig<void, void>>;
                          ephemeralQueryAccountEnabled?: boolean;
                          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                          privateChildren?: (
                              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                          )[];
                          publicChildren?: (
                              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                          )[];
                      },
                      ModuleEventData<object>,
                  >,
                  Payload,
                  Payload,
              >,
          >,
          TIn,
          TOut,
      >[TEventName]

    Parameters

    Returns Promise<void>

emitSerial

  • emitSerial<
        TEventName extends string
        | number
        | symbol = string | number | symbol,
        TEventArgs extends
            EventArgs = DivinerModuleEventData<
            DivinerInstance<
                TParams,
                TIn,
                TOut,
                DivinerModuleEventData<
                    ModuleInstance<
                        BaseParamsFields & {
                            account?: AccountInstance
                            | "random";
                            additionalSigners?: AccountInstance[];
                            addToResolvers?: boolean;
                            allowNameResolution?: boolean;
                            config: AnyConfigSchema<ModuleConfig<void, void>>;
                            ephemeralQueryAccountEnabled?: boolean;
                            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                            privateChildren?: (
                                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                            )[];
                            publicChildren?: (
                                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                            )[];
                        },
                        ModuleEventData<object>,
                    >,
                    Payload,
                    Payload,
                >,
            >,
            TIn,
            TOut,
        >[TEventName],
    >(
        eventName: TEventName,
        eventArgs: TEventArgs,
    ): Promise<void>

    Type Parameters

    • TEventName extends string | number | symbol = string | number | symbol
    • TEventArgs extends EventArgs = DivinerModuleEventData<
          DivinerInstance<
              TParams,
              TIn,
              TOut,
              DivinerModuleEventData<
                  ModuleInstance<
                      BaseParamsFields & {
                          account?: AccountInstance
                          | "random";
                          additionalSigners?: AccountInstance[];
                          addToResolvers?: boolean;
                          allowNameResolution?: boolean;
                          config: AnyConfigSchema<ModuleConfig<void, void>>;
                          ephemeralQueryAccountEnabled?: boolean;
                          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                          privateChildren?: (
                              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                          )[];
                          publicChildren?: (
                              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                          )[];
                      },
                      ModuleEventData<object>,
                  >,
                  Payload,
                  Payload,
              >,
          >,
          TIn,
          TOut,
      >[TEventName]

    Parameters

    Returns Promise<void>

ProtectedgenerateConfigAndAddress

ProtectedgenerateDescribe

ProtectedgetArchivist

  • getArchivist(): Promise<
        | undefined
        | ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

    Returns Promise<
        | undefined
        | ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >,
    >

ProtectedisAllowedArchivingQuery

  • isAllowedArchivingQuery(schema: string): boolean

    Parameters

    • schema: string

    Returns boolean

listenerCount

  • listenerCount(
        eventNames: string | number | symbol | (string | number | symbol)[],
    ): number

    Parameters

    • eventNames: string | number | symbol | (string | number | symbol)[]

    Returns number

manifest

ProtectedmanifestHandler

manifestQuery

moduleAddress

ProtectedmoduleAddressHandler

off

  • off<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<
            DivinerModuleEventData<
                DivinerInstance<
                    TParams,
                    TIn,
                    TOut,
                    DivinerModuleEventData<
                        ModuleInstance<
                            BaseParamsFields & {
                                account?: AccountInstance
                                | "random";
                                additionalSigners?: AccountInstance[];
                                addToResolvers?: boolean;
                                allowNameResolution?: boolean;
                                config: AnyConfigSchema<ModuleConfig<void, void>>;
                                ephemeralQueryAccountEnabled?: boolean;
                                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                                privateChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                                publicChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                            },
                            ModuleEventData<object>,
                        >,
                        Payload,
                        Payload,
                    >,
                >,
                TIn,
                TOut,
            >[TEventName],
        >,
    ): void

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    • eventNames: TEventName | TEventName[]
    • listener: EventListener<
          DivinerModuleEventData<
              DivinerInstance<
                  TParams,
                  TIn,
                  TOut,
                  DivinerModuleEventData<
                      ModuleInstance<
                          BaseParamsFields & {
                              account?: AccountInstance
                              | "random";
                              additionalSigners?: AccountInstance[];
                              addToResolvers?: boolean;
                              allowNameResolution?: boolean;
                              config: AnyConfigSchema<ModuleConfig<void, void>>;
                              ephemeralQueryAccountEnabled?: boolean;
                              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                              privateChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                              publicChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                          },
                          ModuleEventData<object>,
                      >,
                      Payload,
                      Payload,
                  >,
              >,
              TIn,
              TOut,
          >[TEventName],
      >

    Returns void

offAny

on

  • on<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<
            DivinerModuleEventData<
                DivinerInstance<
                    TParams,
                    TIn,
                    TOut,
                    DivinerModuleEventData<
                        ModuleInstance<
                            BaseParamsFields & {
                                account?: AccountInstance
                                | "random";
                                additionalSigners?: AccountInstance[];
                                addToResolvers?: boolean;
                                allowNameResolution?: boolean;
                                config: AnyConfigSchema<ModuleConfig<void, void>>;
                                ephemeralQueryAccountEnabled?: boolean;
                                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                                privateChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                                publicChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                            },
                            ModuleEventData<object>,
                        >,
                        Payload,
                        Payload,
                    >,
                >,
                TIn,
                TOut,
            >[TEventName],
        >,
    ): () => void

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    • eventNames: TEventName | TEventName[]
    • listener: EventListener<
          DivinerModuleEventData<
              DivinerInstance<
                  TParams,
                  TIn,
                  TOut,
                  DivinerModuleEventData<
                      ModuleInstance<
                          BaseParamsFields & {
                              account?: AccountInstance
                              | "random";
                              additionalSigners?: AccountInstance[];
                              addToResolvers?: boolean;
                              allowNameResolution?: boolean;
                              config: AnyConfigSchema<ModuleConfig<void, void>>;
                              ephemeralQueryAccountEnabled?: boolean;
                              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                              privateChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                              publicChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                          },
                          ModuleEventData<object>,
                      >,
                      Payload,
                      Payload,
                  >,
              >,
              TIn,
              TOut,
          >[TEventName],
      >

    Returns () => void

onAny

once

  • once<TEventName extends string | number | symbol>(
        eventName: TEventName,
        listener: EventListener<
            DivinerModuleEventData<
                DivinerInstance<
                    TParams,
                    TIn,
                    TOut,
                    DivinerModuleEventData<
                        ModuleInstance<
                            BaseParamsFields & {
                                account?: AccountInstance
                                | "random";
                                additionalSigners?: AccountInstance[];
                                addToResolvers?: boolean;
                                allowNameResolution?: boolean;
                                config: AnyConfigSchema<ModuleConfig<void, void>>;
                                ephemeralQueryAccountEnabled?: boolean;
                                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                                privateChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                                publicChildren?: (
                                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                                )[];
                            },
                            ModuleEventData<object>,
                        >,
                        Payload,
                        Payload,
                    >,
                >,
                TIn,
                TOut,
            >[TEventName],
        >,
    ): () => void

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    • eventName: TEventName
    • listener: EventListener<
          DivinerModuleEventData<
              DivinerInstance<
                  TParams,
                  TIn,
                  TOut,
                  DivinerModuleEventData<
                      ModuleInstance<
                          BaseParamsFields & {
                              account?: AccountInstance
                              | "random";
                              additionalSigners?: AccountInstance[];
                              addToResolvers?: boolean;
                              allowNameResolution?: boolean;
                              config: AnyConfigSchema<ModuleConfig<void, void>>;
                              ephemeralQueryAccountEnabled?: boolean;
                              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                              privateChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                              publicChildren?: (
                                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                              )[];
                          },
                          ModuleEventData<object>,
                      >,
                      Payload,
                      Payload,
                  >,
              >,
              TIn,
              TOut,
          >[TEventName],
      >

    Returns () => void

parents

  • parents(): Promisable<
        NodeInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<NodeConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            },
            NodeModuleEventData,
        >[],
    >

    Returns Promisable<
        NodeInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<NodeConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            },
            NodeModuleEventData,
        >[],
    >

previousHash

  • previousHash(): Promisable<undefined | string>

    Returns Promisable<undefined | string>

privateChildren

  • privateChildren(): Promisable<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

    Returns Promisable<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

publicChildren

  • publicChildren(): Promisable<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

    Returns Promisable<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

query

queryable

ProtectedqueryHandler

removeParent

  • removeParent(address: Lowercase<string>): void

    Parameters

    • address: Lowercase<string>

    Returns void

resolve

  • resolve(): Promise<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

    Returns Promise<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

  • resolve<
        T extends
            ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                    publicChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                },
                ModuleEventData<object>,
            > = ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        >,
    >(
        all: "*",
        options?: ModuleFilterOptions<T>,
    ): Promise<T[]>

    Type Parameters

    • T extends ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      > = ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns Promise<T[]>

  • resolve<
        T extends
            ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                    publicChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                },
                ModuleEventData<object>,
            > = ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        >,
    >(
        id: string,
        options?: ModuleFilterOptions<T>,
    ): Promise<undefined | T>

    Type Parameters

    • T extends ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      > = ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns Promise<undefined | T>

ProtectedresolveArchivingArchivists

  • resolveArchivingArchivists(): Promise<
        ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >[],
    >

    Returns Promise<
        ArchivistInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ArchivistConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    BaseParamsFields & {
                        account?: (...)
                        | (...)
                        | (...);
                        additionalSigners?: (...) | (...);
                        addToResolvers?: (...) | (...) | (...);
                        allowNameResolution?: (...) | (...) | (...);
                        config: AnyConfigSchema<(...)>;
                        ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                        moduleIdentifierTransformers?: (...) | (...);
                        privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                        publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    },
                    ModuleEventData<object>,
                >[];
            } & ArchivistParamFields & object,
            ArchivistModuleEventData,
            Payload,
        >[],
    >

resolveIdentifier

resolvePrivate

  • resolvePrivate<
        T extends
            ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                    publicChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                },
                ModuleEventData<object>,
            > = ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        >,
    >(
        all: "*",
        options?: ModuleFilterOptions<T>,
    ): Promise<T[]>

    Type Parameters

    • T extends ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      > = ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns Promise<T[]>

  • resolvePrivate<
        T extends
            ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                    publicChildren?: (
                        ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                    )[];
                },
                ModuleEventData<object>,
            > = ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        >,
    >(
        id: string,
        options?: ModuleFilterOptions<T>,
    ): Promise<undefined | T>

    Type Parameters

    • T extends ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      > = ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
              publicChildren?: (
                  ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
              )[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns Promise<undefined | T>

ProtectedsendQuery

ProtectedsendQueryRaw

siblings

  • siblings(): Promise<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

    Returns Promise<
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            },
            ModuleEventData<object>,
        >[],
    >

start

  • start(_timeout?: number): Promisable<boolean>

    Parameters

    • Optional_timeout: number

    Returns Promisable<boolean>

started

  • started(
        notStartedAction?: "error" | "warn" | "log" | "throw" | "none",
        tryStart?: boolean,
    ): Promise<boolean>

    Parameters

    • OptionalnotStartedAction: "error" | "warn" | "log" | "throw" | "none"
    • OptionaltryStart: boolean

    Returns Promise<boolean>

ProtectedstartHandler

  • startHandler(): Promise<boolean>

    Returns Promise<boolean>

state

ProtectedstateHandler

stateQuery

stop

  • stop(_timeout?: number): Promise<boolean>

    Parameters

    • Optional_timeout: number

    Returns Promise<boolean>

ProtectedstopHandler

  • stopHandler(_timeout?: number): Promisable<boolean>

    Parameters

    • Optional_timeout: number

    Returns Promisable<boolean>

ProtectedstoreToArchivists

subscribe

ProtectedsubscribeHandler

  • subscribeHandler(): void

    Returns void

ProtectedvalidateConfig

  • validateConfig(config?: unknown, parents?: string[]): boolean

    Parameters

    • Optionalconfig: unknown
    • Optionalparents: string[]

    Returns boolean

Static_getRootFunction

  • _getRootFunction(funcName: string): any

    Parameters

    • funcName: string

    Returns any

Static_noOverride

  • _noOverride(functionName: string): void

    Parameters

    • functionName: string

    Returns void

Staticcreate

  • create<
        TModule extends
            AttachableModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<
                        (
                            BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                        ),
                        ModuleEventData<object>,
                    >[];
                    publicChildren?: ModuleInstance<
                        (
                            BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                        ),
                        ModuleEventData<object>,
                    >[];
                },
                ModuleEventData<object>,
            >,
    >(
        this: CreatableModule<TModule>,
        params: Omit<TModule["params"], "config"> & {
            config?: TModule["params"]["config"];
        },
    ): Promise<TModule>

    Type Parameters

    • TModule extends AttachableModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<
                  (
                      BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                  ),
                  ModuleEventData<object>,
              >[];
              publicChildren?: ModuleInstance<
                  (
                      BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                  ),
                  ModuleEventData<object>,
              >[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns Promise<TModule>

StaticdetermineAccount

Staticfactory

  • factory<
        TModule extends
            AttachableModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<void, void>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<
                        (
                            BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                        ),
                        ModuleEventData<object>,
                    >[];
                    publicChildren?: ModuleInstance<
                        (
                            BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                        ),
                        ModuleEventData<object>,
                    >[];
                },
                ModuleEventData<object>,
            >,
    >(
        this: CreatableModule<TModule>,
        params: Omit<TModule["params"], "config"> & {
            config?: TModule["params"]["config"];
        },
    ): CreatableModuleFactory<TModule>

    Type Parameters

    • TModule extends AttachableModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig<void, void>>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<
                  (
                      BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                  ),
                  ModuleEventData<object>,
              >[];
              publicChildren?: ModuleInstance<
                  (
                      BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                  ),
                  ModuleEventData<object>,
              >[];
          },
          ModuleEventData<object>,
      >

    Parameters

    Returns CreatableModuleFactory<TModule>

Staticgc

  • gc(force?: boolean): void

    Parameters

    • Optionalforce: boolean

    Returns void

  • gc(className: string): void

    Parameters

    • className: string

    Returns void

StaticinstanceCount

  • instanceCount(className: string): number

    Parameters

    • className: string

    Returns number

StaticinstanceCounts

  • instanceCounts(): Record<string, number>

    Returns Record<string, number>

StaticstartHistory

  • startHistory(): void

    Returns void

StaticstopHistory

  • stopHistory(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods