Merge pull request #1666 from o1-labs/feature/indexed-merkle-map

Indexed Merkle tree

CHANGELOG.md

@@ -17,6 +17,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased](https://github.com/o1-labs/o1js/compare/54d6545bf...HEAD)
 
+### Added
+
+- `Experimental.IndexedMerkleMap`, a better primitive for Merkleized storage which uses 4-8x fewer constraints than `MerkleMap` https://github.com/o1-labs/o1js/pull/1666
+  - In contrast to `MerkleTree` and `MerkleMap`, `IndexedMerkleMap` has a high-level API that can be used in provable code.
+
 ### Deprecated
 
 - `Int64.isPositive()` and `Int64.mod()` deprecated because they behave incorrectly on `-0` https://github.com/o1-labs/o1js/pull/1660

src/index.ts

@@ -52,6 +52,7 @@ export { Gadgets } from './lib/provable/gadgets/gadgets.js';
 export { Types } from './bindings/mina-transaction/types.js';
 
 export { MerkleList, MerkleListIterator } from './lib/provable/merkle-list.js';
+import { IndexedMerkleMap } from './lib/provable/merkle-tree-indexed.js';
 export { Option } from './lib/provable/option.js';
 
 export * as Mina from './lib/mina/mina.js';
@@ -133,6 +134,7 @@ export { Experimental };
 
 const Experimental_ = {
   memoizeWitness,
+  IndexedMerkleMap,
 };
 
 /**
@@ -142,6 +144,9 @@ const Experimental_ = {
 namespace Experimental {
   export let memoizeWitness = Experimental_.memoizeWitness;
 
+  // indexed merkle map
+  export let IndexedMerkleMap = Experimental_.IndexedMerkleMap;
+
   // offchain state
   export let OffchainState = OffchainState_.OffchainState;
 

src/lib/provable/bytes.ts

@@ -198,6 +198,7 @@ class Bytes {
   static _size?: number;
   static _provable?: ProvablePureExtended<
     Bytes,
+    { bytes: { value: bigint }[] },
     { bytes: { value: string }[] }
   >;
 

src/lib/provable/core/provable-context.ts

@@ -26,6 +26,7 @@ export {
   inCompileMode,
   gatesFromJson,
   printGates,
+  summarizeGates,
   MlConstraintSystem,
 };
 
@@ -167,13 +168,7 @@ function constraintSystemToJS(cs: MlConstraintSystem) {
       printGates(gates);
     },
     summary() {
-      let gateTypes: Partial<Record<GateType | 'Total rows', number>> = {};
-      gateTypes['Total rows'] = rows;
-      for (let gate of gates) {
-        gateTypes[gate.type] ??= 0;
-        gateTypes[gate.type]!++;
-      }
-      return gateTypes;
+      return summarizeGates(gates);
     },
   };
 }
@@ -188,6 +183,18 @@ function gatesFromJson(cs: { gates: JsonGate[]; public_input_size: number }) {
   return { publicInputSize: cs.public_input_size, gates };
 }
 
+// collect a summary of the constraint system
+
+function summarizeGates(gates: Gate[]) {
+  let gateTypes: Partial<Record<GateType | 'Total rows', number>> = {};
+  gateTypes['Total rows'] = gates.length;
+  for (let gate of gates) {
+    gateTypes[gate.type] ??= 0;
+    gateTypes[gate.type]!++;
+  }
+  return gateTypes;
+}
+
 // print a constraint system
 
 function printGates(gates: Gate[]) {

src/lib/provable/crypto/foreign-curve.ts

@@ -242,6 +242,7 @@ class ForeignCurve {
   static _Scalar?: typeof AlmostForeignField;
   static _provable?: ProvablePureExtended<
     ForeignCurve,
+    { x: bigint; y: bigint },
     { x: string; y: string }
   >;
 

src/lib/provable/crypto/foreign-ecdsa.ts

@@ -164,6 +164,7 @@ class EcdsaSignature {
   static _Curve?: typeof ForeignCurve;
   static _provable?: ProvablePureExtended<
     EcdsaSignature,
+    { r: bigint; s: bigint },
     { r: string; s: string }
   >;