o1js-pack 0.4.1 → 0.4.3

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

@@ -1,76 +1,76 @@
-import { Bool, Provable } from 'o1js';
-import { PackedBoolFactory } from './PackedBool';
-describe('PackedBool', () => {
-    const booleans = new Array(127).fill([true, false]).flat();
-    const bools = booleans.map((x) => Bool(x));
-    class PackedBool extends PackedBoolFactory() {
-    }
-    describe('Outside of the circuit', () => {
-        it('#fromBooleans', () => {
-            const myPackedBool = PackedBool.fromBooleans(booleans);
-            expect(myPackedBool.toBooleans()).toMatchObject(booleans);
-        });
-        it('#pack and #unPack', () => {
-            const packed = PackedBool.pack(bools);
-            const unpacked = PackedBool.unpack(packed);
-            expect(unpacked.length).toBe(bools.length);
-            expect(unpacked).toMatchObject(bools);
-        });
-    });
-    describe('Provable Properties', () => {
-        it('#sizeInFields', () => {
-            class one extends PackedBoolFactory(1) {
-            }
-            class two_five_four extends PackedBoolFactory(254) {
-            }
-            expect(one.sizeInFields()).toBe(1);
-            expect(two_five_four.sizeInFields()).toBe(1);
-        });
-    });
-    describe('Defensive Cases', () => {
-        it('throws for input >= 255 bools', () => {
-            expect(() => PackedBoolFactory(254)).not.toThrow();
-            expect(() => PackedBoolFactory(255)).toThrow();
-        });
-        it('initalizes with more input than allowed', () => {
-            const tooMany = [...booleans].concat(false);
-            expect(() => {
-                PackedBool.fromBooleans(tooMany);
-            }).toThrow();
-        });
-        it('initalizes with less input than specified', () => {
-            const booleans = [true, false];
-            const pad = new Array(252);
-            pad.fill(false);
-            const expected = booleans.concat(pad);
-            expect(PackedBool.fromBooleans(booleans).toBooleans()).toMatchObject(expected);
-        });
-    });
-    describe('In the circuit', () => {
-        const outsidePackedBool = PackedBool.fromBooleans(booleans);
-        it('Initializes', () => {
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const packedBool = new PackedBool(outsidePackedBool.packed);
-                    PackedBool.check({ packed: packedBool.packed });
-                });
-            }).not.toThrow();
-        });
-        it('#assertEquals', () => {
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const packedBool = new PackedBool(outsidePackedBool.packed);
-                    packedBool.assertEquals(outsidePackedBool);
-                });
-            }).not.toThrow();
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const fakePacked = outsidePackedBool.packed.add(32);
-                    const packedBool = new PackedBool(fakePacked);
-                    packedBool.assertEquals(outsidePackedBool);
-                });
-            }).toThrow();
-        });
-    });
-});
+import { Bool, Provable } from 'o1js';
+import { PackedBoolFactory } from './PackedBool';
+describe('PackedBool', () => {
+    const booleans = new Array(127).fill([true, false]).flat();
+    const bools = booleans.map((x) => Bool(x));
+    class PackedBool extends PackedBoolFactory() {
+    }
+    describe('Outside of the circuit', () => {
+        it('#fromBooleans', () => {
+            const myPackedBool = PackedBool.fromBooleans(booleans);
+            expect(myPackedBool.toBooleans()).toMatchObject(booleans);
+        });
+        it('#pack and #unPack', () => {
+            const packed = PackedBool.pack(bools);
+            const unpacked = PackedBool.unpack(packed);
+            expect(unpacked.length).toBe(bools.length);
+            expect(unpacked).toMatchObject(bools);
+        });
+    });
+    describe('Provable Properties', () => {
+        it('#sizeInFields', () => {
+            class one extends PackedBoolFactory(1) {
+            }
+            class two_five_four extends PackedBoolFactory(254) {
+            }
+            expect(one.sizeInFields()).toBe(1);
+            expect(two_five_four.sizeInFields()).toBe(1);
+        });
+    });
+    describe('Defensive Cases', () => {
+        it('throws for input >= 255 bools', () => {
+            expect(() => PackedBoolFactory(254)).not.toThrow();
+            expect(() => PackedBoolFactory(255)).toThrow();
+        });
+        it('initalizes with more input than allowed', () => {
+            const tooMany = [...booleans].concat(false);
+            expect(() => {
+                PackedBool.fromBooleans(tooMany);
+            }).toThrow();
+        });
+        it('initalizes with less input than specified', () => {
+            const booleans = [true, false];
+            const pad = new Array(252);
+            pad.fill(false);
+            const expected = booleans.concat(pad);
+            expect(PackedBool.fromBooleans(booleans).toBooleans()).toMatchObject(expected);
+        });
+    });
+    describe('In the circuit', () => {
+        const outsidePackedBool = PackedBool.fromBooleans(booleans);
+        it('Initializes', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const packedBool = new PackedBool(outsidePackedBool.packed);
+                    PackedBool.check({ packed: packedBool.packed });
+                });
+            }).not.toThrow();
+        });
+        it('#assertEquals', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const packedBool = new PackedBool(outsidePackedBool.packed);
+                    packedBool.assertEquals(outsidePackedBool);
+                });
+            }).not.toThrow();
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const fakePacked = outsidePackedBool.packed.add(32);
+                    const packedBool = new PackedBool(fakePacked);
+                    packedBool.assertEquals(outsidePackedBool);
+                });
+            }).toThrow();
+        });
+    });
+});
 //# sourceMappingURL=PackedBool.test.js.map

