o1js-pack 0.4.1 → 0.4.3

package/build/src/lib/packed-types/PackedString.js

@@ -1,128 +1,128 @@
-import { Field, Provable, Character, Poseidon } from 'o1js';
-import { PackingPlant, MultiPackingPlant } from '../PackingPlant.js';
-const SIZE_IN_BITS = 16n;
-const L = 15; // Default to one-field worth of characters
-const CHARS_PER_FIELD = 15;
-export function PackedStringFactory(l = L) {
-    class PackedString_ extends PackingPlant(Character, l, SIZE_IN_BITS) {
-        static extractField(input) {
-            return input.value;
-        }
-        static sizeInBits() {
-            return SIZE_IN_BITS;
-        }
-        /**
-         *
-         * @param f Field, packed with the information, as returned by #pack
-         * @returns Array of Character
-         */
-        static unpack(f) {
-            const unpacked = Provable.witness(Provable.Array(Character, l), () => {
-                const unpacked = this.unpackToBigints(f);
-                return unpacked.map((x) => Character.fromString(String.fromCharCode(Number(x))));
-            });
-            f.assertEquals(PackedString_.pack(unpacked));
-            return unpacked;
-        }
-        /**
-         *
-         * @param characters Array of Character to be packed
-         * @returns Instance of the implementing class
-         */
-        static fromCharacters(input) {
-            let characters = new Array(this.l);
-            characters.fill(new Character(Field(0)), 0, this.l);
-            for (let i = 0; i < input.length; i++) {
-                characters[i] = input[i];
-            }
-            const packed = this.pack(characters);
-            return new PackedString_(packed);
-        }
-        /**
-         *
-         * @param str string to be packed
-         * @returns Instance of the implementing class
-         */
-        static fromString(str) {
-            let characters = new Array(this.l);
-            characters.fill(new Character(Field(0)), 0, this.l);
-            for (let i = 0; i < str.length; i++) {
-                characters[i] = Character.fromString(str[i]);
-            }
-            return this.fromCharacters(characters);
-        }
-        toString() {
-            const nullChar = String.fromCharCode(0);
-            return PackedString_.unpack(this.packed)
-                .filter((c) => c.toString() !== nullChar)
-                .join('');
-        }
-    }
-    return PackedString_;
-}
-/**
- *
- * @param n number of fields to employ to store the string
- * @returns MultiPackedString_ class with length of n * CHARS_PER_FIELD
- */
-export function MultiPackedStringFactory(n = 8) {
-    class MultiPackedString_ extends MultiPackingPlant(Character, n * CHARS_PER_FIELD, SIZE_IN_BITS) {
-        static extractField(input) {
-            return input.value;
-        }
-        static sizeInBits() {
-            return SIZE_IN_BITS;
-        }
-        static elementsPerField() {
-            return CHARS_PER_FIELD;
-        }
-        /**
-         *
-         * @param fields Array of Fields, containing packed Characters
-         * @returns Array of Character
-         */
-        static unpack(fields) {
-            const unpacked = Provable.witness(Provable.Array(Character, this.l), () => {
-                let unpacked = this.unpackToBigints(fields);
-                return unpacked.map((x) => Character.fromString(String.fromCharCode(Number(x))));
-            });
-            Poseidon.hash(fields).assertEquals(Poseidon.hash(MultiPackedString_.pack(unpacked)));
-            return unpacked;
-        }
-        /**
-         *
-         * @param characters Array of Character to be packed
-         * @returns Instance of the implementing class
-         */
-        static fromCharacters(input) {
-            let characters = new Array(this.l);
-            characters.fill(new Character(Field(0)), 0, this.l);
-            for (let i = 0; i < input.length; i++) {
-                characters[i] = input[i];
-            }
-            const packed = this.pack(characters);
-            return new MultiPackedString_(packed);
-        }
-        /**
-         *
-         * @param str string to be packed
-         * @returns Instance of the implementing class
-         */
-        static fromString(str) {
-            let characters = new Array(this.l);
-            characters.fill(new Character(Field(0)), 0, this.l);
-            for (let i = 0; i < str.length; i++) {
-                characters[i] = Character.fromString(str[i]);
-            }
-            return this.fromCharacters(characters);
-        }
-        toString() {
-            const nullChar = String.fromCharCode(0);
-            return MultiPackedString_.unpack(this.packed)
-                .filter((c) => c.toString() !== nullChar)
-                .join('');
-        }
-    }
-    return MultiPackedString_;
-}
+import { Field, Provable, Character, Poseidon } from 'o1js';
+import { PackingPlant, MultiPackingPlant } from '../PackingPlant.js';
+const SIZE_IN_BITS = 16n;
+const L = 15; // Default to one-field worth of characters
+const CHARS_PER_FIELD = 15;
+export function PackedStringFactory(l = L) {
+    class PackedString_ extends PackingPlant(Character, l, SIZE_IN_BITS) {
+        static extractField(input) {
+            return input.value;
+        }
+        static sizeInBits() {
+            return SIZE_IN_BITS;
+        }
+        /**
+         *
+         * @param f Field, packed with the information, as returned by #pack
+         * @returns Array of Character
+         */
+        static unpack(f) {
+            const unpacked = Provable.witness(Provable.Array(Character, l), () => {
+                const unpacked = this.unpackToBigints(f);
+                return unpacked.map((x) => Character.fromString(String.fromCharCode(Number(x))));
+            });
+            f.assertEquals(PackedString_.pack(unpacked));
+            return unpacked;
+        }
+        /**
+         *
+         * @param characters Array of Character to be packed
+         * @returns Instance of the implementing class
+         */
+        static fromCharacters(input) {
+            let characters = new Array(this.l);
+            characters.fill(new Character(Field(0)), 0, this.l);
+            for (let i = 0; i < input.length; i++) {
+                characters[i] = input[i];
+            }
+            const packed = this.pack(characters);
+            return new PackedString_(packed);
+        }
+        /**
+         *
+         * @param str string to be packed
+         * @returns Instance of the implementing class
+         */
+        static fromString(str) {
+            let characters = new Array(this.l);
+            characters.fill(new Character(Field(0)), 0, this.l);
+            for (let i = 0; i < str.length; i++) {
+                characters[i] = Character.fromString(str[i]);
+            }
+            return this.fromCharacters(characters);
+        }
+        toString() {
+            const nullChar = String.fromCharCode(0);
+            return PackedString_.unpack(this.packed)
+                .filter((c) => c.toString() !== nullChar)
+                .join('');
+        }
+    }
+    return PackedString_;
+}
+/**
+ *
+ * @param n number of fields to employ to store the string
+ * @returns MultiPackedString_ class with length of n * CHARS_PER_FIELD
+ */
+export function MultiPackedStringFactory(n = 8) {
+    class MultiPackedString_ extends MultiPackingPlant(Character, n * CHARS_PER_FIELD, SIZE_IN_BITS) {
+        static extractField(input) {
+            return input.value;
+        }
+        static sizeInBits() {
+            return SIZE_IN_BITS;
+        }
+        static elementsPerField() {
+            return CHARS_PER_FIELD;
+        }
+        /**
+         *
+         * @param fields Array of Fields, containing packed Characters
+         * @returns Array of Character
+         */
+        static unpack(fields) {
+            const unpacked = Provable.witness(Provable.Array(Character, this.l), () => {
+                let unpacked = this.unpackToBigints(fields);
+                return unpacked.map((x) => Character.fromString(String.fromCharCode(Number(x))));
+            });
+            Poseidon.hash(fields).assertEquals(Poseidon.hash(MultiPackedString_.pack(unpacked)));
+            return unpacked;
+        }
+        /**
+         *
+         * @param characters Array of Character to be packed
+         * @returns Instance of the implementing class
+         */
+        static fromCharacters(input) {
+            let characters = new Array(this.l);
+            characters.fill(new Character(Field(0)), 0, this.l);
+            for (let i = 0; i < input.length; i++) {
+                characters[i] = input[i];
+            }
+            const packed = this.pack(characters);
+            return new MultiPackedString_(packed);
+        }
+        /**
+         *
+         * @param str string to be packed
+         * @returns Instance of the implementing class
+         */
+        static fromString(str) {
+            let characters = new Array(this.l);
+            characters.fill(new Character(Field(0)), 0, this.l);
+            for (let i = 0; i < str.length; i++) {
+                characters[i] = Character.fromString(str[i]);
+            }
+            return this.fromCharacters(characters);
+        }
+        toString() {
+            const nullChar = String.fromCharCode(0);
+            return MultiPackedString_.unpack(this.packed)
+                .filter((c) => c.toString() !== nullChar)
+                .join('');
+        }
+    }
+    return MultiPackedString_;
+}
 //# sourceMappingURL=PackedString.js.map

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

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

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

