@xyo-network/sentinel 2.75.18 → 2.76.1

package/package.json

@@ -10,36 +10,33 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.12.24",
-    "@xylabs/lodash": "^2.12.24",
-    "@xylabs/promise": "^2.12.24",
-    "@xyo-network/archivist": "~2.75.18",
-    "@xyo-network/boundwitness-builder": "~2.75.18",
-    "@xyo-network/boundwitness-model": "~2.75.18",
-    "@xyo-network/core": "~2.75.18",
-    "@xyo-network/error": "~2.75.18",
-    "@xyo-network/module-abstract": "~2.75.18",
-    "@xyo-network/module-model": "~2.75.18",
-    "@xyo-network/module-wrapper": "~2.75.18",
-    "@xyo-network/payload-model": "~2.75.18",
-    "@xyo-network/payload-wrapper": "~2.75.18",
-    "@xyo-network/sentinel-model": "~2.75.18",
-    "@xyo-network/witness-model": "~2.75.18"
+    "@xylabs/assert": "^2.12.28",
+    "@xylabs/promise": "^2.12.28",
+    "@xyo-network/archivist": "~2.76.1",
+    "@xyo-network/boundwitness-builder": "~2.76.1",
+    "@xyo-network/boundwitness-model": "~2.76.1",
+    "@xyo-network/core": "~2.76.1",
+    "@xyo-network/diviner-model": "~2.76.1",
+    "@xyo-network/module-abstract": "~2.76.1",
+    "@xyo-network/module-model": "~2.76.1",
+    "@xyo-network/module-wrapper": "~2.76.1",
+    "@xyo-network/payload-model": "~2.76.1",
+    "@xyo-network/payload-wrapper": "~2.76.1",
+    "@xyo-network/sentinel-model": "~2.76.1",
+    "@xyo-network/witness-model": "~2.76.1"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@xylabs/delay": "^2.12.24",
-    "@xylabs/ts-scripts-yarn3": "^3.1.9",
-    "@xylabs/tsconfig": "^3.1.9",
-    "@xyo-network/abstract-witness": "~2.75.18",
-    "@xyo-network/account": "~2.75.18",
-    "@xyo-network/boundwitness-validator": "~2.75.18",
-    "@xyo-network/boundwitness-wrapper": "~2.75.18",
-    "@xyo-network/id-payload-plugin": "~2.75.18",
-    "@xyo-network/id-plugin": "~2.75.18",
-    "@xyo-network/node-memory": "~2.75.18",
-    "@xyo-network/node-system-info-plugin": "~2.75.18",
-    "@xyo-network/witnesses": "~2.75.18",
+    "@xylabs/delay": "^2.12.28",
+    "@xylabs/ts-scripts-yarn3": "^3.1.12",
+    "@xylabs/tsconfig": "^3.1.12",
+    "@xyo-network/abstract-witness": "~2.76.1",
+    "@xyo-network/account": "~2.76.1",
+    "@xyo-network/id-payload-plugin": "~2.76.1",
+    "@xyo-network/id-plugin": "~2.76.1",
+    "@xyo-network/node-memory": "~2.76.1",
+    "@xyo-network/node-system-info-plugin": "~2.76.1",
+    "@xyo-network/witnesses": "~2.76.1",
     "typescript": "^5.2.2"
   },
   "docs": "dist/docs.json",
@@ -67,15 +64,12 @@
         }
       }
     },
-    "./docs": {
-      "default": "./dist/docs.json"
-    },
     "./package.json": "./package.json"
   },
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",
   "homepage": "https://xyo.network",
-  "license": "LGPL-3.0",
+  "license": "LGPL-3.0-only",
   "publishConfig": {
     "access": "public"
   },
@@ -84,5 +78,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.75.18"
+  "version": "2.76.1"
 }

package/src/AbstractSentinel.ts

@@ -1,5 +1,4 @@
 import { assertEx } from '@xylabs/assert'
