@xyo-network/boundwitness-wrapper 5.3.22 → 5.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/boundwitness-wrapper",
-  "version": "5.3.22",
+  "version": "5.3.25",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,47 +30,43 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*",
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/boundwitness-validator": "~5.3.22",
-    "@xyo-network/payload": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "@xyo-network/payload-wrapper": "~5.3.22"
+    "@xyo-network/boundwitness-model": "~5.3.25",
+    "@xyo-network/boundwitness-validator": "~5.3.25",
+    "@xyo-network/payload": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/payload-wrapper": "~5.3.25",
+    "@xyo-network/payload-builder": "~5.3.25"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.91",
-    "@xylabs/ts-scripts-common": "~7.6.8",
-    "@xylabs/ts-scripts-yarn3": "~7.6.8",
-    "@xylabs/tsconfig": "~7.6.8",
-    "@xylabs/vitest-extended": "~5.0.91",
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/boundwitness-validator": "~5.3.22",
-    "@xyo-network/payload": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "@xyo-network/payload-wrapper": "~5.3.22",
+    "@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",
     "acorn": "^8.16.0",
     "ajv": "^8.18.0",
     "axios": "^1.14.0",
-    "cosmiconfig": "^9.0.1",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.1.0",
+    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
-    "rollup": "^4.60.1",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/boundwitness-model": "~5.3.25",
+    "@xyo-network/boundwitness-validator": "~5.3.25",
+    "@xyo-network/payload": "~5.3.25",
+    "@xyo-network/payload-builder": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/payload-wrapper": "~5.3.25"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -87,4 +83,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/BoundWitnessWrapper.ts