@@ -1,101 +1,101 @@
-import { Character, Provable } from 'o1js';
-import { PackedStringFactory, MultiPackedStringFactory } from './PackedString';
-describe('PackedString', () => {
-    describe('Outside of the Circuit', () => {
-        const vitalik_dot_eth = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
-        class EthAddressString extends MultiPackedStringFactory(3) {
-        }
-        let characters = [];
-        beforeEach(() => {
-            characters = [];
-            for (let i = 0; i < vitalik_dot_eth.length; i++) {
-                characters.push(Character.fromString(vitalik_dot_eth[i]));
-            }
-        });
-        it('#fromString', () => {
-            const myEthAddress = EthAddressString.fromString(vitalik_dot_eth);
-            expect(myEthAddress.toString()).toBe(vitalik_dot_eth);
-        });
-        it('#fromCharacters', () => {
-            const myEthAddress = EthAddressString.fromCharacters(characters);
-            expect(myEthAddress.toString()).toBe(vitalik_dot_eth);
-        });
-        it('#pack and #unPack', () => {
-            const unpacked = EthAddressString.unpack(EthAddressString.fromCharacters(characters).packed);
-            const packed = EthAddressString.pack(unpacked);
-            expect(packed.length).toBe(Math.ceil(vitalik_dot_eth.length / 15));
-            expect(unpacked.length).toBe(EthAddressString.l);
-            expect(unpacked.length).toBe(45);
-            expect(unpacked.slice(0, characters.length).toString()).toBe(characters.toString());
-        });
-    });
-    describe('Provable Properties', () => {
-        it('#sizeInFields', () => {
-            class one extends PackedStringFactory(15) {
-            }
-            class two extends MultiPackedStringFactory(2) {
-            }
-            class three extends MultiPackedStringFactory(3) {
-            }
-            expect(one.sizeInFields()).toBe(1);
-            expect(two.sizeInFields()).toBe(2);
-            expect(three.sizeInFields()).toBe(3);
-        });
-    });
-    describe('Defensive Cases', () => {
-        it('Initializes a class with fewer than allowed characters', () => {
-            class String10 extends PackedStringFactory(10) {
-            }
-            const string0 = String10.fromString('');
-            const string2 = String10.fromString('ab');
-            expect(string0.toString()).toBe('');
-            expect(string2.toString()).toBe('ab');
-        });
-        it('Initializes a class with more than allowed characters', () => {
-            class String10 extends PackedStringFactory(10) {
-            }
-            expect(() => {
-                String10.fromString('abcdefghijk');
-            }).toThrow();
-        });
-        it('Exceeds maximum size string', () => {
-            const tooLong = 'too long!'.repeat(20);
-            class MaxString extends MultiPackedStringFactory(8) {
-            }
-            expect(() => {
-                MaxString.fromString(tooLong);
-            }).toThrow();
-        });
-    });
-    describe('In the circuit', () => {
-        const vitalik_dot_eth = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
-        class EthAddressString extends MultiPackedStringFactory(3) {
-        }
-        const outsideEthAddress = EthAddressString.fromString(vitalik_dot_eth);
-        it('Initializes a string', () => {
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const myEthAddress = new EthAddressString(outsideEthAddress.packed);
-                    EthAddressString.check({ packed: myEthAddress.packed });
-                });
-            }).not.toThrow();
-        });
-        it('#assertEquals', () => {
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const myEthAddress = new EthAddressString(outsideEthAddress.packed);
-                    myEthAddress.assertEquals(outsideEthAddress);
-                });
-            }).not.toThrow();
-            expect(() => {
-                Provable.runAndCheck(() => {
-                    const fakePacked = [...outsideEthAddress.packed];
-                    fakePacked[0] = fakePacked[0].add(1);
-                    const myEthAddress = new EthAddressString(fakePacked);
-                    myEthAddress.assertEquals(outsideEthAddress);
-                });
-            }).toThrow();
-        });
-    });
-});
+import { Character, Provable } from 'o1js';
+import { PackedStringFactory, MultiPackedStringFactory } from './PackedString';
+describe('PackedString', () => {
+    describe('Outside of the Circuit', () => {
+        const vitalik_dot_eth = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+        class EthAddressString extends MultiPackedStringFactory(3) {
+        }
+        let characters = [];
+        beforeEach(() => {
+            characters = [];
+            for (let i = 0; i < vitalik_dot_eth.length; i++) {
+                characters.push(Character.fromString(vitalik_dot_eth[i]));
+            }
+        });
+        it('#fromString', () => {
+            const myEthAddress = EthAddressString.fromString(vitalik_dot_eth);
+            expect(myEthAddress.toString()).toBe(vitalik_dot_eth);
+        });
+        it('#fromCharacters', () => {
+            const myEthAddress = EthAddressString.fromCharacters(characters);
+            expect(myEthAddress.toString()).toBe(vitalik_dot_eth);
+        });
+        it('#pack and #unPack', () => {
+            const unpacked = EthAddressString.unpack(EthAddressString.fromCharacters(characters).packed);
+            const packed = EthAddressString.pack(unpacked);
+            expect(packed.length).toBe(Math.ceil(vitalik_dot_eth.length / 15));
+            expect(unpacked.length).toBe(EthAddressString.l);
+            expect(unpacked.length).toBe(45);
+            expect(unpacked.slice(0, characters.length).toString()).toBe(characters.toString());
+        });
+    });
+    describe('Provable Properties', () => {
+        it('#sizeInFields', () => {
+            class one extends PackedStringFactory(15) {
+            }
+            class two extends MultiPackedStringFactory(2) {
+            }
+            class three extends MultiPackedStringFactory(3) {
+            }
+            expect(one.sizeInFields()).toBe(1);
+            expect(two.sizeInFields()).toBe(2);
+            expect(three.sizeInFields()).toBe(3);
+        });
+    });
+    describe('Defensive Cases', () => {
+        it('Initializes a class with fewer than allowed characters', () => {
+            class String10 extends PackedStringFactory(10) {
+            }
+            const string0 = String10.fromString('');
+            const string2 = String10.fromString('ab');
+            expect(string0.toString()).toBe('');
+            expect(string2.toString()).toBe('ab');
+        });
+        it('Initializes a class with more than allowed characters', () => {
+            class String10 extends PackedStringFactory(10) {
+            }
+            expect(() => {
+                String10.fromString('abcdefghijk');
+            }).toThrow();
+        });
+        it('Exceeds maximum size string', () => {
+            const tooLong = 'too long!'.repeat(20);
+            class MaxString extends MultiPackedStringFactory(8) {
+            }
+            expect(() => {
+                MaxString.fromString(tooLong);
+            }).toThrow();
+        });
+    });
+    describe('In the circuit', () => {
+        const vitalik_dot_eth = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+        class EthAddressString extends MultiPackedStringFactory(3) {
+        }
+        const outsideEthAddress = EthAddressString.fromString(vitalik_dot_eth);
+        it('Initializes a string', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const myEthAddress = new EthAddressString(outsideEthAddress.packed);
+                    EthAddressString.check({ packed: myEthAddress.packed });
+                });
+            }).not.toThrow();
+        });
+        it('#assertEquals', () => {
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const myEthAddress = new EthAddressString(outsideEthAddress.packed);
+                    myEthAddress.assertEquals(outsideEthAddress);
+                });
+            }).not.toThrow();
+            expect(() => {
+                Provable.runAndCheck(() => {
+                    const fakePacked = [...outsideEthAddress.packed];
+                    fakePacked[0] = fakePacked[0].add(1);
+                    const myEthAddress = new EthAddressString(fakePacked);
+                    myEthAddress.assertEquals(outsideEthAddress);
+                });
+            }).toThrow();
+        });
+    });
+});
 //# sourceMappingURL=PackedString.test.js.map

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

