o1js-pack 0.3.1

package/build/src/lib/packed-types/PackedUInt32.test.js

@@ -0,0 +1,84 @@
+import { Provable, UInt32 } from 'o1js';
+import { PackedUInt32Factory } from './PackedUInt32';
+describe('PackedUInt32', () => {
+    class PackedUInt32 extends PackedUInt32Factory(7) {
+    }
+    describe('Outside of the circuit', () => {
+        const bigints = [10n, 2n ** 32n - 1n, 0n, 10n, 2n ** 32n - 100n, 42n, 0n];
+        const uints = bigints.map((x) => UInt32.from(x));
+        it('#fromBigInts', () => {
+            const myPackedUInt32 = PackedUInt32.fromBigInts(bigints);
+            expect(myPackedUInt32.toBigInts()).toMatchObject(bigints);
+        });
+        it('#pack and #unPack', () => {
+            const packed = PackedUInt32.pack(uints);
+            const unpacked = PackedUInt32.unpack(packed);
+            expect(unpacked.length).toBe(uints.length);
+            expect(unpacked).toMatchObject(uints);
+        });
+    });
+    describe('Provable Properties', () => {
+        it('#sizeInFields', () => {
+            class one extends PackedUInt32Factory(1) {
+            }
+            class seven extends PackedUInt32Factory(7) {
+            }
+            expect(one.sizeInFields()).toBe(1);
+            expect(seven.sizeInFields()).toBe(1);
+        });
+    });
+    describe('Defensive Cases', () => {
+        it('throws for input >= 8 uints', () => {
+            expect(() => PackedUInt32Factory(7)).not.toThrow();
+            expect(() => PackedUInt32Factory(8)).toThrow();
+        });
+        it('initalizes with more input than allowed', () => {
+            const bigints = [
+                10n,
+                2n ** 32n - 1n,
+                0n,
+                10n,
+                2n ** 32n - 100n,
+                42n,
+                0n,
+                0n,
+            ];
+            expect(() => {
+                PackedUInt32.fromBigInts(bigints);
+            }).toThrow();
+        });
+        it('initalizes with less input than specified', () => {
+            const bigints = [10n];
+            const expected = [10n, 0n, 0n, 0n, 0n, 0n, 0n];
+            expect(PackedUInt32.fromBigInts(bigints).toBigInts()).toMatchObject(expected);
+        });
+    });
+    describe('In the circuit', () => {
+        const bigints = [10n, 2n ** 32n - 1n, 0n, 10n, 2n ** 32n - 100n, 42n, 0n];
+        const outsidePackedUInt = PackedUInt32.fromBigInts(bigints);
+        it('Initializes', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const packedUInt32 = new PackedUInt32(outsidePackedUInt.packed, outsidePackedUInt.aux);
+                    PackedUInt32.check({ packed: packedUInt32.packed });
+                });
+            }).not.toThrow();
+        });
+        it('#assertEquals', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const packedUInt32 = new PackedUInt32(outsidePackedUInt.packed, outsidePackedUInt.aux);
+                    packedUInt32.assertEquals(outsidePackedUInt);
+                });
+            }).not.toThrow();
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const fakePacked = outsidePackedUInt.packed.add(32);
+                    const packedUInt32 = new PackedUInt32(fakePacked, outsidePackedUInt.aux);
+                    packedUInt32.assertEquals(outsidePackedUInt);
+                });
+            }).toThrow();
+        });
+    });
+});
+//# sourceMappingURL=PackedUInt32.test.js.map

