@aztec/ethereum 0.0.1-commit.f2ce05ee → 0.0.1-commit.f5d02921e

package/src/contracts/fee_asset_price_oracle.ts

@@ -0,0 +1,280 @@
+import { memoize } from '@aztec/foundation/decorators';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { type Logger, createLogger } from '@aztec/foundation/log';
+
+import { type Hex, encodeAbiParameters, getContract, keccak256, parseAbiParameters } from 'viem';
+
+import type { ViemClient } from '../types.js';
+import { RollupContract } from './rollup.js';
+
+/** Maximum price modifier per checkpoint in basis points. ±100 bps = ±1% */
+export const MAX_FEE_ASSET_PRICE_MODIFIER_BPS = 100n;
+
+/**
+ * Validates that a fee asset price modifier is within the allowed range.
+ * Validators should call this before attesting to a checkpoint proposal.
+ *
+ * @param modifier - The fee asset price modifier in basis points
+ * @returns true if the modifier is valid (between -100 and +100 bps)
+ */
+export function validateFeeAssetPriceModifier(modifier: bigint): boolean {
+  return modifier >= -MAX_FEE_ASSET_PRICE_MODIFIER_BPS && modifier <= MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
+}
+
+/**
+ * Oracle for computing fee asset price modifiers based on Uniswap V4 pool prices.
+ * Only active on Ethereum mainnet - returns 0 on other chains.
+ */
+export class FeeAssetPriceOracle {
+  constructor(
+    private client: ViemClient,
+    private readonly rollupContract: RollupContract,
+    private log: Logger = createLogger('fee-asset-price-oracle'),
+  ) {}
+
+  @memoize
+  async getUniswapOracle(): Promise<UniswapPriceOracle | undefined> {
+    const code = await this.client.getCode({ address: STATE_VIEW_ADDRESS.toString() });
+    if (code === undefined || code === '0x') {
+      this.log.warn('Uniswap V4 StateView contract not found, skipping fee asset price oracle');
+      return undefined;
+    }
+    this.log.info('Uniswap V4 StateView contract found, initializing fee asset price oracle');
+    const oracle = new UniswapPriceOracle(this.client, this.log);
+
+    try {
+      if (!(await oracle.isPoolInitialized())) {
+        this.log.warn('Uniswap V4 pool not initialized, skipping fee asset price oracle');
+        return undefined;
+      }
+    } catch (err) {
+      this.log.warn(`Failed to check if Uniswap V4 pool is initialized: ${err}`);
+      return undefined;
+    }
+
+    return oracle;
+  }
+
+  /**
+   * Computes the fee asset price modifier to be used in the next checkpoint proposal.
+   *
+   * The modifier adjusts the on-chain fee asset price toward the oracle price,
+   * clamped to ±1% (±100 basis points) per checkpoint.
+   *
+   * Returns 0 if not on mainnet or if the oracle query fails.
+   *
+   * @returns The price modifier in basis points (positive to increase price, negative to decrease)
+   */
+  async computePriceModifier(): Promise<bigint> {
+    const uniswapOracle = await this.getUniswapOracle();
+    if (!uniswapOracle) {
+      return 0n;
+    }
+
+    try {
+      // Get current on-chain price (ETH per fee asset, E12)
+      const currentPriceE12 = await this.rollupContract.getEthPerFeeAsset();
+
+      // Get oracle price (median of last N blocks, ETH per fee asset, E12)
+      const oraclePriceE12 = await uniswapOracle.getMeanEthPerFeeAssetE12();
+
+      // Compute modifier in basis points
+      const modifier = this.computePriceModifierBps(currentPriceE12, oraclePriceE12);
+
+      this.log.debug('Computed price modifier', {
+        currentPriceE12: currentPriceE12.toString(),
+        oraclePriceE12: oraclePriceE12.toString(),
+        modifierBps: modifier.toString(),
+      });
+
+      return modifier;
+    } catch (err) {
+      this.log.warn(`Failed to compute price modifier, using 0: ${err}`);
+      return 0n;
+    }
+  }
+
+  /**
+   * Gets the current oracle price (ETH per fee asset, scaled by 1e12).
+   * Returns undefined if not on mainnet or if the oracle query fails.
+   */
+  async getOraclePrice(): Promise<bigint | undefined> {
+    const uniswapOracle = await this.getUniswapOracle();
+    if (!uniswapOracle) {
+      return undefined;
+    }
+
+    try {
+      return await uniswapOracle.getMeanEthPerFeeAssetE12();
+    } catch (err) {
+      this.log.warn(`Failed to get oracle price: ${err}`);
+      return undefined;
+    }
+  }
+
+  /**
+   * Computes the basis points modifier needed to move from current price toward target price.
+   *
+   * @param currentPrice - Current ETH per fee asset (E12 scale)
+   * @param targetPrice - Target ETH per fee asset (E12 scale)
+   * @returns Basis points modifier clamped to ±100 (±1%)
+   */
+  computePriceModifierBps(currentPrice: bigint, targetPrice: bigint): bigint {
+    if (currentPrice === 0n) {
+      return MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
+    }
+
+    // Calculate percentage difference in basis points
+    // modifierBps = ((targetPrice - currentPrice) / currentPrice) * 10000
+    const diff = targetPrice - currentPrice;
+    const rawModifierBps = (diff * 10_000n) / currentPrice;
+
+    // Clamp to ±MAX_FEE_ASSET_PRICE_MODIFIER_BPS
+    if (rawModifierBps > MAX_FEE_ASSET_PRICE_MODIFIER_BPS) {
+      return MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
+    }
+    if (rawModifierBps < -MAX_FEE_ASSET_PRICE_MODIFIER_BPS) {
+      return -MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
+    }
+    return rawModifierBps;
+  }
+}
+
+/** Mainnet Uniswap V4 StateView contract address */
+export const STATE_VIEW_ADDRESS = EthAddress.fromString('0x7ffe42c4a5deea5b0fec41c94c136cf115597227');
+
+const PRECISION_Q192 = 10n ** 12n * 2n ** 192n;
+
+/**
+ * Converts Uniswap's sqrtPriceX96 directly to ETH per FeeAsset (E12).
+ *
+ * For an ETH/FeeAsset pool where ETH is currency0 and FeeAsset is currency1:
+ * - Uniswap's sqrtPriceX96 = sqrt(FeeAsset/ETH) * 2^96
+ * - We need: ETH/FeeAsset with 1e12 precision
+ *
+ * Math:
+ *   price = (sqrtPriceX96 / 2^96)^2 = sqrtPriceX96^2 / 2^192  (FeeAsset per ETH)
+ *   ethPerFeeAsset = 1 / price = 2^192 / sqrtPriceX96^2
+ *   ethPerFeeAssetE12 = ethPerFeeAsset * 1e12 = 1e12 * 2^192 / sqrtPriceX96^2
+ */
+export function sqrtPriceX96ToEthPerFeeAssetE12(sqrtPriceX96: bigint): bigint {
+  if (sqrtPriceX96 === 0n) {
+    throw new Error('Cannot convert zero sqrtPriceX96');
+  }
+  return PRECISION_Q192 / (sqrtPriceX96 * sqrtPriceX96);
+}
+/**
+ * Uniswap V4 StateView ABI - only the functions we need
+ */
+const StateViewAbi = [
+  {
+    type: 'function',
+    name: 'getSlot0',
+    inputs: [{ name: 'poolId', type: 'bytes32', internalType: 'PoolId' }],
+    outputs: [
+      { name: 'sqrtPriceX96', type: 'uint160', internalType: 'uint160' },
+      { name: 'tick', type: 'int24', internalType: 'int24' },
+      { name: 'protocolFee', type: 'uint24', internalType: 'uint24' },
+      { name: 'lpFee', type: 'uint24', internalType: 'uint24' },
+    ],
+    stateMutability: 'view',
+  },
+] as const;
+
+/**
+ * Client for querying the ETH/FeeAsset price from Uniswap V4.
+ * Returns prices in ETH per FeeAsset format (E12) to match the rollup contract.
+ */
+class UniswapPriceOracle {
+  private readonly stateView;
+  private readonly poolId: Hex;
+  private readonly log: Logger;
+
+  constructor(
+    private readonly client: ViemClient,
+    log?: Logger,
+  ) {
+    this.log = log ?? createLogger('uniswap-price-oracle');
+    this.stateView = getContract({
+      address: STATE_VIEW_ADDRESS.toString(),
+      abi: StateViewAbi,
+      client,
+    });
+    this.poolId = this.computePoolId();
+    this.log.debug(`Initialized UniswapPriceOracle with poolId: ${this.poolId}`);
+  }
+
+  /**
+   * Computes the PoolId from the pool configuration by hashing its components.
+   * PoolId = keccak256(abi.encode(currency0, currency1, fee, tickSpacing, hooks))
+   * For mainnet, the value is expected to be: 0xce2899b16743cfd5a954d8122d5e07f410305b1aebee39fd73d9f3b9ebf10c2f
+   * Derived anyway to make it simpler to change if needed.
+   */
+  @memoize
+  computePoolId(): Hex {
+    /** ETH/FeeAsset pool configuration (hardcoded for mainnet) */
+    const encoded = encodeAbiParameters(parseAbiParameters('address, address, uint24, int24, address'), [
+      EthAddress.ZERO.toString(),
+      EthAddress.fromString('0xA27EC0006e59f245217Ff08CD52A7E8b169E62D2').toString(),
+      500, // 0.05%
+      10,
+      EthAddress.fromString('0xd53006d1e3110fD319a79AEEc4c527a0d265E080').toString(),
+    ]);
+    return keccak256(encoded);
+  }
+
+  async isPoolInitialized(): Promise<boolean> {
+    const [sqrtPriceX96] = await this.stateView.read.getSlot0([this.poolId], undefined);
+    return sqrtPriceX96 !== 0n;
+  }
+
+  /**
+   * Gets the price as ETH per FeeAsset, scaled by 1e12.
+   * This is the format expected by the rollup contract.
+   *
+   * @param blockNumber - Optional block number to query at (defaults to latest)
+   */
+  async getEthPerFeeAssetE12(blockNumber?: bigint): Promise<bigint> {
+    const [sqrtPriceX96] = await this.stateView.read.getSlot0(
+      [this.poolId],
+      blockNumber !== undefined ? { blockNumber } : undefined,
+    );
+    return sqrtPriceX96ToEthPerFeeAssetE12(sqrtPriceX96);
+  }
+
+  /**
+   * Gets the median price over the last N blocks as ETH per FeeAsset (E12).
+   * Using median helps protect against single-block manipulation.
+   *
+   * @param numBlocks - Number of recent blocks to sample (default: 5)
+   * @returns Median price as ETH per FeeAsset, scaled by 1e12
+   */
+  async getMeanEthPerFeeAssetE12(numBlocks: number = 5): Promise<bigint> {
+    const currentBlock = await this.client.getBlockNumber();
+    const prices: bigint[] = [];
+
+    for (let i = 0; i < numBlocks; i++) {
+      const blockNumber = currentBlock - BigInt(i);
+      if (blockNumber < 0n) {
+        break;
+      }
+
+      try {
+        const price = await this.getEthPerFeeAssetE12(blockNumber);
+        prices.push(price);
+      } catch (err) {
+        this.log.warn(`Failed to get price at block ${blockNumber}: ${err}`);
+        // Continue with fewer samples
+      }
+    }
+
+    const filteredPrices = prices.filter(price => price !== 0n);
+
+    if (filteredPrices.length === 0) {
+      throw new Error('Failed to get any price samples from Uniswap oracle');
+    }
+
+    const mean = filteredPrices.reduce((a, b) => a + b, 0n) / BigInt(filteredPrices.length);
+    return mean;
+  }
+}