@@ -1,223 +0,0 @@
-import {
-  assertEx, isNumber, isObject,
-} from '@xylabs/sdk-js'
-import {
-  type Address, asHash, type Hash,
-} from '@xylabs/sdk-js'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import {
-  asBoundWitness,
-  BoundWitnessSchema, isBoundWitness,
-} from '@xyo-network/boundwitness-model'
-import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { Payload, WithoutPrivateStorageMeta } from '@xyo-network/payload-model'
-import {
-  isPayloadWrapperBase, PayloadWrapper, PayloadWrapperBase,
-} from '@xyo-network/payload-wrapper'
-
-export const isBoundWitnessWrapper = <T extends BoundWitness = BoundWitness, P extends Payload = Payload>(
-  value?: unknown,
-): value is BoundWitnessWrapper<T, P> => {
-  if (isPayloadWrapperBase(value)) {
-    return typeof (value as BoundWitnessWrapper<T, P>).payloadsDataHashMap === 'function'
-  }
-  return false
-}
-
-export class BoundWitnessWrapper<
-  TBoundWitness extends BoundWitness = BoundWitness,
-  TPayload extends Payload = Payload,
-> extends PayloadWrapperBase<TBoundWitness> {
-  boundwitness: TBoundWitness
-  moduleErrors?: Payload[]
-  payloads: TPayload[] = []
-
-  private _payloadDataMap: Record<Hash, TPayload> | undefined
-  private _payloadMap: Record<Hash, TPayload> | undefined
-
-  protected constructor(
-    boundwitness: TBoundWitness,
-    payloads: TPayload[] = [],
-    moduleErrors?: Payload[],
-  ) {
-    super(boundwitness)
-    this.boundwitness = boundwitness
-    this.payloads = payloads
-    this.moduleErrors = moduleErrors
-  }
-
-  get addresses() {
-    return this.boundwitness.addresses
-  }
-
-  get payloadHashes() {
-    return this.boundwitness.payload_hashes
-  }
-
-  get payloadSchemas() {
-    return this.boundwitness.payload_schemas
-  }
-
-  get previousHashes() {
-    return this.boundwitness.previous_hashes
-  }
-
-  static as<T extends BoundWitness = BoundWitness>(value: unknown) {
-    return value instanceof BoundWitnessWrapper ? (value as BoundWitnessWrapper<T>) : undefined
-  }
-
-  static async load(address: Address) {
-    const wrapper = await PayloadWrapper.load(address)
-    const payload = wrapper?.payload
-    assertEx(payload && isBoundWitness(payload), () => 'Attempt to load non-boundwitness')
-
-    const boundWitness: BoundWitness | undefined = payload && isBoundWitness(payload) ? payload : undefined
-    return boundWitness ? BoundWitnessWrapper.wrap(boundWitness) : null
-  }
-
-  static parse<T extends BoundWitness = BoundWitness, P extends Payload = Payload>(
-    obj: unknown,
-    payloads?: P[],
-  ): BoundWitnessWrapper<T, P> {
-    let hydratedObj: T | undefined = undefined
-    switch (typeof obj) {
-      case 'string': {
-        hydratedObj = JSON.parse(obj) as T
-        break
-      }
-      case 'object': {
-        if (isObject(obj)) {
-          hydratedObj = obj as unknown as T
-        }
-        break
-      }
-    }
-
-    if (hydratedObj) {
-      if (isBoundWitnessWrapper<T, P>(hydratedObj)) {
-        return hydratedObj as BoundWitnessWrapper<T, P>
-      }
-      if (isBoundWitness(hydratedObj)) {
-        return new BoundWitnessWrapper(hydratedObj, payloads ?? [])
-      }
-    }
-
-    throw new Error(`Unable to parse [${typeof obj}]`)
-  }
-
-  static tryParse<T extends BoundWitness, P extends Payload>(obj: unknown, payloads?: P[]): BoundWitnessWrapper<T, P> | undefined {
-    if (obj === undefined) return undefined
-    try {
-      return this.parse(obj, payloads)
-    } catch {
-      return undefined
-    }
-  }
-
-  static wrap<T extends BoundWitness, P extends Payload>(
-    obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>,
-    payloads?: P[],
-  ): BoundWitnessWrapper<T, P> {
-    switch (typeof obj) {
-      case 'object': {
-        if (obj instanceof BoundWitnessWrapper) {
-          return obj
-        } else if (obj instanceof PayloadWrapper && obj.schema() === BoundWitnessSchema) {
-          return BoundWitnessWrapper.parse(obj.payload, payloads)
-        } else {
-          return BoundWitnessWrapper.parse(obj, payloads)
-        }
-      }
-    }
-  }
-
-  static async wrappedDataHashMap<T extends BoundWitness>(
-    boundWitnesses: (T | BoundWitnessWrapper<T>)[],
-  ): Promise<Record<string, BoundWitnessWrapper<T>>> {
-    const result: Record<string, BoundWitnessWrapper<T>> = {}
-    await Promise.all(
-      boundWitnesses.map(async (payload) => {
-        const bw = BoundWitnessWrapper.parse<T, Payload>(payload)
-        result[await bw.dataHash()] = bw
-      }),
-    )
-    return result
-  }
-
-  async dig(depth?: number): Promise<BoundWitnessWrapper<TBoundWitness>> {
-    if (depth === 0) return this
-
-    const innerBoundwitnessIndex: number = this.payloadSchemas.indexOf(BoundWitnessSchema)
-    if (innerBoundwitnessIndex !== -1) {
-      const innerBoundwitnessHash = asHash(this.payloadHashes[innerBoundwitnessIndex], true)
-      const innerBoundwitnessPayload = asBoundWitness(
-        (await PayloadBuilder.toAllHashMap(this.payloads))[innerBoundwitnessHash],
-      ) as TBoundWitness | undefined
-      const innerBoundwitness: BoundWitnessWrapper<TBoundWitness> | undefined
-        = innerBoundwitnessPayload
-          ? new BoundWitnessWrapper<TBoundWitness>(innerBoundwitnessPayload, await PayloadBuilder.filterExclude(this.payloads, innerBoundwitnessHash))
-          : undefined
-      if (innerBoundwitness) {
-        return innerBoundwitness.dig(isNumber(depth) ? depth - 1 : undefined)
-      }
-    }
-    assertEx(depth === 0, () => `Dig failed [Remaining Depth: ${depth}]`)
-    return this
-  }
-
-  async getMissingPayloads() {
-    const payloadMap = await this.payloadsDataHashMap()
-    return this.payloadHashes.filter(hash => !payloadMap[asHash(hash, true)])
-  }
-
-  async getWrappedPayloads(): Promise<PayloadWrapper<TPayload>[]> {
-    return await Promise.all(this.payloads.map(payload => PayloadWrapper.wrap(payload)))
-  }
-
-  hashesBySchema(schema: string) {
-    const result: string[] = []
-    for (const [index, payloadSchema] of this.payloadSchemas.entries()) {
-      if (payloadSchema === schema) {
-        result.push(asHash(this.payloadHashes[index], true))
-      }
-    }
-    return result
-  }
-
-  async payloadsByDataHashes(hashes: Hash[]): Promise<TPayload[]> {
-    const map = await this.payloadsDataHashMap()
-    return hashes.map(hash => assertEx(map[hash], () => 'Hash not found') as TPayload)
-  }
-
-  async payloadsByHashes(hashes: Hash[]): Promise<TPayload[]> {
-    const map = await this.payloadsHashMap()
-    return hashes.map(hash => assertEx(map[hash], () => 'Hash not found') as TPayload)
-  }
-
-  payloadsBySchema<T extends TPayload>(schema: string): T[] {
-    return this.payloads.filter(payload => payload?.schema === schema) as T[]
-  }
-
-  async payloadsDataHashMap(): Promise<Partial<Record<Hash, TPayload>>> {
-    this._payloadDataMap = this._payloadDataMap ?? (await PayloadBuilder.toDataHashMap<TPayload>(this.payloads))
-    return this._payloadDataMap
-  }
-
-  async payloadsHashMap(): Promise<Partial<Record<Hash, TPayload>>> {
-    this._payloadMap = this._payloadMap ?? (await PayloadBuilder.toHashMap<TPayload>(this.payloads))
-    return this._payloadMap
-  }
-
-  prev(address: Address) {
-    return this.previousHashes[this.addresses.indexOf(address)]
-  }
-
-  toResult() {
-    return [this.boundwitness, this.payloads]
-  }
-
-  override async validate(): Promise<Error[]> {
-    return await new BoundWitnessValidator(this.boundwitness).validate()
-  }
-}

