more formats

OpenZeppelin · Feb 22, 2024 · ed1e96a · ed1e96a
1 parent a97a469
commit ed1e96a
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/src/format.ts b/src/format.ts
@@ -2,7 +2,7 @@ import type { HexString } from "./bytes";
 
 // Dump/Load format
 export type MerkleTreeData<T> = {
-  format: 'standard-v1' | 'custom-v1';
+  format: 'standard-v1' | 'simple-v1' | 'custom-v1';
   tree: HexString[];
   values: {
     value: T;

diff --git a/src/simple.test.ts b/src/simple.test.ts
@@ -161,12 +161,16 @@ describe('simple merkle tree', () => {
         () => SimpleMerkleTree.load({ format: 'nonstandard' } as any),
         /^Error: Unknown format 'nonstandard'$/,
       );
+      assert.throws(
+        () => SimpleMerkleTree.load({ format: 'standard-v1'} as any, reverseHashPair),
+        /^Error: Unknown format 'standard-v1'$/,
+      );
     });
 
     it('reject standard tree dump with a custom hash', () => {
       assert.throws(
-        () => SimpleMerkleTree.load({ format: 'standard-v1'} as any, reverseHashPair),
-        /^Error: Format 'standard-v1' does not support custom hashing functions$/,
+        () => SimpleMerkleTree.load({ format: 'simple-v1'} as any, reverseHashPair),
+        /^Error: Format 'simple-v1' does not support custom hashing functions$/,
       );
     });
 
@@ -179,7 +183,7 @@ describe('simple merkle tree', () => {
 
     it('reject malformed tree dump', () => {
       const loadedTree1 = SimpleMerkleTree.load({
-        format: 'standard-v1',
+        format: 'simple-v1',
         tree: [zero],
         values: [{ value: '0x0000000000000000000000000000000000000000000000000000000000000001', treeIndex: 0 }],
       });
@@ -189,7 +193,7 @@ describe('simple merkle tree', () => {
       );
 
       const loadedTree2 = SimpleMerkleTree.load({
-        format: 'standard-v1',
+        format: 'simple-v1',
         tree: [zero, zero, zero],
         values: [{ value: zero, treeIndex: 2 }],
       });

diff --git a/src/simple.ts b/src/simple.ts
@@ -72,7 +72,7 @@ export class SimpleMerkleTree {
 
   static load(data: MerkleTreeData<BytesLike>, hashPair ?: HashPairFn): SimpleMerkleTree {
     switch (data.format) {
-      case 'standard-v1':
+      case 'simple-v1':
         if (hashPair !== undefined) throwError(`Format '${data.format}' does not support custom hashing functions`);
         break;
       case 'custom-v1':
@@ -106,7 +106,7 @@ export class SimpleMerkleTree {
 
   dump(): MerkleTreeData<BytesLike> {
     return {
-      format: this.hashPair === undefined ? 'standard-v1' : 'custom-v1',
+      format: this.hashPair === undefined ? 'simple-v1' : 'custom-v1',
       tree:   this.tree,
       values: this.values,
     };

diff --git a/src/standard.test.ts b/src/standard.test.ts
@@ -114,6 +114,14 @@ describe('standard merkle tree', () => {
         () => StandardMerkleTree.load({ format: 'nonstandard' } as any),
         /^Error: Unknown format 'nonstandard'$/,
       );
+      assert.throws(
+        () => StandardMerkleTree.load({ format: 'simple-v1' } as any),
+        /^Error: Unknown format 'simple-v1'$/,
+      );
+      assert.throws(
+        () => StandardMerkleTree.load({ format: 'custom-v1' } as any),
+        /^Error: Unknown format 'custom-v1'$/,
+      );
     });
 
     it('reject malformed tree dump', () => {