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

    Class AsyncQueryBusClient<TParams>

    Type Parameters

    Hierarchy

    • AsyncQueryBusBase<TParams>
      • AsyncQueryBusClient
    Index

    Constructors

    constructor

    Properties

    _lastState? _queryCache? _targetConfigs _targetQueries defaultLogger? globalInstances globalInstancesCountHistory uniqueName

    Accessors

    config lastState logger params pollFrequency queryCache queryCacheConfig rootModule started historyInterval historyTime maxGcFrequency maxHistoryDepth

    Methods

    commitState listeningAddresses queriesArchivist queriesDiviner responsesArchivist responsesDiviner retrieveState send gc instanceCount instanceCounts startHistory stopHistory

    Constructors

    Properties

    Protected Optional_lastState

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

    Protected Optional_queryCache

    _queryCache?: LRUCache<
        Lowercase<string>,
        "pending" | ModuleQueryResult,
        unknown,
    >

    Protected_targetConfigs

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

    Protected_targetQueries

    _targetQueries: Record<Lowercase<string>, string[]> = {}
    defaultLogger?: Logger
    globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>
    globalInstancesCountHistory: Record<string, number[]>
    uniqueName: string

    Accessors

    • get logger(): undefined | Logger

      Returns undefined | Logger

    • get params(): TParams

      Returns TParams

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

    • 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

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

      Parameters

      • address: Lowercase<string>

        The module address to commit the state for

      • nextState: Lowercase<string>

        The state to commit

      Returns Promise<void>

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

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

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

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

    • 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