@xyo-network/boundwitness-validator 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,915 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/boundwitness-validator
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
 
-Version: 5.0.2
+Using yarn:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+yarn add {{name}}
+```
 
-## Documentation
+Using pnpm:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__boundwitness-validator)
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### protocol
+
+    ### packages
+
+      ### boundwitness
+
+        ### packages
+
+          ### validator
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="BoundWitnessValidator"></a>BoundWitnessValidator
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+## Extends
+
+- `PayloadValidator`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `BoundWitness` = `BoundWitness`
+
+## Constructors
+
+### Constructor
+
+```ts
+new BoundWitnessValidator<T>(payload): BoundWitnessValidator<T>;
+```
+
+### Parameters
+
+#### payload
+
+`T`
+
+### Returns
+
+`BoundWitnessValidator`\<`T`\>
+
+### Inherited from
+
+```ts
+PayloadValidator<T>.constructor
+```
+
+## Properties
+
+### schemaNameValidatorFactory
+
+```ts
+protected static schemaNameValidatorFactory: AllValidatorFactory;
+```
+
+### Inherited from
+
+```ts
+PayloadValidator.schemaNameValidatorFactory
+```
+
+***
+
+### payload
+
+```ts
+protected payload: Payload;
+```
+
+### Inherited from
+
+```ts
+PayloadValidator.payload
+```
+
+## Accessors
+
+### expectedSchema
+
+### Get Signature
+
+```ts
+get protected expectedSchema(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### schemaValidator
+
+### Get Signature
+
+```ts
+get schemaValidator(): AllValidator;
+```
+
+#### Returns
+
+`AllValidator`
+
+### Inherited from
+
+```ts
+PayloadValidator.schemaValidator
+```
+
+## Methods
+
+### validateSignature()
+
+```ts
+static validateSignature(
+   hash, 
+   address, 
+signature?): Promise<Error[]>;
+```
+
+### Parameters
+
+#### hash
+
+`ArrayBufferLike`
+
+#### address
+
+`ArrayBufferLike`
+
+#### signature?
+
+`ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+***
+
+### addresses()
+
+```ts
+addresses(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### addressesUniqueness()
+
+```ts
+addressesUniqueness(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### previousHashes()
+
+```ts
+previousHashes(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### schema()
+
+```ts
+schema(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### schemas()
+
+```ts
+schemas(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### signatures()
+
+```ts
+signatures(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Overrides
+
+```ts
+PayloadValidator.validate
+```
+
+***
+
+### validateArrayLengths()
+
+```ts
+validateArrayLengths(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### validatePayloadHashesLength()
+
+```ts
+validatePayloadHashesLength(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+***
+
+### setSchemaNameValidatorFactory()
+
+```ts
+static setSchemaNameValidatorFactory(factory): void;
+```
+
+### Parameters
+
+#### factory
+
+`AllValidatorFactory`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+PayloadValidator.setSchemaNameValidatorFactory
+```
+
+***
+
+### schemaName()
+
+```ts
+schemaName(): Error[];
+```
+
+### Returns
+
+`Error`[]
+
+### Inherited from
+
+```ts
+PayloadValidator.schemaName
+```
+
+              ### functions
+
+                ### <a id="addressesContains"></a>addressesContains
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function addressesContains(bw, address): boolean;
+```
+
+Checks if the boundwitness contains the addresses
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### address
+
+`BrandedAddress`
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains the addresses
+
+                ### <a id="addressesContainsAll"></a>addressesContainsAll
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function addressesContainsAll(bw, addresses): boolean;
+```
+
+Checks if the boundwitness contains all of the addresses
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### addresses
+
+`BrandedAddress`[]
+
+The addresses to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains all of the addresses
+
+                ### <a id="addressesContainsAny"></a>addressesContainsAny
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function addressesContainsAny(bw, addresses): boolean;
+```
+
+Checks if the boundwitness contains any of the addresses. If the addresses array
+is empty, it will return true. This is to match the behavior or addressesContainsAll
+which will return true if the addresses array is empty.
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### addresses
+
+`BrandedAddress`[]
+
+The addresses to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains any of the addresses
+
+                ### <a id="payloadHashesContains"></a>payloadHashesContains
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadHashesContains(bw, payloadHash): boolean;
+```
+
+Checks if the boundwitness contains the payload hash
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### payloadHash
+
+`BrandedHash`
+
+The payload hash to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains the payload hash
+
+                ### <a id="payloadHashesContainsAll"></a>payloadHashesContainsAll
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadHashesContainsAll(bw, payloadHashes): boolean;
+```
+
+Checks if the boundwitness contains all of the payload hashes
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### payloadHashes
+
+`BrandedHash`[]
+
+The payload hashes to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains all of the payload hashes
+
+                ### <a id="payloadHashesContainsAny"></a>payloadHashesContainsAny
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadHashesContainsAny(bw, payloadHashes): boolean;
+```
+
+Checks if the boundwitness contains any of the payload hashes. If the payload hashes array
+is empty, it will return true. This is to match the behavior or payload hashesContainsAll
+which will return true if the payload hashes array is empty.
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### payloadHashes
+
+`BrandedHash`[]
+
+The payload hashes to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains any of the payload hashes
+
+                ### <a id="payloadSchemasContains"></a>payloadSchemasContains
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadSchemasContains(bw, schema): boolean;
+```
+
+Checks if the boundwitness contains the payload schema
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### schema
+
+`Schema`
+
+The payload schema to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains the payload schema
+
+                ### <a id="payloadSchemasContainsAll"></a>payloadSchemasContainsAll
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadSchemasContainsAll(bw, payloadSchemas): boolean;
+```
+
+Checks if the boundwitness contains all of the payload schemas
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### payloadSchemas
+
+`Schema`[]
+
+The payload schemas to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains all of the payload schemas
+
+                ### <a id="payloadSchemasContainsAny"></a>payloadSchemasContainsAny
+
+[**@xyo-network/boundwitness-validator**](#../README)
+
+***
+
+```ts
+function payloadSchemasContainsAny(bw, payloadSchemas): boolean;
+```
+
+Checks if the boundwitness contains any of the payload schemas. If the payload schemas array
+is empty, it will return true. This is to match the behavior or payload schemasContainsAll
+which will return true if the payload schemas array is empty.
+
+## Parameters
+
+### bw
+
+The boundwitness to check
+
+### schema
+
+`"network.xyo.boundwitness"` & `object`
+
+### addresses
+
+`Lowercase`\<`string`\> & `object` & `object`[]
+
+### payload_hashes
+
+`BrandedHash`[]
+
+### payload_schemas
+
+`BrandedSchema`\<`string`\>[]
+
+### previous_hashes
+
+(`BrandedHash` \| `null`)[]
+
+### $destination?
+
+`Lowercase`\<`string`\> & `object` & `object`
+
+### $sourceQuery?
+
+`BrandedHash`
+
+### $signatures
+
+(`BrandedHex` \| `null`)[]
+
+### payloadSchemas
+
+`Schema`[]
+
+The payload schemas to check for
+
+## Returns
+
+`boolean`
 
-## Credits
+True if the boundwitness contains any of the payload schemas
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/boundwitness-validator.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/boundwitness-validator
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/boundwitness-validator.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/boundwitness-validator",
-  "version": "5.3.24",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,20 +36,20 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/boundwitness-model": "~5.3.24",
-    "@xyo-network/payload": "~5.3.24",
-    "@xyo-network/payload-validator": "~5.3.24",
-    "@xyo-network/elliptic": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24"
+    "@xyo-network/boundwitness-model": "~5.3.26",
+    "@xyo-network/payload": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/elliptic": "~5.3.26",
+    "@xyo-network/payload-validator": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
+    "@xylabs/vitest-extended": "~5.0.94",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -59,15 +59,15 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/boundwitness-model": "~5.3.24",
-    "@xyo-network/elliptic": "~5.3.24",
-    "@xyo-network/payload": "~5.3.24",
-    "@xyo-network/boundwitness-builder": "~5.3.24",
-    "@xyo-network/payload-model": "~5.3.24",
-    "@xyo-network/payload-validator": "~5.3.24",
-    "@xyo-network/wallet": "~5.3.24",
-    "@xyo-network/wallet-model": "~5.3.24",
-    "@xyo-network/schema-name-validator": "~5.3.24"
+    "@xyo-network/boundwitness-model": "~5.3.26",
+    "@xyo-network/elliptic": "~5.3.26",
+    "@xyo-network/boundwitness-builder": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/payload-validator": "~5.3.26",
+    "@xyo-network/payload": "~5.3.26",
+    "@xyo-network/schema-name-validator": "~5.3.26",
+    "@xyo-network/wallet": "~5.3.26",
+    "@xyo-network/wallet-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",