package/build/src/lib/packed-types/PackedUInt32.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedUInt32.test.js","sourceRoot":"","sources":["../../../../src/lib/packed-types/PackedUInt32.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,YAAa,SAAQ,mBAAmB,CAAC,CAAC,CAAC;KAAG;IACpD,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,GAAG,GAAG,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,GAAG,GAAG,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;YACtB,MAAM,cAAc,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACzD,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE7C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,MAAM,GAAI,SAAQ,mBAAmB,CAAC,CAAC,CAAC;aAAG;YAC3C,MAAM,KAAM,SAAQ,mBAAmB,CAAC,CAAC,CAAC;aAAG;YAE7C,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACnD,MAAM,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,OAAO,GAAG;gBACd,GAAG;gBACH,EAAE,IAAI,GAAG,GAAG,EAAE;gBACd,EAAE;gBACF,GAAG;gBACH,EAAE,IAAI,GAAG,GAAG,IAAI;gBAChB,GAAG;gBACH,EAAE;gBACF,EAAE;aACH,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE;gBACV,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YAEtB,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,aAAa,CACjE,QAAQ,CACT,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,GAAG,GAAG,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,GAAG,GAAG,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,iBAAiB,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE5D,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,GAAG,EAAE;gBACV,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE;oBACxB,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,iBAAiB,CAAC,MAAM,EACxB,iBAAiB,CAAC,GAAG,CACtB,CAAC;oBAEF,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtD,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,MAAM,CAAC,GAAG,EAAE;gBACV,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE;oBACxB,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,iBAAiB,CAAC,MAAM,EACxB,iBAAiB,CAAC,GAAG,CACtB,CAAC;oBACF,YAAY,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,EAAE;gBACV,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE;oBACxB,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBACpD,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,UAAU,EACV,iBAAiB,CAAC,GAAG,CACtB,CAAC;oBACF,YAAY,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/src/lib/scratch.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/scratch.js

@@ -0,0 +1,16 @@
+import { Character } from 'snarkyjs';
+import { PackedStringFactory } from './packed-types/PackedString';
+const main = () => {
+    const vitalik_dot_eth = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    // length = 42 ~ 3 ZkStringFragments
+    console.log(vitalik_dot_eth, vitalik_dot_eth.length);
+    let myCharacters = [];
+    for (let i = 0; i < vitalik_dot_eth.length; i++) {
+        myCharacters.push(Character.fromString(vitalik_dot_eth[i]));
+    }
+    const EthAddressString = PackedStringFactory(42);
+    const myEthAddress = new EthAddressString(EthAddressString.pack(myCharacters), myCharacters);
+    console.log(EthAddressString.unpack(myEthAddress.packed).toString());
+};
+main();
+//# sourceMappingURL=scratch.js.map

package/build/src/lib/scratch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scratch.js","sourceRoot":"","sources":["../../../src/lib/scratch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,MAAM,IAAI,GAAG,GAAG,EAAE;IAChB,MAAM,eAAe,GAAG,4CAA4C,CAAC;IAErE,oCAAoC;IACpC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAErD,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC/C,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC7D;IAED,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,IAAI,gBAAgB,CACvC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EACnC,YAAY,CACb,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC"}

package/build/src/packed-types/PackedBool.d.ts

