@xyo-network/boundwitness 2.21.11

package/dist/esm/models/Base/XyoBoundWitnessBaseSchema.d.ts

@@ -0,0 +1,36 @@
+export declare const XyoBoundWitnessBaseSchema: {
+    $id: string;
+    additionalProperties: boolean;
+    properties: {
+        addresses: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        payload_hashes: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        payload_schemas: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        previous_hashes: {
+            items: {
+                nullable: boolean;
+                type: string;
+            };
+            type: string;
+        };
+        schema: {
+            type: string;
+        };
+    };
+    required: string[];
+    type: string;
+};

package/dist/esm/models/Base/XyoBoundWitnessBaseSchema.js

@@ -0,0 +1,16 @@
+//Should type as JSONSchemaType<XyoBoundWitnessBody> once ajv/eslint issue is fixed
+//https://github.com/microsoft/TypeScript/issues/44851
+export const XyoBoundWitnessBaseSchema = {
+    $id: 'https://schemas.xyo.network/2.0/boundwitness/body',
+    additionalProperties: false,
+    properties: {
+        addresses: { items: { type: 'string' }, type: 'array' },
+        payload_hashes: { items: { type: 'string' }, type: 'array' },
+        payload_schemas: { items: { type: 'string' }, type: 'array' },
+        previous_hashes: { items: { nullable: true, type: 'string' }, type: 'array' },
+        schema: { type: 'string' },
+    },
+    required: ['addresses', 'payload_hashes', 'payload_schemas', 'previous_hashes', 'schema'],
+    type: 'object',
+};
+//# sourceMappingURL=XyoBoundWitnessBaseSchema.js.map

package/dist/esm/models/Base/XyoBoundWitnessBaseSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoBoundWitnessBaseSchema.js","sourceRoot":"","sources":["../../../../src/models/Base/XyoBoundWitnessBaseSchema.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,sDAAsD;AACtD,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,GAAG,EAAE,mDAAmD;IACxD,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACvD,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QAC5D,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QAC7D,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QAC7E,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC3B;IACD,QAAQ,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,QAAQ,CAAC;IACzF,IAAI,EAAE,QAAQ;CACf,CAAA"}

package/dist/esm/models/Base/index.d.ts

@@ -0,0 +1,2 @@
+export * from './XyoBoundWitnessBase';
+export * from './XyoBoundWitnessBaseSchema';

package/dist/esm/models/Base/index.js

@@ -0,0 +1,3 @@
+export * from './XyoBoundWitnessBase';
+export * from './XyoBoundWitnessBaseSchema';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/Base/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/Base/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA"}

package/dist/esm/models/Meta/XyoBoundWitnessMeta.d.ts

@@ -0,0 +1,7 @@
+import { XyoPayloadMeta, XyoPayloadWithPartialMeta } from '@xyo-network/payload';
+export declare type XyoBoundWitnessMeta<P extends XyoPayloadWithPartialMeta = XyoPayloadWithPartialMeta> = XyoPayloadMeta<{
+    _payloads?: P[];
+    _signatures?: string[];
+    _source_ip?: string;
+    _user_agent?: string;
+}>;

package/dist/esm/models/Meta/XyoBoundWitnessMeta.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=XyoBoundWitnessMeta.js.map

package/dist/esm/models/Meta/XyoBoundWitnessMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoBoundWitnessMeta.js","sourceRoot":"","sources":["../../../../src/models/Meta/XyoBoundWitnessMeta.ts"],"names":[],"mappings":""}

package/dist/esm/models/Meta/XyoBoundWitnessMetaSchema.d.ts

@@ -0,0 +1,85 @@
+export declare const XyoBoundWitnessMetaSchemaProperties: () => {
+    _archive: {
+        nullable: boolean;
+        type: string;
+    };
+    _client: {
+        nullable: boolean;
+        type: string;
+    };
+    _hash: {
+        nullable: boolean;
+        type: string;
+    };
+    _payloads: {
+        items: {
+            type: string;
+        };
+        nullable: boolean;
+        type: string;
+    };
+    _signatures: {
+        items: {
+            type: string;
+        };
+        nullable: boolean;
+        type: string;
+    };
+    _source_ip: {
+        nullable: boolean;
+        type: string;
+    };
+    _timestamp: {
+        nullable: boolean;
+        type: string;
+    };
+    _user_agent: {
+        nullable: boolean;
+        type: string;
+    };
+};
+export declare const XyoBoundWitnessMetaSchema: () => {
+    $id: string;
+    additionalProperties: boolean;
+    properties: () => {
+        _archive: {
+            nullable: boolean;
+            type: string;
+        };
+        _client: {
+            nullable: boolean;
+            type: string;
+        };
+        _hash: {
+            nullable: boolean;
+            type: string;
+        };
+        _payloads: {
+            items: {
+                type: string;
+            };
+            nullable: boolean;
+            type: string;
+        };
+        _signatures: {
+            items: {
+                type: string;
+            };
+            nullable: boolean;
+            type: string;
+        };
+        _source_ip: {
+            nullable: boolean;
+            type: string;
+        };
+        _timestamp: {
+            nullable: boolean;
+            type: string;
+        };
+        _user_agent: {
+            nullable: boolean;
+            type: string;
+        };
+    };
+    type: string;
+};

