Class HttpBridge<TParams>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_account _app? _cachedManifests _exposedModules _globalReentrancyMutex _lastError? _roots? _server? _started _startPromise eventData moduleConfigQueryValidator supportedQueryValidator allowRandomAccount axios configSchemas defaultConfigSchema defaultFailureRetryTime defaultLogger defaultMaxConnections defaultMaxPayloadSizeWarning enableLazyLoad globalInstances globalInstancesCountHistory labels maxFailureCacheSize privateConstructorKey uniqueName useNewResolver

Accessors

account additionalSigners address allowAnonymous allowNameResolution app archiving archivist axios clientUrl config dead discoverRoots downResolver ephemeralQueryAccountEnabled failureRetryTime globalReentrancyMutex id logger maxConnections maxPayloadSizeWarning modName moduleIdentifierTransformers params priority privateResolver queries querySemaphore reentrancy resolver root status timestamp upResolver historyInterval historyTime maxGcFrequency maxHistoryDepth

Methods

_checkDead _getRootFunction _noOverride addParent archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy callLocalModule certifyParents clearListeners emit emitSerial expose exposeChild exposed exposedHandler exposeHandler generateConfigAndAddress generateDescribe getArchivist getRoots handleGet handlePost initializeApp isAllowedArchivingQuery listenerCount manifest manifestHandler manifestQuery moduleAddress moduleAddressHandler moduleUrl off offAny on onAny once parents previousHash privateChildren publicChildren query queryable queryHandler removeParent resolve resolveArchivingArchivists resolveIdentifier resolvePrivate sendBridgeQuery sendQuery sendQueryRaw siblings start started startHandler startHttpServer state stateHandler stateQuery stop stopHandler stopHttpServer storeToArchivists subscribe subscribeHandler unexpose unexposeHandler validateConfig _getRootFunction _noOverride create determineAccount factory gc instanceCount instanceCounts startHistory stopHistory

Constructors

constructor

Properties

Protected_account

_account: AccountInstance

Protected Optional_app

_app?: Application

Protected_cachedManifests

_cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>

Protected_exposedModules

_exposedModules: WeakRef<
    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>,
    >,
>[]

Protected_globalReentrancyMutex

_globalReentrancyMutex: undefined | Mutex

Protected Optional_lastError

_lastError?: ModuleDetailsError

Protected Optional_roots

_roots?: 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>,
>[]

Protected Optional_server

_server?: Server<typeof IncomingMessage, typeof ServerResponse>

Protected_started

_started: undefined | Promisable<boolean>

Protected_startPromise

_startPromise: undefined | Promisable<boolean>

eventData

eventData: BridgeModuleEventData

Protected ReadonlymoduleConfigQueryValidator

moduleConfigQueryValidator: Queryable

Protected ReadonlysupportedQueryValidator

supportedQueryValidator: Queryable

Static ReadonlyallowRandomAccount

allowRandomAccount: boolean

Static Readonlyaxios

axios: AxiosJson

Static ReadonlyconfigSchemas

configSchemas: string[]

Static ReadonlydefaultConfigSchema

defaultConfigSchema: string

Static ReadonlydefaultFailureRetryTime

defaultFailureRetryTime: number

StaticdefaultLogger

defaultLogger: Logger

Static ReadonlydefaultMaxConnections

defaultMaxConnections: 4

Static ReadonlydefaultMaxPayloadSizeWarning

defaultMaxPayloadSizeWarning: number

StaticenableLazyLoad

enableLazyLoad: boolean

Static ReadonlyglobalInstances

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

Static ReadonlyglobalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

Static Readonlylabels

labels: Labels

Static ReadonlymaxFailureCacheSize

maxFailureCacheSize: 1000

Protected StaticprivateConstructorKey

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

Protectedapp

  • get app(): Application

    Returns Application

archiving

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

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

archivist

  • get archivist(): undefined | string

    Returns undefined | string

axios

  • get axios(): AxiosJson

    Returns AxiosJson

clientUrl

  • get clientUrl(): string

    Returns string

config

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

    Returns TParams["config"]

dead

  • get dead(): boolean

    Returns boolean

discoverRoots

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

    Returns false | "start" | "lazy"

downResolver

ephemeralQueryAccountEnabled

  • get ephemeralQueryAccountEnabled(): boolean

    Returns boolean

failureRetryTime

  • get failureRetryTime(): number

    Returns number

