PR comments

Author: 45930

CHANGELOG.md

@@ -19,7 +19,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Added
 - `setFee` and `setFeePerSnarkCost` for `Transaction` and `PendingTransaction` https://github.com/o1-labs/o1js/pull/1968
-- Doc comments for ZkProgram, verify, SelfProof...https://github.com/o1-labs/o1js/pull/1974
+- Doc comments for various ZkProgram methods https://github.com/o1-labs/o1js/pull/1974
 
 ### Changed
 - Sort order for actions now includes the transaction sequence number and the exact account id sequence https://github.com/o1-labs/o1js/pull/1917

src/lib/proof-system/zkprogram.ts

@@ -1,6 +1,7 @@
 import { EmptyUndefined, EmptyVoid } from '../../bindings/lib/generic.js';
 import {
   Base64ProofString,
+  Base64VerificationKeyString,
   Snarky,
   initializeBindings,
   withThreadPool,
@@ -124,15 +125,15 @@ function createProgramState() {
 }
 
 /**
- * Initializes {@link Pickles} bindings, serializes the input proof and VK for use in Ocaml, then calls into {@link Pickles.verify} to verify the proof.
+ * Initializes Pickles bindings, serializes the input proof and verification key for use in OCaml, then calls into the Pickles verify function and returns the result.
  *
- * @param proof Either a Proof instance or a JSON proof which gets converted into an {@link MlPair} of {@link FieldConst} arrays for use in the bindings.
- * @param verificationKey Either a string containing a base64 serialized verification key or a VerificationKey which gets converted into a string for use in the bindings.
+ * @param proof Either a `Proof` instance or a serialized JSON proof
+ * @param verificationKey Either a base64 serialized verification key or a `VerificationKey` instance which will be base64 serialized for use in the bindings.
  * @returns A promise that resolves to a boolean indicating whether the proof is valid.
  */
 async function verify(
   proof: ProofBase<any, any> | JsonProof,
-  verificationKey: string | VerificationKey
+  verificationKey: Base64VerificationKeyString | VerificationKey
 ) {
   await initializeBindings();
   let picklesProof: Pickles.Proof;
@@ -171,9 +172,9 @@ async function verify(
  * Serializeable representation of a Pickles proof, useful for caching compiled proofs.
  */
 type JsonProof = {
-  /** Array of string, where each string is a {@link Field} in the publicInput of this proof */
+  /** Array of string, where each string is a `Field` in the publicInput of this proof */
   publicInput: string[];
-  /** Array of string, where each string is a {@link Field} in the publicOutput of this proof */
+  /** Array of string, where each string is a `Field` in the publicOutput of this proof */
   publicOutput: string[];
   maxProofsVerified: 0 | 1 | 2;
   proof: Base64ProofString;

src/snarky.d.ts

@@ -49,15 +49,21 @@ export {
   MlFeatureFlags,
   areBindingsInitialized,
   Base64ProofString,
+  Base64VerificationKeyString,
 };
 
 declare let areBindingsInitialized: boolean;
 
 /**
- * A string representation of a {@link Pickles.Proof} in base64 encoding, used for communication between Ocaml and TypeScript and for JSON serialization.
+ * A string representation of a Pickles proof in base64 encoding, used for communication between OCaml and TypeScript and for JSON serialization.
  */
 type Base64ProofString = string;
 
+/**
+ * A string representation of a constraint system's verification key in base64 encoding, used for communication between OCaml and TypeScript and for JSON serialization.
+ */
+type Base64VerificationKeyString = string;
+
 type WasmModule = typeof wasm;
 
 type MlGroup = MlPair<FieldVar, FieldVar>;
@@ -706,13 +712,15 @@ declare const Pickles: {
     /**
      * @returns (base64 vk, hash)
      */
-    getVerificationKey: () => Promise<[_: 0, data: string, hash: FieldConst]>;
+    getVerificationKey: () => Promise<
+      [_: 0, data: Base64VerificationKeyString, hash: FieldConst]
+    >;
   };
 
   verify(
     statement: Pickles.Statement<FieldConst>,
     proof: Pickles.Proof,
-    verificationKey: string
+    verificationKey: Base64VerificationKeyString
   ): Promise<boolean>;
 
   loadSrsFp(): WasmFpSrs;
@@ -726,7 +734,11 @@ declare const Pickles: {
   /**
    * @returns (base64 vk, hash)
    */
-  dummyVerificationKey: () => [_: 0, data: string, hash: FieldConst];
+  dummyVerificationKey: () => [
+    _: 0,
+    data: Base64VerificationKeyString,
+    hash: FieldConst
+  ];
 
   encodeVerificationKey: (vk: MlWrapVerificationKey) => string;
   decodeVerificationKey: (vk: string) => MlWrapVerificationKey;
@@ -751,7 +763,10 @@ declare const Pickles: {
     // Instantiate the verification key inside the circuit (required).
     inCircuit: (tag: unknown, verificationKey: unknown) => undefined;
     // Instantiate the verification key in prover-only logic (also required).
-    inProver: (tag: unknown, verificationKey: string) => undefined;
+    inProver: (
+      tag: unknown,
+      verificationKey: Base64VerificationKeyString
+    ) => undefined;
     // Create an in-circuit representation of a verification key
     vkToCircuit: (
       verificationKey: () => string