@xyo-network/sentinel-abstract 5.3.20 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/sentinel-abstract",
-  "version": "5.3.20",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,35 +30,53 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
-    "!**/*.test.*"
+    "!**/*.test.*",
+    "README.md"
   ],
   "dependencies": {
-    "@xyo-network/account-model": "~5.3.20",
-    "@xyo-network/boundwitness-builder": "~5.3.20",
-    "@xyo-network/boundwitness-model": "~5.3.20",
-    "@xyo-network/boundwitness-wrapper": "~5.3.20",
-    "@xyo-network/module-abstract": "~5.3.20",
-    "@xyo-network/module-model": "~5.3.20",
-    "@xyo-network/payload-builder": "~5.3.20",
-    "@xyo-network/payload-model": "~5.3.20",
-    "@xyo-network/sentinel-model": "~5.3.20"
+    "@xyo-network/account-model": "~5.3.24",
+    "@xyo-network/boundwitness-builder": "~5.3.24",
+    "@xyo-network/module-abstract": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/sentinel-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/boundwitness-wrapper": "~5.3.24"
   },
   "devDependencies": {
-    "@xylabs/sdk-js": "^5.0.90",
-    "@xylabs/ts-scripts-common": "~7.5.6",
-    "@xylabs/ts-scripts-yarn3": "~7.5.6",
-    "@xylabs/tsconfig": "~7.5.6",
+    "@opentelemetry/api": "^1.9.1",
+    "@types/node": "^25.5.0",
+    "@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",
+    "acorn": "^8.16.0",
+    "axios": "^1.14.0",
+    "esbuild": "^0.28.0",
+    "ethers": "^6.16.0",
+    "tslib": "^2.8.1",
     "typescript": "~5.9.3",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/boundwitness-builder": "~5.3.24",
+    "@xyo-network/boundwitness-wrapper": "~5.3.24",
+    "@xyo-network/account-model": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/module-abstract": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/sentinel-model": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
+    "ethers": "^6",
+    "tslib": "^2.8.1",
     "zod": "^4"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/AbstractSentinel.ts

@@ -1,182 +0,0 @@
-import {
-  assertEx, forget, globallyUnique,
-} from '@xylabs/sdk-js'
-import type { AccountInstance } from '@xyo-network/account-model'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import type { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model'
-import { isBoundWitness } from '@xyo-network/boundwitness-model'
-import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
-import { AbstractModuleInstance } from '@xyo-network/module-abstract'
-import type {
-  ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,
-} from '@xyo-network/module-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { Payload, Schema } from '@xyo-network/payload-model'
-import type {
-  AttachableSentinelInstance,
-  CustomSentinelInstance,
-  ResolvedTask,
-  SentinelInstance,
-  SentinelJob,
-  SentinelModuleEventData,
-  SentinelParams,
-  SentinelQueries,
-  SentinelReportQuery,
-} from '@xyo-network/sentinel-model'
-import {
-  SentinelConfigSchema,
-  SentinelReportQuerySchema,
-} from '@xyo-network/sentinel-model'
-
-export abstract class AbstractSentinel<
-  TParams extends SentinelParams = SentinelParams,
-  TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
->
-  extends AbstractModuleInstance<TParams, TEventData>
-  implements CustomSentinelInstance<TParams, TEventData>, AttachableSentinelInstance<TParams, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, SentinelConfigSchema]
-  static override readonly defaultConfigSchema: Schema = SentinelConfigSchema
-  static override readonly uniqueName = globallyUnique('AbstractSentinel', AbstractSentinel, 'xyo')
-  history: BoundWitness[] = []
-  private _jobPromise?: Promise<SentinelJob>
-
-  get jobPromise() {
-    this._jobPromise = this._jobPromise ?? this.generateJob()
-    return this._jobPromise
-  }
-
-  override get queries(): Schema[] {
-    return [SentinelReportQuerySchema, ...super.queries]
-  }
-
-  get synchronous(): boolean {
-    return this.config.synchronous ?? true
-  }
-
-  get throwErrors(): boolean {
-    return this.config.throwErrors ?? true
-  }
-
-  async report(inPayloads?: Payload[]): Promise<Payload[]> {
-    this._noOverride('report')
-    this.isSupportedQuery(SentinelReportQuerySchema, 'report')
-    return await this.spanAsync('report', async () => {
-      const reportPromise = (async () => {
-        if (this.reentrancy?.scope === 'global' && this.reentrancy?.action === 'skip' && this.globalReentrancyMutex?.isLocked()) {
-          console.warn(`Skipping report for ${this.id} due to global reentrancy lock`)
-          return []
-        }
-        try {
-          await this.globalReentrancyMutex?.acquire()
-          await this.emit('reportStart', { inPayloads, mod: this })
-          const payloads = await this.reportHandler(inPayloads)
-
-          // create boundwitness
-          const result = (await new BoundWitnessBuilder().payloads(payloads).signer(this.account).build()).flat()
-
-          if (this.config.archiving) {
-            forget(this.storeToArchivists(result), { name: `AbstractSentinel.report.storeArchivist [${this.id}]` })
-          }
-
-          await this.emitReportEnd(inPayloads, result)
-          return result
-        } finally {
-          this.globalReentrancyMutex?.release()
-        }
-      }
-      )()
-      if (this.synchronous) {
-        return await reportPromise
-      } else {
-        forget(reportPromise, { name: `AbstractSentinel.report [${this.id}]` })
-        return []
-      }
-    }, { timeBudgetLimit: 200 })
-  }
-
-  async reportQuery(payloads?: Payload[], account?: AccountInstance): Promise<ModuleQueryResult> {
-    this._noOverride('reportQuery')
-    const queryPayload: SentinelReportQuery = { schema: SentinelReportQuerySchema }
-    return await this.sendQueryRaw(queryPayload, payloads, account)
-  }
-
-  protected async emitReportEnd(inPayloads?: Payload[], payloads?: Payload[]) {
-    const boundwitnesses = payloads?.filter(isBoundWitness) ?? []
-    const outPayloads = payloads?.filter(payload => !isBoundWitness(payload)) ?? []
-    const boundwitness = boundwitnesses.find(bw => bw.addresses.includes(this.address))
-    await this.emit('reportEnd', {
-      boundwitness, inPayloads, mod: this, outPayloads,
-    })
-  }
-
-  protected async generateJob() {
-    const job: SentinelJob = { tasks: [] }
-    let tasks: ResolvedTask[] = await Promise.all(
-      (this.config.tasks ?? []).map(async task => ({
-        input: task.input ?? false,
-        mod: assertEx(await this.resolve(task.mod), () => `Unable to resolve task module [${task.mod}]`),
-      })),
-    )
-    while (tasks.length > 0) {
-      const previousTasks = job.tasks.at(-1) ?? []
-      const newListCandidates
-        // add all tasks that either require no previous input or have the previous input module already added
-        = tasks.filter((task) => {
-          const input = task.input
-          if (input === undefined) {
-            return true
-          }
-          if (typeof input === 'boolean') {
-            return true
-          }
-          if (typeof input === 'string') {
-            return previousTasks.some(prevTask => prevTask.mod.address === input || prevTask.mod.modName === input)
-          }
-          if (Array.isArray(input)) {
-            return previousTasks.some(
-              prevTask => input.includes(prevTask.mod.address) || input.includes(prevTask.mod.modName ?? prevTask.mod.address),
-            )
-          }
-          return false
-        })
-      // remove any tasks that have inputs that are in the current list or the remaining tasks
-      const newList = newListCandidates.filter((taskCandidate) => {
-        const input = taskCandidate.input
-        return !(
-          Array.isArray(input)
-          && tasks.some(
-            remainingTask => input.includes(remainingTask.mod.address) || input.includes(remainingTask.mod.modName ?? remainingTask.mod.address),
-          )
-        )
-      })
-      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))
-    }
-    return job
-  }
-
-  protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(
-    query: T,
-    payloads?: Payload[],
-    queryConfig?: TConfig,
-  ): Promise<ModuleQueryHandlerResult> {
-    const wrapper = QueryBoundWitnessWrapper.parseQuery<SentinelQueries>(query, payloads)
-    const queryPayload = await wrapper.getQuery()
-    assertEx(await this.queryable(query, payloads, queryConfig))
-    const resultPayloads: Payload[] = []
-    switch (queryPayload.schema) {
-      case SentinelReportQuerySchema: {
-        resultPayloads.push(...(await this.report(payloads)))
-        break
-      }
-      default: {
-        return super.queryHandler(query, payloads)
-      }
-    }
-    return PayloadBuilder.omitPrivateStorageMeta(resultPayloads) as ModuleQueryHandlerResult
-  }
-
-  abstract reportHandler(payloads?: Payload[]): Promise<Payload[]>
-}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './AbstractSentinel.ts'