@xyo-network/abstract-witness 2.72.0 → 2.72.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/cjs/AbstractWitness.js +15 -0
- package/dist/cjs/AbstractWitness.js.map +1 -1
- package/dist/docs.json +19194 -0
- package/dist/esm/AbstractWitness.js +13 -0
- package/dist/esm/AbstractWitness.js.map +1 -1
- package/dist/types/AbstractWitness.d.ts +4 -0
- package/dist/types/AbstractWitness.d.ts.map +1 -1
- package/package.json +11 -10
- package/src/AbstractWitness.ts +20 -0
|
@@ -6,6 +6,10 @@ import { WitnessConfigSchema, WitnessObserveQuerySchema, } from '@xyo-network/wi
|
|
|
6
6
|
creatableModule();
|
|
7
7
|
export class AbstractWitness extends AbstractModuleInstance {
|
|
8
8
|
static configSchemas = [WitnessConfigSchema];
|
|
9
|
+
_archivistInstance;
|
|
10
|
+
get archivist() {
|
|
11
|
+
return this.config.archivist;
|
|
12
|
+
}
|
|
9
13
|
get queries() {
|
|
10
14
|
return [WitnessObserveQuerySchema, ...super.queries];
|
|
11
15
|
}
|
|
@@ -17,6 +21,11 @@ export class AbstractWitness extends AbstractModuleInstance {
|
|
|
17
21
|
'network.xyo.query.witness.observe': '1/1',
|
|
18
22
|
};
|
|
19
23
|
}
|
|
24
|
+
async getArchivistInstance() {
|
|
25
|
+
const archivistAddress = this.archivist;
|
|
26
|
+
this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined);
|
|
27
|
+
return this._archivistInstance;
|
|
28
|
+
}
|
|
20
29
|
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
21
30
|
async observe(inPayloads) {
|
|
22
31
|
await this.started('throw');
|
|
@@ -24,6 +33,10 @@ export class AbstractWitness extends AbstractModuleInstance {
|
|
|
24
33
|
const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing');
|
|
25
34
|
assertEx(outPayloads.length > 0, 'Trying to witness empty list');
|
|
26
35
|
outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'));
|
|
36
|
+
const archivist = await this.getArchivistInstance();
|
|
37
|
+
if (archivist) {
|
|
38
|
+
await archivist.insert(outPayloads);
|
|
39
|
+
}
|
|
27
40
|
await this.emit('observeEnd', { inPayloads, module: this, outPayloads });
|
|
28
41
|
return outPayloads;
|
|
29
42
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractWitness.js","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;
|
|
1
|
+
{"version":3,"file":"AbstractWitness.js","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAA0C,MAAM,qBAAqB,CAAA;AAGrH,OAAO,EAEL,mBAAmB,EAGnB,yBAAyB,GAI1B,MAAM,4BAA4B,CAAA;AAEnC,eAAe,EAAE,CAAA;AACjB,MAAM,OAAgB,eAIpB,SAAQ,sBAA2C;IAGnD,MAAM,CAAmB,aAAa,GAAa,CAAC,mBAAmB,CAAC,CAAA;IAEhE,kBAAkB,CAA+B;IAEzD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAA;IAC9B,CAAC;IAED,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,KAAK,CAAC,oBAAoB;QACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAA;QACvC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAC1H,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED,wJAAwJ;IACxJ,KAAK,CAAC,OAAO,CAAC,UAAsB;QAClC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC3B,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACzE,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAChG,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;QAEtF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACnD,IAAI,SAAS,EAAE;YACb,MAAM,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;SACpC;QAED,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;QAExE,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,0GAA0G;IACvF,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,MAAM,cAAc,GAAc,EAAE,CAAA;QACpC,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;QACpF,QAAQ,YAAY,CAAC,MAAM,EAAE;YAC3B,KAAK,yBAAyB,CAAC,CAAC;gBAC9B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;gBAC/D,cAAc,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAA;gBACvC,MAAK;aACN;YACD,OAAO,CAAC,CAAC;gBACP,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;aAC3C;SACF;QACD,OAAO,cAAc,CAAA;IACvB,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ArchivistInstance } from '@xyo-network/archivist-model';
|
|
1
2
|
import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
|
|
2
3
|
import { AbstractModuleInstance, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module';
|
|
3
4
|
import { Payload } from '@xyo-network/payload-model';
|
|
@@ -5,11 +6,14 @@ import { Promisable } from '@xyo-network/promise';
|
|
|
5
6
|
import { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams, WitnessQueryBase } from '@xyo-network/witness-model';
|
|
6
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> {
|
|
7
8
|
static readonly configSchemas: string[];
|
|
9
|
+
private _archivistInstance;
|
|
10
|
+
get archivist(): (import("@xyo-network/module").ArchivistModuleConfig & (import("@xyo-network/module").ArchivistModuleConfig & string)) | undefined;
|
|
8
11
|
get queries(): string[];
|
|
9
12
|
get targetSet(): (import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/payload-model").PayloadSet & {
|
|
10
13
|
schema: "network.xyo.payload.set";
|
|
11
14
|
}) | undefined;
|
|
12
15
|
protected get _queryAccountPaths(): Record<WitnessQueryBase['schema'], string>;
|
|
16
|
+
getArchivistInstance(): Promise<ArchivistInstance | undefined>;
|
|
13
17
|
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
14
18
|
observe(inPayloads?: Payload[]): Promise<Payload[]>;
|
|
15
19
|
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractWitness.d.ts","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AACA,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,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;
|
|
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;IAiBzD,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"}
|
package/package.json
CHANGED
|
@@ -11,17 +11,18 @@
|
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"@xylabs/assert": "^2.9.3",
|
|
14
|
-
"@xyo-network/
|
|
15
|
-
"@xyo-network/
|
|
16
|
-
"@xyo-network/
|
|
17
|
-
"@xyo-network/
|
|
18
|
-
"@xyo-network/
|
|
19
|
-
"@xyo-network/
|
|
14
|
+
"@xyo-network/archivist-model": "~2.72.2",
|
|
15
|
+
"@xyo-network/boundwitness-builder": "~2.72.2",
|
|
16
|
+
"@xyo-network/core": "~2.72.2",
|
|
17
|
+
"@xyo-network/module": "~2.72.2",
|
|
18
|
+
"@xyo-network/payload-model": "~2.72.2",
|
|
19
|
+
"@xyo-network/promise": "~2.72.2",
|
|
20
|
+
"@xyo-network/witness-model": "~2.72.2"
|
|
20
21
|
},
|
|
21
22
|
"devDependencies": {
|
|
22
|
-
"@xylabs/ts-scripts-yarn3": "^2.19.
|
|
23
|
-
"@xylabs/tsconfig": "^2.19.
|
|
24
|
-
"typescript": "^5.
|
|
23
|
+
"@xylabs/ts-scripts-yarn3": "^2.19.3",
|
|
24
|
+
"@xylabs/tsconfig": "^2.19.3",
|
|
25
|
+
"typescript": "^5.2.2"
|
|
25
26
|
},
|
|
26
27
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
27
28
|
"browser": "dist/esm/index.js",
|
|
@@ -56,5 +57,5 @@
|
|
|
56
57
|
},
|
|
57
58
|
"sideEffects": false,
|
|
58
59
|
"types": "dist/types/index.d.ts",
|
|
59
|
-
"version": "2.72.
|
|
60
|
+
"version": "2.72.2"
|
|
60
61
|
}
|
package/src/AbstractWitness.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { assertEx } from '@xylabs/assert'
|
|
2
|
+
import { ArchivistInstance } from '@xyo-network/archivist-model'
|
|
2
3
|
import { QueryBoundWitness, QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-builder'
|
|
3
4
|
import { PayloadHasher } from '@xyo-network/core'
|
|
4
5
|
import { AbstractModuleInstance, creatableModule, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module'
|
|
@@ -25,6 +26,12 @@ export abstract class AbstractWitness<
|
|
|
25
26
|
{
|
|
26
27
|
static override readonly configSchemas: string[] = [WitnessConfigSchema]
|
|
27
28
|
|
|
29
|
+
private _archivistInstance: ArchivistInstance | undefined
|
|
30
|
+
|
|
31
|
+
get archivist() {
|
|
32
|
+
return this.config.archivist
|
|
33
|
+
}
|
|
34
|
+
|
|
28
35
|
override get queries(): string[] {
|
|
29
36
|
return [WitnessObserveQuerySchema, ...super.queries]
|
|
30
37
|
}
|
|
@@ -39,6 +46,12 @@ export abstract class AbstractWitness<
|
|
|
39
46
|
}
|
|
40
47
|
}
|
|
41
48
|
|
|
49
|
+
async getArchivistInstance() {
|
|
50
|
+
const archivistAddress = this.archivist
|
|
51
|
+
this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)
|
|
52
|
+
return this._archivistInstance
|
|
53
|
+
}
|
|
54
|
+
|
|
42
55
|
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
43
56
|
async observe(inPayloads?: Payload[]): Promise<Payload[]> {
|
|
44
57
|
await this.started('throw')
|
|
@@ -46,7 +59,14 @@ export abstract class AbstractWitness<
|
|
|
46
59
|
const outPayloads = assertEx(await this.observeHandler(inPayloads), 'Trying to witness nothing')
|
|
47
60
|
assertEx(outPayloads.length > 0, 'Trying to witness empty list')
|
|
48
61
|
outPayloads?.forEach((payload) => assertEx(payload.schema, 'observe: Missing Schema'))
|
|
62
|
+
|
|
63
|
+
const archivist = await this.getArchivistInstance()
|
|
64
|
+
if (archivist) {
|
|
65
|
+
await archivist.insert(outPayloads)
|
|
66
|
+
}
|
|
67
|
+
|
|
49
68
|
await this.emit('observeEnd', { inPayloads, module: this, outPayloads })
|
|
69
|
+
|
|
50
70
|
return outPayloads
|
|
51
71
|
}
|
|
52
72
|
|