@xyo-network/abstract-witness 2.63.13

package/dist/esm/AbstractWitness.js

@@ -0,0 +1,61 @@
+import { assertEx } from '@xylabs/assert';
+import { Account } from '@xyo-network/account';
+import { PayloadHasher } from '@xyo-network/core';
+import { AbstractModule, creatableModule, ModuleErrorBuilder, QueryBoundWitnessWrapper, } from '@xyo-network/module';
+import { WitnessConfigSchema, WitnessObserveQuerySchema, } from '@xyo-network/witness-model';
+creatableModule();
+export class AbstractWitness extends AbstractModule {
+    static configSchema = WitnessConfigSchema;
+    get queries() {
+        return [WitnessObserveQuerySchema, ...super.queries];
+    }
+    get targetSet() {
+        return this.config?.targetSet;
+    }
+    get _queryAccountPaths() {
+        return {
+            'network.xyo.query.witness.observe': '1/1',
+        };
+    }
+    observe(payloads) {
+        this.started('throw');
+        const payloadList = assertEx(payloads, 'Trying to witness nothing');
+        assertEx(payloadList.length > 0, 'Trying to witness empty list');
+        payloadList?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'));
+        return payloadList;
+    }
+    async queryHandler(query, payloads, queryConfig) {
+        const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
+        const queryPayload = await wrapper.getQuery();
+        assertEx(this.queryable(query, payloads, queryConfig));
+        // Remove the query payload from the arguments passed to us so we don't observe it
+        const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query);
+        const queryAccount = Account.random();
+        try {
+            switch (queryPayload.schema) {
+                case WitnessObserveQuerySchema: {
+                    await this.emit('reportStart', { inPayloads: payloads, module: this });
+                    const resultPayloads = await this.observe(filteredObservation);
+                    await this.emit('reportEnd', { inPayloads: payloads, module: this, outPayloads: resultPayloads });
+                    return (await this.bindQueryResult(queryPayload, resultPayloads, [queryAccount]))[0];
+                }
+                default: {
+                    return super.queryHandler(query, payloads);
+                }
+            }
+        }
+        catch (ex) {
+            const error = ex;
+            const [result] = await this.bindQueryResult(queryPayload, [], [queryAccount], [
+                new ModuleErrorBuilder()
+                    .sources([await wrapper.hashAsync()])
+                    .name(this.config.name ?? '<Unknown>')
+                    .query(query.schema)
+                    .message(error.message)
+                    .build(),
+            ]);
+            return result;
+        }
+    }
+}
+//# sourceMappingURL=AbstractWitness.js.map

package/dist/esm/AbstractWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractWitness.js","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EACL,cAAc,EACd,eAAe,EAEf,kBAAkB,EAGlB,wBAAwB,GACzB,MAAM,qBAAqB,CAAA;AAG5B,OAAO,EACL,mBAAmB,EAGnB,yBAAyB,GAI1B,MAAM,4BAA4B,CAAA;AAEnC,eAAe,EAAE,CAAA;AACjB,MAAM,OAAO,eACX,SAAQ,cAAmC;IAG3C,MAAM,CAAU,YAAY,GAAW,mBAAmB,CAAA;IAE1D,IAAa,OAAO;QAClB,OAAO,CAAC,yBAAyB,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,CAAA;IAC/B,CAAC;IAED,IAAuB,kBAAkB;QACvC,OAAO;YACL,mCAAmC,EAAE,KAAK;SAC3C,CAAA;IACH,CAAC;IAED,OAAO,CAAC,QAAoB;QAC1B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrB,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAA;QACnE,QAAQ,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,8BAA8B,CAAC,CAAA;QAChE,WAAW,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC,CAAA;QACtF,OAAO,WAAW,CAAA;IACpB,CAAC;IAEkB,KAAK,CAAC,YAAY,CACnC,KAAQ,EACR,QAAoB,EACpB,WAAqB;QAErB,MAAM,OAAO,GAAG,wBAAwB,CAAC,UAAU,CAAe,KAAK,EAAE,QAAQ,CAAC,CAAA;QAClF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAA;QAC7C,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAA;QACtD,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;QACpF,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAA;QACrC,IAAI;YACF,QAAQ,YAAY,CAAC,MAAM,EAAE;gBAC3B,KAAK,yBAAyB,CAAC,CAAC;oBAC9B,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;oBACtE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;oBAC9D,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAA;oBACjG,OAAO,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,cAAc,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;iBACrF;gBACD,OAAO,CAAC,CAAC;oBACP,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;iBAC3C;aACF;SACF;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,EAAW,CAAA;YACzB,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,eAAe,CACzC,YAAY,EACZ,EAAE,EACF,CAAC,YAAY,CAAC,EACd;gBACE,IAAI,kBAAkB,EAAE;qBACrB,OAAO,CAAC,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;qBACpC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,WAAW,CAAC;qBACrC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;qBACnB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;qBACtB,KAAK,EAAE;aACX,CACF,CAAA;YACD,OAAO,MAAM,CAAA;SACd;IACH,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './AbstractWitness';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/types/AbstractWitness.d.ts

