Moved and exported merkle module + logic adjustments (#55)

Author: didac-gluwa

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@gluwa/cc-next-query-builder",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/gluwa/cc-next-query-builder"
@@ -34,7 +34,8 @@
   "dependencies": {
     "axios": "^1.13.2",
     "dotenv": "^17.2.3",
-    "ethers": "^6.15.0"
+    "ethers": "^6.15.0",
+    "exponential-backoff": "^3.1.3"
   },
   "author": "Gluwa Inc.",
   "license": "MIT"

package.json

@@ -1,7 +1,8 @@
 import { Contract, ContractMethod, InterfaceAbi, JsonRpcApiProvider } from 'ethers';
 
 import BlockProverABI from './block_prover.json';
-import { ContinuityProof, TransactionMerkleProof } from '../proof-generator';
+import { ContinuityProof } from '../proof-generator';
+import { TransactionMerkleProof } from '../proof-generator/merkle';
 
 const contractABI = BlockProverABI as unknown as InterfaceAbi;
 

src/block-prover/index.ts

@@ -1,4 +1,5 @@
 import { Contract, InterfaceAbi, JsonRpcApiProvider } from 'ethers';
+import { backOff, BackoffOptions } from 'exponential-backoff';
 
 import ChainInfoABI from './chain_info.json';
 
@@ -408,12 +409,23 @@ export class PrecompileChainInfoProvider implements ChainInfoProvider {
   ): Promise<void> {
     const startTime = Date.now();
 
+    const backOffOptions = {
+      delayFirstAttempt: true,
+      jitter: 'full',
+      numOfAttempts: 5,
+      startingDelay: 100, // 100ms
+    } as BackoffOptions;
+
     while (true) {
-      const heightHash = await this.getLatestAttestedHeightAndHash(chainKey);
+      const heightHash = await backOff(() => this.getLatestAttestedHeightAndHash(chainKey), backOffOptions);
       if (heightHash.exists && heightHash.height >= targetHeight) {
         return;
       }
 
+      console.debug(
+        `Height ${targetHeight} not yet attested on chain key ${chainKey}. Latest attested height is ${heightHash.exists ? heightHash.height : 'N/A'}. Retrying in ${pollIntervalMs}ms...`,
+      );
+
       if (Date.now() - startTime > waitTimeoutMs) {
         throw new Error(`Timeout waiting for height ${targetHeight} to be attested on chain key ${chainKey}`);
       }

src/chain-info/index.ts

@@ -1,5 +1,8 @@
 export * as raw from './raw-generator';
 export * as api from './api-generator';
+export * as merkle from './merkle';
+
+import { TransactionMerkleProof } from './merkle';
 
 /**
  * A continuity proof used to prove block continuity in the attestation chain.
@@ -72,26 +75,6 @@ export function mergeProofs(proofs: [number, ContinuityProof][]): ContinuityProo
   }
 }
 
-export class TransactionMerkleProof {
-  public root: string;
-  public siblings: MerkleProofEntry[];
-
-  constructor(root: string, siblings: MerkleProofEntry[]) {
-    this.root = root;
-    this.siblings = siblings;
-  }
-}
-
-export class MerkleProofEntry {
-  public hash: string;
-  public isLeft: boolean;
-
-  constructor(hash: string, isLeft: boolean) {
-    this.hash = hash;
-    this.isLeft = isLeft;
-  }
-}
-
 export interface ContinuityResponse {
   chainKey: number;
   headerNumber: number;

src/proof-generator/index.ts

@@ -1,8 +1,26 @@
-import { Block, TransactionResponse, TransactionReceipt, keccak256, solidityPacked } from 'ethers';
+import { TransactionReceipt, keccak256, solidityPacked } from 'ethers';
 
-import { MerkleProofEntry, TransactionMerkleProof } from '..';
+import { abiEncode, EncodingVersion, TransactionWithRaw } from '../encoding';
 
-import { abiEncode, EncodingVersion, TransactionWithRaw } from '../../encoding';
+export class TransactionMerkleProof {
+  public root: string;
+  public siblings: MerkleProofEntry[];
+
+  constructor(root: string, siblings: MerkleProofEntry[]) {
+    this.root = root;
+    this.siblings = siblings;
+  }
+}
+
+export class MerkleProofEntry {
+  public hash: string;
+  public isLeft: boolean;
+
+  constructor(hash: string, isLeft: boolean) {
+    this.hash = hash;
+    this.isLeft = isLeft;
+  }
+}
 
 /**
  * Hashes two child nodes to produce their parent node in the Merkle tree.
@@ -11,7 +29,7 @@ import { abiEncode, EncodingVersion, TransactionWithRaw } from '../../encoding';
  * @param right A 32-byte hex string representing the right child hash
  * @returns A 32-byte hex string representing the parent node hash
  */
-function hashInner(left: string, right: string): string {
+export function hashInner(left: string, right: string): string {
   // Use solidityPacked to exactly match Solidity's abi.encodePacked(uint8(0x01), bytes32, bytes32)
   return keccak256(solidityPacked(['uint8', 'bytes32', 'bytes32'], [0x01, left, right]));
 }
@@ -22,7 +40,7 @@ function hashInner(left: string, right: string): string {
  * @param leaf A 32-byte hex string representing the data to be hashed as a leaf
  * @returns A 32-byte hex string representing the leaf node hash
  */
-function hashLeaf(leaf: string): string {
+export function hashLeaf(leaf: string): string {
   // Use solidityPacked to exactly match Solidity's abi.encodePacked(uint8(0x00), bytes)
   return keccak256(solidityPacked(['uint8', 'bytes'], [0x00, leaf]));
 }
@@ -87,12 +105,13 @@ export function computeMerkleRootOfBlock(
  * @returns The computed digest as a hex string
  */
 export function computeDigestOf(blockNumber: number, merkleRoot: string, prevDigest: string | null): string {
-  const prevDigestNonNull = prevDigest || ZERO_HASH;
-  const digest = keccak256(
-    solidityPacked(['uint64', 'bytes32', 'bytes32'], [blockNumber, merkleRoot, prevDigestNonNull]),
-  );
+  // If prevDigest is provided, include it in the packed encoding
+  if (prevDigest) {
+    return keccak256(solidityPacked(['uint64', 'bytes32', 'bytes32'], [blockNumber, merkleRoot, prevDigest]));
+  }
 
-  return digest;
+  // Otherwise, only use blockNumber and merkleRoot
+  return keccak256(solidityPacked(['uint64', 'bytes32'], [blockNumber, merkleRoot]));
 }
 
 export class KeccakMerkleTree {

…/proof-generator/raw-generator/merkle.ts src/proof-generator/merkle.tssrc/proof-generator/raw-generator/merkle.ts renamed to src/proof-generator/merkle.ts src/proof-generator/raw-generator/merkle.ts renamed to src/proof-generator/merkle.ts

@@ -3,7 +3,7 @@ import { ChainInfoProvider, ContinuityBounds } from '../../chain-info';
 
 import { EncodingVersion } from '../../encoding';
 
-import { computeDigestOf, computeMerkleRootOfBlock } from './merkle';
+import { computeDigestOf, computeMerkleRootOfBlock } from '../merkle';
 import { BlockProvider } from './block-provider';
 
 export class AttestationBlock {

src/proof-generator/raw-generator/continuity-proof.ts

@@ -1,10 +1,10 @@
 import { ProofGenerationResult, ProofGenerator } from '..';
 import { ChainInfoProvider } from '../../chain-info';
 
-import { abiEncode, EncodingVersion, TransactionWithRaw } from '../../encoding';
+import { abiEncode, EncodingVersion } from '../../encoding';
 
 import { ContinuityProofBuilder } from './continuity-proof';
-import { KeccakMerkleTree } from './merkle';
+import { KeccakMerkleTree } from '../merkle';
 import { BlockProvider } from './block-provider';
 
 // Re-export for easier access

src/proof-generator/raw-generator/index.ts

@@ -1,7 +1,11 @@
 import { test, expect } from '@jest/globals';
 
-import { MerkleProofEntry, TransactionMerkleProof } from '../../src/proof-generator';
-import { KeccakMerkleTree, ZERO_HASH } from '../../src/proof-generator/raw-generator/merkle';
+import {
+  MerkleProofEntry,
+  TransactionMerkleProof,
+  KeccakMerkleTree,
+  ZERO_HASH,
+} from '../../src/proof-generator/merkle';
 
 test('MerkleTree should fail to generate proof for non-existent leaf', async () => {
   const tree = new KeccakMerkleTree([]);