@aztec/sequencer-client 0.50.1 → 0.51.1

package/src/publisher/l1-publisher.ts

@@ -1,8 +1,8 @@
 import { type L2Block, type Signature } from '@aztec/circuit-types';
 import { type L1PublishBlockStats, type L1PublishProofStats } from '@aztec/circuit-types/stats';
-import { ETHEREUM_SLOT_DURATION, EthAddress, type Header, type Proof } from '@aztec/circuits.js';
+import { ETHEREUM_SLOT_DURATION, EthAddress, GENESIS_ARCHIVE_ROOT, type Header, type Proof } from '@aztec/circuits.js';
 import { createEthereumChain } from '@aztec/ethereum';
-import { type Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { serializeToBuffer } from '@aztec/foundation/serialize';
 import { InterruptibleSleep } from '@aztec/foundation/sleep';
@@ -12,6 +12,7 @@ import { type TelemetryClient } from '@aztec/telemetry-client';
 
 import pick from 'lodash.pick';
 import {
+  ContractFunctionRevertedError,
   type GetContractReturnType,
   type Hex,
   type HttpTransport,
@@ -59,13 +60,6 @@ export type MinimalTransactionReceipt = {
   logs: any[];
 };
 
-/**
- * @notice An attestation for the sequencing model.
- * @todo    This is not where it belongs. But I think we should do a bigger rewrite of some of
- *          this spaghetti.
- */
-export type Attestation = { isEmpty: boolean; v: number; r: `0x${string}`; s: `0x${string}` };
-
 /** Arguments to the process method of the rollup contract */
 export type L1ProcessArgs = {
   /** The L2 block header. */
@@ -94,6 +88,13 @@ export type L1SubmitProofArgs = {
   aggregationObject: Buffer;
 };
 
+export type MetadataForSlot = {
+  proposer: EthAddress;
+  slot: bigint;
+  pendingBlockNumber: bigint;
+  archive: Buffer;
+};
+
 /**
  * Publishes L2 blocks to L1. This implementation does *not* retry a transaction in
  * the event of network congestion, but should work for local development.
@@ -103,6 +104,15 @@ export type L1SubmitProofArgs = {
  * Adapted from https://github.com/AztecProtocol/aztec2-internal/blob/master/falafel/src/rollup_publisher.ts.
  */
 export class L1Publisher {
+  // @note  If we want to simulate in the future, we have to skip the viem simulations and use `reads` instead
+  //        This is because the viem simulations are not able to simulate the future, only the current state.
+  //        This means that we will be simulating as if `block.timestamp` is the same for the next block
+  //        as for the last block.
+  //        Nevertheless, it can be quite useful for figuring out why exactly the transaction is failing
+  //        as a middle ground right now, we will be skipping the simulation and just sending the transaction
+  //        but only after we have done a successful run of the `validateHeader` for the timestamp in the future.
+  public static SKIP_SIMULATION = true;
+
   private interruptibleSleep = new InterruptibleSleep();
   private sleepTimeMs: number;
   private interrupted = false;
@@ -154,24 +164,76 @@ export class L1Publisher {
     return Promise.resolve(EthAddress.fromString(this.account.address));
   }
 
-  // Computes who will be the L2 proposer at the next Ethereum block
-  // Using next Ethereum block so we do NOT need to wait for it being mined before seeing the effect
-  // @note Assumes that all ethereum slots have blocks
-  async getProposerAtNextEthBlock(): Promise<EthAddress> {
+  /**
+   * @notice  Calls `canProposeAtTime` with the time of the next Ethereum block and the sender address
+   *
+   * @dev     Throws if unable to propose
+   *
+   * @param archive - The archive that we expect to be current state
+   * @return slot - The L2 slot number  of the next Ethereum block,
+   * @return blockNumber - The L2 block number of the next L2 block
+   */
+  public async canProposeAtNextEthBlock(archive: Buffer): Promise<[bigint, bigint]> {
+    const ts = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(ETHEREUM_SLOT_DURATION));
+    const [slot, blockNumber] = await this.rollupContract.read.canProposeAtTime([
+      ts,
+      this.account.address,
+      `0x${archive.toString('hex')}`,
+    ]);
+    return [slot, blockNumber];
+  }
+
+  public async validateBlockForSubmission(
+    header: Header,
+    digest: Buffer = new Fr(GENESIS_ARCHIVE_ROOT).toBuffer(),
+    attestations: Signature[] = [],
+  ): Promise<boolean> {
+    const ts = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(ETHEREUM_SLOT_DURATION));
+
+    const formattedAttestations = attestations.map(attest => attest.toViemSignature());
+    const flags = { ignoreDA: true, ignoreSignatures: attestations.length == 0 };
+
+    const args = [
+      `0x${header.toBuffer().toString('hex')}`,
+      formattedAttestations,
+      `0x${digest.toString('hex')}`,
+      ts,
+      flags,
+    ] as const;
+
     try {
-      const ts = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(ETHEREUM_SLOT_DURATION));
-      const submitter = await this.rollupContract.read.getProposerAt([ts]);
-      return EthAddress.fromString(submitter);
-    } catch (err) {
-      this.log.warn(`Failed to get submitter: ${err}`);
-      return EthAddress.ZERO;
+      await this.rollupContract.read.validateHeader(args, { account: this.account });
+      return true;
+    } catch (error: unknown) {
+      // Specify the type of error
+      if (error instanceof ContractFunctionRevertedError) {
+        const err = error as ContractFunctionRevertedError;
+        this.log.debug(`Validation failed: ${err.message}`, err.data);
+      } else {
+        this.log.debug(`Unexpected error during validation: ${error}`);
+      }
+      return false;
     }
   }
 
-  public async isItMyTurnToSubmit(): Promise<boolean> {
-    const submitter = await this.getProposerAtNextEthBlock();
-    const sender = await this.getSenderAddress();
-    return submitter.isZero() || submitter.equals(sender);
+  // @note Assumes that all ethereum slots have blocks
+  // Using next Ethereum block so we do NOT need to wait for it being mined before seeing the effect
+  public async getMetadataForSlotAtNextEthBlock(): Promise<MetadataForSlot> {
+    const ts = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(ETHEREUM_SLOT_DURATION));
+
+    const [submitter, slot, pendingBlockCount, archive] = await Promise.all([
+      this.rollupContract.read.getProposerAt([ts]),
+      this.rollupContract.read.getSlotAt([ts]),
+      this.rollupContract.read.pendingBlockCount(),
+      this.rollupContract.read.archive(),
+    ]);
+
+    return {
+      proposer: EthAddress.fromString(submitter),
+      slot,
+      pendingBlockNumber: pendingBlockCount - 1n,
+      archive: Buffer.from(archive.replace('0x', ''), 'hex'),
+    };
   }
 
   public async getCurrentEpochCommittee(): Promise<EthAddress[]> {
@@ -203,44 +265,49 @@ export class L1Publisher {
    * @returns True once the tx has been confirmed and is successful, false on revert or interrupt, blocks otherwise.
    */
   public async processL2Block(block: L2Block, attestations?: Signature[]): Promise<boolean> {
-    const ctx = { blockNumber: block.number, blockHash: block.hash().toString() };
-    // TODO(#4148) Remove this block number check, it's here because we don't currently have proper genesis state on the contract
-    const lastArchive = block.header.lastArchive.root.toBuffer();
-    if (block.number != 1 && !(await this.checkLastArchiveHash(lastArchive))) {
-      this.log.info(`Detected different last archive prior to publishing a block, aborting publish...`, ctx);
+    const ctx = {
+      blockNumber: block.number,
+      slotNumber: block.header.globalVariables.slotNumber.toBigInt(),
+      blockHash: block.hash().toString(),
+    };
+
+    // @note  This will make sure that we are passing the checks for our header ASSUMING that the data is also made available
+    //        This means that we can avoid the simulation issues in later checks.
+    //        By simulation issue, I mean the fact that the block.timestamp is equal to the last block, not the next, which
+    //        make time consistency checks break.
+    if (!(await this.validateBlockForSubmission(block.header, block.archive.root.toBuffer(), attestations))) {
       return false;
     }
-    const encodedBody = block.body.toBuffer();
 
     const processTxArgs = {
       header: block.header.toBuffer(),
       archive: block.archive.root.toBuffer(),
       blockHash: block.header.hash().toBuffer(),
-      body: encodedBody,
+      body: block.body.toBuffer(),
       attestations,
     };
 
-    // Process block and publish the body if needed (if not already published)
-    while (!this.interrupted) {
+    // Publish body and propose block (if not already published)
+    if (!this.interrupted) {
       let txHash;
       const timer = new Timer();
 
       if (await this.checkIfTxsAreAvailable(block)) {
         this.log.verbose(`Transaction effects of block ${block.number} already published.`, ctx);
-        txHash = await this.sendProcessTx(processTxArgs);
+        txHash = await this.sendProposeWithoutBodyTx(processTxArgs);
       } else {
-        txHash = await this.sendPublishAndProcessTx(processTxArgs);
+        txHash = await this.sendProposeTx(processTxArgs);
       }
 
       if (!txHash) {
         this.log.info(`Failed to publish block ${block.number} to L1`, ctx);
-        break;
+        return false;
       }
 
       const receipt = await this.getTransactionReceipt(txHash);
       if (!receipt) {
         this.log.info(`Failed to get receipt for tx ${txHash}`, ctx);
-        break;
+        return false;
       }
 
       // Tx was mined successfully
@@ -254,17 +321,12 @@ export class L1Publisher {
         };
         this.log.info(`Published L2 block to L1 rollup contract`, { ...stats, ...ctx });
         this.metrics.recordProcessBlockTx(timer.ms(), stats);
+
         return true;
       }
 
       this.metrics.recordFailedTx('process');
 
-      // Check if someone else incremented the block number
-      if (!(await this.checkLastArchiveHash(lastArchive))) {
-        this.log.warn('Publish failed. Detected different last archive hash.', ctx);
-        break;
-      }
-
       this.log.error(`Rollup.process tx status failed: ${receipt.transactionHash}`, ctx);
       await this.sleepOrInterrupted();
     }
@@ -280,7 +342,7 @@ export class L1Publisher {
     aggregationObject: Fr[],
     proof: Proof,
   ): Promise<boolean> {
-    const ctx = { blockNumber: header.globalVariables.blockNumber };
+    const ctx = { blockNumber: header.globalVariables.blockNumber, slotNumber: header.globalVariables.slotNumber };
 
     const txArgs: L1SubmitProofArgs = {
       header: header.toBuffer(),
@@ -291,16 +353,16 @@ export class L1Publisher {
     };
 
     // Process block
-    while (!this.interrupted) {
+    if (!this.interrupted) {
       const timer = new Timer();
       const txHash = await this.sendSubmitProofTx(txArgs);
       if (!txHash) {
-        break;
+        return false;
       }
 
       const receipt = await this.getTransactionReceipt(txHash);
       if (!receipt) {
-        break;
+        return false;
       }
 
       // Tx was mined successfully
@@ -341,26 +403,6 @@ export class L1Publisher {
     this.interrupted = false;
   }
 
-  async getCurrentArchive(): Promise<Buffer> {
-    const archive = await this.rollupContract.read.archive();
-    return Buffer.from(archive.replace('0x', ''), 'hex');
-  }
-
-  /**
-   * Verifies that the given value of last archive in a block header equals current archive of the rollup contract
-   * @param lastArchive - The last archive of the block we wish to publish.
-   * @returns Boolean indicating if the hashes are equal.
-   */
-  private async checkLastArchiveHash(lastArchive: Buffer): Promise<boolean> {
-    const fromChain = await this.getCurrentArchive();
-    const areSame = lastArchive.equals(fromChain);
-    if (!areSame) {
-      this.log.debug(`Contract archive: ${fromChain.toString('hex')}`);
-      this.log.debug(`New block last archive: ${lastArchive.toString('hex')}`);
-    }
-    return areSame;
-  }
-
   private async sendSubmitProofTx(submitProofArgs: L1SubmitProofArgs): Promise<string | undefined> {
     try {
       const size = Object.values(submitProofArgs).reduce((acc, arg) => acc + arg.length, 0);
@@ -375,6 +417,12 @@ export class L1Publisher {
         `0x${proof.toString('hex')}`,
       ] as const;
 
+      if (!L1Publisher.SKIP_SIMULATION) {
+        await this.rollupContract.simulate.submitBlockRootProof(args, {
+          account: this.account,
+        });
+      }
+
       return await this.rollupContract.write.submitBlockRootProof(args, {
         account: this.account,
       });
@@ -384,12 +432,17 @@ export class L1Publisher {
     }
   }
 
+  // This is used in `integration_l1_publisher.test.ts` currently. Could be removed though.
   private async sendPublishTx(encodedBody: Buffer): Promise<string | undefined> {
-    while (!this.interrupted) {
+    if (!this.interrupted) {
       try {
         this.log.info(`TxEffects size=${encodedBody.length} bytes`);
         const args = [`0x${encodedBody.toString('hex')}`] as const;
 
+        await this.availabilityOracleContract.simulate.publish(args, {
+          account: this.account,
+        });
+
         return await this.availabilityOracleContract.write.publish(args, {
           account: this.account,
         });
@@ -400,8 +453,8 @@ export class L1Publisher {
     }
   }
 
-  private async sendProcessTx(encodedData: L1ProcessArgs): Promise<string | undefined> {
-    while (!this.interrupted) {
+  private async sendProposeWithoutBodyTx(encodedData: L1ProcessArgs): Promise<string | undefined> {
+    if (!this.interrupted) {
       try {
         if (encodedData.attestations) {
           const attestations = encodedData.attestations.map(attest => attest.toViemSignature());
@@ -412,7 +465,11 @@ export class L1Publisher {
             attestations,
           ] as const;
 
-          return await this.rollupContract.write.process(args, {
+          if (!L1Publisher.SKIP_SIMULATION) {
+            await this.rollupContract.simulate.propose(args, { account: this.account });
+          }
+
+          return await this.rollupContract.write.propose(args, {
             account: this.account,
           });
         } else {
@@ -422,7 +479,10 @@ export class L1Publisher {
             `0x${encodedData.blockHash.toString('hex')}`,
           ] as const;
 
-          return await this.rollupContract.write.process(args, {
+          if (!L1Publisher.SKIP_SIMULATION) {
+            await this.rollupContract.simulate.propose(args, { account: this.account });
+          }
+          return await this.rollupContract.write.propose(args, {
             account: this.account,
           });
         }
@@ -433,10 +493,9 @@ export class L1Publisher {
     }
   }
 
-  private async sendPublishAndProcessTx(encodedData: L1ProcessArgs): Promise<string | undefined> {
-    while (!this.interrupted) {
+  private async sendProposeTx(encodedData: L1ProcessArgs): Promise<string | undefined> {
+    if (!this.interrupted) {
       try {
-        // @note  This is quite a sin, but I'm committing war crimes in this code already.
         if (encodedData.attestations) {
           const attestations = encodedData.attestations.map(attest => attest.toViemSignature());
           const args = [
@@ -447,7 +506,13 @@ export class L1Publisher {
             `0x${encodedData.body.toString('hex')}`,
           ] as const;
 
-          return await this.rollupContract.write.publishAndProcess(args, {
+          if (!L1Publisher.SKIP_SIMULATION) {
+            await this.rollupContract.simulate.propose(args, {
+              account: this.account,
+            });
+          }
+
+          return await this.rollupContract.write.propose(args, {
             account: this.account,
           });
         } else {
@@ -458,7 +523,13 @@ export class L1Publisher {
             `0x${encodedData.body.toString('hex')}`,
           ] as const;
 
-          return await this.rollupContract.write.publishAndProcess(args, {
+          if (!L1Publisher.SKIP_SIMULATION) {
+            await this.rollupContract.simulate.propose(args, {
+              account: this.account,
+            });
+          }
+
+          return await this.rollupContract.write.propose(args, {
             account: this.account,
           });
         }