o1js-pack 0.4.2 → 0.4.4

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

@@ -3,11 +3,11 @@ export declare function PackingPlant<A, T extends InferProvable<A> = InferProvab
     assertEquals(other: any): void;
     packed: import("o1js/dist/node/lib/field").Field;
 }) & {
-    type: import("o1js/dist/node/bindings/lib/provable-snarky").ProvableExtended<{
+    type: import("o1js/dist/node/bindings/lib/generic").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field").Field;
     }, {
         packed: string;
-    }>;
+    }, import("o1js/dist/node/lib/field").Field>;
     l: number;
     bitSize: bigint;
     extractField(input: T): Field;
@@ -61,16 +61,19 @@ export declare function PackingPlant<A, T extends InferProvable<A> = InferProvab
     }) => {
         packed: import("o1js/dist/node/lib/field").Field;
     };
+    empty: () => {
+        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<{
+    type: import("o1js/dist/node/bindings/lib/generic").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field").Field[];
     }, {
         packed: string[];
-    }>;
+    }, import("o1js/dist/node/lib/field").Field>;
     l: number;
     n: number;
     bitSize: bigint;
@@ -129,4 +132,7 @@ export declare function MultiPackingPlant<A, T extends InferProvable<A> = InferP
     }) => {
         packed: import("o1js/dist/node/lib/field").Field[];
     };
+    empty: () => {
+        packed: import("o1js/dist/node/lib/field").Field[];
+    };
 };

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

@@ -42,11 +42,11 @@ export declare function PackedBoolFactory(l?: number): {
         }): void;
         packed: import("o1js/dist/node/lib/field.js").Field;
     };
-    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+    type: import("o1js/dist/node/bindings/lib/generic.js").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field.js").Field;
     }, {
         packed: string;
-    }>;
+    }, import("o1js/dist/node/lib/field.js").Field>;
     l: number;
     bitSize: bigint;
     checkPack(unpacked: import("o1js/dist/node/lib/bool.js").Bool[]): void;
@@ -82,4 +82,7 @@ export declare function PackedBoolFactory(l?: number): {
     }) => {
         packed: import("o1js/dist/node/lib/field.js").Field;
     };
+    empty: () => {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
 };

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

@@ -47,11 +47,11 @@ export declare function PackedStringFactory(l?: number): {
      * @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<{
+    type: import("o1js/dist/node/bindings/lib/generic.js").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field.js").Field;
     }, {
         packed: string;
-    }>;
+    }, import("o1js/dist/node/lib/field.js").Field>;
     l: number;
     bitSize: bigint;
     checkPack(unpacked: Character[]): void;
@@ -87,6 +87,9 @@ export declare function PackedStringFactory(l?: number): {
     }) => {
         packed: import("o1js/dist/node/lib/field.js").Field;
     };
