@xyo-network/core 2.20.38 → 2.20.41

package/dist/esm/Query/QueryPayload.d.ts

@@ -1,6 +1,11 @@
 import { XyoPayload } from '../Payload';
 export interface XyoQueryPayload extends XyoPayload {
+    /** @field The preferred schema to use for the answer */
+    targetSchema?: string;
+    /** @field The maximum XYO that can be spent executing the query */
     budget?: number;
+    /** @field The frequency on which this query can be rerun */
     maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+    /** @field The starting point for the bidding on the query */
     minBid?: number;
 }

package/dist/esm/Witness/LegacyWitness.d.ts

@@ -0,0 +1,14 @@
+import { XyoPayload } from '../Payload';
+import { XyoWitness } from './Witness';
+export interface XyoWitnessConfig<T extends XyoPayload = XyoPayload> {
+    schema: string;
+    template?: XyoPayload;
+    observer?: () => Promise<T> | T;
+}
+export declare class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoWitnessConfig<T> = XyoWitnessConfig<T>> extends XyoWitness<T> {
+    config?: C;
+    previousHash?: string;
+    constructor(config?: C);
+    get targetSchema(): string;
+    observe(fields?: Partial<T>): Promise<T>;
+}

package/dist/esm/Witness/LegacyWitness.js

@@ -0,0 +1,19 @@
+import { XyoPayloadBuilder } from '../Payload';
+import { XyoWitness } from './Witness';
+export class XyoLegacyWitness extends XyoWitness {
+    constructor(config) {
+        super();
+        this.config = config;
+    }
+    get targetSchema() {
+        return this.config?.schema ?? 'network.xyo.payload';
+    }
+    async observe(fields) {
+        return new XyoPayloadBuilder({ schema: this.targetSchema })
+            .previousHash(this.previousHash)
+            .fields(await this.config?.observer?.())
+            .fields(fields)
+            .build();
+    }
+}
+//# sourceMappingURL=LegacyWitness.js.map

package/dist/esm/Witness/LegacyWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LegacyWitness.js","sourceRoot":"","sources":["../../../src/Witness/LegacyWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAQtC,MAAM,OAAO,gBAAyG,SAAQ,UAAa;IAIzI,YAAY,MAAU;QACpB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,IAAa,YAAY;QACvB,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,qBAAqB,CAAA;IACrD,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAmB;QACtC,OAAO,IAAI,iBAAiB,CAAI,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3D,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC;aAC/B,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC;aACvC,MAAM,CAAC,MAAM,CAAC;aACd,KAAK,EAAE,CAAA;IACZ,CAAC;CACF"}

package/dist/esm/Witness/QueryWitness.d.ts

@@ -0,0 +1,9 @@
+import { XyoPayload } from '../Payload';
+import { XyoQueryPayload } from '../Query';
+import { XyoWitness } from './Witness';
+export declare class XyoQueryWitness<Q extends XyoQueryPayload, T extends XyoPayload> extends XyoWitness {
+    query: Q;
+    constructor(query: Q);
+    get targetSchema(): string;
+    observe(fields?: Partial<T>): Promise<T>;
+}

package/dist/esm/Witness/QueryWitness.js

@@ -0,0 +1,17 @@
+import { delay } from '@xylabs/sdk-js';
+import { XyoPayloadBuilder } from '../Payload';
+import { XyoWitness } from './Witness';
+export class XyoQueryWitness extends XyoWitness {
+    constructor(query) {
+        super();
+        this.query = query;
+    }
+    get targetSchema() {
+        return this.query.targetSchema ?? 'network.xyo.payload';
+    }
+    async observe(fields) {
+        await delay(0);
+        return new XyoPayloadBuilder({ schema: this.targetSchema }).fields(fields).build();
+    }
+}
+//# sourceMappingURL=QueryWitness.js.map

package/dist/esm/Witness/QueryWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryWitness.js","sourceRoot":"","sources":["../../../src/Witness/QueryWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAEtC,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE1D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,MAAM,OAAO,eAAiE,SAAQ,UAAU;IAG9F,YAAY,KAAQ;QAClB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,IAAa,YAAY;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,qBAAqB,CAAA;IACzD,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAmB;QACtC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAA;QACd,OAAO,IAAI,iBAAiB,CAAI,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;IACvF,CAAC;CACF"}