package/dist/esm/models/Meta/XyoBoundWitnessMetaSchema.js

@@ -0,0 +1,23 @@
+//Should type as JSONSchemaType<XyoBoundWitnessMeta> once ajv/eslint issue is fixed
+//https://github.com/microsoft/TypeScript/issues/44851
+export const XyoBoundWitnessMetaSchemaProperties = () => {
+    return {
+        _archive: { nullable: true, type: 'string' },
+        _client: { nullable: true, type: 'string' },
+        _hash: { nullable: true, type: 'string' },
+        _payloads: { items: { type: 'object' }, nullable: true, type: 'array' },
+        _signatures: { items: { type: 'string' }, nullable: true, type: 'array' },
+        _source_ip: { nullable: true, type: 'string' },
+        _timestamp: { nullable: true, type: 'number' },
+        _user_agent: { nullable: true, type: 'string' },
+    };
+};
+export const XyoBoundWitnessMetaSchema = () => {
+    return {
+        $id: 'https://schemas.xyo.network/2.0/boundwitness/meta',
+        additionalProperties: false,
+        properties: XyoBoundWitnessMetaSchemaProperties,
+        type: 'object',
+    };
+};
+//# sourceMappingURL=XyoBoundWitnessMetaSchema.js.map

package/dist/esm/models/Meta/XyoBoundWitnessMetaSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoBoundWitnessMetaSchema.js","sourceRoot":"","sources":["../../../../src/models/Meta/XyoBoundWitnessMetaSchema.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,sDAAsD;AAEtD,MAAM,CAAC,MAAM,mCAAmC,GAAG,GAAG,EAAE;IACtD,OAAO;QACL,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5C,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3C,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE;QACvE,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE;QACzE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9C,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9C,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;KAChD,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE;IAC5C,OAAO;QACL,GAAG,EAAE,mDAAmD;QACxD,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE,mCAAmC;QAC/C,IAAI,EAAE,QAAQ;KACf,CAAA;AACH,CAAC,CAAA"}

package/dist/esm/models/Meta/index.d.ts

@@ -0,0 +1,2 @@
+export * from './XyoBoundWitnessMeta';
+export * from './XyoBoundWitnessMetaSchema';

package/dist/esm/models/Meta/index.js

@@ -0,0 +1,3 @@
+export * from './XyoBoundWitnessMeta';
+export * from './XyoBoundWitnessMetaSchema';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/Meta/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/Meta/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA"}

package/dist/esm/models/WithXyoBoundWitnessMeta.d.ts

@@ -0,0 +1,4 @@
+import { XyoBoundWitnessMeta } from './Meta';
+import { XyoBoundWitness } from './XyoBoundWitness';
+declare type WithXyoBoundWitnessMeta<T extends XyoBoundWitness> = T & XyoBoundWitnessMeta;
+export type { WithXyoBoundWitnessMeta };

package/dist/esm/models/WithXyoBoundWitnessMeta.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WithXyoBoundWitnessMeta.js.map

package/dist/esm/models/WithXyoBoundWitnessMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WithXyoBoundWitnessMeta.js","sourceRoot":"","sources":["../../../src/models/WithXyoBoundWitnessMeta.ts"],"names":[],"mappings":""}

package/dist/esm/models/XyoBoundWitness.d.ts

@@ -0,0 +1,6 @@
+import { XyoPayloadWithPartialMeta } from '@xyo-network/payload';
+import { XyoBoundWitnessBase } from './Base';
+import { XyoBoundWitnessMeta } from './Meta';
+export declare type XyoBoundWitness<T extends object = object> = T & XyoBoundWitnessBase;
+export declare type XyoBoundWitnessWithMeta<T = unknown, P extends XyoPayloadWithPartialMeta = XyoPayloadWithPartialMeta> = T & XyoBoundWitnessMeta<P> & XyoBoundWitness;
+export declare type XyoBoundWitnessWithPartialMeta<T = unknown, P extends XyoPayloadWithPartialMeta = XyoPayloadWithPartialMeta> = T & Partial<XyoBoundWitnessMeta<P>> & XyoBoundWitness;

