@aztec/bot 0.0.1-commit.9b94fc1 → 0.0.1-commit.9badcec54

package/src/config.ts

@@ -10,18 +10,21 @@ import {
   secretFrConfigHelper,
   secretStringConfigHelper,
 } from '@aztec/foundation/config';
-import { Fr } from '@aztec/foundation/fields';
-import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
 import { protocolContractsHash } from '@aztec/protocol-contracts';
-import { type ZodFor, schemas } from '@aztec/stdlib/schemas';
+import { type DataStoreConfig, dataConfigMappings } from '@aztec/stdlib/kv-store';
+import { schemas, zodFor } from '@aztec/stdlib/schemas';
 import type { ComponentsVersions } from '@aztec/stdlib/versioning';
 
 import { z } from 'zod';
 
-const BotFollowChain = ['NONE', 'PENDING', 'PROVEN'] as const;
+const BotFollowChain = ['NONE', 'PROPOSED', 'CHECKPOINTED', 'PROVEN'] as const;
 type BotFollowChain = (typeof BotFollowChain)[number];
 
+const BotMode = ['transfer', 'amm', 'crosschain'] as const;
+type BotMode = (typeof BotMode)[number];
+
 export enum SupportedTokenContracts {
   TokenContract = 'TokenContract',
   PrivateTokenContract = 'PrivateTokenContract',
@@ -54,8 +57,8 @@ export type BotConfig = {
   publicTransfersPerTx: number;
   /** How to handle fee payments. */
   feePaymentMethod: 'fee_juice';
-  /** 'How much is the bot willing to overpay vs. the current base fee' */
-  baseFeePadding: number;
+  /** 'How much is the bot willing to overpay vs. the current min fee' */
+  minFeePadding: number;
   /** True to not automatically setup or start the bot on initialization. */
   noStart: boolean;
   /** How long to wait for a tx to be mined before reporting an error. */
@@ -66,9 +69,9 @@ export type BotConfig = {
   maxPendingTxs: number;
   /** Whether to flush after sending each 'setup' transaction */
   flushSetupTransactions: boolean;
-  /** L2 gas limit for the tx (empty to have the bot trigger an estimate gas). */
+  /** L2 gas limit for the tx (empty to let the bot's wallet estimate). */
   l2GasLimit: number | undefined;
-  /** DA gas limit for the tx (empty to have the bot trigger an estimate gas). */
+  /** DA gas limit for the tx (empty to let the bot's wallet estimate). */
   daGasLimit: number | undefined;
   /** Token contract to use */
   contract: SupportedTokenContracts;
@@ -76,54 +79,61 @@ export type BotConfig = {
   maxConsecutiveErrors: number;
   /** Stops the bot if service becomes unhealthy */
   stopWhenUnhealthy: boolean;
-  /** Deploy an AMM contract and do swaps instead of transfers */
-  ammTxs: boolean;
+  /** Bot mode: transfer, amm, or crosschain. */
+  botMode: BotMode;
+  /** Number of L2→L1 messages per tx (crosschain mode). */
+  l2ToL1MessagesPerTx: number;
+  /** Max L1→L2 messages to keep in-flight (crosschain mode). */
+  l1ToL2SeedCount: number;
 } & Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb'>;
 
-export const BotConfigSchema = z
-  .object({
-    nodeUrl: z.string().optional(),
-    nodeAdminUrl: z.string().optional(),
-    l1RpcUrls: z.array(z.string()).optional(),
-    l1Mnemonic: schemas.SecretValue(z.string()).optional(),
-    l1PrivateKey: schemas.SecretValue(z.string()).optional(),
-    l1ToL2MessageTimeoutSeconds: z.number(),
-    senderPrivateKey: schemas.SecretValue(schemas.Fr).optional(),
-    senderSalt: schemas.Fr.optional(),
-    tokenSalt: schemas.Fr,
-    txIntervalSeconds: z.number(),
-    privateTransfersPerTx: z.number().int().nonnegative(),
-    publicTransfersPerTx: z.number().int().nonnegative(),
-    feePaymentMethod: z.literal('fee_juice'),
-    baseFeePadding: z.number().int().nonnegative(),
-    noStart: z.boolean(),
-    txMinedWaitSeconds: z.number(),
-    followChain: z.enum(BotFollowChain),
-    maxPendingTxs: z.number().int().nonnegative(),
-    flushSetupTransactions: z.boolean(),
-    l2GasLimit: z.number().int().nonnegative().optional(),
-    daGasLimit: z.number().int().nonnegative().optional(),
-    contract: z.nativeEnum(SupportedTokenContracts),
-    maxConsecutiveErrors: z.number().int().nonnegative(),
-    stopWhenUnhealthy: z.boolean(),
-    ammTxs: z.boolean().default(false),
-    dataDirectory: z.string().optional(),
-    dataStoreMapSizeKb: z.number().optional(),
-  })
-  .transform(config => ({
-    nodeUrl: undefined,
-    nodeAdminUrl: undefined,
-    l1RpcUrls: undefined,
-    senderSalt: undefined,
-    l2GasLimit: undefined,
-    daGasLimit: undefined,
-    l1Mnemonic: undefined,
-    l1PrivateKey: undefined,
-    senderPrivateKey: undefined,
-    dataDirectory: undefined,
-    dataStoreMapSizeKb: 1_024 * 1_024,
-    ...config,
-  })) satisfies ZodFor<BotConfig>;
+export const BotConfigSchema = zodFor<BotConfig>()(
+  z
+    .object({
+      nodeUrl: z.string().optional(),
+      nodeAdminUrl: z.string().optional(),
+      l1RpcUrls: z.array(z.string()).optional(),
+      l1Mnemonic: schemas.SecretValue(z.string()).optional(),
+      l1PrivateKey: schemas.SecretValue(z.string()).optional(),
+      l1ToL2MessageTimeoutSeconds: z.number(),
+      senderPrivateKey: schemas.SecretValue(schemas.Fr).optional(),
+      senderSalt: schemas.Fr.optional(),
+      tokenSalt: schemas.Fr,
+      txIntervalSeconds: z.number(),
+      privateTransfersPerTx: z.number().int().nonnegative(),
+      publicTransfersPerTx: z.number().int().nonnegative(),
+      feePaymentMethod: z.literal('fee_juice'),
+      minFeePadding: z.number().int().nonnegative(),
+      noStart: z.boolean(),
+      txMinedWaitSeconds: z.number(),
+      followChain: z.enum(BotFollowChain),
+      maxPendingTxs: z.number().int().nonnegative(),
+      flushSetupTransactions: z.boolean(),
+      l2GasLimit: z.number().int().nonnegative().optional(),
+      daGasLimit: z.number().int().nonnegative().optional(),
+      contract: z.nativeEnum(SupportedTokenContracts),
+      maxConsecutiveErrors: z.number().int().nonnegative(),
+      stopWhenUnhealthy: z.boolean(),
+      botMode: z.enum(BotMode).default('transfer'),
+      l2ToL1MessagesPerTx: z.number().int().nonnegative().default(1),
+      l1ToL2SeedCount: z.number().int().nonnegative().default(1),
+      dataDirectory: z.string().optional(),
+      dataStoreMapSizeKb: z.number().optional(),
+    })
+    .transform(config => ({
+      nodeUrl: undefined,
+      nodeAdminUrl: undefined,
+      l1RpcUrls: undefined,
+      senderSalt: undefined,
+      l2GasLimit: undefined,
+      daGasLimit: undefined,
+      l1Mnemonic: undefined,
+      l1PrivateKey: undefined,
+      senderPrivateKey: undefined,
+      dataStoreMapSizeKb: 1_024 * 1_024,
+      ...config,
+    })),
+);
 
 export const botConfigMappings: ConfigMappingsType<BotConfig> = {
   nodeUrl: {
@@ -191,8 +201,8 @@ export const botConfigMappings: ConfigMappingsType<BotConfig> = {
     parseEnv: val => (val as 'fee_juice') || undefined,
     defaultValue: 'fee_juice',
   },
-  baseFeePadding: {
-    env: 'BOT_BASE_FEE_PADDING',
+  minFeePadding: {
+    env: 'BOT_MIN_FEE_PADDING',
     description: 'How much is the bot willing to overpay vs. the current base fee',
     ...numberConfigHelper(3),
   },
@@ -211,10 +221,14 @@ export const botConfigMappings: ConfigMappingsType<BotConfig> = {
     description: 'Which chain the bot follows',
     defaultValue: 'NONE',
     parseEnv(val) {
-      if (!(BotFollowChain as readonly string[]).includes(val.toUpperCase())) {
+      const upper = val.toUpperCase();
+      if (upper === 'PENDING') {
+        return 'CHECKPOINTED';
+      }
+      if (!(BotFollowChain as readonly string[]).includes(upper)) {
         throw new Error(`Invalid value for BOT_FOLLOW_CHAIN: ${val}`);
       }
-      return val as BotFollowChain;
+      return upper as BotFollowChain;
     },
   },
   maxPendingTxs: {
@@ -229,12 +243,12 @@ export const botConfigMappings: ConfigMappingsType<BotConfig> = {
   },
   l2GasLimit: {
     env: 'BOT_L2_GAS_LIMIT',
-    description: 'L2 gas limit for the tx (empty to have the bot trigger an estimate gas).',
+    description: "L2 gas limit for the tx (empty to let the bot's wallet estimate).",
     ...optionalNumberConfigHelper(),
   },
   daGasLimit: {
     env: 'BOT_DA_GAS_LIMIT',
-    description: 'DA gas limit for the tx (empty to have the bot trigger an estimate gas).',
+    description: "DA gas limit for the tx (empty to let the bot's wallet estimate).",
     ...optionalNumberConfigHelper(),
   },
   contract: {
@@ -262,10 +276,26 @@ export const botConfigMappings: ConfigMappingsType<BotConfig> = {
     description: 'Stops the bot if service becomes unhealthy',
     ...booleanConfigHelper(false),
   },
-  ammTxs: {
-    env: 'BOT_AMM_TXS',
-    description: 'Deploy an AMM and send swaps to it',
-    ...booleanConfigHelper(false),
+  botMode: {
+    env: 'BOT_MODE',
+    description: 'Bot mode: transfer, amm, or crosschain',
+    defaultValue: 'transfer' as BotMode,
+    parseEnv(val: string) {
+      if (!(BotMode as readonly string[]).includes(val)) {
+        throw new Error(`Invalid value for BOT_MODE: ${val}`);
+      }
+      return val as BotMode;
+    },
+  },
+  l2ToL1MessagesPerTx: {
+    env: 'BOT_L2_TO_L1_MESSAGES_PER_TX',
+    description: 'Number of L2→L1 messages per tx (crosschain mode)',
+    ...numberConfigHelper(1),
+  },
+  l1ToL2SeedCount: {
+    env: 'BOT_L1_TO_L2_SEED_COUNT',
+    description: 'Max L1→L2 messages to keep in-flight (crosschain mode)',
+    ...numberConfigHelper(1),
   },
   ...pickConfigMappings(dataConfigMappings, ['dataStoreMapSizeKb', 'dataDirectory']),
 };

package/src/cross_chain_bot.ts

@@ -0,0 +1,203 @@
+/**
+ * CrossChainBot exercises L2->L1 and L1->L2 messaging.
+ *
+ *   createAndSendTx                          onTxMined
+ *   ──────────────────────────────────────   ──────────────────────────────
+ *
+ *   1. SEED (fire-and-forget)                3. VERIFY L2->L1
+ *      if store has fewer pending messages       Query getTxEffect, confirm
+ *      than seedCount and no seed is              the expected L2->L1 messages
+ *      in-flight:                                appeared in tx effects.
+ *        * kick off L1 inbox tx
+ *        * store msg on completion
+ *
+ *   2. BUILD & SEND BATCH
+ *      Always:
+ *        N x create_l2_to_l1_message
+ *            (random content, fixed
+ *             L1 recipient)
+ *      If a ready L1->L2 msg exists:
+ *        1 x consume_message_from_
+ *            arbitrary_sender_public
+ *        delete consumed msg from store
+ *      Send batch tx (no wait)
+ *
+ */
+import { AztecAddress } from '@aztec/aztec.js/addresses';
+import { BatchCall, NO_WAIT } from '@aztec/aztec.js/contracts';
+import { isL1ToL2MessageReady } from '@aztec/aztec.js/messaging';
+import { TxHash, TxReceipt } from '@aztec/aztec.js/tx';
+import type { ExtendedViemWalletClient } from '@aztec/ethereum/types';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { TestContract } from '@aztec/noir-test-contracts.js/Test';
+import type { AztecNode, AztecNodeAdmin } from '@aztec/stdlib/interfaces/client';
+import type { EmbeddedWallet } from '@aztec/wallets/embedded';
+
+import { BaseBot } from './base_bot.js';
+import type { BotConfig } from './config.js';
+import { BotFactory } from './factory.js';
+import { seedL1ToL2Message } from './l1_to_l2_seeding.js';
+import type { BotStore, PendingL1ToL2Message } from './store/index.js';
+
+/** Stale message threshold: messages older than this are removed. */
+const STALE_MESSAGE_THRESHOLD_MS = 2 * 60 * 60 * 1000; // 2 hours
+
+/** Bot that exercises both L2→L1 and L1→L2 cross-chain messaging. */
+export class CrossChainBot extends BaseBot {
+  private l2ToL1Sent = 0;
+  private l1ToL2Consumed = 0;
+  private pendingSeedPromise: Promise<void> | undefined;
+
+  protected constructor(
+    node: AztecNode,
+    wallet: EmbeddedWallet,
+    defaultAccountAddress: AztecAddress,
+    private readonly contract: TestContract,
+    private readonly l1Client: ExtendedViemWalletClient,
+    private readonly l1Recipient: EthAddress,
+    private readonly inboxAddress: EthAddress,
+    private readonly rollupVersion: bigint,
+    private readonly store: BotStore,
+    config: BotConfig,
+  ) {
+    super(node, wallet, defaultAccountAddress, config);
+  }
+
+  static async create(
+    config: BotConfig,
+    wallet: EmbeddedWallet,
+    aztecNode: AztecNode,
+    aztecNodeAdmin: AztecNodeAdmin | undefined,
+    store: BotStore,
+  ): Promise<CrossChainBot> {
+    if (config.followChain === 'NONE') {
+      throw new Error(`CrossChainBot requires followChain to be set (got NONE)`);
+    }
+    const factory = new BotFactory(config, wallet, store, aztecNode, aztecNodeAdmin);
+    const { defaultAccountAddress, contract, l1Client, rollupVersion } = await factory.setupCrossChain();
+    const l1Recipient = EthAddress.fromString(l1Client.account!.address);
+    const { l1ContractAddresses } = await aztecNode.getNodeInfo();
+    const inboxAddress = EthAddress.fromString(l1ContractAddresses.inboxAddress.toString());
+    return new CrossChainBot(
+      aztecNode,
+      wallet,
+      defaultAccountAddress,
+      contract,
+      l1Client,
+      l1Recipient,
+      inboxAddress,
+      rollupVersion,
+      store,
+      config,
+    );
+  }
+
+  protected async createAndSendTx(logCtx: object): Promise<TxHash> {
+    const pendingMessages = await this.store.getUnconsumedL1ToL2Messages();
+
+    // Send an L1→L2 message if we're below the threshold and not already seeding one
+    if (pendingMessages.length < this.config.l1ToL2SeedCount && !this.pendingSeedPromise) {
+      this.pendingSeedPromise = this.seedNewL1ToL2Message()
+        .catch(err => this.log.warn(`Failed to seed L1→L2 message: ${err}`, logCtx))
+        .finally(() => {
+          this.pendingSeedPromise = undefined;
+        });
+    }
+
+    // Build batch: always L2→L1, optionally consume L1→L2
+    const calls = [];
+
+    // L2→L1: create messages with random content
+    for (let i = 0; i < this.config.l2ToL1MessagesPerTx; i++) {
+      calls.push(
+        this.contract.methods.create_l2_to_l1_message_arbitrary_recipient_public(Fr.random(), this.l1Recipient),
+      );
+    }
+
+    // L1→L2: consume oldest ready message if available
+    const readyMsg = await this.getReadyL1ToL2Message(pendingMessages);
+    if (readyMsg) {
+      calls.push(
+        this.contract.methods.consume_message_from_arbitrary_sender_public(
+          Fr.fromHexString(readyMsg.content),
+          Fr.fromHexString(readyMsg.secret),
+          EthAddress.fromString(readyMsg.sender),
+          new Fr(BigInt(readyMsg.globalLeafIndex)),
+        ),
+      );
+      // Delete consumed message immediately so it works with FOLLOW_CHAIN=NONE
+      await this.store.deleteL1ToL2Message(readyMsg.msgHash);
+      this.l1ToL2Consumed++;
+    } else {
+      this.log.warn(`No ready L1→L2 message to consume`, {
+        ...logCtx,
+        pendingCount: pendingMessages.length,
+      });
+    }
+
+    const batch = new BatchCall(this.wallet, calls);
+    const opts = this.getSendMethodOpts();
+
+    this.log.verbose(`Sending cross-chain batch with ${calls.length} calls`, logCtx);
+    const { txHash } = await batch.send({ ...opts, wait: NO_WAIT });
+    return txHash;
+  }
+
+  protected override async onTxMined(receipt: TxReceipt, logCtx: object): Promise<void> {
+    // Verify L2→L1 messages appeared in this tx's effects
+    const indexed = await this.node.getTxEffect(receipt.txHash);
+    if (indexed) {
+      const l2ToL1Msgs = indexed.data.l2ToL1Msgs.filter(m => !m.isZero());
+      if (l2ToL1Msgs.length >= this.config.l2ToL1MessagesPerTx) {
+        this.l2ToL1Sent += l2ToL1Msgs.length;
+      } else {
+        this.log.error(`Expected ${this.config.l2ToL1MessagesPerTx} L2→L1 messages but found ${l2ToL1Msgs.length}`, {
+          ...logCtx,
+          blockNumber: receipt.blockNumber,
+          txHash: receipt.txHash.toString(),
+        });
+      }
+    }
+
+    const pendingCount = (await this.store.getUnconsumedL1ToL2Messages()).length;
+    this.log.info(`CrossChainBot txs mined`, {
+      ...logCtx,
+      l2ToL1Sent: this.l2ToL1Sent,
+      l1ToL2Consumed: this.l1ToL2Consumed,
+      l1ToL2Pending: pendingCount,
+    });
+  }
+
+  /** Finds the oldest pending message that is ready for consumption. */
+  private async getReadyL1ToL2Message(
+    pendingMessages: PendingL1ToL2Message[],
+  ): Promise<PendingL1ToL2Message | undefined> {
+    const now = Date.now();
+    for (const msg of pendingMessages) {
+      const ready = await isL1ToL2MessageReady(this.node, Fr.fromHexString(msg.msgHash));
+      if (ready) {
+        return msg;
+      }
+
+      // Time-based stale detection: if the message is old and still not ready, remove it
+      if (now - msg.timestamp > STALE_MESSAGE_THRESHOLD_MS) {
+        await this.store.deleteL1ToL2Message(msg.msgHash);
+        this.log.warn(`Removed stale L1→L2 message ${msg.msgHash}`);
+      }
+    }
+    return undefined;
+  }
+
+  /** Seeds a new L1→L2 message on L1 and stores it. */
+  private async seedNewL1ToL2Message(): Promise<void> {
+    await seedL1ToL2Message(
+      this.l1Client,
+      this.inboxAddress,
+      this.contract.address,
+      this.rollupVersion,
+      this.store,
+      this.log,
+    );
+  }
+}