@xyo-network/api-call-witness 2.79.5

package/dist/node/index.js

@@ -0,0 +1,138 @@
+// src/Payload.ts
+var ApiCallSchema = "network.xyo.api.call";
+var ApiCallResultSchema = "network.xyo.api.call.result";
+
+// src/Witness.ts
+import { assertEx as assertEx2 } from "@xylabs/assert";
+import { Axios, AxiosJson } from "@xylabs/axios";
+import { Buffer } from "@xylabs/buffer";
+import { AbstractWitness } from "@xyo-network/abstract-witness";
+import { PayloadHasher } from "@xyo-network/hash";
+import { isPayloadOfSchemaType } from "@xyo-network/payload-model";
+import { fromByteArray } from "base64-js";
+
+// src/lib/checkIpfsUrl.ts
+import { assertEx } from "@xylabs/assert";
+var checkIpfsUrl = (urlToCheck, ipfsGateway) => {
+  try {
+    const url = new URL(urlToCheck);
+    let protocol = url.protocol;
+    let host = url.host;
+    let path = url.pathname;
+    const query = url.search;
+    if (protocol === "ipfs:") {
+      protocol = "https:";
+      host = assertEx(ipfsGateway, "No ipfsGateway provided");
+      path = url.host === "ipfs" ? `ipfs${path}` : `ipfs/${url.host}${path}`;
+      const root = `${protocol}//${host}/${path}`;
+      return (query == null ? void 0 : query.length) > 0 ? `${root}?${query}` : root;
+    } else {
+      return urlToCheck;
+    }
+  } catch (ex) {
+    const error = ex;
+    console.error(`${error.name}:${error.message} [${urlToCheck}]`);
+    console.log(error.stack);
+    return void 0;
+  }
+};
+
+// src/Witness.ts
+var ApiCallWitnessConfigSchema = "network.xyo.api.call.witness.config";
+var ApiCallWitness = class extends AbstractWitness {
+  static configSchemas = [ApiCallWitnessConfigSchema];
+  get accept() {
+    return this.config.accept;
+  }
+  get ipfsGateway() {
+    return this.params.ipfsGateway;
+  }
+  async observeHandler(inPayloads = []) {
+    await this.started("throw");
+    try {
+      const observations = await Promise.all(
+        inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {
+          const { uri, verb } = call;
+          const validatedUri = assertEx2(checkIpfsUrl(uri, this.ipfsGateway), "Invalid URI");
+          if (verb === "get") {
+            return this.httpGet(validatedUri, uri);
+          }
+          const observation = {
+            call: await PayloadHasher.hashAsync(call),
+            schema: ApiCallResultSchema
+          };
+          return observation;
+        })
+      );
+      return observations;
+    } catch (ex) {
+      const error = ex;
+      console.log(`Error [${this.config.name}]: ${error.message}`);
+      throw error;
+    }
+  }
+  async httpGet(url, call) {
+    var _a, _b, _c;
+    const result = {
+      call,
+      schema: ApiCallResultSchema
+    };
+    try {
+      switch (this.accept) {
+        case "application/json": {
+          const axios = new AxiosJson();
+          const response = await axios.get(url);
+          if (response.status >= 200 && response.status < 300) {
+            const jsonResult = result;
+            jsonResult.data = response.data;
+            jsonResult.contentType = "application/json";
+          } else {
+            const errorResult = result;
+            errorResult.http = {
+              status: response.status
+            };
+          }
+          break;
+        }
+        default: {
+          const axios = new Axios({ responseType: "arraybuffer" });
+          const response = await axios.get(url);
+          if (response.status >= 200 && response.status < 300) {
+            const jsonResult = result;
+            jsonResult.data = fromByteArray(Buffer.from(response.data, "binary"));
+            jsonResult.contentType = ((_a = response.headers["content-type"]) == null ? void 0 : _a.toString()) ?? "application/octet-stream";
+          } else {
+            const errorResult = result;
+            errorResult.http = {
+              status: response.status
+            };
+          }
+          break;
+        }
+      }
+    } catch (ex) {
+      const axiosError = ex;
+      if (axiosError.isAxiosError) {
+        if (((_b = axiosError == null ? void 0 : axiosError.response) == null ? void 0 : _b.status) !== void 0) {
+          result.http = result.http ?? {};
+          result.http.status = (_c = axiosError == null ? void 0 : axiosError.response) == null ? void 0 : _c.status;
+        }
+        if ((axiosError == null ? void 0 : axiosError.code) !== void 0) {
+          result.http = result.http ?? {};
+          result.http.code = axiosError == null ? void 0 : axiosError.code;
+        }
+        return result;
+      } else {
+        throw ex;
+      }
+    }
+    return result;
+  }
+};
+export {
+  ApiCallResultSchema,
+  ApiCallSchema,
+  ApiCallWitness,
+  ApiCallWitnessConfigSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Payload.ts","../../src/Witness.ts","../../src/lib/checkIpfsUrl.ts"],"sourcesContent":["import { Hash } from '@xyo-network/hash'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport const ApiCallSchema = 'network.xyo.api.call'\nexport type ApiCallSchema = typeof ApiCallSchema\n\nexport type Verb = 'get' | 'post'\n\nexport type ApiCall = Payload<\n  {\n    uri: string\n    verb?: Verb\n  },\n  ApiCallSchema\n>\n\nexport const ApiCallResultSchema = 'network.xyo.api.call.result'\nexport type ApiCallResultSchema = typeof ApiCallResultSchema\n\nexport interface HttpMeta {\n  code?: string\n  status?: number\n}\n\nexport type ApiCallJsonResult<T extends object | [] = object> = Payload<\n  {\n    call: Hash\n    contentType: 'application/json'\n    data: T\n  },\n  ApiCallResultSchema\n>\n\nexport type ApiCallBase64Result = Payload<\n  {\n    call: Hash\n    contentType: Exclude<string, ApiCallJsonResult['contentType']>\n    data: string\n  },\n  ApiCallResultSchema\n>\n\nexport type ApiCallErrorResult = Payload<\n  {\n    call: Hash\n    http?: HttpMeta\n  },\n  ApiCallResultSchema\n>\n\nexport type ApiCallResult = ApiCallBase64Result | ApiCallJsonResult | ApiCallErrorResult\n","import { assertEx } from '@xylabs/assert'\nimport { Axios, AxiosError, AxiosJson } from '@xylabs/axios'\nimport { Buffer } from '@xylabs/buffer'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { Hash, PayloadHasher } from '@xyo-network/hash'\nimport { JsonArray, JsonObject } from '@xyo-network/object'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\nimport { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'\nimport { fromByteArray } from 'base64-js'\n\nimport { checkIpfsUrl } from './lib'\nimport {\n  ApiCall,\n  ApiCallBase64Result,\n  ApiCallErrorResult,\n  ApiCallJsonResult,\n  ApiCallResult,\n  ApiCallResultSchema,\n  ApiCallSchema,\n  Verb,\n} from './Payload'\n\nexport const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'\nexport type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema\n\nexport type ApiCallWitnessConfig = WitnessConfig<{\n  accept: 'application/json'\n  schema: ApiCallWitnessConfigSchema\n  verb?: Verb\n}>\n\nexport type ApiCallWitnessParams = WitnessParams<ApiCallWitnessConfig, { ipfsGateway?: string }>\n\nexport class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {\n  static override configSchemas = [ApiCallWitnessConfigSchema]\n\n  get accept() {\n    return this.config.accept\n  }\n\n  get ipfsGateway() {\n    return this.params.ipfsGateway\n  }\n\n  protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {\n    await this.started('throw')\n    try {\n      const observations = await Promise.all(\n        inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {\n          const { uri, verb } = call\n\n          const validatedUri = assertEx(checkIpfsUrl(uri, this.ipfsGateway), 'Invalid URI')\n\n          if (verb === 'get') {\n            return this.httpGet(validatedUri, uri)\n          }\n\n          const observation: ApiCallResult = {\n            call: await PayloadHasher.hashAsync(call),\n            schema: ApiCallResultSchema,\n          }\n          return observation\n        }),\n      )\n      return observations\n    } catch (ex) {\n      const error = ex as Error\n      console.log(`Error [${this.config.name}]: ${error.message}`)\n      throw error\n    }\n  }\n\n  private async httpGet(url: string, call: Hash): Promise<ApiCallResult> {\n    const result: ApiCallResult = {\n      call,\n      schema: ApiCallResultSchema,\n    }\n    try {\n      switch (this.accept) {\n        case 'application/json': {\n          const axios = new AxiosJson()\n          const response = await axios.get<JsonArray | JsonObject>(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallJsonResult\n            jsonResult.data = response.data\n            jsonResult.contentType = 'application/json'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n        default: {\n          const axios = new Axios({ responseType: 'arraybuffer' })\n          const response = await axios.get(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallBase64Result\n            jsonResult.data = fromByteArray(Buffer.from(response.data, 'binary'))\n            jsonResult.contentType = response.headers['content-type']?.toString() ?? 'application/octet-stream'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n      }\n    } catch (ex) {\n      const axiosError = ex as AxiosError\n      if (axiosError.isAxiosError) {\n        if (axiosError?.response?.status !== undefined) {\n          result.http = result.http ?? {}\n          result.http.status = axiosError?.response?.status\n        }\n        if (axiosError?.code !== undefined) {\n          result.http = result.http ?? {}\n          result.http.code = axiosError?.code\n        }\n        return result\n      } else {\n        throw ex\n      }\n    }\n    return result\n  }\n}\n","import { assertEx } from '@xylabs/assert'\n\n/**\n * Returns the equivalent IPFS gateway URL for the supplied URL.\n * @param urlToCheck The URL to check\n * @returns If the supplied URL is an IPFS URL, it converts the URL to the\n * equivalent IPFS gateway URL. Otherwise, returns the original URL.\n */\nexport const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string) => {\n  try {\n    const url = new URL(urlToCheck)\n    let protocol = url.protocol\n    let host = url.host\n    let path = url.pathname\n    const query = url.search\n    if (protocol === 'ipfs:') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, 'No ipfsGateway provided')\n      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else {\n      return urlToCheck\n    }\n  } catch (ex) {\n    const error = ex as Error\n    console.error(`${error.name}:${error.message} [${urlToCheck}]`)\n    console.log(error.stack)\n    return undefined\n  }\n}\n"],"mappings":";AAGO,IAAM,gBAAgB;AAatB,IAAM,sBAAsB;;;AChBnC,SAAS,YAAAA,iBAAgB;AACzB,SAAS,OAAmB,iBAAiB;AAC7C,SAAS,cAAc;AACvB,SAAS,uBAAuB;AAChC,SAAe,qBAAqB;AAEpC,SAAS,6BAA6B;AAEtC,SAAS,qBAAqB;;;ACR9B,SAAS,gBAAgB;AAQlB,IAAM,eAAe,CAAC,YAAoB,gBAAyB;AACxE,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,UAAU;AAC9B,QAAI,WAAW,IAAI;AACnB,QAAI,OAAO,IAAI;AACf,QAAI,OAAO,IAAI;AACf,UAAM,QAAQ,IAAI;AAClB,QAAI,aAAa,SAAS;AACxB,iBAAW;AACX,aAAO,SAAS,aAAa,yBAAyB;AACtD,aAAO,IAAI,SAAS,SAAS,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI;AACpE,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,YAAQ,MAAM,GAAG,MAAM,IAAI,IAAI,MAAM,OAAO,KAAK,UAAU,GAAG;AAC9D,YAAQ,IAAI,MAAM,KAAK;AACvB,WAAO;AAAA,EACT;AACF;;;ADRO,IAAM,6BAA6B;AAWnC,IAAM,iBAAN,cAA0F,gBAAiD;AAAA,EAChJ,OAAgB,gBAAgB,CAAC,0BAA0B;AAAA,EAE3D,IAAI,SAAS;AACX,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,cAAc;AAChB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,MAAyB,eAAe,aAAwB,CAAC,GAA6B;AAC5F,UAAM,KAAK,QAAQ,OAAO;AAC1B,QAAI;AACF,YAAM,eAAe,MAAM,QAAQ;AAAA,QACjC,WAAW,OAAO,sBAAsB,aAAa,CAAC,EAAE,IAAI,OAAO,SAAS;AAC1E,gBAAM,EAAE,KAAK,KAAK,IAAI;AAEtB,gBAAM,eAAeC,UAAS,aAAa,KAAK,KAAK,WAAW,GAAG,aAAa;AAEhF,cAAI,SAAS,OAAO;AAClB,mBAAO,KAAK,QAAQ,cAAc,GAAG;AAAA,UACvC;AAEA,gBAAM,cAA6B;AAAA,YACjC,MAAM,MAAM,cAAc,UAAU,IAAI;AAAA,YACxC,QAAQ;AAAA,UACV;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,SAAS,IAAI;AACX,YAAM,QAAQ;AACd,cAAQ,IAAI,UAAU,KAAK,OAAO,IAAI,MAAM,MAAM,OAAO,EAAE;AAC3D,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAc,QAAQ,KAAa,MAAoC;AAxEzE;AAyEI,UAAM,SAAwB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,IACV;AACA,QAAI;AACF,cAAQ,KAAK,QAAQ;AAAA,QACnB,KAAK,oBAAoB;AACvB,gBAAM,QAAQ,IAAI,UAAU;AAC5B,gBAAM,WAAW,MAAM,MAAM,IAA4B,GAAG;AAC5D,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,SAAS;AAC3B,uBAAW,cAAc;AAAA,UAC3B,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,QACA,SAAS;AACP,gBAAM,QAAQ,IAAI,MAAM,EAAE,cAAc,cAAc,CAAC;AACvD,gBAAM,WAAW,MAAM,MAAM,IAAI,GAAG;AACpC,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,cAAc,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAC;AACpE,uBAAW,gBAAc,cAAS,QAAQ,cAAc,MAA/B,mBAAkC,eAAc;AAAA,UAC3E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,IAAI;AACX,YAAM,aAAa;AACnB,UAAI,WAAW,cAAc;AAC3B,cAAI,8CAAY,aAAZ,mBAAsB,YAAW,QAAW;AAC9C,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,UAAS,8CAAY,aAAZ,mBAAsB;AAAA,QAC7C;AACA,aAAI,yCAAY,UAAS,QAAW;AAClC,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,OAAO,yCAAY;AAAA,QACjC;AACA,eAAO;AAAA,MACT,OAAO;AACL,cAAM;AAAA,MACR;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":["assertEx","assertEx"]}

package/dist/node/lib/checkIpfsUrl.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string | undefined;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,uBAsBpE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string | undefined;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,uBAsBpE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string | undefined;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,uBAsBpE,CAAA"}

package/dist/node/lib/index.d.cts

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

package/dist/node/lib/index.d.cts.map

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

package/dist/node/lib/index.d.mts

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

package/dist/node/lib/index.d.mts.map

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

package/dist/node/lib/index.d.ts

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

package/dist/node/lib/index.d.ts.map

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

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@xyo-network/api-call-witness",
+  "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": {
+    "@xylabs/assert": "^2.13.8",
+    "@xylabs/axios": "^2.13.8",
+    "@xylabs/buffer": "^2.13.8",
+    "@xyo-network/abstract-witness": "~2.79.5",
+    "@xyo-network/hash": "~2.79.5",
+    "@xyo-network/object": "~2.79.5",
+    "@xyo-network/payload-model": "~2.79.5",
+    "@xyo-network/witness-model": "~2.79.5",
+    "base64-js": "^1.5.1"
+  },
+  "devDependencies": {
+    "@xylabs/jest-helpers": "^2.13.8",
+    "@xylabs/ts-scripts-yarn3": "^3.1.21",
+    "@xylabs/tsconfig": "^3.1.21",
+    "ethers": "^5.7.2",
+    "jest": "^29.7.0",
+    "typescript": "^5.2.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "types": "dist/node/index.d.mts",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.79.5",
+  "type": "module"
+}

package/src/Payload.ts

@@ -0,0 +1,51 @@
+import { Hash } from '@xyo-network/hash'
+import { Payload } from '@xyo-network/payload-model'
+
+export const ApiCallSchema = 'network.xyo.api.call'
+export type ApiCallSchema = typeof ApiCallSchema
+
+export type Verb = 'get' | 'post'
+
+export type ApiCall = Payload<
+  {
+    uri: string
+    verb?: Verb
+  },
+  ApiCallSchema
+>
+
+export const ApiCallResultSchema = 'network.xyo.api.call.result'
+export type ApiCallResultSchema = typeof ApiCallResultSchema
+
+export interface HttpMeta {
+  code?: string
+  status?: number
+}
+
+export type ApiCallJsonResult<T extends object | [] = object> = Payload<
+  {
+    call: Hash
+    contentType: 'application/json'
+    data: T
+  },
+  ApiCallResultSchema
+>
+
+export type ApiCallBase64Result = Payload<
+  {
+    call: Hash
+    contentType: Exclude<string, ApiCallJsonResult['contentType']>
+    data: string
+  },
+  ApiCallResultSchema
+>
+
+export type ApiCallErrorResult = Payload<
+  {
+    call: Hash
+    http?: HttpMeta
+  },
+  ApiCallResultSchema
+>
+
+export type ApiCallResult = ApiCallBase64Result | ApiCallJsonResult | ApiCallErrorResult

package/src/Witness.ts

@@ -0,0 +1,129 @@
+import { assertEx } from '@xylabs/assert'
+import { Axios, AxiosError, AxiosJson } from '@xylabs/axios'
+import { Buffer } from '@xylabs/buffer'
+import { AbstractWitness } from '@xyo-network/abstract-witness'
+import { Hash, PayloadHasher } from '@xyo-network/hash'
+import { JsonArray, JsonObject } from '@xyo-network/object'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'
+import { fromByteArray } from 'base64-js'
+
+import { checkIpfsUrl } from './lib'
+import {
+  ApiCall,
+  ApiCallBase64Result,
+  ApiCallErrorResult,
+  ApiCallJsonResult,
+  ApiCallResult,
+  ApiCallResultSchema,
+  ApiCallSchema,
+  Verb,
+} from './Payload'
+
+export const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'
+export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema
+
+export type ApiCallWitnessConfig = WitnessConfig<{
+  accept: 'application/json'
+  schema: ApiCallWitnessConfigSchema
+  verb?: Verb
+}>
+
+export type ApiCallWitnessParams = WitnessParams<ApiCallWitnessConfig, { ipfsGateway?: string }>
+
+export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {
+  static override configSchemas = [ApiCallWitnessConfigSchema]
+
+  get accept() {
+    return this.config.accept
+  }
+
+  get ipfsGateway() {
+    return this.params.ipfsGateway
+  }
+
+  protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {
+    await this.started('throw')
+    try {
+      const observations = await Promise.all(
+        inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {
+          const { uri, verb } = call
+
+          const validatedUri = assertEx(checkIpfsUrl(uri, this.ipfsGateway), 'Invalid URI')
+
+          if (verb === 'get') {
+            return this.httpGet(validatedUri, uri)
+          }
+
+          const observation: ApiCallResult = {
+            call: await PayloadHasher.hashAsync(call),
+            schema: ApiCallResultSchema,
+          }
+          return observation
+        }),
+      )
+      return observations
+    } catch (ex) {
+      const error = ex as Error
+      console.log(`Error [${this.config.name}]: ${error.message}`)
+      throw error
+    }
+  }
+
+  private async httpGet(url: string, call: Hash): Promise<ApiCallResult> {
+    const result: ApiCallResult = {
+      call,
+      schema: ApiCallResultSchema,
+    }
+    try {
+      switch (this.accept) {
+        case 'application/json': {
+          const axios = new AxiosJson()
+          const response = await axios.get<JsonArray | JsonObject>(url)
+          if (response.status >= 200 && response.status < 300) {
+            const jsonResult = result as ApiCallJsonResult
+            jsonResult.data = response.data
+            jsonResult.contentType = 'application/json'
+          } else {
+            const errorResult = result as ApiCallErrorResult
+            errorResult.http = {
+              status: response.status,
+            }
+          }
+          break
+        }
+        default: {
+          const axios = new Axios({ responseType: 'arraybuffer' })
+          const response = await axios.get(url)
+          if (response.status >= 200 && response.status < 300) {
+            const jsonResult = result as ApiCallBase64Result
+            jsonResult.data = fromByteArray(Buffer.from(response.data, 'binary'))
+            jsonResult.contentType = response.headers['content-type']?.toString() ?? 'application/octet-stream'
+          } else {
+            const errorResult = result as ApiCallErrorResult
+            errorResult.http = {
+              status: response.status,
+            }
+          }
+          break
+        }
+      }
+    } catch (ex) {
+      const axiosError = ex as AxiosError
+      if (axiosError.isAxiosError) {
+        if (axiosError?.response?.status !== undefined) {
+          result.http = result.http ?? {}
+          result.http.status = axiosError?.response?.status
+        }
+        if (axiosError?.code !== undefined) {
+          result.http = result.http ?? {}
+          result.http.code = axiosError?.code
+        }
+        return result
+      } else {
+        throw ex
+      }
+    }
+    return result
+  }
+}

package/src/index.ts

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

package/src/lib/checkIpfsUrl.ts

@@ -0,0 +1,31 @@
+import { assertEx } from '@xylabs/assert'
+
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string) => {
+  try {
+    const url = new URL(urlToCheck)
+    let protocol = url.protocol
+    let host = url.host
+    let path = url.pathname
+    const query = url.search
+    if (protocol === 'ipfs:') {
+      protocol = 'https:'
+      host = assertEx(ipfsGateway, 'No ipfsGateway provided')
+      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`
+      const root = `${protocol}//${host}/${path}`
+      return query?.length > 0 ? `${root}?${query}` : root
+    } else {
+      return urlToCheck
+    }
+  } catch (ex) {
+    const error = ex as Error
+    console.error(`${error.name}:${error.message} [${urlToCheck}]`)
+    console.log(error.stack)
+    return undefined
+  }
+}

package/src/lib/index.ts

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

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}