Merge pull request #1208 from o1-labs/feature/vk-txnversion

add txnVersion to verification key permission

src/examples/zkapps/dex/upgradability.ts

@@ -5,6 +5,7 @@ import {
   Permissions,
   PrivateKey,
   UInt64,
+  TransactionVersion,
 } from 'snarkyjs';
 import { createDex, TokenContract, addresses, keys, tokenIds } from './dex.js';
 import { expect } from 'expect';
@@ -427,7 +428,10 @@ async function upgradeabilityTests({ withVesting }: { withVesting: boolean }) {
     let update = AccountUpdate.createSigned(addresses.dex);
     update.account.permissions.set({
       ...Permissions.initial(),
-      setVerificationKey: Permissions.impossible(),
+      setVerificationKey: {
+        auth: Permissions.impossible(),
+        txnVersion: TransactionVersion.current(),
+      },
     });
   });
   await tx.prove();

src/examples/zkapps/voting/dummyContract.ts

@@ -6,6 +6,7 @@ import {
   method,
   DeployArgs,
   Permissions,
+  TransactionVersion,
 } from 'snarkyjs';
 
 export class DummyContract extends SmartContract {
@@ -18,7 +19,10 @@ export class DummyContract extends SmartContract {
       editState: Permissions.proofOrSignature(),
       editActionState: Permissions.proofOrSignature(),
       setPermissions: Permissions.proofOrSignature(),
-      setVerificationKey: Permissions.proofOrSignature(),
+      setVerificationKey: {
+        auth: Permissions.signature(),
+        txnVersion: TransactionVersion.current(),
+      },
       incrementNonce: Permissions.proofOrSignature(),
     });
     this.sum.set(Field(0));

src/examples/zkapps/voting/membership.ts

@@ -12,6 +12,7 @@ import {
   provablePure,
   AccountUpdate,
   Provable,
+  TransactionVersion,
 } from 'snarkyjs';
 import { Member } from './member.js';
 import { ParticipantPreconditions } from './preconditions.js';
@@ -74,7 +75,10 @@ export class Membership_ extends SmartContract {
       editState: Permissions.proofOrSignature(),
       editActionState: Permissions.proofOrSignature(),
       setPermissions: Permissions.proofOrSignature(),
-      setVerificationKey: Permissions.proofOrSignature(),
+      setVerificationKey: {
+        auth: Permissions.proofOrSignature(),
+        txnVersion: TransactionVersion.current(),
+      },
       incrementNonce: Permissions.proofOrSignature(),
     });
   }

src/examples/zkapps/voting/voting.ts

@@ -12,6 +12,7 @@ import {
   provablePure,
   AccountUpdate,
   Provable,
+  TransactionVersion,
 } from 'snarkyjs';
 
 import { Member } from './member.js';
@@ -103,7 +104,10 @@ export class Voting_ extends SmartContract {
       editState: Permissions.proofOrSignature(),
       editActionState: Permissions.proofOrSignature(),
       incrementNonce: Permissions.proofOrSignature(),
-      setVerificationKey: Permissions.none(),
+      setVerificationKey: {
+        auth: Permissions.none(),
+        txnVersion: TransactionVersion.current(),
+      },
       setPermissions: Permissions.proofOrSignature(),
     });
     this.accumulatedVotes.set(Reducer.initialActionState);

src/examples/zkapps/zkapp-self-update.ts

