@xyo-network/boundwitness-model 5.1.24 → 5.2.1

package/dist/node/isBoundWitness.d.ts

@@ -1,14 +1,48 @@
 import type { WithStorageMeta } from '@xyo-network/payload-model';
 import type { BoundWitness, Signed, Unsigned } from './BoundWitness/index.ts';
 export declare const isBoundWitness: (value: unknown) => value is BoundWitness;
-export declare const notBoundWitness: (x?: unknown | null) => x is BoundWitness;
-export declare const asBoundWitness: <T extends BoundWitness<{
-    schema: string;
-}> = BoundWitness>(payload?: unknown) => T | undefined;
-export declare const asOptionalBoundWitness: (value: import(".store/@xylabs-promise-npm-5.0.37-e0d0dd2b09/package").AnyNonPromise) => BoundWitness | undefined;
+export declare const notBoundWitness: (x?: unknown | null) => x is {
+    schema: "network.xyo.boundwitness";
+    addresses: import("@xylabs/sdk-js").Address[];
+    payload_hashes: import("@xylabs/sdk-js").Hash[];
+    payload_schemas: string[];
+    previous_hashes: (import("@xylabs/sdk-js").Hash | null)[];
+    $signatures: (import("@xylabs/sdk-js").Hex | null)[];
+    $destination?: import("@xylabs/sdk-js").Address | undefined;
+    $sourceQuery?: import("@xylabs/sdk-js").Hash | undefined;
+};
+export declare const asBoundWitness: <T extends BoundWitness = BoundWitness>(payload?: unknown) => T | undefined;
+export declare const asOptionalBoundWitness: (value: import("@xylabs/sdk-js").AnyNonPromise) => {
+    schema: "network.xyo.boundwitness";
+    addresses: import("@xylabs/sdk-js").Address[];
+    payload_hashes: import("@xylabs/sdk-js").Hash[];
+    payload_schemas: string[];
+    previous_hashes: (import("@xylabs/sdk-js").Hash | null)[];
+    $signatures: (import("@xylabs/sdk-js").Hex | null)[];
+    $destination?: import("@xylabs/sdk-js").Address | undefined;
+    $sourceQuery?: import("@xylabs/sdk-js").Hash | undefined;
+} | undefined;
 export declare const isBoundWitnessWithStorageMeta: (value: unknown) => value is WithStorageMeta<BoundWitness>;
-export declare const asBoundWitnessWithStorageMeta: (value: import(".store/@xylabs-promise-npm-5.0.37-e0d0dd2b09/package").AnyNonPromise) => WithStorageMeta<BoundWitness> | undefined;
-export declare const asOptionalBoundWitnessWithStorageMeta: (value: import(".store/@xylabs-promise-npm-5.0.37-e0d0dd2b09/package").AnyNonPromise) => WithStorageMeta<BoundWitness> | undefined;
+export declare const asBoundWitnessWithStorageMeta: (value: import("@xylabs/sdk-js").AnyNonPromise) => WithStorageMeta<{
+    schema: "network.xyo.boundwitness";
+    addresses: import("@xylabs/sdk-js").Address[];
+    payload_hashes: import("@xylabs/sdk-js").Hash[];
+    payload_schemas: string[];
+    previous_hashes: (import("@xylabs/sdk-js").Hash | null)[];
+    $signatures: (import("@xylabs/sdk-js").Hex | null)[];
+    $destination?: import("@xylabs/sdk-js").Address | undefined;
+    $sourceQuery?: import("@xylabs/sdk-js").Hash | undefined;
+}> | undefined;
+export declare const asOptionalBoundWitnessWithStorageMeta: (value: import("@xylabs/sdk-js").AnyNonPromise) => WithStorageMeta<{
+    schema: "network.xyo.boundwitness";
+    addresses: import("@xylabs/sdk-js").Address[];
+    payload_hashes: import("@xylabs/sdk-js").Hash[];
+    payload_schemas: string[];
+    previous_hashes: (import("@xylabs/sdk-js").Hash | null)[];
+    $signatures: (import("@xylabs/sdk-js").Hex | null)[];
+    $destination?: import("@xylabs/sdk-js").Address | undefined;
+    $sourceQuery?: import("@xylabs/sdk-js").Hash | undefined;
+}> | undefined;
 export declare function isSigned(value: unknown): value is Signed;
 export declare function isSigned<T extends Unsigned>(value: T): value is Signed<T>;
 export declare function isUnsigned(value: unknown): value is Unsigned;

