@xyo-network/boundwitness-builder 2.42.16

package/dist/esm/Builder.d.ts

@@ -0,0 +1,33 @@
+import { Account } from '@xyo-network/account';
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
+import { XyoPayload } from '@xyo-network/payload-model';
+import { Logger } from '@xyo-network/shared';
+export interface BoundWitnessBuilderConfig {
+    /** Whether or not the payloads should be included in the metadata sent to and recorded by the ArchivistApi */
+    readonly inlinePayloads?: boolean;
+    readonly meta?: boolean;
+    readonly timestamp?: boolean;
+}
+export declare class BoundWitnessBuilder<TBoundWitness extends XyoBoundWitness<{
+    schema: string;
+}> = XyoBoundWitness, TPayload extends XyoPayload = XyoPayload> {
+    readonly config: BoundWitnessBuilderConfig;
+    protected readonly logger?: Logger | undefined;
+    private _accounts;
+    private _payloadHashes;
+    private _payloadSchemas;
+    private _payloads;
+    private _timestamp;
+    constructor(config?: BoundWitnessBuilderConfig, logger?: Logger | undefined);
+    private get _payload_hashes();
+    private get _payload_schemas();
+    build(): [TBoundWitness, TPayload[]];
+    hashableFields(): TBoundWitness;
+    hashes(hashes: string[], schema: string[]): this;
+    payload(payload?: TPayload): this;
+    payloads(payloads?: (TPayload | null)[]): this;
+    witness(account: Account): this;
+    protected signatures(_hash: string): string[];
+    private inlinePayloads;
+}
+//# sourceMappingURL=Builder.d.ts.map

package/dist/esm/Builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAyB,MAAM,iCAAiC,CAAA;AAGxF,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,MAAM,WAAW,yBAAyB;IACxC,8GAA8G;IAC9G,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED,qBAAa,mBAAmB,CAC9B,aAAa,SAAS,eAAe,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,eAAe,EAC3E,QAAQ,SAAS,UAAU,GAAG,UAAU;aAQZ,MAAM,EAAE,yBAAyB;IAA8B,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;IANrH,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,eAAe,CAAsB;IAC7C,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,UAAU,CAAa;gBAEH,MAAM,GAAE,yBAAqD,EAAqB,MAAM,CAAC,oBAAQ;IAE7H,OAAO,KAAK,eAAe,GAO1B;IAED,OAAO,KAAK,gBAAgB,GAO3B;IAEM,KAAK,IAAI,CAAC,aAAa,EAAE,QAAQ,EAAE,CAAC;IA0BpC,cAAc,IAAI,aAAa;IAuB/B,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;IAOzC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ;IAQ1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE;IASvC,OAAO,CAAC,OAAO,EAAE,OAAO;IAK/B,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM;IAIlC,OAAO,CAAC,cAAc;CAQvB"}

package/dist/esm/Builder.js

@@ -0,0 +1,107 @@
+import { assertEx } from '@xylabs/assert';
+import { Buffer } from '@xylabs/buffer';
+import { XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model';
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
+import { Hasher, sortFields } from '@xyo-network/core';
+export class BoundWitnessBuilder {
+    config;
+    logger;
+    _accounts = [];
+    _payloadHashes;
+    _payloadSchemas;
+    _payloads = [];
+    _timestamp = Date.now();
+    constructor(config = { inlinePayloads: false }, logger) {
+        this.config = config;
+        this.logger = logger;
+    }
+    get _payload_hashes() {
+        return (this._payloadHashes ??
+            this._payloads.map((payload) => {
+                return assertEx(new Hasher(payload).hash);
+            }));
+    }
+    get _payload_schemas() {
+        return (this._payloadSchemas ??
+            this._payloads.map((payload) => {
+                return assertEx(payload.schema, 'Missing Schema');
+            }));
+    }
+    build() {
+        const hashableFields = this.hashableFields();
+        const _hash = BoundWitnessWrapper.hash(hashableFields);
+        const ret = {
+            ...hashableFields,
+            _signatures: this.signatures(_hash),
+        };
+        if (this.config?.meta ?? true) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const bwWithMeta = ret;
+            bwWithMeta._client = 'js';
+            bwWithMeta._hash = _hash;
+            bwWithMeta._timestamp = this._timestamp;
+        }
+        if (this.config.inlinePayloads) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const anyRet = ret;
+            //leaving this in here to prevent breaking code (for now)
+            anyRet._payloads = this.inlinePayloads();
+        }
+        return [ret, this._payloads];
+    }
+    hashableFields() {
+        const addresses = this._accounts.map((account) => account.addressValue.hex);
+        const previous_hashes = this._accounts.map((account) => account.previousHash?.hex ?? null);
+        const result = {
+            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: XyoBoundWitnessSchema,
+        };
+        assertEx(result.payload_hashes?.length === result.payload_schemas?.length, 'Payload hash/schema mismatch');
+        assertEx(!result.payload_hashes.reduce((inValid, hash) => inValid || !hash, false), 'nulls found in hashes');
+        assertEx(!result.payload_schemas.reduce((inValid, schema) => inValid || !schema, false), 'nulls found in schemas');
+        if (this.config.timestamp ?? true) {
+            result.timestamp = this._timestamp;
+        }
+        return result;
+    }
+    hashes(hashes, schema) {
+        assertEx(this.payloads.length === 0, 'Can not set hashes when payloads already set');
+        this._payloadHashes = hashes;
+        this._payloadSchemas = schema;
+        return this;
+    }
+    payload(payload) {
+        assertEx(this._payloadHashes === undefined, 'Can not set payloads when hashes already set');
+        if (payload) {
+            this._payloads.push(assertEx(sortFields(payload)));
+        }
+        return this;
+    }
+    payloads(payloads) {
+        payloads?.forEach((payload) => {
+            if (payload !== null) {
+                this.payload(payload);
+            }
+        });
+        return this;
+    }
+    witness(account) {
+        this._accounts?.push(account);
+        return this;
+    }
+    signatures(_hash) {
+        return this._accounts.map((account) => Buffer.from(account.sign(Buffer.from(_hash, 'hex'))).toString('hex'));
+    }
+    inlinePayloads() {
+        return this._payloads.map((payload, index) => {
+            return {
+                ...payload,
+                schema: this._payload_schemas[index],
+            };
+        });
+    }
+}
+//# sourceMappingURL=Builder.js.map