package/src/QueryBoundWitnessWrapper.ts

@@ -1,67 +0,0 @@
-import type { Promisable } from '@xylabs/sdk-js'
-import {
-  asHash, assertEx, exists,
-} from '@xylabs/sdk-js'
-import type { QueryBoundWitness } from '@xyo-network/boundwitness-model'
-import { isQueryBoundWitness } from '@xyo-network/boundwitness-model'
-import { PayloadBuilder } from '@xyo-network/payload'
-import type { Payload, Query } from '@xyo-network/payload-model'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-
-import { BoundWitnessWrapper } from './BoundWitnessWrapper.ts'
-
-export class QueryBoundWitnessWrapper<T extends Query = Query> extends BoundWitnessWrapper<QueryBoundWitness> {
-  private _payloadsWithoutQuery: PayloadWrapper<Payload>[] | undefined
-  private _query: T | undefined
-
-  static parseQuery<T extends Query = Query>(obj: unknown, payloads?: Payload[]): QueryBoundWitnessWrapper<T> {
-    assertEx(!Array.isArray(obj), () => 'Array can not be converted to QueryBoundWitnessWrapper')
-    switch (typeof obj) {
-      case 'object': {
-        const castWrapper = obj as QueryBoundWitnessWrapper<T>
-        /* if (!wrapper.valid) {
-          console.warn(`Parsed invalid QueryBoundWitness ${JSON.stringify(wrapper.errors.map((error) => error.message))}`)
-        } */
-        const result = castWrapper instanceof QueryBoundWitnessWrapper
-          ? castWrapper
-          : isQueryBoundWitness(obj)
-            ? (
-                new QueryBoundWitnessWrapper<T>(
-                  obj,
-                  payloads,
-                )
-              )
-            : undefined
-        if (result === undefined) {
-          throw new Error('Unable to parse. Failed isQueryBoundWitness.')
-        }
-        return result
-      }
-    }
-    throw new Error(`Unable to parse [${typeof obj}]`)
-  }
-
-  static tryParseQuery<T extends Query>(obj: unknown): Promisable<QueryBoundWitnessWrapper<T> | undefined> {
-    if (obj === undefined) return undefined
-    try {
-      return this.parseQuery<T>(obj)
-    } catch {
-      return undefined
-    }
-  }
-
-  async getPayloadsWithoutQuery(): Promise<PayloadWrapper<Payload>[]> {
-    this._payloadsWithoutQuery
-      = this._payloadsWithoutQuery
-        ?? (await Promise.all(
-          (await PayloadBuilder.filterExclude(this.payloads, asHash(this.payload.query, true))).map(payload => PayloadWrapper.wrap(payload)).filter(exists),
-        ))
-    return this._payloadsWithoutQuery
-  }
-
-  async getQuery(): Promise<T> {
-    const payloadMap = await this.payloadsDataHashMap()
-    this._query = this._query ?? (payloadMap[asHash(this.boundwitness.query, true)] as T | undefined)
-    return assertEx(this._query, () => `Missing Query [${JSON.stringify(this.boundwitness)}]`)
-  }
-}

