Class AsyncQueryBusHost<TParams>

Type Parameters

Hierarchy

  • AsyncQueryBusBase<TParams>
    • AsyncQueryBusHost

Constructors

constructor

Properties

_exposedAddresses _lastState? _targetConfigs _targetQueries defaultLogger? globalInstances globalInstancesCountHistory uniqueName

Accessors

config exposedAddresses idlePollFrequency idleThreshold lastState logger params perAddressBatchQueryLimit pollFrequency rootModule started historyInterval historyTime maxGcFrequency maxHistoryDepth

Methods

callLocalModule commitState expose findQueriesToAddress listeningModules queriesArchivist queriesDiviner responsesArchivist responsesDiviner retrieveState start stop unexpose gc instanceCount instanceCounts startHistory stopHistory

Constructors

constructor

Properties

Protected_exposedAddresses

_exposedAddresses: Set<Lowercase<string>> = ...

Protected Optional_lastState

_lastState?: LRUCache<Lowercase<string>, Lowercase<string>, unknown>

Protected_targetConfigs

_targetConfigs: Record<Lowercase<string>, ModuleConfig> = {}

Protected_targetQueries

_targetQueries: Record<Lowercase<string>, string[]> = {}

Static OptionaldefaultLogger

defaultLogger?: Logger

Static ReadonlyglobalInstances

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

Static ReadonlyglobalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

Static ReadonlyuniqueName

uniqueName: string

Accessors

config

exposedAddresses

idlePollFrequency

idleThreshold

ProtectedlastState

logger

  • get logger(): undefined | Logger

    Returns undefined | Logger

params

  • get params(): TParams

    Returns TParams

perAddressBatchQueryLimit

pollFrequency

rootModule

  • get rootModule(): 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 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>,
    >

started

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

ProtectedcallLocalModule

ProtectedcommitState

  • commitState(
        address: Lowercase<string>,
        nextState: Lowercase<string>,
    ): Promise<void>

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

    Parameters

    • address: Lowercase<string>

      The module address to commit the state for

    • nextState: Lowercase<string>

      The state to commit

    Returns Promise<void>

expose

  • expose(
        mod: ModuleInstance,
        options?: ExposeOptions,
    ):
        | undefined
        | 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
        | undefined
        | 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>,
        >

ProtectedfindQueriesToAddress

listeningModules

  • listeningModules(): 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>,
        >[],
    >

queriesArchivist

  • queriesArchivist(): 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,
        >,
    >

queriesDiviner

  • queriesDiviner(): Promise<
        DivinerInstance<
            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?: (...)[];
                        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>,
                >[];
            },
            BoundWitnessDivinerQueryPayload,
            UnsignedQueryBoundWitness,
            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,
            >,
        >,
    >

    Returns Promise<
        DivinerInstance<
            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?: (...)[];
                        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>,
                >[];
            },
            BoundWitnessDivinerQueryPayload,
            UnsignedQueryBoundWitness,
            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,
            >,
        >,
    >

responsesArchivist

  • responsesArchivist(): 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,
        >,
    >

responsesDiviner

  • responsesDiviner(): Promise<
        DivinerInstance<
            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?: (...)[];
                        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>,
                >[];
            },
            BoundWitnessDivinerQueryPayload,
            BoundWitness,
            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,
            >,
        >,
    >

    Returns Promise<
        DivinerInstance<
            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?: (...)[];
                        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>,
                >[];
            },
            BoundWitnessDivinerQueryPayload,
            BoundWitness,
            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,
            >,
        >,
    >

ProtectedretrieveState

start

stop

unexpose

  • unexpose(
        id: string,
        validate?: boolean,
    ): Promise<
        | undefined
        | ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<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>,
                >[];
            },
            ModuleEventData<object>,
        >,
    >

    Parameters

    • id: string
    • validate: boolean = true

    Returns Promise<
        | undefined
        | ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<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>,
                >[];
            },
            ModuleEventData<object>,
        >,
    >

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