@xyo-network/boundwitness-validator 2.42.16

package/dist/esm/Validator.d.ts

@@ -0,0 +1,19 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
+import { PayloadValidator } from '@xyo-network/payload-validator';
+export declare class BoundWitnessValidator<T extends XyoBoundWitness<{
+    schema: string;
+}> = XyoBoundWitness> extends PayloadValidator<T> {
+    get hash(): string;
+    static validateSignature(hash: string, address: string, signature?: string): Error[];
+    addresses(): Error[];
+    addressesUniqueness(): Error[];
+    previousHashes(): Error[];
+    schema(): Error[];
+    schemas(): Error[];
+    signatures(): Error[];
+    validate(): Error[];
+    validateArrayLengths(): Error[];
+    validatePayloadHashesLength(): Error[];
+    private validateArrayLength;
+}
+//# sourceMappingURL=Validator.d.ts.map

package/dist/esm/Validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.d.ts","sourceRoot":"","sources":["../../src/Validator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAyB,MAAM,iCAAiC,CAAA;AAExF,OAAO,EAAE,gBAAgB,EAA0B,MAAM,gCAAgC,CAAA;AAQzF,qBAAa,qBAAqB,CAAC,CAAC,SAAS,eAAe,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,eAAe,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAC7H,IAAW,IAAI,WAEd;IAED,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAUnE,SAAS;IAQT,mBAAmB;IAQnB,cAAc;IAKd,MAAM;IASN,OAAO;IAcP,UAAU;IAUD,QAAQ;IAYjB,oBAAoB;IAMpB,2BAA2B;IAMlC,OAAO,CAAC,mBAAmB;CAY5B"}

package/dist/esm/Validator.js