package/dist/esm/models/XyoBoundWitness.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=XyoBoundWitness.js.map

package/dist/esm/models/XyoBoundWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoBoundWitness.js","sourceRoot":"","sources":["../../../src/models/XyoBoundWitness.ts"],"names":[],"mappings":""}

package/dist/esm/models/XyoBoundWitnessSchema.d.ts

@@ -0,0 +1,75 @@
+declare const XyoBoundWitnessSchema: () => {
+    $id: string;
+    additionalProperties: boolean;
+    properties: {
+        addresses: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        payload_hashes: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        payload_schemas: {
+            items: {
+                type: string;
+            };
+            type: string;
+        };
+        previous_hashes: {
+            items: {
+                nullable: boolean;
+                type: string;
+            };
+            type: string;
+        };
+        schema: {
+            type: string;
+        };
+        _archive: {
+            nullable: boolean;
+            type: string;
+        };
+        _client: {
+            nullable: boolean;
+            type: string;
+        };
+        _hash: {
+            nullable: boolean;
+            type: string;
+        };
+        _payloads: {
+            items: {
+                type: string;
+            };
+            nullable: boolean;
+            type: string;
+        };
+        _signatures: {
+            items: {
+                type: string;
+            };
+            nullable: boolean;
+            type: string;
+        };
+        _source_ip: {
+            nullable: boolean;
+            type: string;
+        };
+        _timestamp: {
+            nullable: boolean;
+            type: string;
+        };
+        _user_agent: {
+            nullable: boolean;
+            type: string;
+        };
+    };
+    required: string[];
+    type: string;
+};
+export { XyoBoundWitnessSchema };

package/dist/esm/models/XyoBoundWitnessSchema.js

@@ -0,0 +1,21 @@
+//Should type as JSONSchemaType<XyoBoundWitness> once ajv/eslint issue is fixed
+//https://github.com/microsoft/TypeScript/issues/44851
+import { XyoBoundWitnessMetaSchemaProperties } from './Meta';
+const XyoBoundWitnessSchema = () => {
+    return {
+        $id: 'https://schemas.xyo.network/2.0/boundwitness',
+        additionalProperties: false,
+        properties: {
+            ...XyoBoundWitnessMetaSchemaProperties(),
+            addresses: { items: { type: 'string' }, type: 'array' },
+            payload_hashes: { items: { type: 'string' }, type: 'array' },
+            payload_schemas: { items: { type: 'string' }, type: 'array' },
+            previous_hashes: { items: { nullable: true, type: 'string' }, type: 'array' },
+            schema: { type: 'string' },
+        },
+        required: ['addresses', 'payload_hashes', 'payload_schemas', 'previous_hashes', 'schema'],
+        type: 'object',
+    };
+};
+export { XyoBoundWitnessSchema };
+//# sourceMappingURL=XyoBoundWitnessSchema.js.map

package/dist/esm/models/XyoBoundWitnessSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoBoundWitnessSchema.js","sourceRoot":"","sources":["../../../src/models/XyoBoundWitnessSchema.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,sDAAsD;AAEtD,OAAO,EAAE,mCAAmC,EAAE,MAAM,QAAQ,CAAA;AAE5D,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACjC,OAAO;QACL,GAAG,EAAE,8CAA8C;QACnD,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE;YACV,GAAG,mCAAmC,EAAE;YACxC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YACvD,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YAC5D,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YAC7D,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;YAC7E,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC3B;QACD,QAAQ,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,QAAQ,CAAC;QACzF,IAAI,EAAE,QAAQ;KACf,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAA"}

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

@@ -0,0 +1,5 @@
+export * from './Base';
+export * from './Meta';
+export * from './WithXyoBoundWitnessMeta';
+export * from './XyoBoundWitness';
+export * from './XyoBoundWitnessSchema';

package/dist/esm/models/index.js

@@ -0,0 +1,6 @@
+export * from './Base';
+export * from './Meta';
+export * from './WithXyoBoundWitnessMeta';
+export * from './XyoBoundWitness';
+export * from './XyoBoundWitnessSchema';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA"}

package/jest.config.cjs