package/src/contracts/governance.ts

@@ -14,7 +14,7 @@ import {
 } from 'viem';
 
 import type { L1ContractAddresses } from '../l1_contract_addresses.js';
-import { createL1TxUtilsFromViemWallet } from '../l1_tx_utils/index.js';
+import { createL1TxUtils } from '../l1_tx_utils/index.js';
 import { type ExtendedViemWalletClient, type ViemClient, isExtendedClient } from '../types.js';
 
 export type L1GovernanceContractAddresses = Pick<
@@ -194,7 +194,7 @@ export class GovernanceContract extends ReadOnlyGovernanceContract {
     retries: number;
     logger: Logger;
   }) {
-    const l1TxUtils = createL1TxUtilsFromViemWallet(this.client, { logger });
+    const l1TxUtils = createL1TxUtils(this.client, { logger });
     const retryDelaySeconds = 12;
 
     voteAmount = voteAmount ?? (await this.getPowerForProposal(proposalId));
@@ -252,7 +252,7 @@ export class GovernanceContract extends ReadOnlyGovernanceContract {
     retries: number;
     logger: Logger;
   }) {
-    const l1TxUtils = createL1TxUtilsFromViemWallet(this.client, { logger });
+    const l1TxUtils = createL1TxUtils(this.client, { logger });
     const retryDelaySeconds = 12;
     let success = false;
     for (let i = 0; i < retries; i++) {

package/src/contracts/governance_proposer.ts

@@ -110,6 +110,12 @@ export class GovernanceProposerContract implements IEmpireBase {
     };
   }
 
+  /** Checks if a payload was ever submitted to governance via submitRoundWinner. */
+  public async hasPayloadBeenProposed(payload: Hex, fromBlock: bigint): Promise<boolean> {
+    const events = await this.proposer.getEvents.PayloadSubmitted({ payload }, { fromBlock, strict: true });
+    return events.length > 0;
+  }
+
   public async submitRoundWinner(
     round: bigint,
     l1TxUtils: L1TxUtils,

package/src/contracts/index.ts

@@ -1,6 +1,7 @@
 export * from './empire_base.js';
 export * from './errors.js';
 export * from './fee_asset_handler.js';
+export * from './fee_asset_price_oracle.js';
 export * from './fee_juice.js';
 export * from './governance.js';
 export * from './governance_proposer.js';

package/src/contracts/multicall.ts

@@ -2,7 +2,7 @@ import { toHex as toPaddedHex } from '@aztec/foundation/bigint-buffer';
 import { TimeoutError } from '@aztec/foundation/error';
 import type { Logger } from '@aztec/foundation/log';
 
-import { type EncodeFunctionDataParameters, type Hex, encodeFunctionData, multicall3Abi } from 'viem';
+import { type Address, type EncodeFunctionDataParameters, type Hex, encodeFunctionData, multicall3Abi } from 'viem';
 
 import type { L1BlobInputs, L1TxConfig, L1TxRequest, L1TxUtils } from '../l1_tx_utils/index.js';
 import type { ExtendedViemWalletClient } from '../types.js';
@@ -11,6 +11,39 @@ import { RollupContract } from './rollup.js';
 
 export const MULTI_CALL_3_ADDRESS = '0xcA11bde05977b3631167028862bE2a173976CA11' as const;
 
+/** ABI fragment for aggregate3Value — not included in viem's multicall3Abi. */
+export const aggregate3ValueAbi = [
+  {
+    inputs: [
+      {
+        components: [
+          { internalType: 'address', name: 'target', type: 'address' },
+          { internalType: 'bool', name: 'allowFailure', type: 'bool' },
+          { internalType: 'uint256', name: 'value', type: 'uint256' },
+          { internalType: 'bytes', name: 'callData', type: 'bytes' },
+        ],
+        internalType: 'struct Multicall3.Call3Value[]',
+        name: 'calls',
+        type: 'tuple[]',
+      },
+    ],
+    name: 'aggregate3Value',
+    outputs: [
+      {
+        components: [
+          { internalType: 'bool', name: 'success', type: 'bool' },
+          { internalType: 'bytes', name: 'returnData', type: 'bytes' },
+        ],
+        internalType: 'struct Multicall3.Result[]',
+        name: 'returnData',
+        type: 'tuple[]',
+      },
+    ],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+] as const;
+
 export class Multicall3 {
   static async forward(
     requests: L1TxRequest[],
@@ -122,6 +155,37 @@ export class Multicall3 {
       throw err;
     }
   }
+
+  /** Batch multiple value transfers into a single aggregate3Value call on Multicall3. */
+  static async forwardValue(calls: { to: Address; value: bigint }[], l1TxUtils: L1TxUtils, logger: Logger) {
+    const args = calls.map(c => ({
+      target: c.to,
+      allowFailure: false,
+      value: c.value,
+      callData: '0x' as Hex,
+    }));
+
+    const data = encodeFunctionData({
+      abi: aggregate3ValueAbi,
+      functionName: 'aggregate3Value',
+      args: [args],
+    });
+
+    const totalValue = calls.reduce((sum, c) => sum + c.value, 0n);
+
+    logger.info(`Sending aggregate3Value with ${calls.length} calls`, { totalValue });
+    const { receipt } = await l1TxUtils.sendAndMonitorTransaction({
+      to: MULTI_CALL_3_ADDRESS,
+      data,
+      value: totalValue,
+    });
+
+    if (receipt.status !== 'success') {
+      throw new Error(`aggregate3Value transaction reverted: ${receipt.transactionHash}`);
+    }
+
+    return { receipt };
+  }
 }
 
 export async function deployMulticall3(l1Client: ExtendedViemWalletClient, logger: Logger) {

package/src/contracts/registry.ts

@@ -3,7 +3,7 @@ import { createLogger } from '@aztec/foundation/log';
 import { RegistryAbi } from '@aztec/l1-artifacts/RegistryAbi';
 import { TestERC20Abi } from '@aztec/l1-artifacts/TestERC20Abi';
 
-import { type GetContractReturnType, type Hex, getContract } from 'viem';
+import { type GetContractReturnType, type Hex, getAbiItem, getContract } from 'viem';
 
 import type { L1ContractAddresses } from '../l1_contract_addresses.js';
 import type { ViemClient } from '../types.js';
@@ -128,4 +128,34 @@ export class RegistryContract {
   public async getRewardDistributor(): Promise<EthAddress> {
     return EthAddress.fromString(await this.registry.read.getRewardDistributor());
   }
+
+  /** Returns the L1 timestamp at which the given rollup was registered via addRollup(). */
+  public async getCanonicalRollupRegistrationTimestamp(
+    rollupAddress: EthAddress,
+    fromBlock?: bigint,
+  ): Promise<bigint | undefined> {
+    const event = getAbiItem({ abi: RegistryAbi, name: 'CanonicalRollupUpdated' });
+    const start = fromBlock ?? 0n;
+    const latestBlock = await this.client.getBlockNumber();
+    const chunkSize = 1_000n;
+
+    for (let from = start; from <= latestBlock; from += chunkSize) {
+      const to = from + chunkSize - 1n > latestBlock ? latestBlock : from + chunkSize - 1n;
+      const logs = await this.client.getLogs({
+        address: this.address.toString(),
+        fromBlock: from,
+        toBlock: to,
+        strict: true,
+        event,
+        args: { instance: rollupAddress.toString() },
+      });
+
+      if (logs.length > 0) {
+        const block = await this.client.getBlock({ blockNumber: logs[0].blockNumber });
+        return block.timestamp;
+      }
+    }
+
+    return undefined;
+  }
 }