@@ -0,0 +1,104 @@
+import { AddressValue } from '@xyo-network/account';
+import { XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model';
+import { Hasher } from '@xyo-network/core';
+import { PayloadValidator, XyoSchemaNameValidator } from '@xyo-network/payload-validator';
+import { validateType } from '@xyo-network/typeof';
+import uniq from 'lodash/uniq';
+const validateArraysSameLength = (a, b, message = 'Array length mismatch') => {
+    return a.length != b.length ? [Error(`${message} []`)] : [];
+};
+export class BoundWitnessValidator extends PayloadValidator {
+    get hash() {
+        return new Hasher(this.obj).hash;
+    }
+    static validateSignature(hash, address, signature) {
+        if (!signature) {
+            return [Error(`Missing signature [${address}]`)];
+        }
+        if (!new AddressValue(address).verify(hash, signature)) {
+            return [Error(`Invalid signature [${address}] [${signature}]`)];
+        }
+        return [];
+    }
+    addresses() {
+        const errors = [];
+        const { addresses } = this.obj;
+        if (!addresses?.length)
+            errors.push(new Error('addresses missing [at least one address required]'));
+        errors.push(...this.addressesUniqueness());
+        return errors;
+    }
+    addressesUniqueness() {
+        const errors = [];
+        const { addresses } = this.obj;
+        const uniqAddresses = uniq(addresses);
+        if (addresses?.length !== uniqAddresses?.length)
+            errors.push(new Error('addresses must be unique'));
+        return errors;
+    }
+    previousHashes() {
+        const errors = [];
+        return errors;
+    }
+    schema() {
+        const errors = [];
+        const expectedSchema = XyoBoundWitnessSchema;
+        if (this.obj.schema !== expectedSchema) {
+            errors.push(new Error(`invalid schema [${expectedSchema} !== ${this.obj.schema}]`));
+        }
+        return errors;
+    }
+    schemas() {
+        const errors = [];
+        const Schemas = this.obj.payload_schemas;
+        if (Schemas) {
+            const schemaValidators = Schemas.map((schema) => {
+                return new XyoSchemaNameValidator(schema);
+            });
+            schemaValidators.forEach((validator) => {
+                errors.push(...validator.all());
+            });
+        }
+        return errors;
+    }
+    signatures() {
+        return [
+            ...validateArraysSameLength(this.obj._signatures ?? [], this.obj.addresses, 'Length mismatch: address/_signature'),
+            ...this.obj.addresses.reduce((errors, address, index) => {
+                errors.push(...BoundWitnessValidator.validateSignature(this.hash, address, this.obj._signatures?.[index]));
+                return errors;
+            }, []),
+        ];
+    }
+    validate() {
+        return [
+            ...this.signatures(),
+            ...this.addresses(),
+            ...this.validateArrayLengths(),
+            ...this.schemas(),
+            ...this.previousHashes(),
+            ...this.schema(),
+            ...super.validate(),
+        ];
+    }
+    validateArrayLengths() {
+        const errors = [];
+        errors.push(...this.validatePayloadHashesLength());
+        return errors;
+    }
+    validatePayloadHashesLength() {
+        const errors = [];
+        errors.push(...this.validateArrayLength('payload_hashes', 'payload_schemas'));
+        return errors;
+    }
+    validateArrayLength(fieldName, compareArrayName) {
+        const errors = [];
+        const [array, arrayErrors] = validateType('array', this.stringKeyObj[fieldName], true);
+        const [compareArray, compareArrayErrors] = validateType('array', this.stringKeyObj[compareArrayName], true);
+        if (array?.length !== compareArray?.length) {
+            errors.push(new Error(`${fieldName}/${compareArrayName} count mismatch [${array?.length} !== ${compareArray?.length}]`));
+        }
+        return [...arrayErrors, ...compareArrayErrors, ...errors];
+    }
+}
+//# sourceMappingURL=Validator.js.map

package/dist/esm/Validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../src/Validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAmB,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACxF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,IAAI,MAAM,aAAa,CAAA;AAE9B,MAAM,wBAAwB,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,OAAO,GAAG,uBAAuB,EAAE,EAAE;IACjG,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC7D,CAAC,CAAA;AAED,MAAM,OAAO,qBAAuF,SAAQ,gBAAmB;IAC7H,IAAW,IAAI;QACb,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAA;IAClC,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,IAAY,EAAE,OAAe,EAAE,SAAkB;QACxE,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,sBAAsB,OAAO,GAAG,CAAC,CAAC,CAAA;SACjD;QACD,IAAI,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE;YACtD,OAAO,CAAC,KAAK,CAAC,sBAAsB,OAAO,MAAM,SAAS,GAAG,CAAC,CAAC,CAAA;SAChE;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAEM,SAAS;QACd,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAA;QAC9B,IAAI,CAAC,SAAS,EAAE,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC,CAAA;QACnG,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAA;QAC1C,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,mBAAmB;QACxB,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAA;QAC9B,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,SAAS,EAAE,MAAM,KAAK,aAAa,EAAE,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAA;QACnG,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,cAAc;QACnB,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,MAAM;QACX,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,cAAc,GAAG,qBAAqB,CAAA;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,cAAc,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,mBAAmB,cAAc,QAAQ,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;SACpF;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,OAAO;QACZ,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,eAAe,CAAA;QACxC,IAAI,OAAO,EAAE;YACX,MAAM,gBAAgB,GAA6B,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE;gBAChF,OAAO,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAA;YAC3C,CAAC,CAAC,CAAA;YACF,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACrC,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC,CAAA;YACjC,CAAC,CAAC,CAAA;SACH;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,UAAU;QACf,OAAO;YACL,GAAG,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,qCAAqC,CAAC;YAClH,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAU,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;gBAC/D,MAAM,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC1G,OAAO,MAAM,CAAA;YACf,CAAC,EAAE,EAAE,CAAC;SACP,CAAA;IACH,CAAC;IAEe,QAAQ;QACtB,OAAO;YACL,GAAG,IAAI,CAAC,UAAU,EAAE;YACpB,GAAG,IAAI,CAAC,SAAS,EAAE;YACnB,GAAG,IAAI,CAAC,oBAAoB,EAAE;YAC9B,GAAG,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,KAAK,CAAC,QAAQ,EAAE;SACpB,CAAA;IACH,CAAC;IAEM,oBAAoB;QACzB,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAA;QAClD,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,2BAA2B;QAChC,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAA;QAC7E,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,mBAAmB,CAAC,SAAiB,EAAE,gBAAwB;QACrE,MAAM,MAAM,GAAY,EAAE,CAAA;QAE1B,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAO,EAAE,IAAI,CAAC,CAAA;QAC5F,MAAM,CAAC,YAAY,EAAE,kBAAkB,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAO,EAAE,IAAI,CAAC,CAAA;QAEjH,IAAI,KAAK,EAAE,MAAM,KAAK,YAAY,EAAE,MAAM,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,SAAS,IAAI,gBAAgB,oBAAoB,KAAK,EAAE,MAAM,QAAQ,YAAY,EAAE,MAAM,GAAG,CAAC,CAAC,CAAA;SACzH;QAED,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC,CAAA;IAC3D,CAAC;CACF"}

package/dist/esm/index.d.ts

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

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

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

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './Validator';
+//# 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,aAAa,CAAA"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@xyo-network/boundwitness-validator",
+  "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/account": "^2.42.16",
+    "@xyo-network/boundwitness-model": "^2.42.16",
+    "@xyo-network/core": "^2.42.16",
+    "@xyo-network/payload-validator": "^2.42.15",
+    "@xyo-network/typeof": "^2.42.16",
+    "lodash": "^4.17.21"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@types/lodash": "^4.14.191",
+    "@xylabs/ts-scripts-yarn3": "^2.10.25"
+  },
+  "peerDependencies": {
+    "axios": "^1.2.1"
+  },
+  "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-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.42.16"
+}

package/src/Validator.spec.ts