@@ -0,0 +1,15 @@
+import { AbstractModule, ModuleConfig, ModuleQueryResult, QueryBoundWitness } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+import { WitnessModule, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
+export declare class AbstractWitness<TParams extends WitnessParams = WitnessParams, TEventData extends WitnessModuleEventData = WitnessModuleEventData> extends AbstractModule<TParams, TEventData> implements WitnessModule<TParams, TEventData> {
+    static configSchema: string;
+    get queries(): string[];
+    get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+    protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
+    observe(payloads?: Payload[]): Promisable<Payload[]>;
+    protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryResult>;
+}
+//# sourceMappingURL=AbstractWitness.d.ts.map

package/dist/types/AbstractWitness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractWitness.d.ts","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EAEd,YAAY,EAEZ,iBAAiB,EACjB,iBAAiB,EAElB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAEL,aAAa,EACb,sBAAsB,EAEtB,aAAa,EAEb,gBAAgB,EACjB,MAAM,4BAA4B,CAAA;AAGnC,qBAAa,eAAe,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,EAAE,UAAU,SAAS,sBAAsB,GAAG,sBAAsB,CAC5I,SAAQ,cAAc,CAAC,OAAO,EAAE,UAAU,CAC1C,YAAW,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7C,OAAgB,YAAY,EAAE,MAAM,CAAsB;IAE1D,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,SAAS;;mBAEZ;IAED,cAAuB,kBAAkB,IAAI,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAItF;IAED,OAAO,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;cAQ3B,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,iBAAiB,CAAC;CAqC9B"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AbstractWitness';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@xyo-network/abstract-witness",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.9.3",
+    "@xyo-network/account": "^2.63.13",
+    "@xyo-network/core": "^2.63.13",
+    "@xyo-network/module": "^2.63.13",
+    "@xyo-network/payload-model": "^2.63.13",
+    "@xyo-network/promise": "^2.63.13",
+    "@xyo-network/witness-model": "^2.63.13"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.17.17",
+    "@xylabs/tsconfig": "^2.17.17",
+    "typescript": "^5.1.5"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.63.13"
+}

package/src/AbstractWitness.ts

@@ -0,0 +1,95 @@
+import { assertEx } from '@xylabs/assert'
+import { Account } from '@xyo-network/account'
+import { PayloadHasher } from '@xyo-network/core'
+import {
+  AbstractModule,
+  creatableModule,
+  ModuleConfig,
+  ModuleErrorBuilder,
+  ModuleQueryResult,
+  QueryBoundWitness,
+  QueryBoundWitnessWrapper,
+} from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+import { Promisable } from '@xyo-network/promise'
+import {
+  WitnessConfigSchema,
+  WitnessModule,
+  WitnessModuleEventData,
+  WitnessObserveQuerySchema,
+  WitnessParams,
+  WitnessQuery,
+  WitnessQueryBase,
+} from '@xyo-network/witness-model'
+
+creatableModule()
+export class AbstractWitness<TParams extends WitnessParams = WitnessParams, TEventData extends WitnessModuleEventData = WitnessModuleEventData>
+  extends AbstractModule<TParams, TEventData>
+  implements WitnessModule<TParams, TEventData>
+{
+  static override configSchema: string = WitnessConfigSchema
+
+  override get queries(): string[] {
+    return [WitnessObserveQuerySchema, ...super.queries]
+  }
+
+  get targetSet() {
+    return this.config?.targetSet
+  }
+
+  protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {
+    return {
+      'network.xyo.query.witness.observe': '1/1',
+    }
+  }
+
+  observe(payloads?: Payload[]): Promisable<Payload[]> {
+    this.started('throw')
+    const payloadList = assertEx(payloads, 'Trying to witness nothing')
+    assertEx(payloadList.length > 0, 'Trying to witness empty list')
+    payloadList?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))
+    return payloadList
+  }
+
+  protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(
+    query: T,
+    payloads?: Payload[],
+    queryConfig?: TConfig,
+  ): Promise<ModuleQueryResult> {
+    const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)
+    const queryPayload = await wrapper.getQuery()
+    assertEx(this.queryable(query, payloads, queryConfig))
+    // Remove the query payload from the arguments passed to us so we don't observe it
+    const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)
+    const queryAccount = Account.random()
+    try {
+      switch (queryPayload.schema) {
+        case WitnessObserveQuerySchema: {
+          await this.emit('reportStart', { inPayloads: payloads, module: this })
+          const resultPayloads = await this.observe(filteredObservation)
+          await this.emit('reportEnd', { inPayloads: payloads, module: this, outPayloads: resultPayloads })
+          return (await this.bindQueryResult(queryPayload, resultPayloads, [queryAccount]))[0]
+        }
+        default: {
+          return super.queryHandler(query, payloads)
+        }
+      }
+    } catch (ex) {
+      const error = ex as Error
+      const [result] = await this.bindQueryResult(
+        queryPayload,
+        [],
+        [queryAccount],
+        [
+          new ModuleErrorBuilder()
+            .sources([await wrapper.hashAsync()])
+            .name(this.config.name ?? '<Unknown>')
+            .query(query.schema)
+            .message(error.message)
+            .build(),
+        ],
+      )
+      return result
+    }
+  }
+}

package/src/index.ts

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

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}