package/dist/esm/Witness/Witness.d.ts

@@ -1,14 +1,5 @@
 import { XyoPayload } from '../Payload';
-export interface XyoWitnessConfig<T extends XyoPayload = XyoPayload> {
-    schema: string;
-    template?: XyoPayload;
-    observer?: () => Promise<T> | T;
-}
-export declare class XyoWitness<T extends XyoPayload = XyoPayload, C extends XyoWitnessConfig<T> = XyoWitnessConfig<T>> {
-    config: C;
-    previousHash?: string;
-    schema: string;
-    template?: XyoPayload;
-    constructor(config: C);
-    observe(fields?: Partial<T>): Promise<T>;
+export declare abstract class XyoWitness<T extends XyoPayload = XyoPayload> {
+    abstract observe(fields?: Partial<T>): Promise<T>;
+    abstract get targetSchema(): string;
 }

package/dist/esm/Witness/Witness.js

@@ -1,16 +1,3 @@
-import { XyoPayloadBuilder } from '../Payload';
 export class XyoWitness {
-    constructor(config) {
-        this.config = config;
-        this.schema = config.schema;
-        this.template = config.template;
-    }
-    async observe(fields) {
-        return new XyoPayloadBuilder({ schema: this.config.schema })
-            .previousHash(this.previousHash)
-            .fields(await this.config.observer?.())
-            .fields(fields)
-            .build();
-    }
 }
 //# sourceMappingURL=Witness.js.map

package/dist/esm/Witness/Witness.js.map

@@ -1 +1 @@
-{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../../src/Witness/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAQ1D,MAAM,OAAO,UAAU;IAMrB,YAAY,MAAS;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IACjC,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAmB;QACtC,OAAO,IAAI,iBAAiB,CAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;aAC5D,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC;aAC/B,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;aACtC,MAAM,CAAC,MAAM,CAAC;aACd,KAAK,EAAE,CAAA;IACZ,CAAC;CACF"}
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../../src/Witness/Witness.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,UAAU;CAG/B"}

package/dist/esm/Witness/index.d.ts

@@ -1 +1,3 @@
+export * from './LegacyWitness';
+export * from './QueryWitness';
 export * from './Witness';

package/dist/esm/Witness/index.js

@@ -1,2 +1,4 @@
+export * from './LegacyWitness';
+export * from './QueryWitness';
 export * from './Witness';
 //# sourceMappingURL=index.js.map

package/dist/esm/Witness/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/package.json

@@ -9,7 +9,7 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/sdk-js": "^2.5.5",
+    "@xylabs/sdk-js": "^2.5.7",
     "axios": "^0.27.2",
     "elliptic": "^6.5.4",
     "keccak256": "^1.0.6",
@@ -23,7 +23,7 @@
     "@babel/preset-env": "^7.18.2",
     "@types/elliptic": "^6.4.14",
     "@types/lodash": "^4.14.182",
-    "@types/node": "^17.0.36",
+    "@types/node": "^17.0.38",
     "@types/sha.js": "^2.4.0",
     "@types/ua-parser-js": "^0.7.36",
     "@xylabs/eslint-config": "^2.3.22",
@@ -69,6 +69,6 @@
   },
   "sideEffects": true,
   "types": "dist/esm/index.d.ts",
-  "version": "2.20.38",
+  "version": "2.20.41",
   "packageManager": "yarn@3.1.1"
 }

package/src/Query/QueryPayload.ts

@@ -1,7 +1,15 @@
 import { XyoPayload } from '../Payload'
 
 export interface XyoQueryPayload extends XyoPayload {
+  /** @field The preferred schema to use for the answer */
+  targetSchema?: string
+
+  /** @field The maximum XYO that can be spent executing the query */
   budget?: number
+
+  /** @field The frequency on which this query can be rerun */
   maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
+
+  /** @field The starting point for the bidding on the query */
   minBid?: number
 }

