o1js-pack 0.4.0 → 0.4.1

package/README.md

@@ -1,33 +1,18 @@
-# O1JS Pack
+# o1js Pack
 
-Make the most of your ZKApp state!
+Make the most of your zkApp state!
 
 ## What is it
 
-O1JS Pack is a library for [O1JS](https://github.com/o1-labs/o1js/) that allows a zkapp developer to pack extra data into a single Field.
+o1js Pack is a library for [o1js](https://github.com/o1-labs/o1js/) that allows a zkApp developer to pack extra data into a single Field.
 
-### Usage in a ZKApp
+### Usage in a zkApp
 
-```
-import {
-  PackedBoolFactory,
-  PackedStringFactory,
-  PackedUInt32Factory,
-} from 'o1js-pack';
-
-const MyPackedBools = PackedBoolFactory(); // Max of 254 Bools
-const MyPackedString = PackedStringFactory(); // Max of 120 Characters
-const MyPackedUInts = PackedUInt32Factory(); // Max of 7 UInt32s
-
-const sevenUints = [1, 2, 3, 4, 5, 6, 7].map(x => UInt32.from(x));
-const myPackedUInts = new MyPackedUInts(MyPackedUInts.pack(sevenUints), sevenUints);
-```
+TODO
 
-## What's the catch?
+### Smart Contract
 
-If a zkapp has two or more independent Fields of state, then preconditions can be set on just one, or on any combination of the Fields. With SnarkyPack, one precondition will be set on the packed Field, which means that independent updates cannot happen asynchronously.
-
-For example, let's say there is a voting app with two independent Fields of state: `yesCount` and `noCount`. If one user issues an update to `yesCount` and another user issues an update to `noCount` at the same time, both proofs may be valid at the same time. Both transactions may succeed during the same block, since they don't interfere with each others' preconditions. With SnarkyPack, a devolper can save state by putting both `yesCount` and `noCount` into the same Field of state, making room for other state to exist on chain. The tradeoff is that two votes will no longer be able to be cast independently. `yesCount` and `noCount` depend on the same precontition, meaning that to update one or the other, you must lock both.
+### ZK Program
 
 ## How to build
 
@@ -39,18 +24,12 @@ npm run build
 
 ```sh
 npm run test src # non-proof tests
-npm run testw # watch mode
-```
-
-## How to run coverage
-
-```sh
-npm run coverage
+npm run test tests/provable # provable tests
 ```
 
 ## Credits
 
-Thanks to @mario_zito for seeding the idea for this library on discord ([Thread 1](https://discord.com/channels/484437221055922177/1128509274465779822), [Thread 2](https://discord.com/channels/484437221055922177/1128501705173106698)), and to @gregor for sounding out the early implementation.
+Thanks to @mario_zito for seeding the idea for this library on Discord ([Thread 1](https://discord.com/channels/484437221055922177/1128509274465779822), [Thread 2](https://discord.com/channels/484437221055922177/1128501705173106698)), and to @gregor for sounding out the early implementation.
 
 Thanks to @iam-dev for early adoption!
 

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 } from './lib/packed-types/PackedString.js';
+export { PackedBoolFactory, PackedStringFactory, 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 } from './lib/packed-types/PackedString.js';
+export { PackedBoolFactory, PackedStringFactory, PackedUInt32Factory, PackingPlant, MultiPackingPlant, };
 //# sourceMappingURL=index.js.map

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

@@ -1,140 +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) => {
-    bitSize: bigint;
-    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;
-    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; /**
-     *
-     * @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
-     */
-    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>) => {
-    bitSize: bigint;
-    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;
-    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; /**
-     *
-     * @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
-     */
-    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[];
+    };
+};