@xyo-network/diviner-stateful 5.3.22 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-stateful",
-  "version": "5.3.22",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,63 +30,59 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*",
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/archivist-wrapper": "~5.3.22",
-    "@xyo-network/boundwitness-builder": "~5.3.22",
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/diviner-abstract": "~5.3.22",
-    "@xyo-network/diviner-boundwitness-model": "~5.3.22",
-    "@xyo-network/diviner-model": "~5.3.22",
-    "@xyo-network/diviner-wrapper": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22"
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/archivist-wrapper": "~5.3.24",
+    "@xyo-network/boundwitness-builder": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/diviner-abstract": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/diviner-wrapper": "~5.3.24",
+    "@xyo-network/diviner-boundwitness-model": "~5.3.24"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.91",
-    "@xylabs/ts-scripts-common": "~7.6.8",
-    "@xylabs/ts-scripts-yarn3": "~7.6.8",
-    "@xylabs/tsconfig": "~7.6.8",
-    "@xylabs/vitest-extended": "~5.0.91",
-    "@xyo-network/archivist-memory": "~5.3.22",
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/archivist-wrapper": "~5.3.22",
-    "@xyo-network/boundwitness-builder": "~5.3.22",
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/diviner-abstract": "~5.3.22",
-    "@xyo-network/diviner-boundwitness-memory": "~5.3.22",
-    "@xyo-network/diviner-boundwitness-model": "~5.3.22",
-    "@xyo-network/diviner-model": "~5.3.22",
-    "@xyo-network/diviner-payload-generic": "~5.3.22",
-    "@xyo-network/diviner-wrapper": "~5.3.22",
-    "@xyo-network/manifest": "~5.3.22",
-    "@xyo-network/module-factory-locator": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/node-memory": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "@xyo-network/wallet": "~5.3.22",
+    "@xylabs/sdk-js": "^5.0.93",
+    "@xylabs/ts-scripts-common": "~7.6.16",
+    "@xylabs/ts-scripts-pnpm": "~7.6.16",
+    "@xylabs/tsconfig": "~7.6.16",
+    "@xylabs/vitest-extended": "~5.0.93",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
-    "cosmiconfig": "^9.0.1",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.1.0",
+    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
-    "rollup": "^4.60.1",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/archivist-memory": "~5.3.24",
+    "@xyo-network/diviner-abstract": "~5.3.24",
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/archivist-wrapper": "~5.3.24",
+    "@xyo-network/boundwitness-builder": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/diviner-payload-generic": "~5.3.24",
+    "@xyo-network/module-factory-locator": "~5.3.24",
+    "@xyo-network/diviner-wrapper": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/diviner-boundwitness-memory": "~5.3.24",
+    "@xyo-network/manifest": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/diviner-boundwitness-model": "~5.3.24",
+    "@xyo-network/node-memory": "~5.3.24",
+    "@xyo-network/wallet": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -97,4 +93,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Config.ts

@@ -1,26 +0,0 @@
-import type { DivinerConfig } from '@xyo-network/diviner-model'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-import { StatefulDivinerSchema } from './Schema.ts'
-
-/**
- * The schema for a Stateful Diviner config
- */
-export const StatefulDivinerConfigSchema = asSchema(`${StatefulDivinerSchema}.config`, true)
-/**
- * The schema for a Stateful Diviner config
- */
-export type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema
-
-/**
- * The config for a Stateful Diviner
- */
-export type StatefulDivinerConfig = DivinerConfig<{
-  schema: StatefulDivinerConfigSchema
-  stateStore: {
-    archivist: ModuleIdentifier
-    boundWitnessDiviner: ModuleIdentifier
-    payloadDiviner: ModuleIdentifier
-  }
-}>

package/src/Diviner.ts