globalReentrancyMutex

  • get globalReentrancyMutex(): undefined | Mutex

    Returns undefined | Mutex

id

  • get id(): string

    Returns string

logger

  • get logger(): Logger

    Returns Logger

maxConnections

  • get maxConnections(): number

    Returns number

maxPayloadSizeWarning

  • get maxPayloadSizeWarning(): number

    Returns number

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[]

querySemaphore

  • get querySemaphore(): Semaphore

    Returns Semaphore

reentrancy

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

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

resolver

  • get resolver(): HttpBridgeModuleResolver<HttpBridgeModuleResolverParams>

    Returns HttpBridgeModuleResolver<HttpBridgeModuleResolverParams>

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

  • addParent(mod: ModuleInstance): void

    Parameters

    Returns void

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

  • bindHashes(
        hashes: Lowercase<string>[],
        schema: string[],
        account?: AccountInstance,
    ): PromiseEx<unknown, AccountInstance>

    Parameters

    • hashes: Lowercase<string>[]
    • schema: string[]
    • Optionalaccount: AccountInstance

    Returns PromiseEx<unknown, AccountInstance>

ProtectedbindHashesInternal

  • bindHashesInternal(
        hashes: Lowercase<string>[],
        schema: string[],
        account?: AccountInstance,
    ): Promise<BoundWitness>

    Parameters

    • hashes: Lowercase<string>[]
    • schema: string[]
    • Optionalaccount: AccountInstance

    Returns Promise<BoundWitness>

ProtectedbindQuery

ProtectedbindQueryInternal

ProtectedbindQueryResult

busy

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

    Type Parameters

    • R

    Parameters

    • closure: () => Promise<R>

    Returns Promise<R>

ProtectedcallLocalModule

certifyParents

  • certifyParents(): Promise<Payload[]>

    Returns Promise<Payload[]>

clearListeners

  • clearListeners(
        eventNames:
            | (keyof BridgeModuleEventData)
            | (keyof BridgeModuleEventData)[],
    ): void

    Parameters

    • eventNames: (keyof BridgeModuleEventData) | (keyof BridgeModuleEventData)[]

    Returns void

emit

emitSerial

expose

  • expose(
        id: string,
        options?: BridgeExposeOptions,
    ): 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>,
        >[],
    >

    Parameters

    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>,
        >[],
    >

exposeChild

  • exposeChild(
        mod: ModuleInstance,
        options?: BridgeExposeOptions,
    ): 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>,
        >[],
    >

    Parameters

    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>,
        >[],
    >

exposed

  • exposed(): Promise<Lowercase<string>[]>

    Returns Promise<Lowercase<string>[]>

exposedHandler

  • exposedHandler(): Lowercase<string>[]

    Returns Lowercase<string>[]

exposeHandler

  • exposeHandler(
        address: Lowercase<string>,
        options?: BridgeExposeOptions,
    ): 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>,
        >[],
    >

    Parameters

    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>,
        >[],
    >

ProtectedgenerateConfigAndAddress

  • generateConfigAndAddress(_maxDepth?: number): Promisable<Payload[]>

    Parameters

    • Optional_maxDepth: number

    Returns Promisable<Payload[]>

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,
        >,
    >

getRoots

  • getRoots(
        force?: boolean,
    ): 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>,
        >[],
    >

    Parameters

    • Optionalforce: boolean

    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>,
        >[],
    >

ProtectedhandleGet

  • handleGet(
        req: Request<
            AddressPathParams,
            ModuleQueryResult,
            PostAddressRequestBody,
        >,
        res: Response,
    ): Promise<void>

    Parameters

    • req: Request<AddressPathParams, ModuleQueryResult, PostAddressRequestBody>
    • res: Response

    Returns Promise<void>

ProtectedhandlePost

  • handlePost(
        req: Request<
            AddressPathParams,
            ModuleQueryResult,
            PostAddressRequestBody,
        >,
        res: Response,
    ): Promise<undefined | Response<any, Record<string, any>>>

    Parameters

    • req: Request<AddressPathParams, ModuleQueryResult, PostAddressRequestBody>
    • res: Response

    Returns Promise<undefined | Response<any, Record<string, any>>>

ProtectedinitializeApp

  • initializeApp(): Express

    Returns Express

ProtectedisAllowedArchivingQuery

  • isAllowedArchivingQuery(schema: string): boolean

    Parameters

    • schema: string

    Returns boolean