@@ -1,85 +1,85 @@
-import { Field, UInt32 } from 'o1js';
-export declare function PackedUInt32Factory(l?: number): {
-    new (packed: import("o1js/dist/node/lib/field.js").Field): {
-        toBigInts(): Array<bigint>;
-        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: UInt32): Field;
-    sizeInBits(): bigint;
-    /**
-     *
-     * @param f Field, packed with the information, as returned by #pack
-     * @returns Array of UInt32
-     */
-    unpack(f: Field): UInt32[];
-    /**
-     *
-     * @param uint32s Array of UInt32s to be packed
-     * @returns Instance of the implementing class
-     */
-    fromUInt32s(uint32s: Array<UInt32>): {
-        toBigInts(): Array<bigint>;
-        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 bigints Array of bigints to be packed
-     * @returns Instance of the implementing class
-     */
-    fromBigInts(bigints: Array<bigint>): {
-        toBigInts(): Array<bigint>;
-        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;
-    bitSize: bigint;
-    checkPack(unpacked: UInt32[]): void;
-    pack(unpacked: UInt32[]): 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;
-    };
-};
+import { Field, UInt32 } from 'o1js';
+export declare function PackedUInt32Factory(l?: number): {
+    new (packed: import("o1js/dist/node/lib/field.js").Field): {
+        toBigInts(): Array<bigint>;
+        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: UInt32): Field;
+    sizeInBits(): bigint;
+    /**
+     *
+     * @param f Field, packed with the information, as returned by #pack
+     * @returns Array of UInt32
+     */
+    unpack(f: Field): UInt32[];
+    /**
+     *
+     * @param uint32s Array of UInt32s to be packed
+     * @returns Instance of the implementing class
+     */
+    fromUInt32s(uint32s: Array<UInt32>): {
+        toBigInts(): Array<bigint>;
+        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 bigints Array of bigints to be packed
+     * @returns Instance of the implementing class
+     */
+    fromBigInts(bigints: Array<bigint>): {
+        toBigInts(): Array<bigint>;
+        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;
+    bitSize: bigint;
+    checkPack(unpacked: UInt32[]): void;
+    pack(unpacked: UInt32[]): 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;
+    };
+};