@xyo-network/diviner 2.25.2 → 2.26.0

package/package.json

@@ -10,15 +10,16 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/account": "^2.25.2",
-    "@xyo-network/archivist": "^2.25.2",
-    "@xyo-network/boundwitness": "^2.25.2",
-    "@xyo-network/payload": "^2.25.2",
+    "@xyo-network/account": "^2.26.0",
+    "@xyo-network/archivist": "^2.26.0",
+    "@xyo-network/boundwitness": "^2.26.0",
+    "@xyo-network/module": "^2.26.0",
+    "@xyo-network/payload": "^2.26.0",
     "tslib": "^2.4.0"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@xylabs/tsconfig": "^2.5.87"
+    "@xylabs/tsconfig": "^2.5.117"
   },
   "browser": "dist/esm/index.js",
   "docs": "dist/docs.json",
@@ -52,5 +53,5 @@
   },
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
-  "version": "2.25.2"
+  "version": "2.26.0"
 }

package/src/Abstract.ts

@@ -0,0 +1,15 @@
+import { XyoAbstractModule, XyoModuleConfig } from '@xyo-network/module'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { XyoDiviner, XyoDivinerQueryPayload } from './Diviner'
+
+export type XyoDivinerConfig<T extends XyoPayload = XyoPayload> = XyoModuleConfig<
+  {
+    targetSchema: string
+  } & T
+>
+export abstract class XyoAbstractDiviner<Q extends XyoDivinerQueryPayload = XyoDivinerQueryPayload, C extends XyoDivinerConfig = XyoDivinerConfig>
+  extends XyoAbstractModule<Q, C>
+  implements XyoDiviner<Q> {}
+
+export abstract class XyoAbstractTimestampDiviner<Q extends XyoDivinerQueryPayload = XyoDivinerQueryPayload> extends XyoAbstractDiviner<Q> {}

package/src/Diviner.ts

@@ -0,0 +1,6 @@
+import { XyoModule, XyoQueryPayload } from '@xyo-network/module'
+import { XyoPayload } from '@xyo-network/payload'
+
+export type XyoDivinerQueryPayload<T extends XyoPayload = XyoPayload> = XyoQueryPayload<T>
+
+export type XyoDiviner<Q extends XyoDivinerQueryPayload = XyoDivinerQueryPayload> = XyoModule<Q>

package/src/{Diviner/Payload → Payload}/Archivist/Diviner.ts