listenerCount

  • listenerCount(
        eventNames:
            | (keyof BridgeModuleEventData)
            | (keyof BridgeModuleEventData)[],
    ): number

    Parameters

    • eventNames: (keyof BridgeModuleEventData) | (keyof BridgeModuleEventData)[]

    Returns number

manifest

  • manifest(maxDepth?: number): Promise<ModuleManifestPayload>

    Parameters

    • OptionalmaxDepth: number

    Returns Promise<ModuleManifestPayload>

ProtectedmanifestHandler

  • manifestHandler(
        maxDepth?: number,
        _ignoreAddresses?: Lowercase<string>[],
    ): Promise<ModuleManifestPayload>

    Parameters

    • OptionalmaxDepth: number
    • Optional_ignoreAddresses: Lowercase<string>[]

    Returns Promise<ModuleManifestPayload>

manifestQuery

moduleAddress

ProtectedmoduleAddressHandler

moduleUrl

  • moduleUrl(address: Lowercase<string>): URL

    Parameters

    • address: Lowercase<string>

    Returns URL

off

offAny

  • offAny(listener: EventAnyListener): void

    Parameters

    Returns void

on

onAny

  • onAny(listener: EventAnyListener): () => void

    Parameters

    Returns () => void

once

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

  • resolveIdentifier(
        id: string,
        options?: ObjectFilterOptions<AnyObject>,
    ): Promise<undefined | Lowercase<string>>

    Parameters

    Returns Promise<undefined | Lowercase<string>>

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>

sendBridgeQuery

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>

startHandler

  • startHandler(): Promise<boolean>

    Returns Promise<boolean>

ProtectedstartHttpServer

  • startHttpServer(): Promise<boolean>

    Returns Promise<boolean>

state

  • state(): Promise<Payload[]>

    Returns Promise<Payload[]>

ProtectedstateHandler

  • stateHandler(): Promise<Payload[]>

    Returns Promise<Payload[]>

stateQuery

stop

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

    Parameters

    • Optional_timeout: number

    Returns Promise<boolean>

stopHandler

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

    Parameters

    • Optional_timeout: number

    Returns Promise<boolean>

ProtectedstopHttpServer

  • stopHttpServer(): Promise<boolean>

    Returns Promise<boolean>

ProtectedstoreToArchivists

  • storeToArchivists(payloads: Payload[]): Promise<Payload[]>

    Parameters

    Returns Promise<Payload[]>

subscribe

  • subscribe(_queryAccount?: AccountInstance): void

    Parameters

    Returns void

ProtectedsubscribeHandler

  • subscribeHandler(): void

    Returns void

unexpose

  • unexpose(
        id: string,
        options?: BridgeUnexposeOptions,
    ): Promise<Lowercase<string>[]>

    Parameters

    Returns Promise<Lowercase<string>[]>

unexposeHandler

  • unexposeHandler(
        address: Lowercase<string>,
        options?: BridgeUnexposeOptions,
    ): 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>,
        >[],
    >

    Parameters

    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>,
        >[],
    >

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

  • determineAccount(
        params: {
            account?: AccountInstance | "random";
            accountPath?: string;
            wallet?: WalletInstance;
        },
    ): Promise<AccountInstance>

    Parameters

    Returns Promise<AccountInstance>

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
_checkDead_getRootFunction_noOverrideaddParentarchivistInstancebindHashesbindHashesInternalbindQuerybindQueryInternalbindQueryResultbusycallLocalModulecertifyParentsclearListenersemitemitSerialexposeexposeChildexposedexposedHandlerexposeHandlergenerateConfigAndAddressgenerateDescribegetArchivistgetRootshandleGethandlePostinitializeAppisAllowedArchivingQuerylistenerCountmanifestmanifestHandlermanifestQuerymoduleAddressmoduleAddressHandlermoduleUrloffoffAnyononAnyonceparentspreviousHashprivateChildrenpublicChildrenqueryqueryablequeryHandlerremoveParentresolveresolveArchivingArchivistsresolveIdentifierresolvePrivatesendBridgeQuerysendQuerysendQueryRawsiblingsstartstartedstartHandlerstartHttpServerstatestateHandlerstateQuerystopstopHandlerstopHttpServerstoreToArchivistssubscribesubscribeHandlerunexposeunexposeHandlervalidateConfig_getRootFunction_noOverridecreatedetermineAccountfactorygcinstanceCountinstanceCountsstartHistorystopHistory