@xyo-network/abstract-witness 2.75.0 → 2.75.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/AbstractWitness.d.cts +24 -0
- package/dist/browser/AbstractWitness.d.cts.map +1 -0
- package/dist/browser/AbstractWitness.js +2 -4
- package/dist/browser/AbstractWitness.js.map +1 -1
- package/dist/browser/index.d.cts +2 -0
- package/dist/browser/index.d.cts.map +1 -0
- package/dist/browser/index.js +1 -85
- package/dist/browser/index.js.map +1 -1
- package/dist/docs.json +20055 -0
- package/dist/node/AbstractWitness.d.cts +24 -0
- package/dist/node/AbstractWitness.d.cts.map +1 -0
- package/dist/node/AbstractWitness.js +17 -10
- package/dist/node/AbstractWitness.js.map +1 -1
- package/dist/node/AbstractWitness.mjs +17 -10
- package/dist/node/AbstractWitness.mjs.map +1 -1
- package/dist/node/index.d.cts +2 -0
- package/dist/node/index.d.cts.map +1 -0
- package/dist/node/index.js +96 -3
- package/dist/node/index.js.map +1 -1
- package/dist/node/index.mjs +90 -1
- package/dist/node/index.mjs.map +1 -1
- package/package.json +12 -12
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ArchivistInstance } from '@xyo-network/archivist-model';
|
|
2
|
+
import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
|
|
3
|
+
import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
|
|
4
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
5
|
+
import { Promisable } from '@xyo-network/promise';
|
|
6
|
+
import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
|
|
7
|
+
export declare abstract class AbstractWitness<TParams extends WitnessParams = WitnessParams, TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>> extends AbstractModuleInstance<TParams, TEventData> implements CustomWitnessInstance<TParams, TEventData> {
|
|
8
|
+
static readonly configSchemas: string[];
|
|
9
|
+
private _archivistInstance;
|
|
10
|
+
get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
|
|
11
|
+
get queries(): string[];
|
|
12
|
+
get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
|
|
13
|
+
schema: "network.xyo.payload.set";
|
|
14
|
+
}) | undefined;
|
|
15
|
+
protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
|
|
16
|
+
getArchivistInstance(): Promise<ArchivistInstance | undefined>;
|
|
17
|
+
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
18
|
+
observe(inPayloads?: Payload[]): Promise<Payload[]>;
|
|
19
|
+
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
20
|
+
protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
|
|
21
|
+
/** @function observeHandler Implement or override to add custom functionality to a witness */
|
|
22
|
+
protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=AbstractWitness.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AbstractWitness.d.ts","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAA4B,MAAM,mCAAmC,CAAA;AAE/F,OAAO,EAAE,sBAAsB,EAAmB,YAAY,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AACrH,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EACL,qBAAqB,EAErB,eAAe,EACf,sBAAsB,EAEtB,aAAa,EAEb,gBAAgB,EACjB,MAAM,4BAA4B,CAAA;AAGnC,8BAAsB,eAAe,CACjC,OAAO,SAAS,aAAa,GAAG,aAAa,EAC7C,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAExH,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;IAErD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwB;IAExE,OAAO,CAAC,kBAAkB,CAA+B;IAEzD,IAAI,SAAS,uIAEZ;IAED,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;IAEK,oBAAoB;IAM1B,wJAAwJ;IAClJ,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBzD,0GAA0G;cACjF,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,wBAAwB,CAAC;IAoBpC,8FAA8F;IAC9F,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;CAC/E"}
|
|
@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
|
|
|
3
3
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
5
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
6
7
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
7
8
|
var __export = (target, all) => {
|
|
8
9
|
for (var name in all)
|
|
@@ -17,6 +18,12 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
17
18
|
return to;
|
|
18
19
|
};
|
|
19
20
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
21
|
+
var __publicField = (obj, key, value) => {
|
|
22
|
+
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
23
|
+
return value;
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
// src/AbstractWitness.ts
|
|
20
27
|
var AbstractWitness_exports = {};
|
|
21
28
|
__export(AbstractWitness_exports, {
|
|
22
29
|
AbstractWitness: () => AbstractWitness
|
|
@@ -28,13 +35,7 @@ var import_core = require("@xyo-network/core");
|
|
|
28
35
|
var import_module = require("@xyo-network/module");
|
|
29
36
|
var import_witness_model = require("@xyo-network/witness-model");
|
|
30
37
|
(0, import_module.creatableModule)();
|
|
31
|
-
class
|
|
32
|
-
static {
|
|
33
|
-
__name(this, "AbstractWitness");
|
|
34
|
-
}
|
|
35
|
-
static configSchemas = [
|
|
36
|
-
import_witness_model.WitnessConfigSchema
|
|
37
|
-
];
|
|
38
|
+
var _AbstractWitness = class _AbstractWitness extends import_module.AbstractModuleInstance {
|
|
38
39
|
_archivistInstance;
|
|
39
40
|
get archivist() {
|
|
40
41
|
return this.config.archivist;
|
|
@@ -46,7 +47,8 @@ class AbstractWitness extends import_module.AbstractModuleInstance {
|
|
|
46
47
|
];
|
|
47
48
|
}
|
|
48
49
|
get targetSet() {
|
|
49
|
-
|
|
50
|
+
var _a;
|
|
51
|
+
return (_a = this.config) == null ? void 0 : _a.targetSet;
|
|
50
52
|
}
|
|
51
53
|
get _queryAccountPaths() {
|
|
52
54
|
return {
|
|
@@ -68,7 +70,7 @@ class AbstractWitness extends import_module.AbstractModuleInstance {
|
|
|
68
70
|
});
|
|
69
71
|
const outPayloads = (0, import_assert.assertEx)(await this.observeHandler(inPayloads), "Trying to witness nothing");
|
|
70
72
|
(0, import_assert.assertEx)(outPayloads.length > 0, "Trying to witness empty list");
|
|
71
|
-
outPayloads
|
|
73
|
+
outPayloads == null ? void 0 : outPayloads.forEach((payload) => (0, import_assert.assertEx)(payload.schema, "observe: Missing Schema"));
|
|
72
74
|
const archivist = await this.getArchivistInstance();
|
|
73
75
|
if (archivist) {
|
|
74
76
|
await archivist.insert(outPayloads);
|
|
@@ -99,7 +101,12 @@ class AbstractWitness extends import_module.AbstractModuleInstance {
|
|
|
99
101
|
}
|
|
100
102
|
return resultPayloads;
|
|
101
103
|
}
|
|
102
|
-
}
|
|
104
|
+
};
|
|
105
|
+
__name(_AbstractWitness, "AbstractWitness");
|
|
106
|
+
__publicField(_AbstractWitness, "configSchemas", [
|
|
107
|
+
import_witness_model.WitnessConfigSchema
|
|
108
|
+
]);
|
|
109
|
+
var AbstractWitness = _AbstractWitness;
|
|
103
110
|
// Annotate the CommonJS export names for ESM import in node:
|
|
104
111
|
0 && (module.exports = {
|
|
105
112
|
AbstractWitness
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;oBAAyB;AAEzB,kCAA4D;AAC5D,kBAA8B;AAC9B,oBAAgG;AAGhG,2BASO;IAEPA,+BAAAA;AACO,IAAeC,mBAAf,MAAeA,yBAIZC,qCAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,kBAAcC,wBAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,gCAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,+CAAaI,QAAQ,CAACC,gBAAYJ,wBAASI,QAAQC,QAAQ,yBAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,qDAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,gCAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,0BAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,gDAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["creatableModule","AbstractWitness","AbstractModuleInstance","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push","configSchemas","WitnessConfigSchema"]}
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
var __defProp = Object.defineProperty;
|
|
2
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
2
3
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
4
|
+
var __publicField = (obj, key, value) => {
|
|
5
|
+
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
6
|
+
return value;
|
|
7
|
+
};
|
|
8
|
+
|
|
9
|
+
// src/AbstractWitness.ts
|
|
3
10
|
import { assertEx } from "@xylabs/assert";
|
|
4
11
|
import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
|
|
5
12
|
import { PayloadHasher } from "@xyo-network/core";
|
|
6
13
|
import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
|
|
7
14
|
import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
|
|
8
15
|
creatableModule();
|
|
9
|
-
class
|
|
10
|
-
static {
|
|
11
|
-
__name(this, "AbstractWitness");
|
|
12
|
-
}
|
|
13
|
-
static configSchemas = [
|
|
14
|
-
WitnessConfigSchema
|
|
15
|
-
];
|
|
16
|
+
var _AbstractWitness = class _AbstractWitness extends AbstractModuleInstance {
|
|
16
17
|
_archivistInstance;
|
|
17
18
|
get archivist() {
|
|
18
19
|
return this.config.archivist;
|
|
@@ -24,7 +25,8 @@ class AbstractWitness extends AbstractModuleInstance {
|
|
|
24
25
|
];
|
|
25
26
|
}
|
|
26
27
|
get targetSet() {
|
|
27
|
-
|
|
28
|
+
var _a;
|
|
29
|
+
return (_a = this.config) == null ? void 0 : _a.targetSet;
|
|
28
30
|
}
|
|
29
31
|
get _queryAccountPaths() {
|
|
30
32
|
return {
|
|
@@ -46,7 +48,7 @@ class AbstractWitness extends AbstractModuleInstance {
|
|
|
46
48
|
});
|
|
47
49
|
const outPayloads = assertEx(await this.observeHandler(inPayloads), "Trying to witness nothing");
|
|
48
50
|
assertEx(outPayloads.length > 0, "Trying to witness empty list");
|
|
49
|
-
outPayloads
|
|
51
|
+
outPayloads == null ? void 0 : outPayloads.forEach((payload) => assertEx(payload.schema, "observe: Missing Schema"));
|
|
50
52
|
const archivist = await this.getArchivistInstance();
|
|
51
53
|
if (archivist) {
|
|
52
54
|
await archivist.insert(outPayloads);
|
|
@@ -77,7 +79,12 @@ class AbstractWitness extends AbstractModuleInstance {
|
|
|
77
79
|
}
|
|
78
80
|
return resultPayloads;
|
|
79
81
|
}
|
|
80
|
-
}
|
|
82
|
+
};
|
|
83
|
+
__name(_AbstractWitness, "AbstractWitness");
|
|
84
|
+
__publicField(_AbstractWitness, "configSchemas", [
|
|
85
|
+
WitnessConfigSchema
|
|
86
|
+
]);
|
|
87
|
+
var AbstractWitness = _AbstractWitness;
|
|
81
88
|
export {
|
|
82
89
|
AbstractWitness
|
|
83
90
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;;;;;;AAAA,SAASA,gBAAgB;AAEzB,SAA4BC,gCAAgC;AAC5D,SAASC,qBAAqB;AAC9B,SAASC,wBAAwBC,uBAA+D;AAGhG,SAEEC,qBAGAC,iCAIK;AAEPC,gBAAAA;AACO,IAAeC,mBAAf,MAAeA,yBAIZC,uBAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,cAAcC,SAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,aAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,+CAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,yBAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,aAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,cAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,2BAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push","configSchemas","WitnessConfigSchema"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
|
package/dist/node/index.js
CHANGED
|
@@ -3,6 +3,12 @@ var __defProp = Object.defineProperty;
|
|
|
3
3
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
5
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
7
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
6
12
|
var __copyProps = (to, from, except, desc) => {
|
|
7
13
|
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
14
|
for (let key of __getOwnPropNames(from))
|
|
@@ -11,13 +17,100 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
11
17
|
}
|
|
12
18
|
return to;
|
|
13
19
|
};
|
|
14
|
-
var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
|
|
15
20
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
21
|
+
var __publicField = (obj, key, value) => {
|
|
22
|
+
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
23
|
+
return value;
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
// src/index.ts
|
|
16
27
|
var src_exports = {};
|
|
28
|
+
__export(src_exports, {
|
|
29
|
+
AbstractWitness: () => AbstractWitness
|
|
30
|
+
});
|
|
17
31
|
module.exports = __toCommonJS(src_exports);
|
|
18
|
-
|
|
32
|
+
|
|
33
|
+
// src/AbstractWitness.ts
|
|
34
|
+
var import_assert = require("@xylabs/assert");
|
|
35
|
+
var import_boundwitness_builder = require("@xyo-network/boundwitness-builder");
|
|
36
|
+
var import_core = require("@xyo-network/core");
|
|
37
|
+
var import_module = require("@xyo-network/module");
|
|
38
|
+
var import_witness_model = require("@xyo-network/witness-model");
|
|
39
|
+
(0, import_module.creatableModule)();
|
|
40
|
+
var _AbstractWitness = class _AbstractWitness extends import_module.AbstractModuleInstance {
|
|
41
|
+
_archivistInstance;
|
|
42
|
+
get archivist() {
|
|
43
|
+
return this.config.archivist;
|
|
44
|
+
}
|
|
45
|
+
get queries() {
|
|
46
|
+
return [
|
|
47
|
+
import_witness_model.WitnessObserveQuerySchema,
|
|
48
|
+
...super.queries
|
|
49
|
+
];
|
|
50
|
+
}
|
|
51
|
+
get targetSet() {
|
|
52
|
+
var _a;
|
|
53
|
+
return (_a = this.config) == null ? void 0 : _a.targetSet;
|
|
54
|
+
}
|
|
55
|
+
get _queryAccountPaths() {
|
|
56
|
+
return {
|
|
57
|
+
"network.xyo.query.witness.observe": "1/1"
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
async getArchivistInstance() {
|
|
61
|
+
const archivistAddress = this.archivist;
|
|
62
|
+
this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
|
|
63
|
+
return this._archivistInstance;
|
|
64
|
+
}
|
|
65
|
+
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
66
|
+
async observe(inPayloads) {
|
|
67
|
+
this._noOverride("observe");
|
|
68
|
+
await this.started("throw");
|
|
69
|
+
await this.emit("observeStart", {
|
|
70
|
+
inPayloads,
|
|
71
|
+
module: this
|
|
72
|
+
});
|
|
73
|
+
const outPayloads = (0, import_assert.assertEx)(await this.observeHandler(inPayloads), "Trying to witness nothing");
|
|
74
|
+
(0, import_assert.assertEx)(outPayloads.length > 0, "Trying to witness empty list");
|
|
75
|
+
outPayloads == null ? void 0 : outPayloads.forEach((payload) => (0, import_assert.assertEx)(payload.schema, "observe: Missing Schema"));
|
|
76
|
+
const archivist = await this.getArchivistInstance();
|
|
77
|
+
if (archivist) {
|
|
78
|
+
await archivist.insert(outPayloads);
|
|
79
|
+
}
|
|
80
|
+
await this.emit("observeEnd", {
|
|
81
|
+
inPayloads,
|
|
82
|
+
module: this,
|
|
83
|
+
outPayloads
|
|
84
|
+
});
|
|
85
|
+
return outPayloads;
|
|
86
|
+
}
|
|
87
|
+
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
88
|
+
async queryHandler(query, payloads, queryConfig) {
|
|
89
|
+
const wrapper = import_boundwitness_builder.QueryBoundWitnessWrapper.parseQuery(query, payloads);
|
|
90
|
+
const queryPayload = await wrapper.getQuery();
|
|
91
|
+
(0, import_assert.assertEx)(this.queryable(query, payloads, queryConfig));
|
|
92
|
+
const resultPayloads = [];
|
|
93
|
+
const filteredObservation = await import_core.PayloadHasher.filterExclude(payloads, query.query);
|
|
94
|
+
switch (queryPayload.schema) {
|
|
95
|
+
case import_witness_model.WitnessObserveQuerySchema: {
|
|
96
|
+
const observePayloads = await this.observe(filteredObservation);
|
|
97
|
+
resultPayloads.push(...observePayloads);
|
|
98
|
+
break;
|
|
99
|
+
}
|
|
100
|
+
default: {
|
|
101
|
+
return super.queryHandler(query, payloads);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
return resultPayloads;
|
|
105
|
+
}
|
|
106
|
+
};
|
|
107
|
+
__name(_AbstractWitness, "AbstractWitness");
|
|
108
|
+
__publicField(_AbstractWitness, "configSchemas", [
|
|
109
|
+
import_witness_model.WitnessConfigSchema
|
|
110
|
+
]);
|
|
111
|
+
var AbstractWitness = _AbstractWitness;
|
|
19
112
|
// Annotate the CommonJS export names for ESM import in node:
|
|
20
113
|
0 && (module.exports = {
|
|
21
|
-
|
|
114
|
+
AbstractWitness
|
|
22
115
|
});
|
|
23
116
|
//# sourceMappingURL=index.js.map
|
package/dist/node/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './AbstractWitness'\n"],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/AbstractWitness.ts"],"sourcesContent":["export * from './AbstractWitness'\n","import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACAA,oBAAyB;AAEzB,kCAA4D;AAC5D,kBAA8B;AAC9B,oBAAgG;AAGhG,2BASO;IAEPA,+BAAAA;AACO,IAAeC,mBAAf,MAAeA,yBAIZC,qCAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,kBAAcC,wBAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,gCAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,+CAAaI,QAAQ,CAACC,gBAAYJ,wBAASI,QAAQC,QAAQ,yBAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,qDAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,gCAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,0BAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,gDAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["creatableModule","AbstractWitness","AbstractModuleInstance","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push","configSchemas","WitnessConfigSchema"]}
|
package/dist/node/index.mjs
CHANGED
|
@@ -1,2 +1,91 @@
|
|
|
1
|
-
|
|
1
|
+
var __defProp = Object.defineProperty;
|
|
2
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
3
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
4
|
+
var __publicField = (obj, key, value) => {
|
|
5
|
+
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
6
|
+
return value;
|
|
7
|
+
};
|
|
8
|
+
|
|
9
|
+
// src/AbstractWitness.ts
|
|
10
|
+
import { assertEx } from "@xylabs/assert";
|
|
11
|
+
import { QueryBoundWitnessWrapper } from "@xyo-network/boundwitness-builder";
|
|
12
|
+
import { PayloadHasher } from "@xyo-network/core";
|
|
13
|
+
import { AbstractModuleInstance, creatableModule } from "@xyo-network/module";
|
|
14
|
+
import { WitnessConfigSchema, WitnessObserveQuerySchema } from "@xyo-network/witness-model";
|
|
15
|
+
creatableModule();
|
|
16
|
+
var _AbstractWitness = class _AbstractWitness extends AbstractModuleInstance {
|
|
17
|
+
_archivistInstance;
|
|
18
|
+
get archivist() {
|
|
19
|
+
return this.config.archivist;
|
|
20
|
+
}
|
|
21
|
+
get queries() {
|
|
22
|
+
return [
|
|
23
|
+
WitnessObserveQuerySchema,
|
|
24
|
+
...super.queries
|
|
25
|
+
];
|
|
26
|
+
}
|
|
27
|
+
get targetSet() {
|
|
28
|
+
var _a;
|
|
29
|
+
return (_a = this.config) == null ? void 0 : _a.targetSet;
|
|
30
|
+
}
|
|
31
|
+
get _queryAccountPaths() {
|
|
32
|
+
return {
|
|
33
|
+
"network.xyo.query.witness.observe": "1/1"
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
async getArchivistInstance() {
|
|
37
|
+
const archivistAddress = this.archivist;
|
|
38
|
+
this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : void 0);
|
|
39
|
+
return this._archivistInstance;
|
|
40
|
+
}
|
|
41
|
+
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
42
|
+
async observe(inPayloads) {
|
|
43
|
+
this._noOverride("observe");
|
|
44
|
+
await this.started("throw");
|
|
45
|
+
await this.emit("observeStart", {
|
|
46
|
+
inPayloads,
|
|
47
|
+
module: this
|
|
48
|
+
});
|
|
49
|
+
const outPayloads = assertEx(await this.observeHandler(inPayloads), "Trying to witness nothing");
|
|
50
|
+
assertEx(outPayloads.length > 0, "Trying to witness empty list");
|
|
51
|
+
outPayloads == null ? void 0 : outPayloads.forEach((payload) => assertEx(payload.schema, "observe: Missing Schema"));
|
|
52
|
+
const archivist = await this.getArchivistInstance();
|
|
53
|
+
if (archivist) {
|
|
54
|
+
await archivist.insert(outPayloads);
|
|
55
|
+
}
|
|
56
|
+
await this.emit("observeEnd", {
|
|
57
|
+
inPayloads,
|
|
58
|
+
module: this,
|
|
59
|
+
outPayloads
|
|
60
|
+
});
|
|
61
|
+
return outPayloads;
|
|
62
|
+
}
|
|
63
|
+
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
64
|
+
async queryHandler(query, payloads, queryConfig) {
|
|
65
|
+
const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
|
|
66
|
+
const queryPayload = await wrapper.getQuery();
|
|
67
|
+
assertEx(this.queryable(query, payloads, queryConfig));
|
|
68
|
+
const resultPayloads = [];
|
|
69
|
+
const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query);
|
|
70
|
+
switch (queryPayload.schema) {
|
|
71
|
+
case WitnessObserveQuerySchema: {
|
|
72
|
+
const observePayloads = await this.observe(filteredObservation);
|
|
73
|
+
resultPayloads.push(...observePayloads);
|
|
74
|
+
break;
|
|
75
|
+
}
|
|
76
|
+
default: {
|
|
77
|
+
return super.queryHandler(query, payloads);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
return resultPayloads;
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
__name(_AbstractWitness, "AbstractWitness");
|
|
84
|
+
__publicField(_AbstractWitness, "configSchemas", [
|
|
85
|
+
WitnessConfigSchema
|
|
86
|
+
]);
|
|
87
|
+
var AbstractWitness = _AbstractWitness;
|
|
88
|
+
export {
|
|
89
|
+
AbstractWitness
|
|
90
|
+
};
|
|
2
91
|
//# sourceMappingURL=index.mjs.map
|
package/dist/node/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { ArchivistInstance } from '@xyo-network/archivist-model'\nimport { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { Promisable } from '@xyo-network/promise'\nimport {\n CustomWitnessInstance,\n WitnessConfigSchema,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuerySchema,\n WitnessParams,\n WitnessQuery,\n WitnessQueryBase,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams>> = WitnessModuleEventData<WitnessInstance<TParams>>,\n >\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TEventData>\n{\n static override readonly configSchemas: string[] = [WitnessConfigSchema]\n\n private _archivistInstance: ArchivistInstance | undefined\n\n get archivist() {\n return this.config.archivist\n }\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n get targetSet() {\n return this.config?.targetSet\n }\n\n protected override get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string> {\n return {\n 'network.xyo.query.witness.observe': '1/1',\n }\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: Payload[]): Promise<Payload[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads: inPayloads, module: this })\n const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')\n assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', { inPayloads, module: this, outPayloads })\n\n return outPayloads\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQuery>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = await PayloadHasher.filterExclude(payloads, query.query)\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: Payload[]): Promisable<Payload[]>\n}\n"],"mappings":";;;;;;;;;AAAA,SAASA,gBAAgB;AAEzB,SAA4BC,gCAAgC;AAC5D,SAASC,qBAAqB;AAC9B,SAASC,wBAAwBC,uBAA+D;AAGhG,SAEEC,qBAGAC,iCAIK;AAEPC,gBAAAA;AACO,IAAeC,mBAAf,MAAeA,yBAIZC,uBAAAA;EAKAC;EAER,IAAIC,YAAY;AACd,WAAO,KAAKC,OAAOD;EACrB;EAEA,IAAaE,UAAoB;AAC/B,WAAO;MAACC;SAA8B,MAAMD;;EAC9C;EAEA,IAAIE,YAAY;AAtClB;AAuCI,YAAO,UAAKH,WAAL,mBAAaG;EACtB;EAEA,IAAuBC,qBAAiE;AACtF,WAAO;MACL,qCAAqC;IACvC;EACF;EAEA,MAAMC,uBAAuB;AAC3B,UAAMC,mBAAmB,KAAKP;AAC9B,SAAKD,qBAAqB,KAAKA,uBAAuBQ,mBAAmB,MAAM,KAAKC,QAAQD,gBAAAA,IAAoBE;AAChH,WAAO,KAAKV;EACd;;EAGA,MAAMW,QAAQC,YAA4C;AACxD,SAAKC,YAAY,SAAA;AACjB,UAAM,KAAKC,QAAQ,OAAA;AACnB,UAAM,KAAKC,KAAK,gBAAgB;MAAEH;MAAwBI,QAAQ;IAAK,CAAA;AACvE,UAAMC,cAAcC,SAAS,MAAM,KAAKC,eAAeP,UAAAA,GAAa,2BAAA;AACpEM,aAASD,YAAYG,SAAS,GAAG,8BAAA;AACjCH,+CAAaI,QAAQ,CAACC,YAAYJ,SAASI,QAAQC,QAAQ,yBAAA;AAE3D,UAAMtB,YAAY,MAAM,KAAKM,qBAAoB;AACjD,QAAIN,WAAW;AACb,YAAMA,UAAUuB,OAAOP,WAAAA;IACzB;AAEA,UAAM,KAAKF,KAAK,cAAc;MAAEH;MAAYI,QAAQ;MAAMC;IAAY,CAAA;AAEtE,WAAOA;EACT;;EAGA,MAAyBQ,aACvBC,OACAC,UACAC,aACmC;AACnC,UAAMC,UAAUC,yBAAyBC,WAAyBL,OAAOC,QAAAA;AACzE,UAAMK,eAAe,MAAMH,QAAQI,SAAQ;AAC3Cf,aAAS,KAAKgB,UAAUR,OAAOC,UAAUC,WAAAA,CAAAA;AACzC,UAAMO,iBAA4B,CAAA;AAElC,UAAMC,sBAAsB,MAAMC,cAAcC,cAAcX,UAAUD,MAAMA,KAAK;AACnF,YAAQM,aAAaT,QAAM;MACzB,KAAKnB,2BAA2B;AAC9B,cAAMmC,kBAAkB,MAAM,KAAK5B,QAAQyB,mBAAAA;AAC3CD,uBAAeK,KAAI,GAAID,eAAAA;AACvB;MACF;MACA,SAAS;AACP,eAAO,MAAMd,aAAaC,OAAOC,QAAAA;MACnC;IACF;AACA,WAAOQ;EACT;AAIF;AA7EUpC;AAGR,cAPoBD,kBAOK2C,iBAA0B;EAACC;;AAP/C,IAAe5C,kBAAf;","names":["assertEx","QueryBoundWitnessWrapper","PayloadHasher","AbstractModuleInstance","creatableModule","WitnessConfigSchema","WitnessObserveQuerySchema","creatableModule","AbstractWitness","AbstractModuleInstance","_archivistInstance","archivist","config","queries","WitnessObserveQuerySchema","targetSet","_queryAccountPaths","getArchivistInstance","archivistAddress","resolve","undefined","observe","inPayloads","_noOverride","started","emit","module","outPayloads","assertEx","observeHandler","length","forEach","payload","schema","insert","queryHandler","query","payloads","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","queryPayload","getQuery","queryable","resultPayloads","filteredObservation","PayloadHasher","filterExclude","observePayloads","push","configSchemas","WitnessConfigSchema"]}
|
package/package.json
CHANGED
|
@@ -10,18 +10,18 @@
|
|
|
10
10
|
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@xylabs/assert": "^2.
|
|
14
|
-
"@xyo-network/archivist-model": "~2.75.
|
|
15
|
-
"@xyo-network/boundwitness-builder": "~2.75.
|
|
16
|
-
"@xyo-network/core": "~2.75.
|
|
17
|
-
"@xyo-network/module": "~2.75.
|
|
18
|
-
"@xyo-network/payload-model": "~2.75.
|
|
19
|
-
"@xyo-network/promise": "~2.75.
|
|
20
|
-
"@xyo-network/witness-model": "~2.75.
|
|
13
|
+
"@xylabs/assert": "^2.12.10",
|
|
14
|
+
"@xyo-network/archivist-model": "~2.75.2",
|
|
15
|
+
"@xyo-network/boundwitness-builder": "~2.75.2",
|
|
16
|
+
"@xyo-network/core": "~2.75.2",
|
|
17
|
+
"@xyo-network/module": "~2.75.2",
|
|
18
|
+
"@xyo-network/payload-model": "~2.75.2",
|
|
19
|
+
"@xyo-network/promise": "~2.75.2",
|
|
20
|
+
"@xyo-network/witness-model": "~2.75.2"
|
|
21
21
|
},
|
|
22
22
|
"devDependencies": {
|
|
23
|
-
"@xylabs/ts-scripts-yarn3": "^3.0.
|
|
24
|
-
"@xylabs/tsconfig": "^3.0.
|
|
23
|
+
"@xylabs/ts-scripts-yarn3": "^3.0.77",
|
|
24
|
+
"@xylabs/tsconfig": "^3.0.77",
|
|
25
25
|
"typescript": "^5.2.2"
|
|
26
26
|
},
|
|
27
27
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
".": {
|
|
32
32
|
"browser": {
|
|
33
33
|
"require": {
|
|
34
|
-
"types": "./dist/browser/index.d.
|
|
34
|
+
"types": "./dist/browser/index.d.cts",
|
|
35
35
|
"default": "./dist/browser/index.cjs"
|
|
36
36
|
},
|
|
37
37
|
"import": {
|
|
@@ -67,5 +67,5 @@
|
|
|
67
67
|
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
|
|
68
68
|
},
|
|
69
69
|
"sideEffects": false,
|
|
70
|
-
"version": "2.75.
|
|
70
|
+
"version": "2.75.2"
|
|
71
71
|
}
|