@@ -12,14 +12,19 @@ import {
   AccountUpdate,
   Circuit,
   Provable,
+  TransactionVersion,
+  UInt32,
 } from 'snarkyjs';
 
 class Foo extends SmartContract {
   init() {
     super.init();
     this.account.permissions.set({
       ...Permissions.default(),
-      setVerificationKey: Permissions.proof(),
+      setVerificationKey: {
+        auth: Permissions.proof(),
+        txnVersion: TransactionVersion.current(),
+      },
     });
   }
 

src/index.ts

@@ -51,6 +51,7 @@ export {
   AccountUpdate,
   Permissions,
   ZkappPublicInput,
+  TransactionVersion,
 } from './lib/account_update.js';
 
 export type { TransactionStatus } from './lib/fetch.js';

src/lib/account_update.ts

@@ -26,7 +26,11 @@ import {
 } from '../bindings/mina-transaction/transaction-leaves.js';
 import { TokenId as Base58TokenId } from './base58-encodings.js';
 import { hashWithPrefix, packToFields } from './hash.js';
-import { mocks, prefixes } from '../bindings/crypto/constants.js';
+import {
+  mocks,
+  prefixes,
+  protocolVersions,
+} from '../bindings/crypto/constants.js';
 import { Context } from './global-context.js';
 import { assert } from './errors.js';
 import { MlArray } from './ml/base.js';
@@ -35,7 +39,7 @@ import { MlFieldConstArray } from './ml/fields.js';
 import { transactionCommitments } from '../mina-signer/src/sign-zkapp-command.js';
 
 // external API
-export { AccountUpdate, Permissions, ZkappPublicInput };
+export { AccountUpdate, Permissions, ZkappPublicInput, TransactionVersion };
 // internal API
 export {
   smartContractContext,
@@ -63,6 +67,10 @@ export {
 
 const ZkappStateLength = 8;
 
+const TransactionVersion = {
+  current: () => UInt32.from(protocolVersions.txnVersion),
+};
+
 type SmartContractContext = {
   this: SmartContract;
   methodCallDepth: number;
@@ -199,7 +207,10 @@ interface Permissions extends Permissions_ {
    * key associated with the circuit tied to this account. Effectively
    * "upgradeability" of the smart contract.
    */
-  setVerificationKey: Permission;
+  setVerificationKey: {
+    auth: Permission;
+    txnVersion: UInt32;
+  };
 
   /**
    * The {@link Permission} corresponding to the ability to set the zkapp uri
@@ -265,7 +276,10 @@ let Permissions = {
     receive: Permission.none(),
     setDelegate: Permission.signature(),
     setPermissions: Permission.signature(),
-    setVerificationKey: Permission.signature(),
+    setVerificationKey: {
+      auth: Permission.signature(),
+      txnVersion: TransactionVersion.current(),
+    },
     setZkappUri: Permission.signature(),
     editActionState: Permission.proof(),
     setTokenSymbol: Permission.signature(),
@@ -281,7 +295,10 @@ let Permissions = {
     receive: Permission.none(),
     setDelegate: Permission.signature(),
     setPermissions: Permission.signature(),
-    setVerificationKey: Permission.signature(),
+    setVerificationKey: {
+      auth: Permission.signature(),
+      txnVersion: TransactionVersion.current(),
+    },
     setZkappUri: Permission.signature(),
     editActionState: Permission.signature(),
     setTokenSymbol: Permission.signature(),
@@ -298,7 +315,10 @@ let Permissions = {
     access: Permission.none(),
     setDelegate: Permission.none(),
     setPermissions: Permission.none(),
-    setVerificationKey: Permission.none(),
+    setVerificationKey: {
+      auth: Permission.signature(),
+      txnVersion: TransactionVersion.current(),
+    },
     setZkappUri: Permission.none(),
     editActionState: Permission.none(),
     setTokenSymbol: Permission.none(),
@@ -314,7 +334,10 @@ let Permissions = {
     access: Permission.impossible(),
     setDelegate: Permission.impossible(),
     setPermissions: Permission.impossible(),
-    setVerificationKey: Permission.impossible(),
+    setVerificationKey: {
+      auth: Permission.signature(),
+      txnVersion: TransactionVersion.current(),
+    },
     setZkappUri: Permission.impossible(),
     editActionState: Permission.impossible(),
     setTokenSymbol: Permission.impossible(),
@@ -350,7 +373,7 @@ let Permissions = {
     return Object.fromEntries(
       Object.entries(permissions).map(([k, v]) => [
         k,
-        Permissions.fromString(v),
+        Permissions.fromString(typeof v === 'string' ? v : v.auth),
       ])
     ) as unknown as Permissions;
   },
@@ -695,6 +718,7 @@ class AccountUpdate implements Types.AccountUpdate {
       this,
       isSelf
     );
+
     this.account = account;
     this.network = network;
     this.currentSlot = currentSlot;

src/lib/mina.ts

@@ -1280,7 +1280,7 @@ async function verifyAccountUpdate(
       case 'delegate':
         return perm.setDelegate;
       case 'verificationKey':
-        return perm.setVerificationKey;
+        return perm.setVerificationKey.auth;
       case 'permissions':
         return perm.setPermissions;
       case 'zkappUri':

src/lib/mina/account.ts

@@ -44,7 +44,10 @@ type FetchedAccount = {
     receive: AuthRequired;
     setDelegate: AuthRequired;
     setPermissions: AuthRequired;
-    setVerificationKey: AuthRequired;
+    setVerificationKey: {
+      auth: AuthRequired;
+      txnVersion: string;
+    };
     setZkappUri: AuthRequired;
     editActionState: AuthRequired;
     setTokenSymbol: AuthRequired;

src/lib/testing/random.ts

@@ -135,6 +135,7 @@ const Generators: Generators = {
   null: constant(null),
   string: base58(nat(50)), // TODO replace various strings, like signature, with parsed types
   number: nat(3),
+  TransactionVersion: uint32,
 };
 let typeToBigintGenerator = new Map<Provable<any>, Random<any>>(
   [TypeMap, PrimitiveMap, customTypes]
@@ -238,6 +239,7 @@ const JsonGenerators: JsonGenerators = {
   null: constant(null),
   string: base58(nat(50)),
   number: nat(3),
+  TransactionVersion: json_.uint32,
 };
 let typeToJsonGenerator = new Map<Provable<any>, Random<any>>(
   [TypeMap, PrimitiveMap, customTypes]

src/mina-signer/src/test-vectors/accountUpdate.ts

@@ -19,7 +19,10 @@ let accountUpdateExample: Json.AccountUpdate = {
         receive: 'Proof',
         setDelegate: 'Signature',
         setPermissions: 'None',
-        setVerificationKey: 'None',
+        setVerificationKey: {
+          auth: 'None',
+          txnVersion: '3',
+        },
         setZkappUri: 'Signature',
         editActionState: 'Proof',
         setTokenSymbol: 'Signature',