@xyo-network/diviner-indexing-memory 5.2.18 → 5.2.20

package/dist/neutral/index.mjs

@@ -15,9 +15,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 var __superGet = (cls, obj, key) => __reflectGet(__getProtoOf(cls), key, obj);
 
 // src/Diviner.ts
-import { assertEx } from "@xylabs/assert";
+import {
+  assertEx,
+  isString
+} from "@xylabs/sdk-js";
 import { clearTimeoutEx, setTimeoutEx } from "@xylabs/timer";
-import { isString } from "@xylabs/typeof";
 import { ArchivistWrapper } from "@xyo-network/archivist-wrapper";
 import { BoundWitnessBuilder } from "@xyo-network/boundwitness-builder";
 import { isBoundWitness } from "@xyo-network/boundwitness-model";

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Diviner.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { clearTimeoutEx, setTimeoutEx } from '@xylabs/timer'\nimport { isString } from '@xylabs/typeof'\nimport { ArchivistWrapper } from '@xyo-network/archivist-wrapper'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { BoundWitnessDivinerQueryPayload, BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'\nimport {\n  IndexingDivinerConfig,\n  IndexingDivinerConfigSchema,\n  IndexingDivinerParams,\n  IndexingDivinerStage,\n  IndexingDivinerState,\n} from '@xyo-network/diviner-indexing-model'\nimport {\n  asDivinerInstance, DivinerInstance, DivinerModuleEventData,\n} from '@xyo-network/diviner-model'\nimport { DivinerWrapper } from '@xyo-network/diviner-wrapper'\nimport {\n  creatableModule, isModuleState, ModuleState, ModuleStateSchema,\n} from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport {\n  Payload, Schema, SequenceConstants, WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nexport type ConfigStoreKey = 'indexStore' | 'stateStore'\n\nexport type ConfigStore = Extract<keyof IndexingDivinerConfig, ConfigStoreKey>\n\nconst moduleName = 'IndexingDiviner'\n\n@creatableModule<IndexingDiviner>()\nexport class IndexingDiviner<\n  TParams extends IndexingDivinerParams = IndexingDivinerParams,\n  TIn extends Payload = Payload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly allowRandomAccount = true\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, IndexingDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = IndexingDivinerConfigSchema\n\n  private _lastState?: ModuleState<IndexingDivinerState>\n  private _pollId?: string\n\n  get payloadDivinerLimit() {\n    return this.config.payloadDivinerLimit ?? 1000\n  }\n\n  get pollFrequency() {\n    return this.config.pollFrequency ?? 10_000\n  }\n\n  /**\n   * Works via batched iteration of the source archivist to populate the index.\n   * @returns A promise that resolves when the background process is complete\n   */\n  protected backgroundDivine = async (): Promise<void> => {\n    // Load last state\n    const lastState = await this.retrieveState()\n    // Get next batch of results\n    const indexCandidateDiviner = await this.getIndexingDivinerStage('stateToIndexCandidateDiviner')\n    const results = lastState ? await indexCandidateDiviner.divine([lastState]) : await indexCandidateDiviner.divine()\n    // Filter next state out from results\n    const nextState = results.find(isModuleState<IndexingDivinerState>)\n    const indexCandidates = results.filter(x => !isModuleState(x))\n    // Transform candidates to indexes\n    const toIndexTransformDiviner = await this.getIndexingDivinerStage('indexCandidateToIndexDiviner')\n    const indexes = await toIndexTransformDiviner.divine(indexCandidates)\n    // Insert index results\n    const indexArchivist = await this.getArchivistForStore('indexStore')\n    await indexArchivist.insert(indexes)\n    // Update state\n    if (nextState) {\n      await this.commitState(nextState)\n    }\n  }\n\n  /**\n   * Commit the internal state of the Diviner process. This is similar\n   * to a transaction completion in a database and should only be called\n   * when results have been successfully persisted to the appropriate\n   * external stores.\n   * @param nextState The state to commit\n   */\n  protected async commitState(nextState: ModuleState<IndexingDivinerState>) {\n    // Don't commit state if no state has changed\n    if (nextState.state.cursor === this._lastState?.state.cursor) return\n    this._lastState = nextState\n    const archivist = await this.getArchivistForStore('stateStore')\n    const [bw] = await new BoundWitnessBuilder().payload(nextState).signer(this.account).build()\n    await archivist.insert([bw, nextState])\n  }\n\n  protected override async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const indexPayloadDiviner = await this.getPayloadDivinerForStore('indexStore')\n    const divinerQueryToIndexQueryDiviner = await this.getIndexingDivinerStage('divinerQueryToIndexQueryDiviner')\n    const indexQueryResponseToDivinerQueryResponseDiviner = await this.getIndexingDivinerStage('indexQueryResponseToDivinerQueryResponseDiviner')\n    const results = (\n      await Promise.all(\n        payloads.map(async (payload) => {\n          const indexQuery = await divinerQueryToIndexQueryDiviner.divine([payload])\n          // Divine the results\n          const indexedResults = await indexPayloadDiviner.divine(indexQuery)\n          // Transform the results to the response shape\n          const response = await Promise.all(\n            indexedResults.flat().map(indexedResult => indexQueryResponseToDivinerQueryResponseDiviner.divine([payload, indexedResult])),\n          )\n          return response.flat()\n        }),\n      )\n    ).flat()\n    // TODO: Infer this type over casting to this type\n    return results as TOut[]\n  }\n\n  /**\n   * Retrieves the archivist for the specified store\n   * @param store The store to retrieve the archivist for\n   * @returns The archivist for the specified store\n   */\n  protected async getArchivistForStore(store: ConfigStore): Promise<ArchivistWrapper> {\n    const name = assertEx(this.config?.[store]?.archivist, () => `${moduleName}: Config for ${store}.archivist not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.archivist [${name}]`)\n    return ArchivistWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Retrieves the BoundWitness Diviner for the specified store\n   * @param store The store to retrieve the BoundWitness Diviner for\n   * @returns The BoundWitness Diviner for the specified store\n   */\n  protected async getBoundWitnessDivinerForStore(store: ConfigStore) {\n    const name = assertEx(this.config?.[store]?.boundWitnessDiviner, () => `${moduleName}: Config for ${store}.boundWitnessDiviner not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.boundWitnessDiviner [${name}]`)\n    return DivinerWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Gets the Diviner for the supplied Indexing Diviner stage\n   * @param transform The Indexing Diviner stage\n   * @returns The diviner corresponding to the Indexing Diviner stage\n   */\n  protected async getIndexingDivinerStage(transform: IndexingDivinerStage) {\n    const nameOrAddress = assertEx(\n      this.config?.indexingDivinerStages?.[transform],\n      () => `${moduleName}: Config for indexingDivinerStages.${transform} not specified`,\n    )\n    const mod = await this.resolve(nameOrAddress)\n    return assertEx(asDivinerInstance(mod), () => `${moduleName}: Failed to resolve indexing diviner stage for ${transform}`) as DivinerInstance\n  }\n\n  /**\n   * Retrieves the Payload Diviner for the specified store\n   * @param store The store to retrieve the Payload Diviner for\n   * @returns The Payload Diviner for the specified store\n   */\n  protected async getPayloadDivinerForStore(store: ConfigStore) {\n    const name = assertEx(this.config?.[store]?.payloadDiviner, () => `${moduleName}: Config for ${store}.payloadDiviner not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.payloadDiviner [${name}]`)\n    return DivinerWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Retrieves the last state of the Diviner process. Used to recover state after\n   * preemptions, reboots, etc.\n   */\n  protected async retrieveState(): Promise<ModuleState<IndexingDivinerState> | undefined> {\n    const accountAddress = this.account.address\n    if (this._lastState) return this._lastState\n    let hash = '' as Hash\n    const diviner = await this.getBoundWitnessDivinerForStore('stateStore')\n    const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })\n      .fields({\n        address: accountAddress,\n        limit: 1,\n        cursor: SequenceConstants.minLocalSequence,\n        order: 'desc',\n        payload_schemas: [ModuleStateSchema],\n      })\n      .build()\n    const boundWitnesses = await diviner.divine([query])\n    if (boundWitnesses.length > 0) {\n      const boundWitness = boundWitnesses[0]\n      if (isBoundWitness(boundWitness)) {\n        // Find the index for this address in the BoundWitness that is a ModuleState\n        hash = boundWitness.addresses\n          .map((address, index) => ({ address, index }))\n          .filter(({ address }) => address === accountAddress)\n          // eslint-disable-next-line unicorn/no-array-reduce\n          .reduce(\n            (prev, curr) => (boundWitness.payload_schemas?.[curr?.index] === ModuleStateSchema ? boundWitness.payload_hashes[curr?.index] : prev),\n            '' as Hash,\n          )\n      }\n    }\n\n    // If we able to located the last state\n    if (hash !== '') {\n      // Get last state\n      const archivist = await this.getArchivistForStore('stateStore')\n      const payload = (await archivist.get([hash])).find(isModuleState<IndexingDivinerState>)\n      if (payload) {\n        return payload as WithStorageMeta<ModuleState<IndexingDivinerState>>\n      }\n    }\n    return undefined\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    this.poll()\n  }\n\n  protected override async stopHandler(_timeout?: number | undefined) {\n    if (isString(this._pollId)) {\n      clearTimeout(this._pollId)\n      this._pollId = undefined\n    }\n    await super.stopHandler()\n  }\n\n  /**\n   * Runs the background divine process on a loop with a delay\n   * specified by the `config.pollFrequency`\n   */\n  private poll() {\n    this._pollId = setTimeoutEx(async () => {\n      try {\n        await Promise.resolve()\n        await this.backgroundDivine()\n      } catch (e) {\n        console.log(e)\n      } finally {\n        if (this._pollId) clearTimeoutEx(this._pollId)\n        this._pollId = undefined\n        this.poll()\n      }\n    }, this.pollFrequency)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,SAAS,gBAAgB;AAEzB,SAAS,gBAAgB,oBAAoB;AAC7C,SAAS,gBAAgB;AACzB,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,sBAAsB;AAC/B,SAAS,uBAAuB;AAChC,SAA0C,sCAAsC;AAChF;AAAA,EAEE;AAAA,OAIK;AACP;AAAA,EACE;AAAA,OACK;AACP,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EAAiB;AAAA,EAA4B;AAAA,OACxC;AACP,SAAS,sBAAsB;AAC/B;AAAA,EACmB;AAAA,OACZ;AAMP,IAAM,aAAa;AAGZ,IAAM,kBAAN,cASG,gBAAgD;AAAA,EAKhD;AAAA,EACA;AAAA,EAER,IAAI,sBAAsB;AACxB,WAAO,KAAK,OAAO,uBAAuB;AAAA,EAC5C;AAAA,EAEA,IAAI,gBAAgB;AAClB,WAAO,KAAK,OAAO,iBAAiB;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,mBAAmB,YAA2B;AAEtD,UAAM,YAAY,MAAM,KAAK,cAAc;AAE3C,UAAM,wBAAwB,MAAM,KAAK,wBAAwB,8BAA8B;AAC/F,UAAM,UAAU,YAAY,MAAM,sBAAsB,OAAO,CAAC,SAAS,CAAC,IAAI,MAAM,sBAAsB,OAAO;AAEjH,UAAM,YAAY,QAAQ,KAAK,aAAmC;AAClE,UAAM,kBAAkB,QAAQ,OAAO,OAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,UAAM,0BAA0B,MAAM,KAAK,wBAAwB,8BAA8B;AACjG,UAAM,UAAU,MAAM,wBAAwB,OAAO,eAAe;AAEpE,UAAM,iBAAiB,MAAM,KAAK,qBAAqB,YAAY;AACnE,UAAM,eAAe,OAAO,OAAO;AAEnC,QAAI,WAAW;AACb,YAAM,KAAK,YAAY,SAAS;AAAA,IAClC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAgB,YAAY,WAA8C;AAExE,QAAI,UAAU,MAAM,WAAW,KAAK,YAAY,MAAM,OAAQ;AAC9D,SAAK,aAAa;AAClB,UAAM,YAAY,MAAM,KAAK,qBAAqB,YAAY;AAC9D,UAAM,CAAC,EAAE,IAAI,MAAM,IAAI,oBAAoB,EAAE,QAAQ,SAAS,EAAE,OAAO,KAAK,OAAO,EAAE,MAAM;AAC3F,UAAM,UAAU,OAAO,CAAC,IAAI,SAAS,CAAC;AAAA,EACxC;AAAA,EAEA,MAAyB,cAAc,WAAkB,CAAC,GAAoB;AAC5E,UAAM,sBAAsB,MAAM,KAAK,0BAA0B,YAAY;AAC7E,UAAM,kCAAkC,MAAM,KAAK,wBAAwB,iCAAiC;AAC5G,UAAM,kDAAkD,MAAM,KAAK,wBAAwB,iDAAiD;AAC5I,UAAM,WACJ,MAAM,QAAQ;AAAA,MACZ,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,aAAa,MAAM,gCAAgC,OAAO,CAAC,OAAO,CAAC;AAEzE,cAAM,iBAAiB,MAAM,oBAAoB,OAAO,UAAU;AAElE,cAAM,WAAW,MAAM,QAAQ;AAAA,UAC7B,eAAe,KAAK,EAAE,IAAI,mBAAiB,gDAAgD,OAAO,CAAC,SAAS,aAAa,CAAC,CAAC;AAAA,QAC7H;AACA,eAAO,SAAS,KAAK;AAAA,MACvB,CAAC;AAAA,IACH,GACA,KAAK;AAEP,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,qBAAqB,OAA+C;AAClF,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,WAAW,MAAM,GAAG,UAAU,gBAAgB,KAAK,0BAA0B;AACzH,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,eAAe,IAAI,GAAG;AACpH,WAAO,iBAAiB,KAAK,KAAK,KAAK,OAAO;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,+BAA+B,OAAoB;AACjE,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,qBAAqB,MAAM,GAAG,UAAU,gBAAgB,KAAK,oCAAoC;AAC7I,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,yBAAyB,IAAI,GAAG;AAC9H,WAAO,eAAe,KAAK,KAAK,KAAK,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,wBAAwB,WAAiC;AACvE,UAAM,gBAAgB;AAAA,MACpB,KAAK,QAAQ,wBAAwB,SAAS;AAAA,MAC9C,MAAM,GAAG,UAAU,sCAAsC,SAAS;AAAA,IACpE;AACA,UAAM,MAAM,MAAM,KAAK,QAAQ,aAAa;AAC5C,WAAO,SAAS,kBAAkB,GAAG,GAAG,MAAM,GAAG,UAAU,kDAAkD,SAAS,EAAE;AAAA,EAC1H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,0BAA0B,OAAoB;AAC5D,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,gBAAgB,MAAM,GAAG,UAAU,gBAAgB,KAAK,+BAA+B;AACnI,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,oBAAoB,IAAI,GAAG;AACzH,WAAO,eAAe,KAAK,KAAK,KAAK,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,gBAAwE;AACtF,UAAM,iBAAiB,KAAK,QAAQ;AACpC,QAAI,KAAK,WAAY,QAAO,KAAK;AACjC,QAAI,OAAO;AACX,UAAM,UAAU,MAAM,KAAK,+BAA+B,YAAY;AACtE,UAAM,QAAQ,IAAI,eAAgD,EAAE,QAAQ,+BAA+B,CAAC,EACzG,OAAO;AAAA,MACN,SAAS;AAAA,MACT,OAAO;AAAA,MACP,QAAQ,kBAAkB;AAAA,MAC1B,OAAO;AAAA,MACP,iBAAiB,CAAC,iBAAiB;AAAA,IACrC,CAAC,EACA,MAAM;AACT,UAAM,iBAAiB,MAAM,QAAQ,OAAO,CAAC,KAAK,CAAC;AACnD,QAAI,eAAe,SAAS,GAAG;AAC7B,YAAM,eAAe,eAAe,CAAC;AACrC,UAAI,eAAe,YAAY,GAAG;AAEhC,eAAO,aAAa,UACjB,IAAI,CAAC,SAAS,WAAW,EAAE,SAAS,MAAM,EAAE,EAC5C,OAAO,CAAC,EAAE,QAAQ,MAAM,YAAY,cAAc,EAElD;AAAA,UACC,CAAC,MAAM,SAAU,aAAa,kBAAkB,MAAM,KAAK,MAAM,oBAAoB,aAAa,eAAe,MAAM,KAAK,IAAI;AAAA,UAChI;AAAA,QACF;AAAA,MACJ;AAAA,IACF;AAGA,QAAI,SAAS,IAAI;AAEf,YAAM,YAAY,MAAM,KAAK,qBAAqB,YAAY;AAC9D,YAAM,WAAW,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,aAAmC;AACtF,UAAI,SAAS;AACX,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AACzB,SAAK,KAAK;AAAA,EACZ;AAAA,EAEA,MAAyB,YAAY,UAA+B;AAClE,QAAI,SAAS,KAAK,OAAO,GAAG;AAC1B,mBAAa,KAAK,OAAO;AACzB,WAAK,UAAU;AAAA,IACjB;AACA,UAAM,MAAM,YAAY;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,OAAO;AACb,SAAK,UAAU,aAAa,YAAY;AACtC,UAAI;AACF,cAAM,QAAQ,QAAQ;AACtB,cAAM,KAAK,iBAAiB;AAAA,MAC9B,SAAS,GAAG;AACV,gBAAQ,IAAI,CAAC;AAAA,MACf,UAAE;AACA,YAAI,KAAK,QAAS,gBAAe,KAAK,OAAO;AAC7C,aAAK,UAAU;AACf,aAAK,KAAK;AAAA,MACZ;AAAA,IACF,GAAG,KAAK,aAAa;AAAA,EACvB;AACF;AA1ME,cAVW,iBAUc,sBAAqB;AAC9C,cAXW,iBAWc,iBAA0B,CAAC,GAAG,6CAAM,kBAAe,2BAA2B;AACvG,cAZW,iBAYc,uBAA8B;AAZ5C,kBAAN;AAAA,EADN,gBAAiC;AAAA,GACrB;","names":[]}
+{"version":3,"sources":["../../src/Diviner.ts"],"sourcesContent":["import {\n  assertEx, Hash, isString,\n} from '@xylabs/sdk-js'\nimport { clearTimeoutEx, setTimeoutEx } from '@xylabs/timer'\nimport { ArchivistWrapper } from '@xyo-network/archivist-wrapper'\nimport { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport { AbstractDiviner } from '@xyo-network/diviner-abstract'\nimport { BoundWitnessDivinerQueryPayload, BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'\nimport {\n  IndexingDivinerConfig,\n  IndexingDivinerConfigSchema,\n  IndexingDivinerParams,\n  IndexingDivinerStage,\n  IndexingDivinerState,\n} from '@xyo-network/diviner-indexing-model'\nimport {\n  asDivinerInstance, DivinerInstance, DivinerModuleEventData,\n} from '@xyo-network/diviner-model'\nimport { DivinerWrapper } from '@xyo-network/diviner-wrapper'\nimport {\n  creatableModule, isModuleState, ModuleState, ModuleStateSchema,\n} from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport {\n  Payload, Schema, SequenceConstants, WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nexport type ConfigStoreKey = 'indexStore' | 'stateStore'\n\nexport type ConfigStore = Extract<keyof IndexingDivinerConfig, ConfigStoreKey>\n\nconst moduleName = 'IndexingDiviner'\n\n@creatableModule<IndexingDiviner>()\nexport class IndexingDiviner<\n  TParams extends IndexingDivinerParams = IndexingDivinerParams,\n  TIn extends Payload = Payload,\n  TOut extends Payload = Payload,\n  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n    DivinerInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {\n  static override readonly allowRandomAccount = true\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, IndexingDivinerConfigSchema]\n  static override readonly defaultConfigSchema: Schema = IndexingDivinerConfigSchema\n\n  private _lastState?: ModuleState<IndexingDivinerState>\n  private _pollId?: string\n\n  get payloadDivinerLimit() {\n    return this.config.payloadDivinerLimit ?? 1000\n  }\n\n  get pollFrequency() {\n    return this.config.pollFrequency ?? 10_000\n  }\n\n  /**\n   * Works via batched iteration of the source archivist to populate the index.\n   * @returns A promise that resolves when the background process is complete\n   */\n  protected backgroundDivine = async (): Promise<void> => {\n    // Load last state\n    const lastState = await this.retrieveState()\n    // Get next batch of results\n    const indexCandidateDiviner = await this.getIndexingDivinerStage('stateToIndexCandidateDiviner')\n    const results = lastState ? await indexCandidateDiviner.divine([lastState]) : await indexCandidateDiviner.divine()\n    // Filter next state out from results\n    const nextState = results.find(isModuleState<IndexingDivinerState>)\n    const indexCandidates = results.filter(x => !isModuleState(x))\n    // Transform candidates to indexes\n    const toIndexTransformDiviner = await this.getIndexingDivinerStage('indexCandidateToIndexDiviner')\n    const indexes = await toIndexTransformDiviner.divine(indexCandidates)\n    // Insert index results\n    const indexArchivist = await this.getArchivistForStore('indexStore')\n    await indexArchivist.insert(indexes)\n    // Update state\n    if (nextState) {\n      await this.commitState(nextState)\n    }\n  }\n\n  /**\n   * Commit the internal state of the Diviner process. This is similar\n   * to a transaction completion in a database and should only be called\n   * when results have been successfully persisted to the appropriate\n   * external stores.\n   * @param nextState The state to commit\n   */\n  protected async commitState(nextState: ModuleState<IndexingDivinerState>) {\n    // Don't commit state if no state has changed\n    if (nextState.state.cursor === this._lastState?.state.cursor) return\n    this._lastState = nextState\n    const archivist = await this.getArchivistForStore('stateStore')\n    const [bw] = await new BoundWitnessBuilder().payload(nextState).signer(this.account).build()\n    await archivist.insert([bw, nextState])\n  }\n\n  protected override async divineHandler(payloads: TIn[] = []): Promise<TOut[]> {\n    const indexPayloadDiviner = await this.getPayloadDivinerForStore('indexStore')\n    const divinerQueryToIndexQueryDiviner = await this.getIndexingDivinerStage('divinerQueryToIndexQueryDiviner')\n    const indexQueryResponseToDivinerQueryResponseDiviner = await this.getIndexingDivinerStage('indexQueryResponseToDivinerQueryResponseDiviner')\n    const results = (\n      await Promise.all(\n        payloads.map(async (payload) => {\n          const indexQuery = await divinerQueryToIndexQueryDiviner.divine([payload])\n          // Divine the results\n          const indexedResults = await indexPayloadDiviner.divine(indexQuery)\n          // Transform the results to the response shape\n          const response = await Promise.all(\n            indexedResults.flat().map(indexedResult => indexQueryResponseToDivinerQueryResponseDiviner.divine([payload, indexedResult])),\n          )\n          return response.flat()\n        }),\n      )\n    ).flat()\n    // TODO: Infer this type over casting to this type\n    return results as TOut[]\n  }\n\n  /**\n   * Retrieves the archivist for the specified store\n   * @param store The store to retrieve the archivist for\n   * @returns The archivist for the specified store\n   */\n  protected async getArchivistForStore(store: ConfigStore): Promise<ArchivistWrapper> {\n    const name = assertEx(this.config?.[store]?.archivist, () => `${moduleName}: Config for ${store}.archivist not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.archivist [${name}]`)\n    return ArchivistWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Retrieves the BoundWitness Diviner for the specified store\n   * @param store The store to retrieve the BoundWitness Diviner for\n   * @returns The BoundWitness Diviner for the specified store\n   */\n  protected async getBoundWitnessDivinerForStore(store: ConfigStore) {\n    const name = assertEx(this.config?.[store]?.boundWitnessDiviner, () => `${moduleName}: Config for ${store}.boundWitnessDiviner not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.boundWitnessDiviner [${name}]`)\n    return DivinerWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Gets the Diviner for the supplied Indexing Diviner stage\n   * @param transform The Indexing Diviner stage\n   * @returns The diviner corresponding to the Indexing Diviner stage\n   */\n  protected async getIndexingDivinerStage(transform: IndexingDivinerStage) {\n    const nameOrAddress = assertEx(\n      this.config?.indexingDivinerStages?.[transform],\n      () => `${moduleName}: Config for indexingDivinerStages.${transform} not specified`,\n    )\n    const mod = await this.resolve(nameOrAddress)\n    return assertEx(asDivinerInstance(mod), () => `${moduleName}: Failed to resolve indexing diviner stage for ${transform}`) as DivinerInstance\n  }\n\n  /**\n   * Retrieves the Payload Diviner for the specified store\n   * @param store The store to retrieve the Payload Diviner for\n   * @returns The Payload Diviner for the specified store\n   */\n  protected async getPayloadDivinerForStore(store: ConfigStore) {\n    const name = assertEx(this.config?.[store]?.payloadDiviner, () => `${moduleName}: Config for ${store}.payloadDiviner not specified`)\n    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve ${store}.payloadDiviner [${name}]`)\n    return DivinerWrapper.wrap(mod, this.account)\n  }\n\n  /**\n   * Retrieves the last state of the Diviner process. Used to recover state after\n   * preemptions, reboots, etc.\n   */\n  protected async retrieveState(): Promise<ModuleState<IndexingDivinerState> | undefined> {\n    const accountAddress = this.account.address\n    if (this._lastState) return this._lastState\n    let hash = '' as Hash\n    const diviner = await this.getBoundWitnessDivinerForStore('stateStore')\n    const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })\n      .fields({\n        address: accountAddress,\n        limit: 1,\n        cursor: SequenceConstants.minLocalSequence,\n        order: 'desc',\n        payload_schemas: [ModuleStateSchema],\n      })\n      .build()\n    const boundWitnesses = await diviner.divine([query])\n    if (boundWitnesses.length > 0) {\n      const boundWitness = boundWitnesses[0]\n      if (isBoundWitness(boundWitness)) {\n        // Find the index for this address in the BoundWitness that is a ModuleState\n        hash = boundWitness.addresses\n          .map((address, index) => ({ address, index }))\n          .filter(({ address }) => address === accountAddress)\n          // eslint-disable-next-line unicorn/no-array-reduce\n          .reduce(\n            (prev, curr) => (boundWitness.payload_schemas?.[curr?.index] === ModuleStateSchema ? boundWitness.payload_hashes[curr?.index] : prev),\n            '' as Hash,\n          )\n      }\n    }\n\n    // If we able to located the last state\n    if (hash !== '') {\n      // Get last state\n      const archivist = await this.getArchivistForStore('stateStore')\n      const payload = (await archivist.get([hash])).find(isModuleState<IndexingDivinerState>)\n      if (payload) {\n        return payload as WithStorageMeta<ModuleState<IndexingDivinerState>>\n      }\n    }\n    return undefined\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    this.poll()\n  }\n\n  protected override async stopHandler(_timeout?: number | undefined) {\n    if (isString(this._pollId)) {\n      clearTimeout(this._pollId)\n      this._pollId = undefined\n    }\n    await super.stopHandler()\n  }\n\n  /**\n   * Runs the background divine process on a loop with a delay\n   * specified by the `config.pollFrequency`\n   */\n  private poll() {\n    this._pollId = setTimeoutEx(async () => {\n      try {\n        await Promise.resolve()\n        await this.backgroundDivine()\n      } catch (e) {\n        console.log(e)\n      } finally {\n        if (this._pollId) clearTimeoutEx(this._pollId)\n        this._pollId = undefined\n        this.poll()\n      }\n    }, this.pollFrequency)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA,EACE;AAAA,EAAgB;AAAA,OACX;AACP,SAAS,gBAAgB,oBAAoB;AAC7C,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,sBAAsB;AAC/B,SAAS,uBAAuB;AAChC,SAA0C,sCAAsC;AAChF;AAAA,EAEE;AAAA,OAIK;AACP;AAAA,EACE;AAAA,OACK;AACP,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EAAiB;AAAA,EAA4B;AAAA,OACxC;AACP,SAAS,sBAAsB;AAC/B;AAAA,EACmB;AAAA,OACZ;AAMP,IAAM,aAAa;AAGZ,IAAM,kBAAN,cASG,gBAAgD;AAAA,EAKhD;AAAA,EACA;AAAA,EAER,IAAI,sBAAsB;AACxB,WAAO,KAAK,OAAO,uBAAuB;AAAA,EAC5C;AAAA,EAEA,IAAI,gBAAgB;AAClB,WAAO,KAAK,OAAO,iBAAiB;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,mBAAmB,YAA2B;AAEtD,UAAM,YAAY,MAAM,KAAK,cAAc;AAE3C,UAAM,wBAAwB,MAAM,KAAK,wBAAwB,8BAA8B;AAC/F,UAAM,UAAU,YAAY,MAAM,sBAAsB,OAAO,CAAC,SAAS,CAAC,IAAI,MAAM,sBAAsB,OAAO;AAEjH,UAAM,YAAY,QAAQ,KAAK,aAAmC;AAClE,UAAM,kBAAkB,QAAQ,OAAO,OAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,UAAM,0BAA0B,MAAM,KAAK,wBAAwB,8BAA8B;AACjG,UAAM,UAAU,MAAM,wBAAwB,OAAO,eAAe;AAEpE,UAAM,iBAAiB,MAAM,KAAK,qBAAqB,YAAY;AACnE,UAAM,eAAe,OAAO,OAAO;AAEnC,QAAI,WAAW;AACb,YAAM,KAAK,YAAY,SAAS;AAAA,IAClC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAgB,YAAY,WAA8C;AAExE,QAAI,UAAU,MAAM,WAAW,KAAK,YAAY,MAAM,OAAQ;AAC9D,SAAK,aAAa;AAClB,UAAM,YAAY,MAAM,KAAK,qBAAqB,YAAY;AAC9D,UAAM,CAAC,EAAE,IAAI,MAAM,IAAI,oBAAoB,EAAE,QAAQ,SAAS,EAAE,OAAO,KAAK,OAAO,EAAE,MAAM;AAC3F,UAAM,UAAU,OAAO,CAAC,IAAI,SAAS,CAAC;AAAA,EACxC;AAAA,EAEA,MAAyB,cAAc,WAAkB,CAAC,GAAoB;AAC5E,UAAM,sBAAsB,MAAM,KAAK,0BAA0B,YAAY;AAC7E,UAAM,kCAAkC,MAAM,KAAK,wBAAwB,iCAAiC;AAC5G,UAAM,kDAAkD,MAAM,KAAK,wBAAwB,iDAAiD;AAC5I,UAAM,WACJ,MAAM,QAAQ;AAAA,MACZ,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,aAAa,MAAM,gCAAgC,OAAO,CAAC,OAAO,CAAC;AAEzE,cAAM,iBAAiB,MAAM,oBAAoB,OAAO,UAAU;AAElE,cAAM,WAAW,MAAM,QAAQ;AAAA,UAC7B,eAAe,KAAK,EAAE,IAAI,mBAAiB,gDAAgD,OAAO,CAAC,SAAS,aAAa,CAAC,CAAC;AAAA,QAC7H;AACA,eAAO,SAAS,KAAK;AAAA,MACvB,CAAC;AAAA,IACH,GACA,KAAK;AAEP,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,qBAAqB,OAA+C;AAClF,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,WAAW,MAAM,GAAG,UAAU,gBAAgB,KAAK,0BAA0B;AACzH,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,eAAe,IAAI,GAAG;AACpH,WAAO,iBAAiB,KAAK,KAAK,KAAK,OAAO;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,+BAA+B,OAAoB;AACjE,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,qBAAqB,MAAM,GAAG,UAAU,gBAAgB,KAAK,oCAAoC;AAC7I,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,yBAAyB,IAAI,GAAG;AAC9H,WAAO,eAAe,KAAK,KAAK,KAAK,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,wBAAwB,WAAiC;AACvE,UAAM,gBAAgB;AAAA,MACpB,KAAK,QAAQ,wBAAwB,SAAS;AAAA,MAC9C,MAAM,GAAG,UAAU,sCAAsC,SAAS;AAAA,IACpE;AACA,UAAM,MAAM,MAAM,KAAK,QAAQ,aAAa;AAC5C,WAAO,SAAS,kBAAkB,GAAG,GAAG,MAAM,GAAG,UAAU,kDAAkD,SAAS,EAAE;AAAA,EAC1H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,0BAA0B,OAAoB;AAC5D,UAAM,OAAO,SAAS,KAAK,SAAS,KAAK,GAAG,gBAAgB,MAAM,GAAG,UAAU,gBAAgB,KAAK,+BAA+B;AACnI,UAAM,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,GAAG,MAAM,GAAG,UAAU,uBAAuB,KAAK,oBAAoB,IAAI,GAAG;AACzH,WAAO,eAAe,KAAK,KAAK,KAAK,OAAO;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,gBAAwE;AACtF,UAAM,iBAAiB,KAAK,QAAQ;AACpC,QAAI,KAAK,WAAY,QAAO,KAAK;AACjC,QAAI,OAAO;AACX,UAAM,UAAU,MAAM,KAAK,+BAA+B,YAAY;AACtE,UAAM,QAAQ,IAAI,eAAgD,EAAE,QAAQ,+BAA+B,CAAC,EACzG,OAAO;AAAA,MACN,SAAS;AAAA,MACT,OAAO;AAAA,MACP,QAAQ,kBAAkB;AAAA,MAC1B,OAAO;AAAA,MACP,iBAAiB,CAAC,iBAAiB;AAAA,IACrC,CAAC,EACA,MAAM;AACT,UAAM,iBAAiB,MAAM,QAAQ,OAAO,CAAC,KAAK,CAAC;AACnD,QAAI,eAAe,SAAS,GAAG;AAC7B,YAAM,eAAe,eAAe,CAAC;AACrC,UAAI,eAAe,YAAY,GAAG;AAEhC,eAAO,aAAa,UACjB,IAAI,CAAC,SAAS,WAAW,EAAE,SAAS,MAAM,EAAE,EAC5C,OAAO,CAAC,EAAE,QAAQ,MAAM,YAAY,cAAc,EAElD;AAAA,UACC,CAAC,MAAM,SAAU,aAAa,kBAAkB,MAAM,KAAK,MAAM,oBAAoB,aAAa,eAAe,MAAM,KAAK,IAAI;AAAA,UAChI;AAAA,QACF;AAAA,MACJ;AAAA,IACF;AAGA,QAAI,SAAS,IAAI;AAEf,YAAM,YAAY,MAAM,KAAK,qBAAqB,YAAY;AAC9D,YAAM,WAAW,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,aAAmC;AACtF,UAAI,SAAS;AACX,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AACzB,SAAK,KAAK;AAAA,EACZ;AAAA,EAEA,MAAyB,YAAY,UAA+B;AAClE,QAAI,SAAS,KAAK,OAAO,GAAG;AAC1B,mBAAa,KAAK,OAAO;AACzB,WAAK,UAAU;AAAA,IACjB;AACA,UAAM,MAAM,YAAY;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,OAAO;AACb,SAAK,UAAU,aAAa,YAAY;AACtC,UAAI;AACF,cAAM,QAAQ,QAAQ;AACtB,cAAM,KAAK,iBAAiB;AAAA,MAC9B,SAAS,GAAG;AACV,gBAAQ,IAAI,CAAC;AAAA,MACf,UAAE;AACA,YAAI,KAAK,QAAS,gBAAe,KAAK,OAAO;AAC7C,aAAK,UAAU;AACf,aAAK,KAAK;AAAA,MACZ;AAAA,IACF,GAAG,KAAK,aAAa;AAAA,EACvB;AACF;AA1ME,cAVW,iBAUc,sBAAqB;AAC9C,cAXW,iBAWc,iBAA0B,CAAC,GAAG,6CAAM,kBAAe,2BAA2B;AACvG,cAZW,iBAYc,uBAA8B;AAZ5C,kBAAN;AAAA,EADN,gBAAiC;AAAA,GACrB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-memory",
-  "version": "5.2.18",
+  "version": "5.2.20",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -36,28 +36,27 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.50",
-    "@xylabs/timer": "~5.0.50",
-    "@xylabs/typeof": "~5.0.50",
-    "@xyo-network/archivist-wrapper": "~5.2.18",
-    "@xyo-network/boundwitness-builder": "~5.2.18",
-    "@xyo-network/boundwitness-model": "~5.2.18",
-    "@xyo-network/diviner-abstract": "~5.2.18",
-    "@xyo-network/diviner-boundwitness-model": "~5.2.18",
-    "@xyo-network/diviner-indexing-model": "~5.2.18",
-    "@xyo-network/diviner-model": "~5.2.18",
-    "@xyo-network/diviner-wrapper": "~5.2.18",
-    "@xyo-network/module-model": "~5.2.18",
-    "@xyo-network/payload-builder": "~5.2.18",
-    "@xyo-network/payload-model": "~5.2.18"
+    "@xylabs/sdk-js": "~5.0.61",
+    "@xylabs/timer": "~5.0.61",
+    "@xyo-network/archivist-wrapper": "workspace:~",
+    "@xyo-network/boundwitness-builder": "workspace:~",
+    "@xyo-network/boundwitness-model": "workspace:~",
+    "@xyo-network/diviner-abstract": "workspace:~",
+    "@xyo-network/diviner-boundwitness-model": "workspace:~",
+    "@xyo-network/diviner-indexing-model": "workspace:~",
+    "@xyo-network/diviner-model": "workspace:~",
+    "@xyo-network/diviner-wrapper": "workspace:~",
+    "@xyo-network/module-model": "workspace:~",
+    "@xyo-network/payload-builder": "workspace:~",
+    "@xyo-network/payload-model": "workspace:~"
   },
   "devDependencies": {
-    "@xylabs/hex": "~5.0.50",
-    "@xylabs/ts-scripts-yarn3": "~7.2.8",
-    "@xylabs/tsconfig": "~7.2.8",
+    "@xylabs/sdk-js": "~5.0.61",
+    "@xylabs/ts-scripts-yarn3": "~7.2.32",
+    "@xylabs/tsconfig": "~7.2.32",
     "typescript": "~5.9.3"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Diviner.ts

@@ -1,7 +1,7 @@
-import { assertEx } from '@xylabs/assert'
-import { Hash } from '@xylabs/hex'
+import {
+  assertEx, Hash, isString,
+} from '@xylabs/sdk-js'
 import { clearTimeoutEx, setTimeoutEx } from '@xylabs/timer'
-import { isString } from '@xylabs/typeof'
 import { ArchivistWrapper } from '@xyo-network/archivist-wrapper'
 import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
 import { isBoundWitness } from '@xyo-network/boundwitness-model'