@@ -0,0 +1,25 @@
+const generateJestConfig = ({ esModules }) => {
+  const esModuleslist = Array.isArray(esModules) ? esModules.join('|') : esModules
+  return {
+    globals: {
+      'ts-jest': {
+        tsconfig: 'tsconfig.test.json',
+      },
+    },
+    moduleNameMapper: {
+      '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    preset: 'ts-jest/presets/default-esm',
+    setupFiles: ['dotenv/config'],
+    setupFilesAfterEnv: ['jest-sorted'],
+    testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+    testTimeout: 20000,
+    transform: {
+      [`(${esModuleslist}).+\\.js$`]: 'babel-jest',
+      '^.+\\.tsx?$': 'ts-jest/legacy',
+    },
+    transformIgnorePatterns: [`./node_modules/(?!${esModuleslist})`],
+  }
+}
+
+module.exports = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid'] })

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@xyo-network/boundwitness",
+  "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": {
+    "@xylabs/sdk-js": "^2.5.9",
+    "@xyo-network/account": "^2.21.11",
+    "@xyo-network/core": "^2.21.11",
+    "@xyo-network/payload": "^2.21.11",
+    "@xyo-network/typeof": "^2.21.11",
+    "lodash": "^4.17.21",
+    "ua-parser-js": "^1.0.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@types/lodash": "^4.14.182",
+    "@types/ua-parser-js": "^0.7.36",
+    "tslib": "^2.4.0"
+  },
+  "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": true,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.21.11",
+  "packageManager": "yarn@3.1.1"
+}

package/src/Builder/Builder.spec.ts

@@ -0,0 +1,88 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+/* eslint-disable sort-keys */
+
+import { XyoAccount, XyoAddressValue } from '@xyo-network/account'
+import { StringKeyObject, XyoHasher } from '@xyo-network/core'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { XyoBoundWitnessBuilder } from './Builder'
+
+const schema = 'network.xyo.temp'
+const payload1: XyoPayload<StringKeyObject> = {
+  number_field: 1,
+  object_field: {
+    number_value: 2,
+    string_value: 'yo',
+  },
+  schema,
+  string_field: 'there',
+  timestamp: 1618603439107,
+}
+const payload2: XyoPayload<StringKeyObject> = {
+  timestamp: 1618603439107,
+  string_field: 'there',
+  schema,
+  object_field: {
+    string_value: 'yo',
+    number_value: 2,
+  },
+  number_field: 1,
+}
+const payloads = [payload1, payload2]
+const payloadHash = '3c817871cbf24708703e907dbc344b1b2aefcc3603d14d59c3a35a5c446410d1'
+
+describe('XyoBoundWitnessBuilder', () => {
+  describe('hash', () => {
+    it.each(payloads)('consistently hashes equivalent payload independent of the order of the keys', (payload) => {
+      const hash = new XyoHasher(payload).hash
+      expect(hash).toEqual(payloadHash)
+    })
+  })
+  describe('build', () => {
+    describe('_hash', () => {
+      it.each(payloads)('consistently hashes equivalent payloads independent of the order of the keys', (payload) => {
+        const address = XyoAccount.fromPhrase('test1')
+        let builder = new XyoBoundWitnessBuilder()
+        expect(builder).toBeDefined()
+        builder = builder.witness(address)
+        expect(builder).toBeDefined()
+        builder = builder.payload(payload)
+        expect(builder).toBeDefined()
+
+        const actual = builder.build()
+
+        expect(actual).toBeDefined()
+        expect(actual._hash).toEqual('7f3203f2d191f12c26cd1aec62b718be8848471f82831a8870f82fc669a5f35b')
+
+        if (actual._hash && actual._signatures) {
+          const addr = new XyoAddressValue(actual.addresses[0])
+          expect(addr.hex).toBe(actual.addresses[0])
+          const verify = new XyoAddressValue(actual.addresses[0]).verify(actual._hash, actual._signatures[0])
+          expect(verify).toBe(true)
+        }
+      })
+    })
+    describe('with inlinePayloads true', () => {
+      it('contains the _payloads field', () => {
+        const address = XyoAccount.fromPhrase('test2')
+        const builder = new XyoBoundWitnessBuilder({ inlinePayloads: true }).witness(address).payload(payload1)
+
+        const actual = builder.build()
+
+        expect(actual).toBeDefined()
+        expect(actual._payloads).toBeDefined()
+      })
+    })
+    describe('with inlinePayloads false', () => {
+      it('omits the _payloads field', () => {
+        const address = XyoAccount.fromPhrase('test3')
+        const builder = new XyoBoundWitnessBuilder({ inlinePayloads: false }).witness(address).payload(payload1)
+
+        const actual = builder.build()
+
+        expect(actual).toBeDefined()
+        expect(actual._payloads).toBeUndefined()
+      })
+    })
+  })
+})

package/src/Builder/Builder.ts