package/src/SchemaType.ts

@@ -1,36 +0,0 @@
-import {
-  AddressRegEx, HashRegEx, HexRegExMinMax,
-} from '@xylabs/sdk-js'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import { SchemaRegEx } from '@xyo-network/payload-model'
-import { payloadJsonSchema } from '@xyo-network/payload-wrapper'
-import type { JSONSchemaType } from 'ajv'
-
-export const SignatureRegEx = HexRegExMinMax(64, 64)
-
-export const boundWitnessProperties: JSONSchemaType<BoundWitness>['properties'] = {
-  ...payloadJsonSchema.properties,
-  addresses: { items: { type: 'string', pattern: AddressRegEx.source }, type: 'array' },
-  payload_hashes: { items: { type: 'string', pattern: HashRegEx.source }, type: 'array' },
-  payload_schemas: { items: { type: 'string', pattern: SchemaRegEx.source }, type: 'array' },
-  previous_hashes: {
-    items: {
-      type: 'string', pattern: HashRegEx.source, nullable: true,
-    },
-    type: 'array',
-  },
-  root: { type: 'string', pattern: HashRegEx.source },
-  $destination: { items: { type: 'string', pattern: HashRegEx.source }, type: 'array' },
-  $sourceQuery: { type: 'string', pattern: HashRegEx.source },
-  $sources: { items: { type: 'string', pattern: HashRegEx.source }, type: 'array' },
-  $signatures: { items: { type: 'string', pattern: SignatureRegEx.source }, type: 'array' },
-}
-
-export const boundWitnessJsonSchema: JSONSchemaType<BoundWitness> = {
-  ...payloadJsonSchema,
-  $id: 'https://schemas.xyo.network/2.0/boundwitness',
-  additionalProperties: false,
-  properties: boundWitnessProperties,
-  required: [...payloadJsonSchema.required, 'addresses', 'payload_hashes', 'payload_schemas', 'previous_hashes'],
-  type: 'object',
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './BoundWitnessWrapper.ts'
-export * from './QueryBoundWitnessWrapper.ts'
-export * from './SchemaType.ts'