@@ -11,14 +11,14 @@ export class XyoArchivistPayloadDiviner extends XyoPayloadDiviner {
   protected archivist: XyoArchivist
 
   constructor(account: XyoAccount, archivist: XyoArchivist) {
-    super(account)
+    super({ account, schema: 'network.xyo.diviner.payload.config', targetSchema: 'network.xyo.payload' })
     this.archivist = archivist
   }
 
-  override async divine(query: XyoPayloadDivinerQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]> {
+  override async query(query: XyoPayloadDivinerQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]> {
     const huri = new Huri(query.huri)
     const [payloads = []] = await profile(async () => await this.archivist.get([huri.hash]))
     const resultPayloads = payloads?.[0] ? [payloads?.[0]] : []
-    return [this.bind(resultPayloads), resultPayloads]
+    return [this.bindPayloads(resultPayloads), resultPayloads]
   }
 }

package/src/Payload/Huri/Diviner.ts

@@ -0,0 +1,32 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { Huri, HuriOptions, XyoPayload } from '@xyo-network/payload'
+
+import { XyoDivinerConfig } from '../../Abstract'
+import { XyoDivinerQueryPayload } from '../../Diviner'
+import { profile } from '../lib'
+import { XyoPayloadDiviner } from '../XyoPayloadDiviner'
+import { XyoPayloadDivinerQueryPayload } from '../XyoPayloadDivinerQueryPayload'
+
+export type XyoHuriPayloadDivinerConfig = XyoDivinerConfig<{
+  schema: 'network.xyo.diviner.payload.huri.config'
+  huriOptions: HuriOptions
+  huri: string
+}>
+
+export type XyoHuriPayloadDivinerQuery = XyoDivinerQueryPayload<{
+  schema: 'network.xyo.diviner.payload.huri.query'
+  huri: string
+}>
+
+export class XyoHuriPayloadDiviner extends XyoPayloadDiviner<XyoHuriPayloadDivinerQuery, XyoHuriPayloadDivinerConfig> {
+  protected get options() {
+    return this.config.huriOptions
+  }
+
+  override async query(query: XyoPayloadDivinerQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]> {
+    const huri = new Huri(query.huri, this.options)
+    const [payload = null] = await profile(async () => await huri.fetch())
+    const payloads = payload ? [payload] : []
+    return [this.bindPayloads(payloads), payloads]
+  }
+}

package/src/Payload/XyoPayloadDiviner.ts

@@ -0,0 +1,7 @@
+import { XyoAbstractDiviner, XyoDivinerConfig } from '../Abstract'
+import { XyoPayloadDivinerQueryPayload } from './XyoPayloadDivinerQueryPayload'
+
+export abstract class XyoPayloadDiviner<
+  Q extends XyoPayloadDivinerQueryPayload = XyoPayloadDivinerQueryPayload,
+  C extends XyoDivinerConfig = XyoDivinerConfig,
+> extends XyoAbstractDiviner<Q, C> {}

package/src/{Diviner/Payload → Payload}/XyoPayloadDivinerQueryPayload.ts

@@ -1,9 +1,10 @@
-import { XyoQueryPayload } from '@xyo-network/payload'
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload'
 
 export type XyoPayloadDivinerQueryPayloadSchema = 'network.xyo.diviner.payload.query'
 export const XyoPayloadDivinerQueryPayloadSchema: XyoPayloadDivinerQueryPayloadSchema = 'network.xyo.diviner.payload.query'
 
-export type XyoPayloadDivinerQueryPayload = XyoQueryPayload<{
-  schema: XyoPayloadDivinerQueryPayloadSchema
-  huri: string
-}>
+export type XyoPayloadDivinerQueryPayload<T extends XyoPayload = XyoPayload> = XyoQueryPayload<
+  {
+    huri: string
+  } & T
+>

package/src/{Diviner/Payload → Payload}/index.ts

@@ -1,5 +1,4 @@
 export * from './Archivist'
 export * from './Huri'
 export * from './XyoPayloadDiviner'
-export * from './XyoPayloadDivinerPayload'
 export * from './XyoPayloadDivinerQueryPayload'

package/src/Sequence/XyoSequenceDiviner.ts

@@ -0,0 +1,13 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { XyoAbstractDiviner } from '../Abstract'
+import { XyoSequenceDivinerQueryPayload } from './XyoSequenceDivinerQueryPayload'
+
+export abstract class XyoSequenceDiviner<
+  TQueryPayload extends XyoSequenceDivinerQueryPayload = XyoSequenceDivinerQueryPayload,
+> extends XyoAbstractDiviner<TQueryPayload> {
+  override query(query: XyoSequenceDivinerQueryPayload): [XyoBoundWitness, XyoPayload[]] {
+    return [this.bindHashes(query.payload_hashes, query.payload_schemas), []]
+  }
+}

package/src/Sequence/XyoSequenceDivinerQueryPayload.ts

@@ -0,0 +1,10 @@
+import { XyoDivinerQueryPayload } from '../Diviner'
+
+export type XyoSequenceDivinerQueryPayloadSchema = 'network.xyo.diviner.sequence.query'
+export const XyoSequenceDivinerQueryPayloadSchema: XyoSequenceDivinerQueryPayloadSchema = 'network.xyo.diviner.sequence.query'
+
+export type XyoSequenceDivinerQueryPayload = XyoDivinerQueryPayload<{
+  schema: XyoSequenceDivinerQueryPayloadSchema
+  payload_hashes: string[]
+  payload_schemas: string[]
+}>

package/src/Sequence/index.ts

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

package/src/index.ts

@@ -1 +1,4 @@
+export * from './Abstract'
 export * from './Diviner'
+export * from './Payload'
+export * from './Sequence'

package/dist/cjs/Diviner/Payload/XyoPayloadDivinerPayload.d.ts

@@ -1,11 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload';
-export declare type XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload';
-export declare const XyoPayloadDivinerPayloadSchema: XyoPayloadDivinerPayloadSchema;
-export declare type XyoPayloadDivinerPayload<T extends XyoPayload = XyoPayload> = XyoPayload<{
-    schema: XyoPayloadDivinerPayloadSchema;
-    /** @field payload returned or null */
-    payload: T | null;
-    /** @field duration of the call in ms */
-    duration?: number;
-}>;
-//# sourceMappingURL=XyoPayloadDivinerPayload.d.ts.map

package/dist/cjs/Diviner/Payload/XyoPayloadDivinerPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"XyoPayloadDivinerPayload.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/Payload/XyoPayloadDivinerPayload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,oBAAY,8BAA8B,GAAG,6BAA6B,CAAA;AAC1E,eAAO,MAAM,8BAA8B,EAAE,8BAA8D,CAAA;AAE3G,oBAAY,wBAAwB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC;IACnF,MAAM,EAAE,8BAA8B,CAAA;IACtC,sCAAsC;IACtC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAA;IACjB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAC,CAAA"}

