@xyo-network/diviner-stateful 4.3.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-stateful",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,35 +28,39 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.0",
-    "@xylabs/object": "^4.15.0",
-    "@xyo-network/archivist-model": "^4.3.0",
-    "@xyo-network/archivist-wrapper": "^4.3.0",
-    "@xyo-network/boundwitness-builder": "^4.3.0",
-    "@xyo-network/boundwitness-model": "^4.3.0",
-    "@xyo-network/diviner-abstract": "^4.3.0",
-    "@xyo-network/diviner-boundwitness-model": "^4.3.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/diviner-wrapper": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/payload-builder": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xyo-network/archivist-model": "^5.0.0",
+    "@xyo-network/archivist-wrapper": "^5.0.0",
+    "@xyo-network/boundwitness-builder": "^5.0.0",
+    "@xyo-network/boundwitness-model": "^5.0.0",
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-boundwitness-model": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/diviner-wrapper": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/hex": "^4.15.0",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.0",
-    "@xyo-network/account": "^4.3.0",
-    "@xyo-network/archivist-memory": "^4.3.0",
-    "@xyo-network/diviner-boundwitness-memory": "^4.3.0",
-    "@xyo-network/diviner-payload-generic": "^4.3.0",
-    "@xyo-network/diviner-payload-memory": "^4.3.0",
-    "@xyo-network/manifest": "^4.3.0",
-    "@xyo-network/module-factory-locator": "^4.3.0",
-    "@xyo-network/node-memory": "^4.3.0",
-    "@xyo-network/wallet": "^4.3.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/account": "^5.0.0",
+    "@xyo-network/archivist-memory": "^5.0.0",
+    "@xyo-network/diviner-boundwitness-memory": "^5.0.0",
+    "@xyo-network/diviner-payload-generic": "^5.0.0",
+    "@xyo-network/diviner-payload-memory": "^5.0.0",
+    "@xyo-network/manifest": "^5.0.0",
+    "@xyo-network/module-factory-locator": "^5.0.0",
+    "@xyo-network/node-memory": "^5.0.0",
+    "@xyo-network/wallet": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Diviner.spec.ts

@@ -0,0 +1,89 @@
+import '@xylabs/vitest-extended'
+
+import { assertEx } from '@xylabs/assert'
+import { MemoryArchivist } from '@xyo-network/archivist-memory'
+import { MemoryBoundWitnessDiviner } from '@xyo-network/diviner-boundwitness-memory'
+import { asDivinerInstance } from '@xyo-network/diviner-model'
+import { GenericPayloadDiviner } from '@xyo-network/diviner-payload-generic'
+import type { PackageManifestPayload } from '@xyo-network/manifest'
+import { ManifestWrapper } from '@xyo-network/manifest'
+import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
+import {
+  creatableModule, CreatableModuleInstance, type ModuleState,
+} from '@xyo-network/module-model'
+import type { MemoryNode } from '@xyo-network/node-memory'
+import type { Payload } from '@xyo-network/payload-model'
+import { HDWallet } from '@xyo-network/wallet'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { StatefulDiviner } from '../Diviner.ts'
+import { StatefulDivinerParams } from '../Params.ts'
+import TestManifest from './TestManifest.json' with { type: 'json' }
+
+@creatableModule<CreatableModuleInstance<StatefulDivinerParams>>()
+class TestStatefulDiviner extends StatefulDiviner {
+  callCommitState(state: ModuleState) {
+    return this.commitState(state)
+  }
+
+  callRetrieveState() {
+    return this.retrieveState()
+  }
+
+  protected override divineHandler(payloads?: Payload[]): Promise<Payload[]> {
+    return Promise.resolve(payloads ?? [])
+  }
+}
+
+/**
+ * @group slow
+ */
+describe('TestStatefulDiviner', () => {
+  let sut: TestStatefulDiviner
+  let node: MemoryNode
+
+  beforeAll(async () => {
+    const wallet = await HDWallet.random()
+    const locator = new ModuleFactoryLocator()
+    locator.register(MemoryArchivist.factory())
+    locator.register(MemoryBoundWitnessDiviner.factory())
+    locator.register(GenericPayloadDiviner.factory())
+    locator.register(TestStatefulDiviner.factory())
+    const manifest = TestManifest as PackageManifestPayload
+    const manifestWrapper = new ManifestWrapper(manifest, wallet, locator)
+    node = await manifestWrapper.loadNodeFromIndex(0)
+    await node.start()
+
+    const privateModules = manifest.nodes[0].modules?.private ?? []
+    const publicModules = manifest.nodes[0].modules?.public ?? []
+    const mods = await node.resolve('*')
+    expect(mods.length).toBe(privateModules.length + publicModules.length + 1)
+
+    sut = assertEx(asDivinerInstance<TestStatefulDiviner>(await node.resolve('Diviner')))
+  })
+
+  describe('divine', () => {
+    describe('with no previous state', () => {
+      it('returns undefined', async () => {
+        const results = await sut.callRetrieveState()
+        expect(results).toBeUndefined()
+      })
+    })
+    describe('with previous state', () => {
+      const cases: ModuleState[] = [
+        { schema: 'network.xyo.module.state', state: { offset: 0 } },
+        { schema: 'network.xyo.module.state', state: { offset: 1 } },
+        { schema: 'network.xyo.module.state', state: { offset: 1000 } },
+      ]
+
+      it.each(cases)('returns state', async (state) => {
+        await sut.callCommitState(state)
+        const results = await sut.callRetrieveState()
+        expect(results).toMatchObject(state)
+      })
+    })
+  })
+})

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config