package/dist/node/isBoundWitness.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isBoundWitness.d.ts","sourceRoot":"","sources":["../../src/isBoundWitness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAKjE,OAAO,KAAK,EACV,YAAY,EAAE,MAAM,EAAE,QAAQ,EAC/B,MAAM,yBAAyB,CAAA;AAGhC,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,YAA8E,CAAA;AAEvI,eAAO,MAAM,eAAe,2CAA2D,CAAA;AAIvF,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,YAAY,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,YAAY,EAAE,UAAU,OAAO,kBACrD,CAAA;AAEtD,eAAO,MAAM,sBAAsB,mHAA+D,CAAA;AAElG,eAAO,MAAM,6BAA6B,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAAe,CAAC,YAAY,CACZ,CAAA;AACxF,eAAO,MAAM,6BAA6B,oIAA+F,CAAA;AACzI,eAAO,MAAM,qCAAqC,oIAA+F,CAAA;AAEjJ,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAA;AACzD,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAA;AAO1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAA;AAC7D,wBAAgB,UAAU,CAAC,CAAC,SAAS,YAAY,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA"}
+{"version":3,"file":"isBoundWitness.d.ts","sourceRoot":"","sources":["../../src/isBoundWitness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAKjE,OAAO,KAAK,EACV,YAAY,EAAE,MAAM,EAAE,QAAQ,EAC/B,MAAM,yBAAyB,CAAA;AAGhC,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,YAA8E,CAAA;AAEvI,eAAO,MAAM,eAAe;;;;;;;;;CAA2D,CAAA;AAIvF,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,UAAU,OAAO,kBACjC,CAAA;AAEtD,eAAO,MAAM,sBAAsB;;;;;;;;;aAA+D,CAAA;AAElG,eAAO,MAAM,6BAA6B,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAAe,CAAC,YAAY,CACZ,CAAA;AACxF,eAAO,MAAM,6BAA6B;;;;;;;;;cAA+F,CAAA;AACzI,eAAO,MAAM,qCAAqC;;;;;;;;;cAA+F,CAAA;AAEjJ,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAA;AACzD,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAA;AAO1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAA;AAC7D,wBAAgB,UAAU,CAAC,CAAC,SAAS,YAAY,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/boundwitness-model",
-  "version": "5.1.24",
+  "version": "5.2.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -36,9 +36,9 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/hex": "~5.0.37",
-    "@xylabs/object": "~5.0.37",
-    "@xyo-network/payload-model": "~5.1.24"
+    "@xylabs/sdk-js": "~5.0.39",
+    "@xyo-network/payload-model": "~5.2.1",
+    "zod": "~4.1.12"
   },
   "devDependencies": {
     "@types/node": "~24.10.1",

package/src/BoundWitness/BoundWitness.ts

@@ -1,66 +1,64 @@
-import type {
-  Address, Hash, Hex,
-} from '@xylabs/hex'
-import type { EmptyObject, JsonObject } from '@xylabs/object'
-import type { Payload, Schema } from '@xyo-network/payload-model'
-
-import type { BoundWitnessSchema } from './BoundWitnessSchema.ts'
-
-export interface BoundWitnessRequiredFields {
-  /** @field Array of signatures by the accounts that are listed in addresses */
-  addresses: Address[]
-  payload_hashes: Hash[]
-  payload_schemas: Schema[]
-  previous_hashes: (Hash | null)[]
-}
-
-export interface BoundWitnessMeta {
-  /**
-   * @field The address to which the query is directed
-   */
-  $destination?: Address
-  /**
-   * @field The query that initiated the bound witness
-   */
-  $sourceQuery?: Hash
-}
-
-export interface BoundWitnessBlockField {
-  /** @field sequential number (if this boundwitness is part of a multi-party chain) */
-  block: number
-}
-
-export interface BoundWitnessChainField {
-  /** @field unique id of a multi-party chain (usually staking contract address) */
-  chain: Hex
-}
-
-export interface BoundWitnessOptionalFields extends Partial<BoundWitnessBlockField>, Partial<BoundWitnessChainField> {
-  root: Hash
-}
-
-export interface BoundWitnessFields extends BoundWitnessRequiredFields, Partial<BoundWitnessOptionalFields> {}
-
-export type UnsignedBoundWitness<T extends EmptyObject | void = void> = Payload<
-  T extends void ? BoundWitnessFields : BoundWitnessFields & T,
-  BoundWitnessSchema
-> & BoundWitnessMeta
-
-export type Unsigned<T extends UnsignedBoundWitness = UnsignedBoundWitness> = T & {
-  $signatures: Hex[]
-}
-
-export type Signed<T extends UnsignedBoundWitness = UnsignedBoundWitness> = T & {
-  $signatures: Hex[]
-}
-
-export type SignedBoundWitness = Signed<UnsignedBoundWitness>
-
-export type WithBlock = BoundWitness & BoundWitnessBlockField
-
-export const hasBlock = (bw: BoundWitness): bw is WithBlock => bw.block !== undefined && typeof bw.block === 'string'
-export const asBlock = (bw: BoundWitness): WithBlock => bw as WithBlock
-
-export type BoundWitness<T extends Payload | EmptyObject | void = void> = Signed<UnsignedBoundWitness<T>>
-
-export type AnyBoundWitness = BoundWitness<JsonObject>
+import {
+  AddressZod, HashZod, HexZod,
+} from '@xylabs/sdk-js'
+import {
+  PayloadZod, SchemaZod, StorageMetaZod,
+} from '@xyo-network/payload-model'
+import * as z from 'zod'
+
+import { BoundWitnessSchema } from './BoundWitnessSchema.ts'
+
+const BoundWitnessRequiredFieldsZod = z.object({
+  addresses: z.array(AddressZod),
+  payload_hashes: z.array(HashZod),
+  payload_schemas: z.array(SchemaZod),
+  previous_hashes: z.array(HashZod.nullable()),
+})
+
+const BoundWitnessMetaZod = z.object({
+  $destination: AddressZod.optional(),
+  $sourceQuery: HashZod.optional(),
+  $signatures: z.array(z.union([HexZod, z.null()])),
+})
+
+export const BoundWitnessZod = PayloadZod
+  .extend({ schema: z.literal(BoundWitnessSchema) })
+  .extend(BoundWitnessRequiredFieldsZod.shape)
+  .extend(BoundWitnessMetaZod.shape)
+  .refine(data => data.$signatures.length === data.addresses.length, { message: '$signatures length must equal addresses length' })
+
+export type BoundWitness = z.infer<typeof BoundWitnessZod>
+
+export const AnyBoundWitnessZod = BoundWitnessZod
+  .catchall(z.any())
+
+export type AnyBoundWitness = z.infer<typeof AnyBoundWitnessZod>
+
+export const UnsignedBoundWitnessZod = BoundWitnessZod.refine(data => data.$signatures.includes(null), { message: 'all $signatures must be null' })
+
+export type UnsignedBoundWitness = z.infer<typeof UnsignedBoundWitnessZod>
+
+export const AnyUnsignedBoundWitnessZod = UnsignedBoundWitnessZod
+  .catchall(z.any())
+
+export type AnyUnsignedBoundWitness = z.infer<typeof AnyUnsignedBoundWitnessZod>
+
+export const UnsignedBoundWitnessWithStorageMetaZod = UnsignedBoundWitnessZod
+  .safeExtend(BoundWitnessRequiredFieldsZod.shape)
+  .safeExtend(BoundWitnessMetaZod.shape)
+  .safeExtend(StorageMetaZod.shape)
+
+export const SignedZod = z.object({ $signatures: z.array(HexZod) })
+export const UnsignedZod = z.object({ $signatures: z.array(z.null()) })
+
+export const SignedBoundWitnessZod = BoundWitnessZod.refine(data => !data.$signatures.includes(null), { message: 'all $signatures must not be null' })
+
+export const SignedBoundWitnessWithStorageMetaZod = UnsignedBoundWitnessWithStorageMetaZod
+
+export const AnySignedBoundWitnessZod = UnsignedBoundWitnessZod.catchall(z.any())
+
+export const AnySignedBoundWitnessWithStorageMetaZod = UnsignedBoundWitnessWithStorageMetaZod.catchall(z.any())
+
+export type Unsigned<T extends UnsignedBoundWitness = UnsignedBoundWitness> = T & z.infer<typeof UnsignedZod>
+
+export type Signed<T extends UnsignedBoundWitness = UnsignedBoundWitness> = T & z.infer<typeof SignedZod>

package/src/QueryBoundWitness.ts

@@ -1,4 +1,4 @@
-import type { Hash } from '@xylabs/hex'
+import type { Hash } from '@xylabs/sdk-js'
 import type { WithStorageMeta } from '@xyo-network/payload-model'
 import { isStorageMeta } from '@xyo-network/payload-model'
 
@@ -10,7 +10,7 @@ export type QueryBoundWitnessFields = {
   query: Hash
 }
 
-export type UnsignedQueryBoundWitness = BoundWitness<QueryBoundWitnessFields>
+export type UnsignedQueryBoundWitness = BoundWitness & QueryBoundWitnessFields
 
 export type QueryBoundWitness = UnsignedQueryBoundWitness
 

package/src/isBoundWitness.ts

@@ -1,4 +1,4 @@
-import { AsObjectFactory } from '@xylabs/object'
+import { AsObjectFactory } from '@xylabs/sdk-js'
 import type { WithStorageMeta } from '@xyo-network/payload-model'
 import {
   isPayloadOfSchemaType, isStorageMeta, notPayloadOfSchemaType,
@@ -15,7 +15,7 @@ export const notBoundWitness = notPayloadOfSchemaType<BoundWitness>(BoundWitness
 
 // TODO: Use AsObjectFactory here to match standard pattern
 // TODO: Other as identity functions throw if not valid, this one returns undefined with is more of a asOptional behavior
-export const asBoundWitness = <T extends BoundWitness<{ schema: string }> = BoundWitness>(payload?: unknown) =>
+export const asBoundWitness = <T extends BoundWitness = BoundWitness>(payload?: unknown) =>
   isBoundWitness(payload) ? (payload as T) : undefined
 
 export const asOptionalBoundWitness = AsObjectFactory.createOptional<BoundWitness>(isBoundWitness)