package/dist/cjs/Diviner/Payload/XyoPayloadDivinerPayload.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XyoPayloadDivinerPayloadSchema = void 0;
-exports.XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload';
-//# sourceMappingURL=XyoPayloadDivinerPayload.js.map

package/dist/cjs/Diviner/Payload/XyoPayloadDivinerPayload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"XyoPayloadDivinerPayload.js","sourceRoot":"","sources":["../../../../src/Diviner/Payload/XyoPayloadDivinerPayload.ts"],"names":[],"mappings":";;;AAGa,QAAA,8BAA8B,GAAmC,6BAA6B,CAAA"}

package/dist/esm/Diviner/Payload/XyoPayloadDivinerPayload.d.ts

@@ -1,11 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload';
-export declare type XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload';
-export declare const XyoPayloadDivinerPayloadSchema: XyoPayloadDivinerPayloadSchema;
-export declare type XyoPayloadDivinerPayload<T extends XyoPayload = XyoPayload> = XyoPayload<{
-    schema: XyoPayloadDivinerPayloadSchema;
-    /** @field payload returned or null */
-    payload: T | null;
-    /** @field duration of the call in ms */
-    duration?: number;
-}>;
-//# sourceMappingURL=XyoPayloadDivinerPayload.d.ts.map

package/dist/esm/Diviner/Payload/XyoPayloadDivinerPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"XyoPayloadDivinerPayload.d.ts","sourceRoot":"","sources":["../../../../src/Diviner/Payload/XyoPayloadDivinerPayload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,oBAAY,8BAA8B,GAAG,6BAA6B,CAAA;AAC1E,eAAO,MAAM,8BAA8B,EAAE,8BAA8D,CAAA;AAE3G,oBAAY,wBAAwB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC;IACnF,MAAM,EAAE,8BAA8B,CAAA;IACtC,sCAAsC;IACtC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAA;IACjB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAC,CAAA"}

package/dist/esm/Diviner/Payload/XyoPayloadDivinerPayload.js

@@ -1,2 +0,0 @@
-export const XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload';
-//# sourceMappingURL=XyoPayloadDivinerPayload.js.map