@@ -1,140 +0,0 @@
-import type { Hash } from '@xylabs/sdk-js'
-import { assertEx, toSafeJson } from '@xylabs/sdk-js'
-import { ArchivistWrapper } from '@xyo-network/archivist-wrapper'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import { isBoundWitness } from '@xyo-network/boundwitness-model'
-import { AbstractDiviner } from '@xyo-network/diviner-abstract'
-import type { BoundWitnessDivinerQueryPayload } from '@xyo-network/diviner-boundwitness-model'
-import { BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'
-import type { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'
-import { DivinerWrapper } from '@xyo-network/diviner-wrapper'
-import type { ModuleState, StateDictionary } from '@xyo-network/module-model'
-import { isModuleState, ModuleStateSchema } from '@xyo-network/module-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type {
-  Payload, Schema,
-  WithStorageMeta,
-} from '@xyo-network/payload-model'
-import { SequenceConstants } from '@xyo-network/payload-model'
-
-import { StatefulDivinerConfigSchema } from './Config.ts'
-import type { StatefulDivinerParams } from './Params.ts'
-
-const moduleName = 'StatefulDiviner'
-
-/**
- * A Diviner that maintains state
- */
-export abstract class StatefulDiviner<
-  TParams extends StatefulDivinerParams = StatefulDivinerParams,
-  TIn extends Payload = Payload,
-  TOut extends Payload = Payload,
-  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<
-    DivinerInstance<TParams, TIn, TOut>,
-    TIn,
-    TOut
-  >,
-  TState extends StateDictionary = StateDictionary,
-> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, StatefulDivinerConfigSchema]
-  static override readonly defaultConfigSchema: Schema = StatefulDivinerConfigSchema
-
-  /**
-   * The last state
-   */
-  protected _lastState?: ModuleState<TState>
-
-  /**
-   * Commit the internal state of the Diviner 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.
-   * @param nextState The state to commit
-   */
-  protected async commitState(nextState: ModuleState<TState>) {
-    // Don't commit state if no state has changed
-    if (toSafeJson(nextState.state) === toSafeJson(this._lastState?.state)) return
-    this._lastState = nextState
-    const archivist = await this.getArchivistForStateStore()
-    const [bw] = await new BoundWitnessBuilder().payload(nextState).signer(this.account).build()
-    await archivist.insert([bw, nextState])
-  }
-
-  /**
-   * Retrieves the archivist for the specified store
-   * @param store The store to retrieve the archivist for
-   * @returns The archivist for the specified store
-   */
-  protected async getArchivistForStateStore() {
-    const name = assertEx(this.config?.stateStore?.archivist, () => `${moduleName}: Config for stateStore.archivist not specified`)
-    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.archivist`)
-    return ArchivistWrapper.wrap(mod, this.account)
-  }
-
-  /**
-   * Retrieves the BoundWitness Diviner for the specified store
-   * @param store The store to retrieve the BoundWitness Diviner for
-   * @returns The BoundWitness Diviner for the specified store
-   */
-  protected async getBoundWitnessDivinerForStateStore() {
-    const name = assertEx(this.config?.stateStore?.boundWitnessDiviner, () => `${moduleName}: Config for stateStore.boundWitnessDiviner not specified`)
-    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.boundWitnessDiviner`)
-    return DivinerWrapper.wrap(mod, this.account)
-  }
-
-  /**
-   * Retrieves the Payload Diviner for the specified store
-   * @param store The store to retrieve the Payload Diviner for
-   * @returns The Payload Diviner for the specified store
-   */
-  protected async getPayloadDivinerForStateStore() {
-    const name = assertEx(this.config?.stateStore?.payloadDiviner, () => `${moduleName}: Config for stateStore.payloadDiviner not specified`)
-    const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.payloadDiviner`)
-    return DivinerWrapper.wrap(mod, this.account)
-  }
-
-  /**
-   * Retrieves the last state of the Diviner process. Used to recover state after
-   * preemptions, reboots, etc.
-   */
-  protected async retrieveState(): Promise<ModuleState<TState> | undefined> {
-    if (this._lastState) return this._lastState
-    let hash: Hash | null = null
-    const diviner = await this.getBoundWitnessDivinerForStateStore()
-    const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-      .fields({
-        address: this.account.address,
-        limit: 1,
-        cursor: SequenceConstants.minLocalSequence,
-        order: 'desc',
-        payload_schemas: [ModuleStateSchema],
-      })
-      .build()
-    const boundWitnesses = await diviner.divine([query])
-    if (boundWitnesses.length > 0) {
-      const boundWitness = boundWitnesses[0]
-      if (isBoundWitness(boundWitness)) {
-        // Find the index for this address in the BoundWitness that is a ModuleState
-        hash = boundWitness.addresses
-          .map((address, index) => ({ address, index }))
-          .filter(({ address }) => address === this.account.address)
-          // eslint-disable-next-line unicorn/no-array-reduce
-          .reduce(
-            (prev, curr) => (boundWitness.payload_schemas?.[curr?.index] === ModuleStateSchema ? boundWitness.payload_hashes[curr?.index] : prev),
-            null as Hash | null,
-          )
-      }
-    }
-
-    // If we able to located the last state
-    if (hash !== null) {
-      // Get last state
-      const archivist = await this.getArchivistForStateStore()
-      const payload = (await archivist.get([hash])).find(isModuleState<TState>)
-      if (payload) {
-        return payload as WithStorageMeta<ModuleState<TState>>
-      }
-    }
-    return undefined
-  }
-}

package/src/DivinerMixin.ts

@@ -1,154 +0,0 @@
-import type { Hash } from '@xylabs/sdk-js'
-import { assertEx, toSafeJson } from '@xylabs/sdk-js'
-import { asArchivistInstance } from '@xyo-network/archivist-model'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import { isBoundWitness } from '@xyo-network/boundwitness-model'
-import type { BoundWitnessDivinerQueryPayload } from '@xyo-network/diviner-boundwitness-model'
-import { BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'
-import { asDivinerInstance } from '@xyo-network/diviner-model'
-import type {
-  AnyConfigSchema,
-  ModuleInstance,
-  ModuleState,
-  QueryableModuleParams,
-  StateDictionary,
-} from '@xyo-network/module-model'
-import {
-  isModuleState,
-  ModuleStateSchema,
-} from '@xyo-network/module-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { WithStorageMeta } from '@xyo-network/payload-model'
-import { SequenceConstants } from '@xyo-network/payload-model'
-
-import type { StatefulDivinerConfig } from './Config.ts'
-
-export type StatefulModuleParams = QueryableModuleParams<AnyConfigSchema<StatefulDivinerConfig>>
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type AnyModule<TParams extends StatefulModuleParams = StatefulModuleParams> = new (...args: any[]) => ModuleInstance<TParams>
-
-const moduleName = 'StatefulModuleMixin'
-
-/**
- * @internal
- * @ignore Inherit from StatefulDiviner instead
- * @param ModuleBase
- * @returns
- */
-export const StatefulModuleMixin = <
-  TParams extends StatefulModuleParams = StatefulModuleParams,
-  TModule extends AnyModule<TParams> = AnyModule<TParams>,
-  TState extends StateDictionary = StateDictionary,
->(
-  ModuleBase: TModule,
-) => {
-  abstract class StatefulModuleBase extends ModuleBase {
-    _lastState?: ModuleState<TState>
-
-    /**
-     * Commit the internal state of the Diviner 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.
-     * @param nextState The state to commit
-     */
-    async commitState(nextState: ModuleState<TState>) {
-      // Don't commit state if no state has changed
-      if (toSafeJson(nextState.state) === toSafeJson(this._lastState?.state)) return
-      this._lastState = nextState
-      const archivist = await this.getArchivistForStore()
-      // const [bw] = await new BoundWitnessBuilder().payload(nextState).signer(this.account).build()
-      const [bw] = await new BoundWitnessBuilder().payload(nextState).build()
-      await archivist.insert([bw, nextState])
-    }
-
-    /**
-     * Retrieves the archivist for the specified store
-     * @param store The store to retrieve the archivist for
-     * @returns The archivist for the specified store
-     */
-    async getArchivistForStore() {
-      const name = assertEx(this.config?.stateStore?.archivist, () => `${moduleName}: Config for stateStore.archivist not specified`)
-      const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.archivist`)
-      // return ArchivistWrapper.wrap(mod, this.account)
-      const instance = asArchivistInstance(mod)
-      return assertEx(instance, () => `${moduleName}: Failed to wrap archivist instance`)
-    }
-
-    /**
-     * Retrieves the BoundWitness Diviner for the specified store
-     * @param store The store to retrieve the BoundWitness Diviner for
-     * @returns The BoundWitness Diviner for the specified store
-     */
-    async getBoundWitnessDivinerForStore() {
-      const name = assertEx(
-        this.config?.stateStore?.boundWitnessDiviner,
-        () => `${moduleName}: Config for stateStore.boundWitnessDiviner not specified`,
-      )
-      const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.boundWitnessDiviner`)
-      // return DivinerWrapper.wrap(mod, this.account)
-      const instance = asDivinerInstance(mod)
-      return assertEx(instance, () => `${moduleName}: Failed to wrap diviner instance`)
-    }
-
-    /**
-     * Retrieves the Payload Diviner for the specified store
-     * @param store The store to retrieve the Payload Diviner for
-     * @returns The Payload Diviner for the specified store
-     */
-    async getPayloadDivinerForStateStore() {
-      const name = assertEx(this.config?.stateStore?.payloadDiviner, () => `${moduleName}: Config for stateStore.payloadDiviner not specified`)
-      const mod = assertEx(await this.resolve(name), () => `${moduleName}: Failed to resolve stateStore.payloadDiviner`)
-      // return DivinerWrapper.wrap(mod, this.account)
-      const instance = asDivinerInstance(mod)
-      return assertEx(instance, () => `${moduleName}: Failed to wrap diviner instance`)
-    }
-
-    /**
-     * Retrieves the last state of the Diviner process. Used to recover state after
-     * preemptions, reboots, etc.
-     */
-    async retrieveState(): Promise<ModuleState<TState> | undefined> {
-      if (this._lastState) return this._lastState
-      let hash: Hash | null = null
-      const diviner = await this.getBoundWitnessDivinerForStore()
-      const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-        .fields({
-          // address: this.account.address,
-          limit: 1,
-          cursor: SequenceConstants.minLocalSequence,
-          order: 'desc',
-          payload_schemas: [ModuleStateSchema],
-        })
-        .build()
-      const boundWitnesses = await diviner.divine([query])
-      if (boundWitnesses.length > 0) {
-        const boundWitness = boundWitnesses[0]
-        if (isBoundWitness(boundWitness)) {
-          // Find the index for this address in the BoundWitness that is a ModuleState
-          hash = boundWitness.addresses
-            .map((address, index) => ({ address, index }))
-            // .filter(({ address }) => address === this.account.address)
-            // eslint-disable-next-line unicorn/no-array-reduce
-            .reduce(
-              (prev, curr) => (boundWitness.payload_schemas?.[curr?.index] === ModuleStateSchema ? boundWitness.payload_hashes[curr?.index] : prev),
-              null as Hash | null,
-            )
-        }
-      }
-
-      // If we able to located the last state
-      if (hash !== null) {
-        // Get last state
-        const archivist = await this.getArchivistForStore()
-        const payload = (await archivist.get([hash])).find(isModuleState<TState>)
-        if (payload) {
-          return payload as WithStorageMeta<ModuleState<TState>>
-        }
-      }
-      return undefined
-    }
-  }
-  return StatefulModuleBase
-}

package/src/Params.ts

@@ -1,9 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { StatefulDivinerConfig } from './Config.ts'
-
-/**
- * The parameters for a Stateful Diviner
- */
-export type StatefulDivinerParams = DivinerParams<AnyConfigSchema<StatefulDivinerConfig>>

package/src/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const StatefulDivinerSchema = asSchema('network.xyo.diviner.stateful', true)
-export type StatefulDivinerSchema = typeof StatefulDivinerSchema

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './Config.ts'
-export * from './Diviner.ts'
-export * from './DivinerMixin.ts'
-export * from './Params.ts'
-export * from './Schema.ts'

package/src/spec/TestManifest.json

@@ -1,51 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "name": "DivinerTest",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "public": [
-          {
-            "config": {
-              "language": "javascript",
-              "name": "AddressStateArchivist",
-              "schema": "network.xyo.archivist.config"
-            }
-          },
-          {
-            "config": {
-              "archivist": "AddressStateArchivist",
-              "language": "javascript",
-              "name": "AddressStateBoundWitnessDiviner",
-              "schema": "network.xyo.diviner.boundwitness.config"
-            }
-          },
-          {
-            "config": {
-              "archivist": "AddressStateArchivist",
-              "language": "javascript",
-              "name": "AddressStatePayloadDiviner",
-              "schema": "network.xyo.diviner.payload.config"
-            }
-          },
-          {
-            "config": {
-              "language": "javascript",
-              "name": "Diviner",
-              "schema": "network.xyo.diviner.stateful.config",
-              "stateStore": {
-                "archivist": "AddressStateArchivist",
-                "boundWitnessDiviner": "AddressStateBoundWitnessDiviner",
-                "payloadDiviner": "AddressStatePayloadDiviner"
-              }
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}