@@ -0,0 +1,51 @@
+import { Field, Bool } from 'snarkyjs';
+export declare function PackedBoolFactory(l: number): {
+    new (packed: import("snarkyjs/dist/node/lib/field").Field, aux: import("snarkyjs/dist/node/lib/bool").Bool[]): {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+        aux: import("snarkyjs/dist/node/lib/bool").Bool[];
+        bitSize: bigint;
+    };
+    /**
+     * Unpacks a Field into its component Bool parts
+     * @param value
+     * @returns the unpacked auxilliary data used to pack the value
+     */
+    toAuxiliary(value?: {
+        packed: Field;
+    } | undefined): Bool[];
+    pack(aux: Bool[]): Field;
+    type: import("snarkyjs/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }, {
+        packed: string;
+    }>;
+    l: number;
+    unpack(f: import("snarkyjs/dist/node/lib/field").Field): import("snarkyjs/dist/node/lib/bool").Bool[];
+    check(value: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }): void;
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => import("snarkyjs/dist/node/lib/field").Field[];
+    fromFields: (fields: import("snarkyjs/dist/node/lib/field").Field[]) => {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    };
+    sizeInFields(): number;
+    toInput: (x: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => {
+        fields?: import("snarkyjs/dist/node/lib/field").Field[] | undefined;
+        packed?: [import("snarkyjs/dist/node/lib/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => {
+        packed: string;
+    };
+    fromJSON: (x: {
+        packed: string;
+    }) => {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    };
+};

package/build/src/packed-types/PackedBool.js

@@ -0,0 +1,34 @@
+import { Field, Provable, Bool } from 'snarkyjs';
+import { PackingPlant } from './PackingPlant';
+const SIZE_IN_BITS = 1n;
+export function PackedBoolFactory(l) {
+    class PackedBool_ extends PackingPlant(Bool, l, SIZE_IN_BITS) {
+        /**
+         * Unpacks a Field into its component Bool parts
+         * @param value
+         * @returns the unpacked auxilliary data used to pack the value
+         */
+        static toAuxiliary(value) {
+            const auxiliary = Provable.witness(Provable.Array(Bool, l), () => {
+                let bools_ = [];
+                let packedN = value?.packed.toBigInt() || 0n;
+                for (let i = 0; i < l; i++) {
+                    bools_[i] = packedN & ((1n << SIZE_IN_BITS) - 1n);
+                    packedN >>= SIZE_IN_BITS;
+                }
+                return bools_.map((x) => Bool.fromJSON(Boolean(x)));
+            });
+            return auxiliary;
+        }
+        static pack(aux) {
+            let f = Field(0);
+            for (let i = 0; i < l; i++) {
+                const c = Field((2n ** SIZE_IN_BITS) ** BigInt(i));
+                f = f.add(aux[i].toField().mul(c));
+            }
+            return f;
+        }
+    }
+    return PackedBool_;
+}
+//# sourceMappingURL=PackedBool.js.map

package/build/src/packed-types/PackedBool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedBool.js","sourceRoot":"","sources":["../../../src/packed-types/PackedBool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB,MAAM,UAAU,iBAAiB,CAAC,CAAS;IACzC,MAAM,WAAY,SAAQ,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC;QAC3D;;;;WAIG;QACH,MAAM,CAAC,WAAW,CAAC,KAAqC;YACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE;gBAC/D,IAAI,MAAM,GAAa,EAAE,CAAC;gBAC1B,IAAI,OAAO,GAAG,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;oBAClD,OAAO,KAAK,YAAY,CAAC;iBAC1B;gBACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAW;YACrB,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC1B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACpC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;KACF;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/build/src/packed-types/PackedBool.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/packed-types/PackedBool.test.js

@@ -0,0 +1,101 @@
+import { Bool } from 'snarkyjs';
+import { PackedBoolFactory } from './PackedBool';
+describe('PackedBool', () => {
+    it('packs and unpacks 2 Bool values', async () => {
+        const myBooleans = [false, true];
+        const myBools = myBooleans.map((b) => Bool(b));
+        const PackedBool_2 = PackedBoolFactory(2);
+        const packedBool_2 = new PackedBool_2(PackedBool_2.pack(myBools), myBools);
+        const f = packedBool_2.packed;
+        const unpacked = PackedBool_2.unpack(f);
+        expect(unpacked[0].toBoolean()).toBe(false);
+        expect(unpacked[1].toBoolean()).toBe(true);
+        expect(unpacked[0].toBoolean()).toBe(packedBool_2.aux[0].toBoolean());
+        expect(unpacked[1].toBoolean()).toBe(packedBool_2.aux[1].toBoolean());
+    });
+    it('packs and unpacks 50 Bool values', async () => {
+        const myBooleans = [
+            true,
+            true,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+            true,
+            true,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+            true,
+            true,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+            true,
+            true,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+            true,
+            true,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+        ];
+        const myBools = myBooleans.map((b) => Bool(b));
+        const PackedBool_50 = PackedBoolFactory(50);
+        const packedBool_50 = new PackedBool_50(PackedBool_50.pack(myBools), myBools);
+        const f = packedBool_50.packed;
+        const unpacked = PackedBool_50.unpack(f);
+        expect(unpacked[0].toBoolean()).toBe(myBooleans[0]);
+        expect(unpacked[1].toBoolean()).toBe(myBooleans[1]);
+        expect(unpacked[15].toBoolean()).toBe(myBooleans[15]);
+        expect(unpacked[20].toBoolean()).toBe(myBooleans[20]);
+        expect(unpacked[35].toBoolean()).toBe(myBooleans[35]);
+        expect(unpacked[49].toBoolean()).toBe(myBooleans[49]);
+    });
+    it('mixes and matches class types', () => {
+        const myBooleans = [true, true, false, false, true, false];
+        const myBools = myBooleans.map((b) => Bool(b));
+        const PackedBool_2 = PackedBoolFactory(2);
+        const PackedBool_50 = PackedBoolFactory(50);
+        const packedBool_2 = new PackedBool_2(PackedBool_2.pack(myBools), myBools);
+        const packedBool_50 = new PackedBool_50(PackedBool_2.pack(myBools), myBools);
+        // TODO: Is this desired behavior?
+        console.log(PackedBool_2.toAuxiliary({ packed: packedBool_2.packed }).toString());
+        // > console.log
+        // > true,true
+        console.log(PackedBool_50.toAuxiliary({ packed: packedBool_50.packed }).toString());
+        // > console.log
+        // > true,true,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false,false
+    });
+    it('throws for input >= 255 bools', () => {
+        expect(() => PackedBoolFactory(254)).not.toThrow();
+        expect(() => PackedBoolFactory(255)).toThrow();
+    });
+});
+//# sourceMappingURL=PackedBool.test.js.map

package/build/src/packed-types/PackedBool.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedBool.test.js","sourceRoot":"","sources":["../../../src/packed-types/PackedBool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QAC3E,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC;QAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAExC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,UAAU,GAAG;YACjB,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,KAAK;SACN,CAAC;QACF,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,aAAa,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAE5C,MAAM,aAAa,GAAG,IAAI,aAAa,CACrC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAC3B,OAAO,CACR,CAAC;QACF,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC;QAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEzC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,aAAa,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAE5C,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAG,IAAI,aAAa,CACrC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAC1B,OAAO,CACR,CAAC;QAEF,kCAAkC;QAClC,OAAO,CAAC,GAAG,CACT,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CACrE,CAAC;QACF,gBAAgB;QAChB,cAAc;QACd,OAAO,CAAC,GAAG,CACT,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CACvE,CAAC;QACF,gBAAgB;QAChB,8SAA8S;IAChT,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/src/packed-types/PackedCharacter.d.ts

@@ -0,0 +1,51 @@
+import { Field, Character } from 'snarkyjs';
+export declare function PackedCharacterFactory(l: number): {
+    new (packed: import("snarkyjs/dist/node/lib/field.js").Field, aux: Character[]): {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+        aux: Character[];
+        bitSize: bigint;
+    };
+    /**
+     * Unpacks a Field into its component Character parts
+     * @param value
+     * @returns the unpacked auxilliary data used to pack the value
+     */
+    toAuxiliary(value?: {
+        packed: Field;
+    } | undefined): Character[];
+    pack(aux: Character[]): Field;
+    type: import("snarkyjs/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    }, {
+        packed: string;
+    }>;
+    l: number;
+    unpack(f: import("snarkyjs/dist/node/lib/field.js").Field): Character[];
+    check(value: {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    }): void;
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    }) => import("snarkyjs/dist/node/lib/field.js").Field[];
+    fromFields: (fields: import("snarkyjs/dist/node/lib/field.js").Field[]) => {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    };
+    sizeInFields(): number;
+    toInput: (x: {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    }) => {
+        fields?: import("snarkyjs/dist/node/lib/field.js").Field[] | undefined;
+        packed?: [import("snarkyjs/dist/node/lib/field.js").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    }) => {
+        packed: string;
+    };
+    fromJSON: (x: {
+        packed: string;
+    }) => {
+        packed: import("snarkyjs/dist/node/lib/field.js").Field;
+    };
+};

