@xyo-network/diviner-forecasting-abstract 2.56.0

package/dist/esm/AbstractForecasting.js

@@ -0,0 +1,20 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner';
+import { Hasher } from '@xyo-network/core';
+import { ForecastingDivinerConfigSchema, ForecastPayloadSchema, isForecastingDivinerQueryPayload, } from '@xyo-network/diviner-forecasting-model';
+export class AbstractForecastingDiviner extends AbstractDiviner {
+    static configSchema = ForecastingDivinerConfigSchema;
+    async divine(payloads) {
+        const query = payloads?.find(isForecastingDivinerQueryPayload);
+        if (!query)
+            return [];
+        const windowSettings = { ...this.config, ...this.query };
+        const stopTimestamp = query.timestamp || Date.now();
+        const startTimestamp = windowSettings.windowSize ? stopTimestamp - windowSettings.windowSize : 0;
+        const data = await this.getPayloadsInWindow(startTimestamp, stopTimestamp);
+        const sources = data.map((x) => Hasher.hash(x));
+        const values = await this.forecastingMethod(data, this.transformer);
+        const response = { schema: ForecastPayloadSchema, sources, values };
+        return [response];
+    }
+}
+//# sourceMappingURL=AbstractForecasting.js.map

package/dist/esm/AbstractForecasting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractForecasting.js","sourceRoot":"","sources":["../../src/AbstractForecasting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAEL,8BAA8B,EAK9B,qBAAqB,EACrB,gCAAgC,GAEjC,MAAM,wCAAwC,CAAA;AAQ/C,MAAM,OAAgB,0BAEpB,SAAQ,eAAwB;IAChC,MAAM,CAAU,YAAY,GAAG,8BAA8B,CAAA;IAK7D,KAAK,CAAC,MAAM,CAAC,QAAgC;QAC3C,MAAM,KAAK,GAAG,QAAQ,EAAE,IAAI,CAAiC,gCAAgC,CAAC,CAAA;QAC9F,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAA;QACrB,MAAM,cAAc,GAAwB,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;QAC7E,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,CAAA;QACnD,MAAM,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;QAChG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAA;QAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QACnE,MAAM,QAAQ,GAAoB,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;QACpF,OAAO,CAAC,QAAQ,CAAC,CAAA;IACnB,CAAC"}

package/dist/esm/index.js

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

package/dist/esm/index.js.map

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

package/dist/types/AbstractForecasting.d.ts

@@ -0,0 +1,15 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner';
+import { ForecastingDivinerConfig, ForecastingMethod, PayloadValueTransformer } from '@xyo-network/diviner-forecasting-model';
+import { DivinerParams } from '@xyo-network/diviner-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+import { Payload } from '@xyo-network/payload-model';
+import { Promisable } from '@xyo-network/promise';
+export type ForecastingDivinerParams = DivinerParams<AnyConfigSchema<ForecastingDivinerConfig>>;
+export declare abstract class AbstractForecastingDiviner<TParams extends ForecastingDivinerParams = ForecastingDivinerParams> extends AbstractDiviner<TParams> {
+    static configSchema: "network.xyo.diviner.forecasting.config";
+    protected abstract get forecastingMethod(): ForecastingMethod;
+    protected abstract get transformer(): PayloadValueTransformer;
+    divine(payloads?: Payload[] | undefined): Promise<Payload[]>;
+    protected abstract getPayloadsInWindow(startTimestamp: number, stopTimestamp: number): Promisable<Payload[]>;
+}
+//# sourceMappingURL=AbstractForecasting.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractForecasting.d.ts","sourceRoot":"","sources":["../../src/AbstractForecasting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,EACL,wBAAwB,EAGxB,iBAAiB,EAKjB,uBAAuB,EACxB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAA;AAE/F,8BAAsB,0BAA0B,CAC9C,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,CACnE,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,OAAgB,YAAY,2CAAiC;IAE7D,SAAS,CAAC,QAAQ,KAAK,iBAAiB,IAAI,iBAAiB,CAAA;IAC7D,SAAS,CAAC,QAAQ,KAAK,WAAW,IAAI,uBAAuB,CAAA;IAEvD,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAalE,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;CAC7G"}

package/dist/types/index.d.ts

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

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

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

package/package.json

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

package/src/AbstractForecasting.ts

@@ -0,0 +1,43 @@
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import { Hasher } from '@xyo-network/core'
+import {
+  ForecastingDivinerConfig,
+  ForecastingDivinerConfigSchema,
+  ForecastingDivinerQueryPayload,
+  ForecastingMethod,
+  ForecastingSettings,
+  ForecastPayload,
+  ForecastPayloadSchema,
+  isForecastingDivinerQueryPayload,
+  PayloadValueTransformer,
+} from '@xyo-network/diviner-forecasting-model'
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import { Payload } from '@xyo-network/payload-model'
+import { Promisable } from '@xyo-network/promise'
+
+export type ForecastingDivinerParams = DivinerParams<AnyConfigSchema<ForecastingDivinerConfig>>
+
+export abstract class AbstractForecastingDiviner<
+  TParams extends ForecastingDivinerParams = ForecastingDivinerParams,
+> extends AbstractDiviner<TParams> {
+  static override configSchema = ForecastingDivinerConfigSchema
+
+  protected abstract get forecastingMethod(): ForecastingMethod
+  protected abstract get transformer(): PayloadValueTransformer
+
+  async divine(payloads?: Payload[] | undefined): Promise<Payload[]> {
+    const query = payloads?.find<ForecastingDivinerQueryPayload>(isForecastingDivinerQueryPayload)
+    if (!query) return []
+    const windowSettings: ForecastingSettings = { ...this.config, ...this.query }
+    const stopTimestamp = query.timestamp || Date.now()
+    const startTimestamp = windowSettings.windowSize ? stopTimestamp - windowSettings.windowSize : 0
+    const data = await this.getPayloadsInWindow(startTimestamp, stopTimestamp)
+    const sources = data.map((x) => Hasher.hash(x))
+    const values = await this.forecastingMethod(data, this.transformer)
+    const response: ForecastPayload = { schema: ForecastPayloadSchema, sources, values }
+    return [response]
+  }
+
+  protected abstract getPayloadsInWindow(startTimestamp: number, stopTimestamp: number): Promisable<Payload[]>
+}

package/src/index.ts

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