@@ -0,0 +1,20 @@
+import { XyoBoundWitness, XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
+import { dumpErrors } from '@xyo-network/core'
+
+import { BoundWitnessValidator } from './Validator'
+
+const testBoundWitness: XyoBoundWitness = {
+  _signatures: ['95100e5fd2012b958e96895870cfac5353c3a33a19314cfd1304ef7d01d052ec2a3ef80d6449cf88d463027fe0d868ed8cfb8b7323d37e93a08570233eea0b17'],
+  addresses: ['5346a2ce56ec4177b67092bda710e150ba6fa046'],
+  payload_hashes: ['20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c'],
+  payload_schemas: ['network.xyo.test'],
+  previous_hashes: [null],
+  schema: XyoBoundWitnessSchema,
+}
+
+test('all', () => {
+  const validator = new BoundWitnessValidator(testBoundWitness)
+  const errors = validator.validate()
+  dumpErrors(errors)
+  expect(errors.length).toBe(0)
+})

package/src/Validator.ts

@@ -0,0 +1,117 @@
+import { AddressValue } from '@xyo-network/account'
+import { XyoBoundWitness, XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
+import { Hasher } from '@xyo-network/core'
+import { PayloadValidator, XyoSchemaNameValidator } from '@xyo-network/payload-validator'
+import { validateType } from '@xyo-network/typeof'
+import uniq from 'lodash/uniq'
+
+const validateArraysSameLength = (a: unknown[], b: unknown[], message = 'Array length mismatch') => {
+  return a.length != b.length ? [Error(`${message} []`)] : []
+}
+
+export class BoundWitnessValidator<T extends XyoBoundWitness<{ schema: string }> = XyoBoundWitness> extends PayloadValidator<T> {
+  public get hash() {
+    return new Hasher(this.obj).hash
+  }
+
+  static validateSignature(hash: string, address: string, signature?: string) {
+    if (!signature) {
+      return [Error(`Missing signature [${address}]`)]
+    }
+    if (!new AddressValue(address).verify(hash, signature)) {
+      return [Error(`Invalid signature [${address}] [${signature}]`)]
+    }
+    return []
+  }
+
+  public addresses() {
+    const errors: Error[] = []
+    const { addresses } = this.obj
+    if (!addresses?.length) errors.push(new Error('addresses missing [at least one address required]'))
+    errors.push(...this.addressesUniqueness())
+    return errors
+  }
+
+  public addressesUniqueness() {
+    const errors: Error[] = []
+    const { addresses } = this.obj
+    const uniqAddresses = uniq(addresses)
+    if (addresses?.length !== uniqAddresses?.length) errors.push(new Error('addresses must be unique'))
+    return errors
+  }
+
+  public previousHashes() {
+    const errors: Error[] = []
+    return errors
+  }
+
+  public schema() {
+    const errors: Error[] = []
+    const expectedSchema = XyoBoundWitnessSchema
+    if (this.obj.schema !== expectedSchema) {
+      errors.push(new Error(`invalid schema [${expectedSchema} !== ${this.obj.schema}]`))
+    }
+    return errors
+  }
+
+  public schemas() {
+    const errors: Error[] = []
+    const Schemas = this.obj.payload_schemas
+    if (Schemas) {
+      const schemaValidators: XyoSchemaNameValidator[] = Schemas.map((schema: string) => {
+        return new XyoSchemaNameValidator(schema)
+      })
+      schemaValidators.forEach((validator) => {
+        errors.push(...validator.all())
+      })
+    }
+    return errors
+  }
+
+  public signatures() {
+    return [
+      ...validateArraysSameLength(this.obj._signatures ?? [], this.obj.addresses, 'Length mismatch: address/_signature'),
+      ...this.obj.addresses.reduce<Error[]>((errors, address, index) => {
+        errors.push(...BoundWitnessValidator.validateSignature(this.hash, address, this.obj._signatures?.[index]))
+        return errors
+      }, []),
+    ]
+  }
+
+  public override validate() {
+    return [
+      ...this.signatures(),
+      ...this.addresses(),
+      ...this.validateArrayLengths(),
+      ...this.schemas(),
+      ...this.previousHashes(),
+      ...this.schema(),
+      ...super.validate(),
+    ]
+  }
+
+  public validateArrayLengths() {
+    const errors: Error[] = []
+    errors.push(...this.validatePayloadHashesLength())
+    return errors
+  }
+
+  public validatePayloadHashesLength() {
+    const errors: Error[] = []
+    errors.push(...this.validateArrayLength('payload_hashes', 'payload_schemas'))
+    return errors
+  }
+
+  private validateArrayLength(fieldName: string, compareArrayName: string) {
+    const errors: Error[] = []
+
+    const [array, arrayErrors] = validateType('array', this.stringKeyObj[fieldName] as [], true)
+    const [compareArray, compareArrayErrors] = validateType('array', this.stringKeyObj[compareArrayName] as [], true)
+
+    if (array?.length !== compareArray?.length) {
+      errors.push(new Error(`${fieldName}/${compareArrayName} count mismatch [${array?.length} !== ${compareArray?.length}]`))
+    }
+
+    return [...arrayErrors, ...compareArrayErrors, ...errors]
+  }
+}

package/src/index.ts

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