package/build/src/packed-types/PackedCharacter.js

@@ -0,0 +1,34 @@
+import { Field, Provable, Character } from 'snarkyjs';
+import { PackingPlant } from './PackingPlant.js';
+const SIZE_IN_BITS = 16n;
+export function PackedCharacterFactory(l) {
+    class PackedCharacter_ extends PackingPlant(Character, l, SIZE_IN_BITS) {
+        /**
+         * Unpacks a Field into its component Character parts
+         * @param value
+         * @returns the unpacked auxilliary data used to pack the value
+         */
+        static toAuxiliary(value) {
+            const auxiliary = Provable.witness(Provable.Array(Character, l), () => {
+                let uints_ = [];
+                let packedN = value?.packed.toBigInt() || 0n;
+                for (let i = 0; i < l; i++) {
+                    uints_[i] = packedN & ((1n << SIZE_IN_BITS) - 1n);
+                    packedN >>= SIZE_IN_BITS;
+                }
+                return uints_.map((x) => Character.fromString(String.fromCharCode(Number(x))));
+            });
+            return auxiliary;
+        }
+        static pack(aux) {
+            let f = Field(0);
+            for (let i = 0; i < l; i++) {
+                const c = Field((2n ** SIZE_IN_BITS) ** BigInt(i));
+                f = f.add(aux[i].value.mul(c));
+            }
+            return f;
+        }
+    }
+    return PackedCharacter_;
+}
+//# sourceMappingURL=PackedCharacter.js.map