package/dist/esm/Builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC,OAAO,EAAmB,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAWtD,MAAM,OAAO,mBAAmB;IAUF;IAAkF;IANtG,SAAS,GAAc,EAAE,CAAA;IACzB,cAAc,CAAsB;IACpC,eAAe,CAAsB;IACrC,SAAS,GAAe,EAAE,CAAA;IAC1B,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE/B,YAA4B,SAAoC,EAAE,cAAc,EAAE,KAAK,EAAE,EAAqB,MAAe;QAAjG,WAAM,GAAN,MAAM,CAAuD;QAAqB,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;IAEjI,IAAY,eAAe;QACzB,OAAO,CACL,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7B,OAAO,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAA;YAC3C,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,IAAY,gBAAgB;QAC1B,OAAO,CACL,IAAI,CAAC,eAAe;YACpB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7B,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;YACnD,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAEM,KAAK;QACV,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;QAC5C,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAEtD,MAAM,GAAG,GAAkB;YACzB,GAAG,cAAc;YACjB,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;SACpC,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI,EAAE;YAC7B,8DAA8D;YAC9D,MAAM,UAAU,GAAG,GAAU,CAAA;YAC7B,UAAU,CAAC,OAAO,GAAG,IAAI,CAAA;YACzB,UAAU,CAAC,KAAK,GAAG,KAAK,CAAA;YACxB,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;SACxC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,8DAA8D;YAC9D,MAAM,MAAM,GAAG,GAAU,CAAA;YACzB,yDAAyD;YACzD,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;SACzC;QACD,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC9B,CAAC;IAEM,cAAc;QACnB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,IAAI,CAAC,CAAA;QAC1F,MAAM,MAAM,GAAkB;YAC5B,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,mBAAmB,CAAC;YACnD,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,wBAAwB,CAAC;YACxE,eAAe,EAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,yBAAyB,CAAC;YAC3E,eAAe;YACf,MAAM,EAAE,qBAAqB;SACb,CAAA;QAElB,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,KAAK,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAA;QAE1G,QAAQ,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,uBAAuB,CAAC,CAAA;QAE5G,QAAQ,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAA;QAElH,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE;YACjC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAA;SACnC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,MAAM,CAAC,MAAgB,EAAE,MAAgB;QAC9C,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,8CAA8C,CAAC,CAAA;QACpF,IAAI,CAAC,cAAc,GAAG,MAAM,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,OAAO,CAAC,OAAkB;QAC/B,QAAQ,CAAC,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,8CAA8C,CAAC,CAAA;QAC3F,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAW,OAAO,CAAC,CAAC,CAAC,CAAA;SAC7D;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,QAAQ,CAAC,QAA8B;QAC5C,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;aACtB;QACH,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,OAAO,CAAC,OAAgB;QAC7B,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IAES,UAAU,CAAC,KAAa;QAChC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9G,CAAC;IAEO,cAAc;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAW,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACrD,OAAO;gBACL,GAAG,OAAO;gBACV,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;aACrC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Builder';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './Builder';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@xyo-network/boundwitness-builder",
+  "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/assert": "^2.6.12",
+    "@xylabs/buffer": "^2.6.12",
+    "@xyo-network/account": "^2.42.16",
+    "@xyo-network/boundwitness-model": "^2.42.16",
+    "@xyo-network/boundwitness-wrapper": "^2.42.16",
+    "@xyo-network/core": "^2.42.16",
+    "@xyo-network/payload-model": "^2.42.15",
+    "@xyo-network/shared": "^2.42.16"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.10.25"
+  },
+  "peerDependencies": {
+    "axios": "^1.2.1"
+  },
+  "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": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.42.16"
+}

