o1js-pack 0.4.1 → 0.4.2

package/README.md

@@ -8,12 +8,18 @@ o1js Pack is a library for [o1js](https://github.com/o1-labs/o1js/) that allows
 
 ### Usage in a zkApp
 
-TODO
-
 ### Smart Contract
 
+The primary benefit of using this library in a smart contract is that it allows you to use more of your allotted 8 Fields of storage.
+
+Check out example usage in a smart contract in [Smart Contract Examples](/examples/smart_contract/).
+
 ### ZK Program
 
+The benefit to using this library in a zk program is less obvious. In some cases, the number of gates required in a circuit is less using this library than with provable arrays. Especially in applications where the array is hashed many times, packing and unpacking ends up being more effecient than doing a lot of Poseidon hashes. In other cases, you may just prefer the API of o1js Pack compared to using provable arrays.
+
+Check out example usage in a zk program in [Zk Program Examples](/examples/zk_program/).
+
 ## How to build
 
 ```sh

package/build/src/index.d.ts

@@ -1,5 +1,5 @@
-import { PackedBoolFactory } from './lib/packed-types/PackedBool.js';
-import { PackedUInt32Factory } from './lib/packed-types/PackedUInt32.js';
-import { PackingPlant, MultiPackingPlant } from './lib/PackingPlant.js';
-import { PackedStringFactory } from './lib/packed-types/PackedString.js';
-export { PackedBoolFactory, PackedStringFactory, PackedUInt32Factory, PackingPlant, MultiPackingPlant, };
+import { PackedBoolFactory } from './lib/packed-types/PackedBool.js';
+import { PackedUInt32Factory } from './lib/packed-types/PackedUInt32.js';
+import { PackingPlant, MultiPackingPlant } from './lib/PackingPlant.js';
+import { PackedStringFactory, MultiPackedStringFactory } from './lib/packed-types/PackedString.js';
+export { PackedBoolFactory, PackedStringFactory, MultiPackedStringFactory, PackedUInt32Factory, PackingPlant, MultiPackingPlant, };

package/build/src/index.js

@@ -1,6 +1,6 @@
-import { PackedBoolFactory } from './lib/packed-types/PackedBool.js';
-import { PackedUInt32Factory } from './lib/packed-types/PackedUInt32.js';
-import { PackingPlant, MultiPackingPlant } from './lib/PackingPlant.js';
-import { PackedStringFactory } from './lib/packed-types/PackedString.js';
-export { PackedBoolFactory, PackedStringFactory, PackedUInt32Factory, PackingPlant, MultiPackingPlant, };
+import { PackedBoolFactory } from './lib/packed-types/PackedBool.js';
+import { PackedUInt32Factory } from './lib/packed-types/PackedUInt32.js';
+import { PackingPlant, MultiPackingPlant } from './lib/PackingPlant.js';
+import { PackedStringFactory, MultiPackedStringFactory, } from './lib/packed-types/PackedString.js';
+export { PackedBoolFactory, PackedStringFactory, MultiPackedStringFactory, PackedUInt32Factory, PackingPlant, MultiPackingPlant, };
 //# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,GAClB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EACL,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,GAClB,CAAC"}

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

@@ -1,132 +1,132 @@
-import { Field, InferProvable } from 'o1js';
-export declare function PackingPlant<A, T extends InferProvable<A> = InferProvable<A>>(elementType: A, l: number, bitSize: bigint): (abstract new (packed: Field) => {
-    assertEquals(other: any): void;
-    packed: import("o1js/dist/node/lib/field").Field;
-}) & {
-    type: import("o1js/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
-        packed: import("o1js/dist/node/lib/field").Field;
-    }, {
-        packed: string;
-    }>;
-    l: number;
-    bitSize: bigint;
-    extractField(input: T): Field;
-    sizeInBits(): bigint;
-    unpack(f: Field): Array<T>;
-    /**
-     *
-     * @param unpacked Array of the implemented packed type
-     * @throws if the length of the array is longer than the length of the implementing factory config
-     */
-    checkPack(unpacked: Array<T>): void;
-    /**
-     *
-     * @param unpacked Array of the implemented packed type, must be shorter than the max allowed, which varies by type, will throw if the input is too long
-     * @returns Field, packed with the information from the unpacked input
-     */
-    pack(unpacked: Array<T>): Field;
-    /**
-     *
-     * @param f Field, packed with the information, as returned by #pack
-     * @returns Array of bigints, which can be decoded by the implementing class into the final type
-     */
-    unpackToBigints(f: Field): Array<bigint>;
-    _isStruct: true;
-    toFields: (value: {
-        packed: import("o1js/dist/node/lib/field").Field;
-    }) => import("o1js/dist/node/lib/field").Field[];
-    toAuxiliary: (value?: {
-        packed: import("o1js/dist/node/lib/field").Field;
-    } | undefined) => any[];
-    fromFields: (fields: import("o1js/dist/node/lib/field").Field[]) => {
-        packed: import("o1js/dist/node/lib/field").Field;
-    };
-    sizeInFields(): number;
-    check: (value: {
-        packed: import("o1js/dist/node/lib/field").Field;
-    }) => void;
-    toInput: (x: {
-        packed: import("o1js/dist/node/lib/field").Field;
-    }) => {
-        fields?: import("o1js/dist/node/lib/field").Field[] | undefined;
-        packed?: [import("o1js/dist/node/lib/field").Field, number][] | undefined;
-    };
-    toJSON: (x: {
-        packed: import("o1js/dist/node/lib/field").Field;
-    }) => {
-        packed: string;
-    };
-    fromJSON: (x: {
-        packed: string;
-    }) => {
-        packed: import("o1js/dist/node/lib/field").Field;
-    };
-};
-export declare function MultiPackingPlant<A, T extends InferProvable<A> = InferProvable<A>>(elementType: A, l: number, bitSize: bigint): (abstract new (packed: Array<Field>) => {
-    assertEquals(other: any): void;
-    packed: import("o1js/dist/node/lib/field").Field[];
-}) & {
-    type: import("o1js/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
-        packed: import("o1js/dist/node/lib/field").Field[];
-    }, {
-        packed: string[];
-    }>;
-    l: number;
-    n: number;
-    bitSize: bigint;
-    extractField(input: T | undefined): Field;
-    sizeInBits(): bigint;
-    elementsPerField(): number;
-    unpack(fields: Array<Field>): Array<T>;
-    /**
-     *
-     * @param unpacked Array of the implemented packed type
-     * @throws if the length of the array is longer than the length of the implementing factory config
-     */
-    checkPack(unpacked: Array<T>): void;
-    /**
-     *
-     * @param unpacked Array of the implemented packed type, must be shorter than the max allowed, which varies by type, will throw if the input is too long
-     * @returns Array of Fields, packed such that each Field has as much information as possible
-     *
-     * e.g. 15 Characters pack into 1 Field.  15 or fewer Characters will return an array of 1 Field
-     *      30 of fewer Characters will return an aray of 2 Fields
-     */
-    pack(unpacked: Array<T>): Array<Field>;
-    /**
-     *
-     * @param fields Array of Fields, packed such that each Field has as much information as possible, as returned in #pack
-     * @returns Array of bigints, which can be decoded by the implementing class into the final type
-     */
-    unpackToBigints(fields: Array<Field>): Array<bigint>;
-    _isStruct: true;
-    toFields: (value: {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    }) => import("o1js/dist/node/lib/field").Field[];
-    toAuxiliary: (value?: {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    } | undefined) => any[];
-    fromFields: (fields: import("o1js/dist/node/lib/field").Field[]) => {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    };
-    sizeInFields(): number;
-    check: (value: {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    }) => void;
-    toInput: (x: {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    }) => {
-        fields?: import("o1js/dist/node/lib/field").Field[] | undefined;
-        packed?: [import("o1js/dist/node/lib/field").Field, number][] | undefined;
-    };
-    toJSON: (x: {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    }) => {
-        packed: string[];
-    };
-    fromJSON: (x: {
-        packed: string[];
-    }) => {
-        packed: import("o1js/dist/node/lib/field").Field[];
-    };
-};
+import { Field, InferProvable } from 'o1js';
+export declare function PackingPlant<A, T extends InferProvable<A> = InferProvable<A>>(elementType: A, l: number, bitSize: bigint): (abstract new (packed: Field) => {
+    assertEquals(other: any): void;
+    packed: import("o1js/dist/node/lib/field").Field;
+}) & {
+    type: import("o1js/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
+        packed: import("o1js/dist/node/lib/field").Field;
+    }, {
+        packed: string;
+    }>;
+    l: number;
+    bitSize: bigint;
+    extractField(input: T): Field;
+    sizeInBits(): bigint;
+    unpack(f: Field): Array<T>;
+    /**
+     *
+     * @param unpacked Array of the implemented packed type
+     * @throws if the length of the array is longer than the length of the implementing factory config
+     */
+    checkPack(unpacked: Array<T>): void;
+    /**
+     *
+     * @param unpacked Array of the implemented packed type, must be shorter than the max allowed, which varies by type, will throw if the input is too long
+     * @returns Field, packed with the information from the unpacked input
+     */
+    pack(unpacked: Array<T>): Field;
+    /**
+     *
+     * @param f Field, packed with the information, as returned by #pack
+     * @returns Array of bigints, which can be decoded by the implementing class into the final type
+     */
+    unpackToBigints(f: Field): Array<bigint>;
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("o1js/dist/node/lib/field").Field;
+    }) => import("o1js/dist/node/lib/field").Field[];
+    toAuxiliary: (value?: {
+        packed: import("o1js/dist/node/lib/field").Field;
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/field").Field[]) => {
+        packed: import("o1js/dist/node/lib/field").Field;
+    };
+    sizeInFields(): number;
+    check: (value: {
+        packed: import("o1js/dist/node/lib/field").Field;
+    }) => void;
+    toInput: (x: {
+        packed: import("o1js/dist/node/lib/field").Field;
+    }) => {
+        fields?: import("o1js/dist/node/lib/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("o1js/dist/node/lib/field").Field;
+    }) => {
+        packed: string;
+    };
+    fromJSON: (x: {
+        packed: string;
+    }) => {
+        packed: import("o1js/dist/node/lib/field").Field;
+    };
+};
+export declare function MultiPackingPlant<A, T extends InferProvable<A> = InferProvable<A>>(elementType: A, l: number, bitSize: bigint): (abstract new (packed: Array<Field>) => {
+    assertEquals(other: any): void;
+    packed: import("o1js/dist/node/lib/field").Field[];
+}) & {
+    type: import("o1js/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
+        packed: import("o1js/dist/node/lib/field").Field[];
+    }, {
+        packed: string[];
+    }>;
+    l: number;
+    n: number;
+    bitSize: bigint;
+    extractField(input: T | undefined): Field;
+    sizeInBits(): bigint;
+    elementsPerField(): number;
+    unpack(fields: Array<Field>): Array<T>;
+    /**
+     *
+     * @param unpacked Array of the implemented packed type
+     * @throws if the length of the array is longer than the length of the implementing factory config
+     */
+    checkPack(unpacked: Array<T>): void;
+    /**
+     *
+     * @param unpacked Array of the implemented packed type, must be shorter than the max allowed, which varies by type, will throw if the input is too long
+     * @returns Array of Fields, packed such that each Field has as much information as possible
+     *
+     * e.g. 15 Characters pack into 1 Field.  15 or fewer Characters will return an array of 1 Field
+     *      30 of fewer Characters will return an aray of 2 Fields
+     */
+    pack(unpacked: Array<T>): Array<Field>;
+    /**
+     *
+     * @param fields Array of Fields, packed such that each Field has as much information as possible, as returned in #pack
+     * @returns Array of bigints, which can be decoded by the implementing class into the final type
+     */
+    unpackToBigints(fields: Array<Field>): Array<bigint>;
+    _isStruct: true;
+    toFields: (value: {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    }) => import("o1js/dist/node/lib/field").Field[];
+    toAuxiliary: (value?: {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/field").Field[]) => {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    };
+    sizeInFields(): number;
+    check: (value: {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    }) => void;
+    toInput: (x: {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    }) => {
+        fields?: import("o1js/dist/node/lib/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    }) => {
+        packed: string[];
+    };
+    fromJSON: (x: {
+        packed: string[];
+    }) => {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    };
+};