package/build/src/packed-types/PackedCharacter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedCharacter.js","sourceRoot":"","sources":["../../../src/packed-types/PackedCharacter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,YAAY,GAAG,GAAG,CAAC;AAEzB,MAAM,UAAU,sBAAsB,CAAC,CAAS;IAC9C,MAAM,gBAAiB,SAAQ,YAAY,CAAC,SAAS,EAAE,CAAC,EAAE,YAAY,CAAC;QACrE;;;;WAIG;QACH,MAAM,CAAC,WAAW,CAAC,KAAqC;YACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE;gBACpE,IAAI,MAAM,GAAa,EAAE,CAAC;gBAC1B,IAAI,OAAO,GAAG,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;oBAClD,OAAO,KAAK,YAAY,CAAC;iBAC1B;gBACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACtB,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CACrD,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAgB;YAC1B,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC1B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aAChC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;KACF;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/build/src/packed-types/PackedCharacter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/packed-types/PackedCharacter.test.js

@@ -0,0 +1,31 @@
+import { Character } from 'snarkyjs';
+import { PackedCharacterFactory } from './PackedCharacter';
+describe('PackedCharacter', () => {
+    it('packs and unpacks a string of length < 16', async () => {
+        const myString = 'This is a test!';
+        let myCharacters = [];
+        for (let i = 0; i < myString.length; i++) {
+            myCharacters.push(Character.fromString(myString[i]));
+        }
+        const PackedCharacter_15 = PackedCharacterFactory(15);
+        const packedCharacter_15 = new PackedCharacter_15(PackedCharacter_15.pack(myCharacters), myCharacters);
+        const f = packedCharacter_15.packed;
+        const unpacked = PackedCharacter_15.unpack(f);
+        const unpackedStr = unpacked.map((x) => x.toString()).join('');
+        expect(unpackedStr).toBe(myString);
+    });
+    it('is one field in size', async () => {
+        const myString = 'This is a test!';
+        let myCharacters = [];
+        for (let i = 0; i < myString.length; i++) {
+            myCharacters.push(Character.fromString(myString[i]));
+        }
+        const PackedCharacter_15 = PackedCharacterFactory(15);
+        expect(PackedCharacter_15.sizeInFields()).toBe(1);
+    });
+    it('throws for input >= 16 chars', () => {
+        expect(() => PackedCharacterFactory(15)).not.toThrow();
+        expect(() => PackedCharacterFactory(16)).toThrow();
+    });
+});
+//# sourceMappingURL=PackedCharacter.test.js.map

package/build/src/packed-types/PackedCharacter.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedCharacter.test.js","sourceRoot":"","sources":["../../../src/packed-types/PackedCharacter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,QAAQ,GAAG,iBAAiB,CAAC;QACnC,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACtD;QAED,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAEtD,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAC/C,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,EACrC,YAAY,CACb,CAAC;QACF,MAAM,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC;QACpC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,QAAQ,GAAG,iBAAiB,CAAC;QACnC,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACtD;QAED,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAEtD,MAAM,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACvD,MAAM,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/src/packed-types/PackedUInt32.d.ts