+    empty: () => {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
 };
 /**
  *
@@ -137,11 +140,11 @@ export declare function MultiPackedStringFactory(n?: number): {
         }): void;
         packed: import("o1js/dist/node/lib/field.js").Field[];
     };
-    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+    type: import("o1js/dist/node/bindings/lib/generic.js").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field.js").Field[];
     }, {
         packed: string[];
-    }>;
+    }, import("o1js/dist/node/lib/field.js").Field>;
     l: number;
     n: number;
     bitSize: bigint;
@@ -178,4 +181,7 @@ export declare function MultiPackedStringFactory(n?: number): {
     }) => {
         packed: import("o1js/dist/node/lib/field.js").Field[];
     };
+    empty: () => {
+        packed: import("o1js/dist/node/lib/field.js").Field[];
+    };
 };

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

@@ -42,11 +42,11 @@ export declare function PackedUInt32Factory(l?: number): {
         }): void;
         packed: import("o1js/dist/node/lib/field.js").Field;
     };
-    type: import("o1js/dist/node/bindings/lib/provable-snarky.js").ProvableExtended<{
+    type: import("o1js/dist/node/bindings/lib/generic.js").GenericProvableExtendedPure<{
         packed: import("o1js/dist/node/lib/field.js").Field;
     }, {
         packed: string;
-    }>;
+    }, import("o1js/dist/node/lib/field.js").Field>;
     l: number;
     bitSize: bigint;
     checkPack(unpacked: UInt32[]): void;
@@ -82,4 +82,7 @@ export declare function PackedUInt32Factory(l?: number): {
     }) => {
         packed: import("o1js/dist/node/lib/field.js").Field;
     };
+    empty: () => {
+        packed: import("o1js/dist/node/lib/field.js").Field;
+    };
 };

package/examples/smart_contract/tokenState/README.md

@@ -0,0 +1,7 @@
+## Using Tokens as State Smart Contract
+
+Using o1js-pack, a token can actually be a packed value. Token balances are natively a `UInt64`, so there is not as much room as a full `Field`, but we can still pack 2 `UInt32`, or we could pack 8 characters, or 64 booleans.
+
+The `mint` and `burn` mechanisms are used like an unspent transaction output system. The state going in is always burnt, and the state coming out is unrelated numerically. In the example in `run.ts`, the token balance is set to 5 when the state is (5, 0). But when the state is (5, 10), the token balance becomes 42949672965.
+
+This can be useful for per-user state in a zkapp. Booleans could be used to track feature flags or whether or not a user account is active, in good standing, etc... Characters could be used to store shore strings on a per-user basis, perhaps a country code? UInts can be used like in this example to track the first and last time a user has used an app. Or you could use half of the state to track an actual user balance, and the other half to track another number like number of token transactions.

package/examples/smart_contract/tokenState/contract.ts

@@ -0,0 +1,62 @@
+import {
+  SmartContract,
+  state,
+  State,
+  method,
+  UInt32,
+  UInt64,
+  Account,
+  Provable,
+} from 'o1js';
+import { PackedUInt32Factory } from '../../../src/index.js';
+
+/**
+ * 2 UInt32s representing the first-joined block and the last-updated block
+ * Could be used in conjunction with some other app logic to ensure only active users can access some resource, or similar
+ */
+export class UserBlockStamps extends PackedUInt32Factory(2) {}
+
+export class UserBlockStampsToken extends SmartContract {
+  /**
+   * Initializes the user state by setting the first-joined blockstamp to the current blockheight
+   */
+  @method
+  joinSystem() {
+    const account = Account(this.sender, this.token.id);
+    const currentTokenBalance = account.balance.getAndAssertEquals();
+    currentTokenBalance.assertEquals(UInt64.from(0));
+
+    const userBlockStamps = UserBlockStamps.fromUInt32s([
+      this.network.blockchainLength.getAndAssertEquals(),
+      UInt32.from(0),
+    ]);
+    this.token.mint({
+      address: this.sender,
+      amount: UInt64.from(userBlockStamps.packed),
+    });
+  }
+
+  /**
+   * Updates the user state by setting the last-updated blockstamp to the current blockheight
+   */
+  @method
+  interactWithSystem() {
+    const account = Account(this.sender, this.token.id);
+    const currentTokenBalance = account.balance.getAndAssertEquals();
+    const existingUserBlockstamps = UserBlockStamps.unpack(
+      currentTokenBalance.value
+    );
+
+    this.token.burn({
+      address: this.sender,
+      amount: currentTokenBalance,
+    });
+
+    existingUserBlockstamps[1] =
+      this.network.blockchainLength.getAndAssertEquals();
+    this.token.mint({
+      address: this.sender,
+      amount: UInt64.from(UserBlockStamps.pack(existingUserBlockstamps)),
+    });
+  }
+}

package/examples/smart_contract/tokenState/run.ts

