XYO Platform SDK - v3.10.6
    Preparing search index...

    Class FilesystemArchivist<TParams>

    Currently only a read-only archivist that loads payloads from filesystem but allows for future expansion to read/write

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

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

    Accessors

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

    Methods

    _checkDead _getRootFunction _noOverride addParent all allHandler allQuery archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy certifyParents clear clearHandler clearListeners clearQuery commit commitHandler commitQuery delete deleteHandler deleteQuery deleteWithConfig emit emitSerial generateConfigAndAddress generateDescribe get getArchivist getFromParent getFromParents getHandler getQuery getWithConfig insert insertHandler insertQuery insertQueryHandler insertWithConfig isAllowedArchivingQuery listenerCount manifest manifestHandler manifestQuery moduleAddress moduleAddressHandler next nextHandler nextQuery nextWithConfig off offAny on onAny once parentArchivists parents previousHash privateChildren publicChildren query queryable queryHandler removeParent resolve resolveArchivingArchivists resolveIdentifier resolvePrivate sendQuery sendQueryRaw siblings start started startHandler state stateHandler stateQuery stop stopHandler storeToArchivists subscribe subscribeHandler validateConfig writeToParent writeToParents _getRootFunction _noOverride create determineAccount factory gc instanceCount instanceCounts startHistory stopHistory

    Constructors

    • Type Parameters

      • TParams extends BaseParamsFields & {
            account?: AccountInstance | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<FilesystemArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    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>,
            >[];
        } & ArchivistParamFields & object = BaseParamsFields & {
            account?: AccountInstance | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<FilesystemArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    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>,
            >[];
        } & ArchivistParamFields & object

      Parameters

      Returns FilesystemArchivist<TParams>

    Properties

    Protected_account

    _account: AccountInstance

    Protected_cachedManifests

    _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>

    Protected_globalReentrancyMutex

    _globalReentrancyMutex: undefined | Mutex

    Protected Optional_lastError

    _lastError?: ModuleDetailsError

    Protected_started

    _started: undefined | Promisable<boolean>

    Protected_startPromise

    _startPromise: undefined | Promisable<boolean>
    eventData: ArchivistModuleEventData
    moduleConfigQueryValidator: Queryable
    supportedQueryValidator: Queryable
    allowRandomAccount: boolean
    configSchemas: string[] = ...
    defaultConfigSchema: string = FilesystemArchivistConfigSchema
    defaultLogger: Logger
    defaultNextLimitSetting: number
    enableLazyLoad: boolean
    globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>
    globalInstancesCountHistory: Record<string, number[]>
    labels: Labels
    privateConstructorKey: string
    uniqueName: string
    useNewResolver: false

    Accessors

    • get additionalSigners(): AccountInstance[]

      Returns AccountInstance[]

    • get address(): Lowercase<string>

      Returns Lowercase<string>

    • get allowAnonymous(): boolean

      Returns boolean

    • get allowNameResolution(): boolean

      Returns boolean

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

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

    • get archivist(): undefined | string

      Returns undefined | string

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

      Returns TParams["config"]

    • get dead(): boolean

      Returns boolean

    • get ephemeralQueryAccountEnabled(): boolean

      Returns boolean

    • get globalReentrancyMutex(): undefined | Mutex

      Returns undefined | Mutex

    • get id(): string

      The name (if specified) or address of the module

      Returns string

    • get logger(): Logger

      Returns Logger

    • get modName(): undefined | string

      Returns undefined | string

    • get params(): TParams

      Returns TParams

    • get priority(): 2

      Returns 2

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

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

    • get requireAllParents(): boolean

      Returns boolean

    • get root(): this

      Returns this

    • get status(): ModuleStatus

      Returns ModuleStatus

    • set status(value: ModuleStatus): void

      Parameters

      Returns void

    • get storeParentReads(): boolean

      Returns boolean

    • get timestamp(): boolean

      Returns boolean

    • get defaultNextLimit(): number

      Returns number

    • get historyInterval(): number

      Returns number

    • set historyInterval(value: number): void

      Parameters

      • value: number

      Returns void

    • get historyTime(): number

      Returns number

    • set historyTime(value: number): void

      Parameters

      • value: number

      Returns void

    • get maxGcFrequency(): number

      Returns number

    • set maxGcFrequency(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

    • Returns Promise<
          | undefined
          | ArchivistInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ArchivistConfig>;
                  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,
          >,
      >

    • Parameters

      • required: true

      Returns Promise<
          ArchivistInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ArchivistConfig>;
                  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,
          >,
      >

    • Type Parameters

      • R

      Parameters

      • closure: () => Promise<R>

      Returns Promise<R>

    • Returns Promise<void>

    • Parameters

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

      Returns void

    • Parameters

      • hashes: Lowercase<string>[]

      Returns Promise<Lowercase<string>[]>

    • Parameters

      Returns Promise<Lowercase<string>[]>

    • Parameters

      • Optional_maxDepth: number

      Returns Promisable<Payload[]>

    • Returns Promise<
          | undefined
          | ArchivistInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ArchivistConfig>;
                  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,
          >,
      >

      use archivistInstance() instead

    • Parameters

      • schema: string

      Returns boolean

    • Parameters

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

      Returns number

    • Parameters

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

      Returns Promise<ModuleManifestPayload>

    • Returns Promise<ArchivistParentInstanceMap>

    • Returns Promisable<
          NodeInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<NodeConfig>;
                  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<
          ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig>;
                  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>;
                  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

      • address: Lowercase<string>

      Returns void

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

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

    • Type Parameters

      • T extends ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>;
                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[]>

    • Type Parameters

      • T extends ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>;
                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>

    • Returns Promise<
          ArchivistInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ArchivistConfig>;
                  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,
          >[],
      >

    • Type Parameters

      • T extends ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>;
                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[]>

    • Type Parameters

      • T extends ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>;
                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>

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

      • Optional_timeout: number

      Returns Promisable<boolean>

    • Parameters

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

      Returns Promise<boolean>

    • Parameters

      • Optional_timeout: number

      Returns Promise<boolean>

    • Parameters

      • Optional_timeout: number

      Returns Promisable<boolean>

    • Returns void

    • 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

    • Type Parameters

      • TModule extends AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>

    • Type Parameters

      • TModule extends AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                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>

    • Parameters

      • Optionalforce: boolean

      Returns void

    • Parameters

      • className: string

      Returns void

    • Parameters

      • className: string

      Returns number

    • Returns Record<string, number>

    • Returns void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    _checkDead_getRootFunction_noOverrideaddParentallallHandlerallQueryarchivistInstancebindHashesbindHashesInternalbindQuerybindQueryInternalbindQueryResultbusycertifyParentsclearclearHandlerclearListenersclearQuerycommitcommitHandlercommitQuerydeletedeleteHandlerdeleteQuerydeleteWithConfigemitemitSerialgenerateConfigAndAddressgenerateDescribegetgetArchivistgetFromParentgetFromParentsgetHandlergetQuerygetWithConfiginsertinsertHandlerinsertQueryinsertQueryHandlerinsertWithConfigisAllowedArchivingQuerylistenerCountmanifestmanifestHandlermanifestQuerymoduleAddressmoduleAddressHandlernextnextHandlernextQuerynextWithConfigoffoffAnyononAnyonceparentArchivistsparentspreviousHashprivateChildrenpublicChildrenqueryqueryablequeryHandlerremoveParentresolveresolveArchivingArchivistsresolveIdentifierresolvePrivatesendQuerysendQueryRawsiblingsstartstartedstartHandlerstatestateHandlerstateQuerystopstopHandlerstoreToArchivistssubscribesubscribeHandlervalidateConfigwriteToParentwriteToParents_getRootFunction_noOverridecreatedetermineAccountfactorygcinstanceCountinstanceCountsstartHistorystopHistory