@@ -0,0 +1,51 @@
+import { Field, UInt32 } from 'snarkyjs';
+export declare function PackedUInt32Factory(l: number): {
+    new (packed: import("snarkyjs/dist/node/lib/field").Field, aux: UInt32[]): {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+        aux: UInt32[];
+        bitSize: bigint;
+    };
+    /**
+     * Unpacks a Field into its component UInt32 parts
+     * @param value
+     * @returns the unpacked auxilliary data used to pack the value
+     */
+    toAuxiliary(value?: {
+        packed: Field;
+    } | undefined): UInt32[];
+    pack(aux: UInt32[]): Field;
+    type: import("snarkyjs/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }, {
+        packed: string;
+    }>;
+    l: number;
+    unpack(f: import("snarkyjs/dist/node/lib/field").Field): UInt32[];
+    check(value: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }): void;
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => import("snarkyjs/dist/node/lib/field").Field[];
+    fromFields: (fields: import("snarkyjs/dist/node/lib/field").Field[]) => {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    };
+    sizeInFields(): number;
+    toInput: (x: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => {
+        fields?: import("snarkyjs/dist/node/lib/field").Field[] | undefined;
+        packed?: [import("snarkyjs/dist/node/lib/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    }) => {
+        packed: string;
+    };
+    fromJSON: (x: {
+        packed: string;
+    }) => {
+        packed: import("snarkyjs/dist/node/lib/field").Field;
+    };
+};

package/build/src/packed-types/PackedUInt32.js

@@ -0,0 +1,34 @@
+import { Field, Provable, UInt32 } from 'snarkyjs';
+import { PackingPlant } from './PackingPlant';
+const SIZE_IN_BITS = 32n;
+export function PackedUInt32Factory(l) {
+    class PackedUInt32_ extends PackingPlant(UInt32, l, SIZE_IN_BITS) {
+        /**
+         * Unpacks a Field into its component UInt32 parts
+         * @param value
+         * @returns the unpacked auxilliary data used to pack the value
+         */
+        static toAuxiliary(value) {
+            const auxiliary = Provable.witness(Provable.Array(UInt32, l), () => {
+                let uints_ = [];
+                let packedN = value?.packed.toBigInt() || 0n;
+                for (let i = 0; i < l; i++) {
+                    uints_[i] = packedN & ((1n << SIZE_IN_BITS) - 1n);
+                    packedN >>= SIZE_IN_BITS;
+                }
+                return uints_.map((x) => UInt32.from(x));
+            });
+            return auxiliary;
+        }
+        static pack(aux) {
+            let f = Field(0);
+            for (let i = 0; i < l; i++) {
+                const c = Field((2n ** SIZE_IN_BITS) ** BigInt(i));
+                f = f.add(aux[i].value.mul(c));
+            }
+            return f;
+        }
+    }
+    return PackedUInt32_;
+}
+//# sourceMappingURL=PackedUInt32.js.map

package/build/src/packed-types/PackedUInt32.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedUInt32.js","sourceRoot":"","sources":["../../../src/packed-types/PackedUInt32.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,YAAY,GAAG,GAAG,CAAC;AAEzB,MAAM,UAAU,mBAAmB,CAAC,CAAS;IAC3C,MAAM,aAAc,SAAQ,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,YAAY,CAAC;QAC/D;;;;WAIG;QACH,MAAM,CAAC,WAAW,CAAC,KAAqC;YACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE;gBACjE,IAAI,MAAM,GAAa,EAAE,CAAC;gBAC1B,IAAI,OAAO,GAAG,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC;oBAClD,OAAO,KAAK,YAAY,CAAC;iBAC1B;gBACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAa;YACvB,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC1B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aAChC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;KACF;IACD,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/build/src/packed-types/PackedUInt32.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/packed-types/PackedUInt32.test.js

@@ -0,0 +1,68 @@
+import { Provable, UInt32 } from 'snarkyjs';
+import { PackedUInt32Factory } from './PackedUInt32';
+describe('PackedUInt32', () => {
+    it('packs and unpacks 2 UInt32 values', async () => {
+        const uints = [UInt32.from(67), UInt32.from(2n ** 32n - 1n)];
+        const PackedUInt32_2 = PackedUInt32Factory(2);
+        const packedUInt32_2 = new PackedUInt32_2(PackedUInt32_2.pack(uints), uints);
+        const f = packedUInt32_2.packed;
+        const unpacked = PackedUInt32_2.unpack(f);
+        expect(unpacked[0].toBigint()).toBe(67n);
+        expect(unpacked[1].toBigint()).toBe(2n ** 32n - 1n);
+        expect(unpacked[0].toBigint()).toBe(packedUInt32_2.aux[0].toBigint());
+        expect(unpacked[1].toBigint()).toBe(packedUInt32_2.aux[1].toBigint());
+    });
+    it('packs and unpacks 5 UInt32 values', async () => {
+        const uints = [
+            UInt32.from(67),
+            UInt32.from(2n ** 32n - 1n),
+            UInt32.from(0),
+            UInt32.from(0),
+            UInt32.from(128),
+        ];
+        const PackedUInt32_5 = PackedUInt32Factory(5);
+        const packedUInt32_5 = new PackedUInt32_5(PackedUInt32_5.pack(uints), uints);
+        const f = packedUInt32_5.packed;
+        const unpacked = PackedUInt32_5.unpack(f);
+        expect(unpacked[0].toBigint()).toBe(67n);
+        expect(unpacked[1].toBigint()).toBe(2n ** 32n - 1n);
+        expect(unpacked[2].toBigint()).toBe(0n);
+        expect(unpacked[3].toBigint()).toBe(0n);
+        expect(unpacked[4].toBigint()).toBe(128n);
+        expect(unpacked[0].toBigint()).toBe(packedUInt32_5.aux[0].toBigint());
+        expect(unpacked[1].toBigint()).toBe(packedUInt32_5.aux[1].toBigint());
+        expect(unpacked[2].toBigint()).toBe(packedUInt32_5.aux[2].toBigint());
+        expect(unpacked[3].toBigint()).toBe(packedUInt32_5.aux[3].toBigint());
+        expect(unpacked[4].toBigint()).toBe(packedUInt32_5.aux[4].toBigint());
+    });
+    it('Validates with #check', () => {
+        const uints = [
+            UInt32.from(67),
+            UInt32.from(2n ** 32n - 1n),
+            UInt32.from(0),
+            UInt32.from(0),
+            UInt32.from(128),
+        ];
+        const PackedUInt32_5 = PackedUInt32Factory(5);
+        Provable.runAndCheck(() => {
+            const packedUInt32_5 = new PackedUInt32_5(PackedUInt32_5.pack(uints), uints);
+        });
+    });
+    it('Is one field in size', () => {
+        const uints = [
+            UInt32.from(67),
+            UInt32.from(2n ** 32n - 1n),
+            UInt32.from(0),
+            UInt32.from(0),
+            UInt32.from(128),
+        ];
+        const PackedUInt32_5 = PackedUInt32Factory(5);
+        expect(PackedUInt32_5.sizeInFields()).toBe(1);
+        expect(PackedUInt32_5.toFields({ packed: PackedUInt32_5.pack(uints) }).toString()).toBe([PackedUInt32_5.pack(uints)].toString());
+    });
+    it('throws for input >= 8 uints', () => {
+        expect(() => PackedUInt32Factory(7)).not.toThrow();
+        expect(() => PackedUInt32Factory(8)).toThrow();
+    });
+});
+//# sourceMappingURL=PackedUInt32.test.js.map

package/build/src/packed-types/PackedUInt32.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackedUInt32.test.js","sourceRoot":"","sources":["../../../src/packed-types/PackedUInt32.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,QAAQ,EAAU,MAAM,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QAC7D,MAAM,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAG,IAAI,cAAc,CACvC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAC1B,KAAK,CACN,CAAC;QACF,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC;QAChC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,KAAK,GAAG;YACZ,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SACjB,CAAC;QACF,MAAM,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAG,IAAI,cAAc,CACvC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAC1B,KAAK,CACN,CAAC;QACF,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC;QAChC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1C,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,KAAK,GAAG;YACZ,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SACjB,CAAC;QACF,MAAM,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAE9C,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE;YACxB,MAAM,cAAc,GAAG,IAAI,cAAc,CACvC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAC1B,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,KAAK,GAAG;YACZ,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SACjB,CAAC;QACF,MAAM,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,CACJ,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAC3E,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}