@@ -0,0 +1,83 @@
+import { assertEx, Buffer } from '@xylabs/sdk-js'
+import { XyoAccount } from '@xyo-network/account'
+import { sortFields, WithAdditional, XyoHasher } from '@xyo-network/core'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { WithXyoBoundWitnessMeta, XyoBoundWitness, XyoBoundWitnessWithMeta } from '../models'
+
+export interface XyoBoundWitnessBuilderConfig {
+  /** Whether or not the payloads should be included in the metadata sent to and recorded by the ArchivistApi */
+  readonly inlinePayloads?: boolean
+}
+
+export class XyoBoundWitnessBuilder {
+  private _accounts: XyoAccount[] = []
+  private _payload_schemas: string[] = []
+  private _payloads: XyoPayload[] = []
+
+  constructor(public readonly config: XyoBoundWitnessBuilderConfig = { inlinePayloads: false }) {}
+
+  private get _payload_hashes(): string[] {
+    return this._payloads.map((payload) => {
+      return new XyoHasher(payload).hash
+    })
+  }
+
+  public witness(account: XyoAccount) {
+    this._accounts?.push(account)
+    return this
+  }
+
+  public payloads<T extends XyoPayload = WithAdditional<XyoPayload>>(payloads: (T | null)[]) {
+    payloads.forEach((payload) => {
+      if (payload !== null) {
+        this.payload(payload)
+      }
+    })
+    return this
+  }
+
+  public payload<T extends XyoPayload = WithAdditional<XyoPayload>>(payload?: T) {
+    if (payload) {
+      this._payload_schemas.push(payload.schema)
+      this._payloads.push(assertEx(sortFields(payload)))
+    }
+    return this
+  }
+
+  public hashableFields(): XyoBoundWitness {
+    const addresses = this._accounts.map((account) => account.addressValue.hex)
+    const previous_hashes = this._accounts.map((account) => account.previousHash?.hex ?? null)
+    return {
+      addresses: assertEx(addresses, 'Missing addresses'),
+      payload_hashes: assertEx(this._payload_hashes, 'Missing payload_hashes'),
+      payload_schemas: assertEx(this._payload_schemas, 'Missing payload_schemas'),
+      previous_hashes,
+      schema: 'network.xyo.boundwitness',
+    }
+  }
+
+  private signatures(_hash: string) {
+    return this._accounts.map((account) => Buffer.from(account.sign(Buffer.from(_hash, 'hex'))).toString('hex'))
+  }
+
+  private inlinePayloads() {
+    return this._payloads.map<XyoPayload>((payload, index) => {
+      return {
+        ...payload,
+        schema: this._payload_schemas[index],
+      }
+    })
+  }
+
+  public build(): XyoBoundWitnessWithMeta {
+    const hashableFields = this.hashableFields() as unknown as Record<string, unknown>
+    const _hash = new XyoHasher(hashableFields).hash
+
+    const ret = { ...hashableFields, _client: 'js', _hash, _signatures: this.signatures(_hash), _timestamp: Date.now() } as WithXyoBoundWitnessMeta<XyoBoundWitness>
+    if (this.config.inlinePayloads) {
+      ret._payloads = this.inlinePayloads()
+    }
+    return ret
+  }
+}

package/src/Builder/index.ts

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

package/src/Test/index.ts

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

package/src/Test/testBoundWitness.ts

@@ -0,0 +1,16 @@
+import { XyoBoundWitnessWithMeta } from '../models'
+
+const testBoundWitness: XyoBoundWitnessWithMeta = {
+  _archive: 'temp',
+  _client: 'js',
+  _hash: 'b0ffb9ebf872dc316b7be48327256c5316f7cb84d7c706861b18b86af1942dea',
+  _signatures: ['95100e5fd2012b958e96895870cfac5353c3a33a19314cfd1304ef7d01d052ec2a3ef80d6449cf88d463027fe0d868ed8cfb8b7323d37e93a08570233eea0b17'],
+  _timestamp: 1650067385598,
+  addresses: ['5346a2ce56ec4177b67092bda710e150ba6fa046'],
+  payload_hashes: ['20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c'],
+  payload_schemas: ['network.xyo.test'],
+  previous_hashes: [null],
+  schema: 'network.xyo.boundwitness',
+}
+
+export { testBoundWitness }

package/src/Validator/BodyValidator.spec.ts

@@ -0,0 +1,11 @@
+import { dumpErrors } from '@xyo-network/core'
+
+import { testBoundWitness } from '../Test'
+import { XyoBoundWitnessBodyValidator } from './BodyValidator'
+
+test('all', () => {
+  const validator = new XyoBoundWitnessBodyValidator(testBoundWitness)
+  const errors = validator.validate()
+  dumpErrors(errors)
+  expect(errors.length).toBe(0)
+})