@@ -0,0 +1,71 @@
+import { AccountUpdate, Mina, PrivateKey, UInt32 } from 'o1js';
+import { UserBlockStamps, UserBlockStampsToken } from './contract.js';
+
+let Local = Mina.LocalBlockchain({ proofsEnabled: true });
+Mina.setActiveInstance(Local);
+
+// a test account that pays all the fees, and puts additional funds into the zkapp
+let { privateKey: senderKey, publicKey: sender } = Local.testAccounts[0];
+
+// the zkapp account
+let zkappKey = PrivateKey.random();
+let zkappAddress = zkappKey.toPublicKey();
+
+// a special account that is allowed to pull out half of the zkapp balance, once
+let privilegedKey = PrivateKey.random();
+let privilegedAddress = privilegedKey.toPublicKey();
+
+let initialBalance = 10_000_000_000;
+let zkapp = new UserBlockStampsToken(zkappAddress);
+
+console.time('compile');
+await UserBlockStampsToken.compile();
+console.timeEnd('compile');
+
+console.time('deploy');
+let tx = await Mina.transaction(sender, () => {
+  let senderUpdate = AccountUpdate.fundNewAccount(sender);
+  senderUpdate.send({ to: zkappAddress, amount: initialBalance });
+  zkapp.deploy({ zkappKey });
+});
+await tx.prove();
+await tx.sign([senderKey]).send();
+console.timeEnd('deploy');
+
+Local.setBlockchainLength(UInt32.from(5));
+
+console.time('join system');
+tx = await Mina.transaction(sender, () => {
+  AccountUpdate.fundNewAccount(sender);
+  zkapp.joinSystem();
+});
+await tx.prove();
+await tx.sign([senderKey]).send();
+console.timeEnd('join system');
+
+let tokenBalance = Mina.getBalance(sender, zkapp.token.id);
+console.log(tokenBalance.toString());
+console.log(UserBlockStamps.unpack(tokenBalance.value).toString());
+
+Local.setBlockchainLength(UInt32.from(10));
+
+console.time('interact with system');
+tx = await Mina.transaction(sender, () => {
+  zkapp.interactWithSystem();
+});
+await tx.prove();
+await tx.sign([senderKey]).send();
+console.timeEnd('interact with system');
+
+tokenBalance = Mina.getBalance(sender, zkapp.token.id);
+console.log(tokenBalance.toString());
+console.log(UserBlockStamps.unpack(tokenBalance.value).toString());
+
+// compile: 1.818s
+// deploy: 615.559ms
+// join system: 23.085s
+// 5
+// 5,0
+// interact with system: 15.263s
+// 42949672965
+// 5,10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "o1js-pack",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "",
   "author": "45930",
   "license": "Apache-2.0",
@@ -40,11 +40,9 @@
     "husky": "^7.0.1",
     "jest": "^27.3.1",
     "lint-staged": "^11.0.1",
+    "o1js": "^0.15.1",
     "prettier": "^2.3.2",
     "ts-jest": "^27.0.7",
     "typescript": "^4.7.2"
-  },
-  "peerDependencies": {
-    "o1js": "^0.13.*"
   }
 }

package/tests/provable/example_packed_string_circuit.ts

@@ -1,5 +1,5 @@
 import {
-  Experimental,
+  ZkProgram,
   SelfProof,
   Character,
   Poseidon,
@@ -10,7 +10,8 @@ import { MultiPackedStringFactory } from '../../src/lib/packed-types/PackedStrin
 
 export class TextInput extends MultiPackedStringFactory(3) {}
 
-export const TextInputProgram = Experimental.ZkProgram({
+export const TextInputProgram = ZkProgram({
+  name: 'TextInputProgram',
   publicInput: TextInput,
 
   methods: {
@@ -43,5 +44,5 @@ export const TextInputProgram = Experimental.ZkProgram({
   },
 });
 
-export let TextInputProof_ = Experimental.ZkProgram.Proof(TextInputProgram);
+export let TextInputProof_ = ZkProgram.Proof(TextInputProgram);
 export class TextInputProof extends TextInputProof_ {}

package/tests/provable/example_packed_uint_circuit.ts

@@ -1,9 +1,10 @@
-import { Experimental, SelfProof } from 'o1js';
+import { ZkProgram, SelfProof } from 'o1js';
 import { PackedUInt32Factory } from '../../src/lib/packed-types/PackedUInt32';
 
 export class Votes extends PackedUInt32Factory() {}
 
-export const VotesProgram = Experimental.ZkProgram({
+export const VotesProgram = ZkProgram({
+  name: 'VotesProgram',
   publicInput: Votes,
 
   methods: {
@@ -35,5 +36,5 @@ export const VotesProgram = Experimental.ZkProgram({
   },
 });
 
-export let VotesProof_ = Experimental.ZkProgram.Proof(VotesProgram);
+export let VotesProof_ = ZkProgram.Proof(VotesProgram);
 export class VotesProof extends VotesProof_ {}