package/build/src/lib/packed-types/PackedString.d.ts

@@ -1,181 +1,181 @@
-import { Field, Character } from 'o1js';
-export declare function PackedStringFactory(l?: number): {
-    new (packed: import("o1js/dist/node/lib/field.js").Field): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field;
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    };
-    extractField(input: Character): Field;
-    sizeInBits(): bigint;
-    /**
-     *
-     * @param f Field, packed with the information, as returned by #pack
-     * @returns Array of Character
-     */
-    unpack(f: Field): Character[];
-    /**
-     *
-     * @param characters Array of Character to be packed
-     * @returns Instance of the implementing class
-     */
-    fromCharacters(input: Array<Character>): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field;
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    };
-    /**
-     *
-     * @param str string to be packed
-     * @returns Instance of the implementing class
-     */
-    fromString(str: string): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field;
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    };
-    /**
-     *
-     * @param f Field, packed with the information, as returned by #pack
-     * @returns Array of Character
-     */
-    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    }, {
-        packed: string;
-    }>;
-    l: number;
-    bitSize: bigint;
-    checkPack(unpacked: Character[]): void;
-    pack(unpacked: Character[]): import("o1js/dist/node/lib/field.js").Field;
-    unpackToBigints(f: import("o1js/dist/node/lib/field.js").Field): bigint[];
-    _isStruct: true;
-    toFields: (value: {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    }) => import("o1js/dist/node/lib/field.js").Field[];
-    toAuxiliary: (value?: {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    } | undefined) => any[];
-    fromFields: (fields: import("o1js/dist/node/lib/field.js").Field[]) => {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    };
-    sizeInFields(): number;
-    check: (value: {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    }) => void;
-    toInput: (x: {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    }) => {
-        fields?: import("o1js/dist/node/lib/field.js").Field[] | undefined;
-        packed?: [import("o1js/dist/node/lib/field.js").Field, number][] | undefined;
-    };
-    toJSON: (x: {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    }) => {
-        packed: string;
-    };
-    fromJSON: (x: {
-        packed: string;
-    }) => {
-        packed: import("o1js/dist/node/lib/field.js").Field;
-    };
-};
-/**
- *
- * @param n number of fields to employ to store the string
- * @returns MultiPackedString_ class with length of n * CHARS_PER_FIELD
- */
-export declare function MultiPackedStringFactory(n?: number): {
-    new (packed: import("o1js/dist/node/lib/field.js").Field[]): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field[];
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    };
-    extractField(input: Character): Field;
-    sizeInBits(): bigint;
-    elementsPerField(): number;
-    /**
-     *
-     * @param fields Array of Fields, containing packed Characters
-     * @returns Array of Character
-     */
-    unpack(fields: Field[]): Character[];
-    /**
-     *
-     * @param characters Array of Character to be packed
-     * @returns Instance of the implementing class
-     */
-    fromCharacters(input: Array<Character>): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field[];
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    };
-    /**
-     *
-     * @param str string to be packed
-     * @returns Instance of the implementing class
-     */
-    fromString(str: string): {
-        toString(): string;
-        assertEquals(other: {
-            assertEquals(other: any): void;
-            packed: import("o1js/dist/node/lib/field.js").Field[];
-        }): void;
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    };
-    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    }, {
-        packed: string[];
-    }>;
-    l: number;
-    n: number;
-    bitSize: bigint;
-    checkPack(unpacked: Character[]): void;
-    pack(unpacked: Character[]): import("o1js/dist/node/lib/field.js").Field[];
-    unpackToBigints(fields: import("o1js/dist/node/lib/field.js").Field[]): bigint[];
-    _isStruct: true;
-    toFields: (value: {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    }) => import("o1js/dist/node/lib/field.js").Field[];
-    toAuxiliary: (value?: {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    } | undefined) => any[];
-    fromFields: (fields: import("o1js/dist/node/lib/field.js").Field[]) => {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    };
-    sizeInFields(): number;
-    check: (value: {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    }) => void;
-    toInput: (x: {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    }) => {
-        fields?: import("o1js/dist/node/lib/field.js").Field[] | undefined;
-        packed?: [import("o1js/dist/node/lib/field.js").Field, number][] | undefined;
-    };
-    toJSON: (x: {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    }) => {
-        packed: string[];
-    };
-    fromJSON: (x: {
-        packed: string[];
-    }) => {
-        packed: import("o1js/dist/node/lib/field.js").Field[];
-    };
-};
+import { Field, Character } from 'o1js';
+export declare function PackedStringFactory(l?: number): {
+    new (packed: import("o1js/dist/node/lib/field.js").Field): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field;
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
+    extractField(input: Character): Field;
+    sizeInBits(): bigint;
+    /**
+     *
+     * @param f Field, packed with the information, as returned by #pack
+     * @returns Array of Character
+     */
+    unpack(f: Field): Character[];
+    /**
+     *
+     * @param characters Array of Character to be packed
+     * @returns Instance of the implementing class
+     */
+    fromCharacters(input: Array<Character>): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field;
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
+    /**
+     *
+     * @param str string to be packed
+     * @returns Instance of the implementing class
+     */
+    fromString(str: string): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field;
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
+    /**
+     *
+     * @param f Field, packed with the information, as returned by #pack
+     * @returns Array of Character
+     */
+    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    }, {
+        packed: string;
+    }>;
+    l: number;
+    bitSize: bigint;
+    checkPack(unpacked: Character[]): void;
+    pack(unpacked: Character[]): import("o1js/dist/node/lib/field.js").Field;
+    unpackToBigints(f: import("o1js/dist/node/lib/field.js").Field): bigint[];
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    }) => import("o1js/dist/node/lib/field.js").Field[];
+    toAuxiliary: (value?: {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/field.js").Field[]) => {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
+    sizeInFields(): number;
+    check: (value: {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    }) => void;
+    toInput: (x: {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    }) => {
+        fields?: import("o1js/dist/node/lib/field.js").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/field.js").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    }) => {
+        packed: string;
+    };
+    fromJSON: (x: {
+        packed: string;
+    }) => {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
+};
+/**
+ *
+ * @param n number of fields to employ to store the string
+ * @returns MultiPackedString_ class with length of n * CHARS_PER_FIELD
+ */
+export declare function MultiPackedStringFactory(n?: number): {
+    new (packed: import("o1js/dist/node/lib/field.js").Field[]): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field[];
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
+    extractField(input: Character): Field;
+    sizeInBits(): bigint;
+    elementsPerField(): number;
+    /**
+     *
+     * @param fields Array of Fields, containing packed Characters
+     * @returns Array of Character
+     */
+    unpack(fields: Field[]): Character[];
+    /**
+     *
+     * @param characters Array of Character to be packed
+     * @returns Instance of the implementing class
+     */
+    fromCharacters(input: Array<Character>): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field[];
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
+    /**
+     *
+     * @param str string to be packed
+     * @returns Instance of the implementing class
+     */
+    fromString(str: string): {
+        toString(): string;
+        assertEquals(other: {
+            assertEquals(other: any): void;
+            packed: import("o1js/dist/node/lib/field.js").Field[];
+        }): void;
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
+    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    }, {
+        packed: string[];
+    }>;
+    l: number;
+    n: number;
+    bitSize: bigint;
+    checkPack(unpacked: Character[]): void;
+    pack(unpacked: Character[]): import("o1js/dist/node/lib/field.js").Field[];
+    unpackToBigints(fields: import("o1js/dist/node/lib/field.js").Field[]): bigint[];
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    }) => import("o1js/dist/node/lib/field.js").Field[];
+    toAuxiliary: (value?: {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/field.js").Field[]) => {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
+    sizeInFields(): number;
+    check: (value: {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    }) => void;
+    toInput: (x: {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    }) => {
+        fields?: import("o1js/dist/node/lib/field.js").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/field.js").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    }) => {
+        packed: string[];
+    };
+    fromJSON: (x: {
+        packed: string[];
+    }) => {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
+};