package/src/Builder.spec.ts

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

package/src/Builder.ts

@@ -0,0 +1,137 @@
+import { assertEx } from '@xylabs/assert'
+import { Buffer } from '@xylabs/buffer'
+import { Account } from '@xyo-network/account'
+import { XyoBoundWitness, XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
+import { Hasher, sortFields } from '@xyo-network/core'
+import { XyoPayload } from '@xyo-network/payload-model'
+import { Logger } from '@xyo-network/shared'
+
+export interface BoundWitnessBuilderConfig {
+  /** Whether or not the payloads should be included in the metadata sent to and recorded by the ArchivistApi */
+  readonly inlinePayloads?: boolean
+  readonly meta?: boolean
+  readonly timestamp?: boolean
+}
+
+export class BoundWitnessBuilder<
+  TBoundWitness extends XyoBoundWitness<{ schema: string }> = XyoBoundWitness,
+  TPayload extends XyoPayload = XyoPayload,
+> {
+  private _accounts: Account[] = []
+  private _payloadHashes: string[] | undefined
+  private _payloadSchemas: string[] | undefined
+  private _payloads: TPayload[] = []
+  private _timestamp = Date.now()
+
+  constructor(public readonly config: BoundWitnessBuilderConfig = { inlinePayloads: false }, protected readonly logger?: Logger) {}
+
+  private get _payload_hashes(): string[] {
+    return (
+      this._payloadHashes ??
+      this._payloads.map((payload) => {
+        return assertEx(new Hasher(payload).hash)
+      })
+    )
+  }
+
+  private get _payload_schemas(): string[] {
+    return (
+      this._payloadSchemas ??
+      this._payloads.map((payload) => {
+        return assertEx(payload.schema, 'Missing Schema')
+      })
+    )
+  }
+
+  public build(): [TBoundWitness, TPayload[]] {
+    const hashableFields = this.hashableFields()
+    const _hash = BoundWitnessWrapper.hash(hashableFields)
+
+    const ret: TBoundWitness = {
+      ...hashableFields,
+      _signatures: this.signatures(_hash),
+    }
+
+    if (this.config?.meta ?? true) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const bwWithMeta = ret as any
+      bwWithMeta._client = 'js'
+      bwWithMeta._hash = _hash
+      bwWithMeta._timestamp = this._timestamp
+    }
+
+    if (this.config.inlinePayloads) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const anyRet = ret as any
+      //leaving this in here to prevent breaking code (for now)
+      anyRet._payloads = this.inlinePayloads()
+    }
+    return [ret, this._payloads]
+  }
+
+  public hashableFields(): TBoundWitness {
+    const addresses = this._accounts.map((account) => account.addressValue.hex)
+    const previous_hashes = this._accounts.map((account) => account.previousHash?.hex ?? null)
+    const result: TBoundWitness = {
+      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: XyoBoundWitnessSchema,
+    } as TBoundWitness
+
+    assertEx(result.payload_hashes?.length === result.payload_schemas?.length, 'Payload hash/schema mismatch')
+
+    assertEx(!result.payload_hashes.reduce((inValid, hash) => inValid || !hash, false), 'nulls found in hashes')
+
+    assertEx(!result.payload_schemas.reduce((inValid, schema) => inValid || !schema, false), 'nulls found in schemas')
+
+    if (this.config.timestamp ?? true) {
+      result.timestamp = this._timestamp
+    }
+    return result
+  }
+
+  public hashes(hashes: string[], schema: string[]) {
+    assertEx(this.payloads.length === 0, 'Can not set hashes when payloads already set')
+    this._payloadHashes = hashes
+    this._payloadSchemas = schema
+    return this
+  }
+
+  public payload(payload?: TPayload) {
+    assertEx(this._payloadHashes === undefined, 'Can not set payloads when hashes already set')
+    if (payload) {
+      this._payloads.push(assertEx(sortFields<TPayload>(payload)))
+    }
+    return this
+  }
+
+  public payloads(payloads?: (TPayload | null)[]) {
+    payloads?.forEach((payload) => {
+      if (payload !== null) {
+        this.payload(payload)
+      }
+    })
+    return this
+  }
+
+  public witness(account: Account) {
+    this._accounts?.push(account)
+    return this
+  }
+
+  protected signatures(_hash: string) {
+    return this._accounts.map((account) => Buffer.from(account.sign(Buffer.from(_hash, 'hex'))).toString('hex'))
+  }
+
+  private inlinePayloads() {
+    return this._payloads.map<TPayload>((payload, index) => {
+      return {
+        ...payload,
+        schema: this._payload_schemas[index],
+      }
+    })
+  }
+}

package/src/index.ts

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