package/dist/esm/Diviner/Payload/XyoPayloadDivinerPayload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"XyoPayloadDivinerPayload.js","sourceRoot":"","sources":["../../../../src/Diviner/Payload/XyoPayloadDivinerPayload.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,8BAA8B,GAAmC,6BAA6B,CAAA"}

package/src/Diviner/Diviner.ts

@@ -1,31 +0,0 @@
-import { XyoAccount } from '@xyo-network/account'
-import { XyoBoundWitness, XyoBoundWitnessBuilder } from '@xyo-network/boundwitness'
-import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload'
-
-export interface XyoNode {
-  attach(module: XyoDiviner): void
-  remove(address: string): void
-  get<T extends XyoDiviner>(address: string): T | undefined
-}
-
-export interface XyoDiviner<TQueryPayload extends XyoQueryPayload = XyoQueryPayload> {
-  address: string
-  divine(query: TQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]>
-}
-
-export abstract class XyoAbstractDiviner<TQueryPayload extends XyoQueryPayload = XyoQueryPayload> implements XyoDiviner<TQueryPayload> {
-  protected account: XyoAccount
-  constructor(account: XyoAccount) {
-    this.account = account
-  }
-  abstract divine(query: TQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]>
-  get address() {
-    return this.account.addressValue.hex
-  }
-
-  bind(payloads: XyoPayload[]) {
-    return new XyoBoundWitnessBuilder().payloads(payloads).witness(this.account).build()
-  }
-}
-
-export abstract class XyoAbstractTimestampDiviner<TQueryPayload extends XyoQueryPayload = XyoQueryPayload> extends XyoAbstractDiviner<TQueryPayload> {}

package/src/Diviner/Payload/Huri/Diviner.ts

@@ -1,23 +0,0 @@
-import { XyoAccount } from '@xyo-network/account'
-import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { Huri, HuriOptions, XyoPayload } from '@xyo-network/payload'
-
-import { profile } from '../lib'
-import { XyoPayloadDiviner } from '../XyoPayloadDiviner'
-import { XyoPayloadDivinerQueryPayload } from '../XyoPayloadDivinerQueryPayload'
-
-export class XyoHuriPayloadDiviner extends XyoPayloadDiviner {
-  protected options: HuriOptions
-
-  constructor(account: XyoAccount, options: HuriOptions) {
-    super(account)
-    this.options = options
-  }
-
-  override async divine(query: XyoPayloadDivinerQueryPayload): Promise<[XyoBoundWitness, XyoPayload[]]> {
-    const huri = new Huri(query.huri, this.options)
-    const [payload = null] = await profile(async () => await huri.fetch())
-    const payloads = payload ? [payload] : []
-    return [this.bind(payloads), payloads]
-  }
-}

package/src/Diviner/Payload/XyoPayloadDiviner.ts

@@ -1,6 +0,0 @@
-import { XyoAbstractDiviner } from '../Diviner'
-import { XyoPayloadDivinerQueryPayload } from './XyoPayloadDivinerQueryPayload'
-
-export abstract class XyoPayloadDiviner<
-  TQueryPayload extends XyoPayloadDivinerQueryPayload = XyoPayloadDivinerQueryPayload
-> extends XyoAbstractDiviner<TQueryPayload> {}

package/src/Diviner/Payload/XyoPayloadDivinerPayload.ts

@@ -1,12 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload'
-
-export type XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload'
-export const XyoPayloadDivinerPayloadSchema: XyoPayloadDivinerPayloadSchema = 'network.xyo.diviner.payload'
-
-export type XyoPayloadDivinerPayload<T extends XyoPayload = XyoPayload> = XyoPayload<{
-  schema: XyoPayloadDivinerPayloadSchema
-  /** @field payload returned or null */
-  payload: T | null
-  /** @field duration of the call in ms */
-  duration?: number
-}>

package/src/Diviner/index.ts

@@ -1,2 +0,0 @@
-export * from './Diviner'
-export * from './Payload'