package/src/Witness/LegacyWitness.ts

@@ -0,0 +1,30 @@
+import { XyoPayload, XyoPayloadBuilder } from '../Payload'
+import { XyoWitness } from './Witness'
+
+export interface XyoWitnessConfig<T extends XyoPayload = XyoPayload> {
+  schema: string
+  template?: XyoPayload
+  observer?: () => Promise<T> | T
+}
+
+export class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoWitnessConfig<T> = XyoWitnessConfig<T>> extends XyoWitness<T> {
+  public config?: C
+  public previousHash?: string
+
+  constructor(config?: C) {
+    super()
+    this.config = config
+  }
+
+  override get targetSchema() {
+    return this.config?.schema ?? 'network.xyo.payload'
+  }
+
+  public async observe(fields?: Partial<T>) {
+    return new XyoPayloadBuilder<T>({ schema: this.targetSchema })
+      .previousHash(this.previousHash)
+      .fields(await this.config?.observer?.())
+      .fields(fields)
+      .build()
+  }
+}

package/src/Witness/QueryWitness.ts

@@ -0,0 +1,23 @@
+import { delay } from '@xylabs/sdk-js'
+
+import { XyoPayload, XyoPayloadBuilder } from '../Payload'
+import { XyoQueryPayload } from '../Query'
+import { XyoWitness } from './Witness'
+
+export class XyoQueryWitness<Q extends XyoQueryPayload, T extends XyoPayload> extends XyoWitness {
+  public query: Q
+
+  constructor(query: Q) {
+    super()
+    this.query = query
+  }
+
+  override get targetSchema() {
+    return this.query.targetSchema ?? 'network.xyo.payload'
+  }
+
+  public async observe(fields?: Partial<T>): Promise<T> {
+    await delay(0)
+    return new XyoPayloadBuilder<T>({ schema: this.targetSchema }).fields(fields).build()
+  }
+}

package/src/Witness/Witness.spec.ts

@@ -1,13 +1,13 @@
-import { XyoWitness } from './Witness'
+import { XyoLegacyWitness } from './LegacyWitness'
 
 describe('XyoWitness', () => {
   test('valid-instantiation', () => {
     const template = {
       schema: 'network.xyo.foo',
     }
-    const witness = new XyoWitness({ schema: 'network.xyo.payload', template })
+    const witness = new XyoLegacyWitness({ schema: 'network.xyo.payload', template })
     expect(witness).toBeTruthy()
-    expect(witness.schema).toBe('network.xyo.payload')
-    expect(witness.template).toBe(template)
+    expect(witness.config?.schema).toBe('network.xyo.payload')
+    expect(witness.config?.template).toBe(template)
   })
 })

package/src/Witness/Witness.ts

@@ -1,28 +1,6 @@
-import { XyoPayload, XyoPayloadBuilder } from '../Payload'
+import { XyoPayload } from '../Payload'
 
-export interface XyoWitnessConfig<T extends XyoPayload = XyoPayload> {
-  schema: string
-  template?: XyoPayload
-  observer?: () => Promise<T> | T
-}
-
-export class XyoWitness<T extends XyoPayload = XyoPayload, C extends XyoWitnessConfig<T> = XyoWitnessConfig<T>> {
-  public config: C
-  public previousHash?: string
-  public schema: string
-  public template?: XyoPayload
-
-  constructor(config: C) {
-    this.config = config
-    this.schema = config.schema
-    this.template = config.template
-  }
-
-  public async observe(fields?: Partial<T>) {
-    return new XyoPayloadBuilder<T>({ schema: this.config.schema })
-      .previousHash(this.previousHash)
-      .fields(await this.config.observer?.())
-      .fields(fields)
-      .build()
-  }
+export abstract class XyoWitness<T extends XyoPayload = XyoPayload> {
+  abstract observe(fields?: Partial<T>): Promise<T>
+  abstract get targetSchema(): string
 }

package/src/Witness/index.ts

@@ -1 +1,3 @@
+export * from './LegacyWitness'
+export * from './QueryWitness'
 export * from './Witness'