@xyo-network/boundwitness-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,936 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/boundwitness-model
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
 
-Version: 5.0.2
+Using npm:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+npm install {{name}}
+```
 
-## Documentation
+Using yarn:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__boundwitness-model)
+```sh
+yarn add {{name}}
+```
+
+Using pnpm:
+
+```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
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### functions
+
+                ### <a id="BoundWitnessJsonSchema"></a>BoundWitnessJsonSchema
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+function BoundWitnessJsonSchema(): object;
+```
+
+## Returns
+
+`object`
+
+### $id
+
+```ts
+$id: string = 'https://schemas.xyo.network/2.0/boundwitness';
+```
+
+### additionalProperties
+
+```ts
+additionalProperties: boolean = false;
+```
+
+### properties
+
+```ts
+properties: object;
+```
+
+### properties.addresses
+
+```ts
+addresses: object;
+```
+
+### properties.addresses.items
+
+```ts
+items: object;
+```
+
+### properties.addresses.items.type
+
+```ts
+type: string = 'string';
+```
+
+### properties.addresses.type
+
+```ts
+type: string = 'array';
+```
+
+### properties.payload\_hashes
+
+```ts
+payload_hashes: object;
+```
+
+### properties.payload\_hashes.items
+
+```ts
+items: object;
+```
+
+### properties.payload\_hashes.items.type
+
+```ts
+type: string = 'string';
+```
+
+### properties.payload\_hashes.type
+
+```ts
+type: string = 'array';
+```
+
+### properties.payload\_schemas
+
+```ts
+payload_schemas: object;
+```
+
+### properties.payload\_schemas.items
+
+```ts
+items: object;
+```
+
+### properties.payload\_schemas.items.type
+
+```ts
+type: string = 'string';
+```
+
+### properties.payload\_schemas.type
+
+```ts
+type: string = 'array';
+```
+
+### properties.previous\_hashes
+
+```ts
+previous_hashes: object;
+```
+
+### properties.previous\_hashes.items
+
+```ts
+items: object;
+```
+
+### properties.previous\_hashes.items.nullable
+
+```ts
+nullable: boolean = true;
+```
+
+### properties.previous\_hashes.items.type
+
+```ts
+type: string = 'string';
+```
+
+### properties.previous\_hashes.type
+
+```ts
+type: string = 'array';
+```
+
+### properties.schema
+
+```ts
+schema: object;
+```
+
+### properties.schema.type
+
+```ts
+type: string = 'string';
+```
+
+### required
+
+```ts
+required: string[];
+```
+
+### type
+
+```ts
+type: string = 'object';
+```
+
+                ### <a id="HydratedBoundWitnessZodBuilder"></a>HydratedBoundWitnessZodBuilder
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+function HydratedBoundWitnessZodBuilder<T>(bwZod): ZodTuple<[T, ZodArray<ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $loose>>], null>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `ZodType`\<\{
+  `addresses`: `BrandedAddress`[];
+  `payload_hashes`: `BrandedHash`[];
+  `payload_schemas`: `BrandedSchema`\<`string`\>[];
+  `previous_hashes`: (`BrandedHash` \| `null`)[];
+  `$destination?`: `BrandedAddress`;
+  `$sourceQuery?`: `BrandedHash`;
+  `schema`: `"network.xyo.boundwitness"` & `object`;
+  `$signatures`: (`BrandedHex` \| `null`)[];
+\}, `unknown`, `$ZodTypeInternals`\<\{
+  `addresses`: `BrandedAddress`[];
+  `payload_hashes`: `BrandedHash`[];
+  `payload_schemas`: `BrandedSchema`\<`string`\>[];
+  `previous_hashes`: (`BrandedHash` \| `null`)[];
+  `$destination?`: `BrandedAddress`;
+  `$sourceQuery?`: `BrandedHash`;
+  `schema`: `"network.xyo.boundwitness"` & `object`;
+  `$signatures`: (`BrandedHex` \| `null`)[];
+\}, `unknown`\>\>
+
+## Parameters
+
+### bwZod
+
+`T`
+
+## Returns
+
+`ZodTuple`\<\[`T`, `ZodArray`\<`ZodObject`\<\{
+  `schema`: `ZodPipe`\<`ZodString`, `ZodTransform`\<`BrandedSchema`\<`string`\>, `string`\>\>;
+\}, `$loose`\>\>\], `null`\>
+
+                ### <a id="isQueryBoundWitness"></a>isQueryBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+function isQueryBoundWitness(x?): x is UnsignedQueryBoundWitness;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is UnsignedQueryBoundWitness`
+
+                ### <a id="isQueryBoundWitnessWithStorageMeta"></a>isQueryBoundWitnessWithStorageMeta
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+function isQueryBoundWitnessWithStorageMeta(x?): x is WithStorageMeta<UnsignedQueryBoundWitness>;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is WithStorageMeta<UnsignedQueryBoundWitness>`
+
+              ### type-aliases
+
+                ### <a id="AnyBoundWitness"></a>AnyBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type AnyBoundWitness = z.infer<typeof AnyBoundWitnessZod>;
+```
+
+                ### <a id="AnySignedBoundWitness"></a>AnySignedBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type AnySignedBoundWitness = z.infer<typeof AnySignedBoundWitnessZod>;
+```
+
+                ### <a id="AnyUnsignedBoundWitness"></a>AnyUnsignedBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type AnyUnsignedBoundWitness = z.infer<typeof AnyUnsignedBoundWitnessZod>;
+```
+
+                ### <a id="BoundWitness"></a>BoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitness = z.infer<typeof BoundWitnessZod>;
+```
+
+                ### <a id="BoundWitnessMeta"></a>BoundWitnessMeta
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessMeta = z.infer<typeof BoundWitnessMetaZod>;
+```
+
+                ### <a id="BoundWitnessRequiredFields"></a>BoundWitnessRequiredFields
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessRequiredFields = z.infer<typeof BoundWitnessRequiredFieldsZod>;
+```
+
+                ### <a id="BoundWitnessSchema"></a>BoundWitnessSchema
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type BoundWitnessSchema = typeof BoundWitnessSchema;
+```
+
+                ### <a id="PossiblySigned"></a>PossiblySigned
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type PossiblySigned<T> = Unsigned<T> | Signed<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BoundWitness`](#BoundWitness)
+
+                ### <a id="QueryBoundWitness"></a>QueryBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type QueryBoundWitness = UnsignedQueryBoundWitness;
+```
+
+                ### <a id="QueryBoundWitnessFields"></a>QueryBoundWitnessFields
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type QueryBoundWitnessFields = object;
+```
+
+## Properties
+
+### error\_hashes?
+
+```ts
+optional error_hashes?: Hash[];
+```
+
+***
+
+### query
+
+```ts
+query: Hash;
+```
+
+                ### <a id="SignaturesMeta"></a>SignaturesMeta
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type SignaturesMeta = z.infer<typeof SignaturesMetaZod>;
+```
+
+                ### <a id="Signed"></a>Signed
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type Signed<T> = Omit<T, "$signatures"> & SignedSignaturesMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BoundWitness`](#BoundWitness)
+
+                ### <a id="SignedBoundWitness"></a>SignedBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type SignedBoundWitness = z.infer<typeof SignedBoundWitnessZod>;
+```
+
+                ### <a id="SignedSignaturesMeta"></a>SignedSignaturesMeta
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type SignedSignaturesMeta = z.infer<typeof SignedSignaturesMetaZod>;
+```
+
+                ### <a id="Unsigned"></a>Unsigned
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type Unsigned<T> = Omit<T, "$signatures"> & UnsignedSignaturesMeta;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BoundWitness`](#BoundWitness)
+
+                ### <a id="UnsignedBoundWitness"></a>UnsignedBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type UnsignedBoundWitness = z.infer<typeof UnsignedBoundWitnessZod>;
+```
+
+                ### <a id="UnsignedQueryBoundWitness"></a>UnsignedQueryBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type UnsignedQueryBoundWitness = BoundWitness & QueryBoundWitnessFields;
+```
+
+                ### <a id="UnsignedSignaturesMeta"></a>UnsignedSignaturesMeta
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+type UnsignedSignaturesMeta = z.infer<typeof UnsignedSignaturesMetaZod>;
+```
+
+              ### variables
+
+                ### <a id="AnyBoundWitnessZod"></a>AnyBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const AnyBoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
+}, $loose>;
+```
+
+                ### <a id="AnySignedBoundWitnessZod"></a>AnySignedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const AnySignedBoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
+}, $loose>;
+```
+
+                ### <a id="AnyUnsignedBoundWitnessZod"></a>AnyUnsignedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const AnyUnsignedBoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodNull>;
+}, $loose>;
+```
+
+                ### <a id="BoundWitnessMetaZod"></a>BoundWitnessMetaZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessMetaZod: ZodObject<{
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
+}, $strip>;
+```
+
+                ### <a id="BoundWitnessRequiredFieldsZod"></a>BoundWitnessRequiredFieldsZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessRequiredFieldsZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+}, $strip>;
+```
+
+                ### <a id="BoundWitnessSchema"></a>BoundWitnessSchema
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessSchema: "network.xyo.boundwitness" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="BoundWitnessZod"></a>BoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const BoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
+}, $strip>;
+```
+
+                ### <a id="HydratedBoundWitnessZod"></a>HydratedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const HydratedBoundWitnessZod: ZodTuple<[ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
+}, $strip>, ZodArray<ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $loose>>], null>;
+```
+
+                ### <a id="SignaturesMetaZod"></a>SignaturesMetaZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const SignaturesMetaZod: ZodObject<{
+  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
+}, $strip>;
+```
+
+                ### <a id="SignedBoundWitnessZod"></a>SignedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const SignedBoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
+}, $strip>;
+```
+
+                ### <a id="SignedHydratedBoundWitnessZod"></a>SignedHydratedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const SignedHydratedBoundWitnessZod: ZodTuple<[ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
+}, $strip>, ZodArray<ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $loose>>], null>;
+```
+
+                ### <a id="SignedSignaturesMetaZod"></a>SignedSignaturesMetaZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const SignedSignaturesMetaZod: ZodObject<{
+  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
+}, $strip>;
+```
+
+                ### <a id="UnsignedBoundWitnessZod"></a>UnsignedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const UnsignedBoundWitnessZod: ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodNull>;
+}, $strip>;
+```
+
+                ### <a id="UnsignedHydratedBoundWitnessZod"></a>UnsignedHydratedBoundWitnessZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const UnsignedHydratedBoundWitnessZod: ZodTuple<[ZodObject<{
+  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
+  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
+  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
+  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
+  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
+  $signatures: ZodArray<ZodNull>;
+}, $strip>, ZodArray<ZodObject<{
+  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
+}, $loose>>], null>;
+```
+
+                ### <a id="UnsignedSignaturesMetaZod"></a>UnsignedSignaturesMetaZod
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const UnsignedSignaturesMetaZod: ZodObject<{
+  $signatures: ZodArray<ZodNull>;
+}, $strip>;
+```
+
+                ### <a id="asBoundWitness"></a>asBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const asBoundWitness: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
+
+`T` & `object`
+
+                ### <a id="isBoundWitness"></a>isBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const isBoundWitness: <T>(value) => value is T & { addresses: BrandedAddress[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & { __schema: true }; $signatures: (BrandedHex | null)[] };
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+value is T & \{ addresses: BrandedAddress\[\]; payload\_hashes: BrandedHash\[\]; payload\_schemas: BrandedSchema\<string\>\[\]; previous\_hashes: (BrandedHash \| null)\[\]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & \{ \_\_schema: true \}; $signatures: (BrandedHex \| null)\[\] \}
+
+                ### <a id="toBoundWitness"></a>toBoundWitness
+
+[**@xyo-network/boundwitness-model**](#../README)
+
+***
+
+```ts
+const toBoundWitness: {
+<T>  (value): T & object | undefined;
+<T>  (value, assert): T & object;
+};
+```
+
+## Call Signature
+
+```ts
+<T>(value): T & object | undefined;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`T` & `object` \| `undefined`
+
+## Call Signature
+
+```ts
+<T>(value, assert): T & object;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### assert
+
+`ZodFactoryConfig`
+
+### Returns
 
-## Credits
+`T` & `object`
 
-[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-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/boundwitness-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/boundwitness-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/boundwitness-model",
-  "version": "5.3.25",
+  "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,15 +36,15 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~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",
+    "@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",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -52,7 +52,7 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "~4.3.6",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",