@xyo-network/url-plugin 2.57.6

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@xyo-network/url-plugin",
+  "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/module": "^2.57.6",
+    "@xyo-network/payload-model": "^2.57.6",
+    "@xyo-network/payloadset-plugin": "^2.57.6",
+    "@xyo-network/url-payload-plugin": "^2.57.6",
+    "@xyo-network/witness": "^2.57.6"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.17.13",
+    "@xylabs/tsconfig": "^2.17.13",
+    "typescript": "^5.0.4"
+  },
+  "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.57.6"
+}

package/src/Plugin.ts

@@ -0,0 +1,16 @@
+import { PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+import { UrlSchema } from '@xyo-network/url-payload-plugin'
+
+import { UrlWitness } from './Witness'
+
+export const UrlPlugin = () =>
+  createPayloadSetWitnessPlugin<UrlWitness>(
+    { required: { [UrlSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await UrlWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness/Config.ts

@@ -0,0 +1,10 @@
+import { UrlSchema } from '@xyo-network/url-payload-plugin'
+import { WitnessConfig } from '@xyo-network/witness'
+
+export const UrlWitnessConfigSchema = `${UrlSchema}.witness.config` as const
+export type UrlWitnessConfigSchema = typeof UrlWitnessConfigSchema
+
+export type UrlWitnessConfig = WitnessConfig<{
+  schema: UrlWitnessConfigSchema
+  url?: string
+}>

package/src/Witness/Params.ts

@@ -0,0 +1,6 @@
+import { AnyConfigSchema } from '@xyo-network/module'
+import { WitnessParams } from '@xyo-network/witness'
+
+import { UrlWitnessConfig } from './Config'
+
+export type UrlWitnessParams = WitnessParams<AnyConfigSchema<UrlWitnessConfig>>

package/src/Witness/Witness.ts

@@ -0,0 +1,33 @@
+import { Payload } from '@xyo-network/payload-model'
+import { UrlPayload, UrlSchema } from '@xyo-network/url-payload-plugin'
+import { AbstractWitness } from '@xyo-network/witness'
+
+import { hashUrl } from '../util'
+import { UrlWitnessConfigSchema } from './Config'
+import { UrlWitnessParams } from './Params'
+
+export class UrlWitness<TParams extends UrlWitnessParams = UrlWitnessParams> extends AbstractWitness<TParams> {
+  static override configSchema = UrlWitnessConfigSchema
+
+  get url() {
+    return this.config?.url
+  }
+
+  override async observe(payloads: Payload[] = []): Promise<Payload[]> {
+    const urls: UrlPayload[] = this.url
+      ? [{ schema: UrlSchema, url: this.url }]
+      : payloads
+          .filter((p): p is UrlPayload => p.schema === UrlSchema)
+          .map((p) => {
+            return { schema: UrlSchema, url: p.url }
+          })
+    const hashed = await Promise.all(
+      urls.map(async (url) => {
+        // TODO: Different schema for hashed url
+        return { ...url, hash: await hashUrl(url.url) }
+      }),
+    )
+    // TODO: Handle partial success
+    return await super.observe(hashed)
+  }
+}

package/src/Witness/index.ts

@@ -0,0 +1,3 @@
+export * from './Config'
+export * from './Params'
+export * from './Witness'

package/src/index.ts

@@ -0,0 +1,8 @@
+import { UrlPlugin } from './Plugin'
+
+export * from './Witness'
+
+export { UrlPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default UrlPlugin

package/src/util/hashFile.ts

@@ -0,0 +1,21 @@
+import { createHash } from 'crypto'
+import { createReadStream } from 'fs'
+import { fileURLToPath } from 'url'
+
+export const hashFile = (url: string): Promise<string> => {
+  const path = url.startsWith('file://') ? fileURLToPath(url) : url
+  const ret = new Promise<string>((resolve, reject) => {
+    const hash = createHash('sha256')
+    const stream = createReadStream(path)
+    stream.on('data', (data) => {
+      hash.update(data)
+    })
+    stream.on('end', () => {
+      resolve(hash.digest('hex'))
+    })
+    stream.on('error', (err) => {
+      reject(err)
+    })
+  })
+  return ret
+}

package/src/util/hashHttpUrl.ts

@@ -0,0 +1,23 @@
+import { createHash } from 'crypto'
+import http from 'http'
+import https from 'https'
+
+export const hashHttpUrl = (url: string): Promise<string> => {
+  const ret = new Promise<string>((resolve, reject) => {
+    const hash = createHash('sha256')
+    const lib = url.startsWith('https') ? https : http
+    lib
+      .get(url, (res) => {
+        res.on('data', (data) => {
+          hash.update(data)
+        })
+        res.on('end', () => {
+          resolve(hash.digest('hex'))
+        })
+      })
+      .on('error', (err) => {
+        reject(err)
+      })
+  })
+  return ret
+}

package/src/util/hashUrl.ts

@@ -0,0 +1,15 @@
+import { hashFile } from './hashFile'
+import { hashHttpUrl } from './hashHttpUrl'
+
+export const hashUrl = (url: string): Promise<string> => {
+  const scheme = url.split('://')[0]?.toLowerCase()
+  switch (scheme) {
+    case 'file':
+      return hashFile(url)
+    case 'http':
+    case 'https':
+      return hashHttpUrl(url)
+    default:
+      throw new Error(`Unsupported URL scheme: ${scheme}`)
+  }
+}

package/src/util/index.ts

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

package/src/util/spec/test.txt

@@ -0,0 +1 @@
+This file exists to test hashing

package/typedoc.json

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