-import { uniq } from '@xylabs/lodash'
 import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'
 import { BoundWitness, isBoundWitness, notBoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model'
 import { AbstractModuleInstance } from '@xyo-network/module-abstract'
@@ -7,13 +6,14 @@ import { ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module-mode
 import { Payload } from '@xyo-network/payload-model'
 import {
   CustomSentinelInstance,
+  ResolvedSentinelTask,
   SentinelInstance,
+  SentinelJob,
   SentinelModuleEventData,
   SentinelParams,
   SentinelQueryBase,
   SentinelReportQuerySchema,
 } from '@xyo-network/sentinel-model'
-import { isWitnessInstance, WitnessInstance } from '@xyo-network/witness-model'
 
 export abstract class AbstractSentinel<
     TParams extends SentinelParams = SentinelParams,
@@ -23,6 +23,12 @@ export abstract class AbstractSentinel<
   implements CustomSentinelInstance<TParams, TEventData>
 {
   history: BoundWitness[] = []
+  private _jobPromise?: Promise<SentinelJob>
+
+  get jobPromise() {
+    this._jobPromise = this._jobPromise ?? this.generateJob()
+    return this._jobPromise
+  }
 
   override get queries(): string[] {
     return [SentinelReportQuerySchema, ...super.queries]
@@ -34,10 +40,6 @@ export abstract class AbstractSentinel<
     }
   }
 
-  addWitness(address: string[]) {
-    this.config.witnesses = uniq([...address, ...(this.config.witnesses ?? [])])
-  }
-
   async report(inPayloads?: Payload[]): Promise<Payload[]> {
     this._noOverride('report')
     await this.emit('reportStart', { inPayloads, module: this })
@@ -50,29 +52,29 @@ export abstract class AbstractSentinel<
     return payloads
   }
 
-  async witnesses() {
-    this.logger?.debug(`witnesses:config:witnesses: ${this.config?.witnesses?.length}`)
-    const namesOrAddresses = this.config?.witnesses
-      ? Array.isArray(this.config.witnesses)
-        ? this.config?.witnesses
-        : [this.config.witnesses]
-      : undefined
-    this.logger?.debug(`witnesses:namesOrAddresses: ${namesOrAddresses?.length}`)
-    const result = namesOrAddresses
-      ? [
-          ...(await this.resolve<WitnessInstance>({ address: namesOrAddresses }, { identity: isWitnessInstance })),
-          ...(await this.resolve<WitnessInstance>({ name: namesOrAddresses }, { identity: isWitnessInstance })),
-        ]
-      : await this.resolve<WitnessInstance>(undefined, { identity: isWitnessInstance })
-
-    if (namesOrAddresses && namesOrAddresses.length !== result.length) {
-      this.logger?.warn(`Not all witnesses found [Requested: ${namesOrAddresses.length}, Found: ${result.length}]`)
+  protected async generateJob() {
+    const job: SentinelJob = { tasks: [] }
+    let tasks: ResolvedSentinelTask[] = await Promise.all(
+      this.config.tasks.map(async (task) => ({
+        input: task.input ?? false,
+        module: assertEx(await this.resolve(task.module), `Unable to resolve task module [${task.module}]`),
+      })),
+    )
+    while (tasks.length) {
+      const previousTasks = job.tasks.length ? job.tasks[job.tasks.length - 1] : []
+      const newList =
+        //add all tasks that either require no previous input or have the previous input module already added
+        tasks.filter(
+          (task) =>
+            typeof task.input === 'boolean' ||
+            previousTasks.find((prevTask) => prevTask.module.address === task.input || prevTask.module.config.name === task.input),
+        )
+      assertEx(newList.length > 0, `Unable to generateJob [${tasks.length}]`)
+      job.tasks.push(newList)
+      //remove the tasks we just added
+      tasks = tasks.filter((task) => !newList.includes(task))
     }
-    result.map((item) => {
-      this.logger?.debug(`witnesses:result: ${item.config.schema}`)
-    })
-
-    return result
+    return job
   }
 
   protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(

package/src/Automation.ts

@@ -1,5 +1,6 @@
 import { AnyObject } from '@xyo-network/core'
 import { Payload } from '@xyo-network/payload-model'
+import { SentinelTask } from '@xyo-network/sentinel-model'
 
 export type SentinelAutomationSchema = 'network.xyo.automation'
 export const SentinelAutomationSchema: SentinelAutomationSchema = 'network.xyo.automation'
@@ -7,9 +8,8 @@ export const SentinelAutomationSchema: SentinelAutomationSchema = 'network.xyo.a
 export type SentinelBaseAutomationPayload<T extends AnyObject = AnyObject> = Payload<
   T & {
     schema: SentinelAutomationSchema
+    tasks?: SentinelTask[]
     type?: 'interval' | 'change'
-    /** @field The list of witnesses to invoke [all if undefined] */
-    witnesses?: string[]
   }
 >
 

package/src/MemorySentinel.ts

@@ -1,17 +1,17 @@
-import { assertEx } from '@xylabs/assert'
 import { fulfilled, rejected } from '@xylabs/promise'
-import { handleError } from '@xyo-network/error'
+import { Address } from '@xyo-network/core'
+import { asDivinerInstance } from '@xyo-network/diviner-model'
 import { AnyConfigSchema } from '@xyo-network/module-model'
 import { Payload } from '@xyo-network/payload-model'
 import {
+  ResolvedSentinelTask,
   SentinelConfig,
   SentinelConfigSchema,
   SentinelInstance,
   SentinelModuleEventData,
   SentinelParams,
-  SentinelReportQuerySchema,
 } from '@xyo-network/sentinel-model'
-import { WitnessInstance } from '@xyo-network/witness-model'
+import { asWitnessInstance } from '@xyo-network/witness-model'
 
 import { AbstractSentinel } from './AbstractSentinel'
 
@@ -23,42 +23,49 @@ export class MemorySentinel<
 > extends AbstractSentinel<TParams, TEventData> {
   static override configSchemas = [SentinelConfigSchema]
 
-  async reportHandler(payloads: Payload[] = []): Promise<Payload[]> {
+  async reportHandler(inPayloads: Payload[] = []): Promise<Payload[]> {
     await this.started('throw')
-    const errors: Error[] = []
-    const allWitnesses = [...(await this.witnesses())]
-    const resultPayloads: Payload[] = []
+    const job = await this.jobPromise
 
-    try {
-      const [generatedPayloads, generatedErrors] = await this.generateResults(allWitnesses, payloads)
-      resultPayloads.push(...generatedPayloads)
-      errors.push(...generatedErrors)
-      if (this.config.passthrough) {
-        resultPayloads.push(...payloads)
-      }
-    } catch (ex) {
-      handleError(ex, (error) => {
-        errors.push(error)
-      })
+    let index = 0
+    let previousResults: Record<Address, Payload[]> = {}
+    while (index < job.tasks.length) {
+      const generatedPayloads = await this.generateResults(job.tasks[index], previousResults, inPayloads)
+      previousResults = generatedPayloads
+      index++
     }
-
-    const [boundWitness] = await this.bindQueryResult({ schema: SentinelReportQuerySchema }, resultPayloads)
-    this.history.push(assertEx(boundWitness))
-    return [boundWitness, ...resultPayloads]
+    return Object.values(previousResults).flat()
   }
 
-  private async generateResults(witnesses: WitnessInstance[], inPayloads?: Payload[]): Promise<[Payload[], Error[]]> {
-    const results: PromiseSettledResult<Payload[]>[] = await Promise.allSettled(witnesses?.map((witness) => witness.observe(inPayloads)))
-    const payloads = results
-      .filter(fulfilled)
-      .map((result) => result.value)
-      .flat()
-    const errors = results
-      .filter(rejected)
-      .map((result) => result.reason)
-      .flat()
-    // console.log(`payloads: ${JSON.stringify(payloads, null, 2)}`)
-    // console.log(`errors: ${JSON.stringify(errors, null, 2)}`)
-    return [payloads, errors]
+  private async generateResults(
+    tasks: ResolvedSentinelTask[],
+    previousResults: Record<Address, Payload[]>,
+    inPayloads?: Payload[],
+  ): Promise<Record<Address, Payload[]>> {
+    const results: PromiseSettledResult<[Address, Payload[]]>[] = await Promise.allSettled(
+      tasks?.map(async (task) => {
+        const witness = asWitnessInstance(task.module)
+        const input = task.input ?? false
+        if (witness) {
+          return [witness.address, await witness.observe(input === true ? inPayloads : input === false ? [] : previousResults[input])]
+        }
+        const diviner = asDivinerInstance(task.module)
+        if (diviner) {
+          return [diviner.address, await diviner.divine(input === true ? inPayloads : input === false ? [] : previousResults[input])]
+        }
+        throw Error('Unsupported module type')
+      }),
+    )
+    const finalResult: Record<Address, Payload[]> = {}
+    results.filter(fulfilled).forEach((result) => {
+      const [address, payloads] = result.value
+      finalResult[address] = finalResult[address] ?? []
+      finalResult[address].push(...payloads)
+    })
+    const errors = results.filter(rejected).map((result) => result.reason)
+    if (errors.length > 0) {
+      throw Error('At least one module failed')
+    }
+    return finalResult
   }
 }