@aztec/ethereum 0.0.1-commit.8afd444 → 0.0.1-commit.8f9871590

package/dest/config.js

@@ -19,7 +19,7 @@ import { l1TxUtilsConfigMappings } from './l1_tx_utils/config.js';
     },
     aztecEpochDuration: {
         env: 'AZTEC_EPOCH_DURATION',
-        description: `How many L2 slots an epoch lasts (maximum AZTEC_MAX_EPOCH_DURATION).`,
+        description: `How many L2 slots an epoch lasts (maximum MAX_CHECKPOINTS_PER_EPOCH).`,
         ...numberConfigHelper(l1ContractsDefaultEnv.AZTEC_EPOCH_DURATION)
     },
     aztecTargetCommitteeSize: {

package/dest/contracts/fee_asset_price_oracle.d.ts

@@ -0,0 +1,101 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { type Logger } from '@aztec/foundation/log';
+import { type Hex } 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 declare 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 declare function validateFeeAssetPriceModifier(modifier: bigint): boolean;
+/**
+ * Oracle for computing fee asset price modifiers based on Uniswap V4 pool prices.
+ * Only active on Ethereum mainnet - returns 0 on other chains.
+ */
+export declare class FeeAssetPriceOracle {
+    private client;
+    private readonly rollupContract;
+    private log;
+    constructor(client: ViemClient, rollupContract: RollupContract, log?: Logger);
+    getUniswapOracle(): Promise<UniswapPriceOracle | undefined>;
+    /**
+     * 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)
+     */
+    computePriceModifier(): Promise<bigint>;
+    /**
+     * Gets the current oracle price (ETH per fee asset, scaled by 1e12).
+     * Returns undefined if not on mainnet or if the oracle query fails.
+     */
+    getOraclePrice(): Promise<bigint | 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;
+}
+/** Mainnet Uniswap V4 StateView contract address */
+export declare const STATE_VIEW_ADDRESS: EthAddress;
+/**
+ * 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 declare function sqrtPriceX96ToEthPerFeeAssetE12(sqrtPriceX96: bigint): bigint;
+/**
+ * Client for querying the ETH/FeeAsset price from Uniswap V4.
+ * Returns prices in ETH per FeeAsset format (E12) to match the rollup contract.
+ */
+declare class UniswapPriceOracle {
+    private readonly client;
+    private readonly stateView;
+    private readonly poolId;
+    private readonly log;
+    constructor(client: ViemClient, log?: Logger);
+    /**
+     * 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.
+     */
+    computePoolId(): Hex;
+    isPoolInitialized(): Promise<boolean>;
+    /**
+     * 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)
+     */
+    getEthPerFeeAssetE12(blockNumber?: bigint): Promise<bigint>;
+    /**
+     * 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
+     */
+    getMeanEthPerFeeAssetE12(numBlocks?: number): Promise<bigint>;
+}
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmVlX2Fzc2V0X3ByaWNlX29yYWNsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0cy9mZWVfYXNzZXRfcHJpY2Vfb3JhY2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUMzRCxPQUFPLEVBQUUsS0FBSyxNQUFNLEVBQWdCLE1BQU0sdUJBQXVCLENBQUM7QUFFbEUsT0FBTyxFQUFFLEtBQUssR0FBRyxFQUFtRSxNQUFNLE1BQU0sQ0FBQztBQUVqRyxPQUFPLEtBQUssRUFBRSxVQUFVLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDOUMsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUU3Qyw4RUFBNEU7QUFDNUUsZUFBTyxNQUFNLGdDQUFnQyxPQUFPLENBQUM7QUFFckQ7Ozs7OztHQU1HO0FBQ0gsd0JBQWdCLDZCQUE2QixDQUFDLFFBQVEsRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUV2RTtBQUVEOzs7R0FHRztBQUNILHFCQUFhLG1CQUFtQjtJQUU1QixPQUFPLENBQUMsTUFBTTtJQUNkLE9BQU8sQ0FBQyxRQUFRLENBQUMsY0FBYztJQUMvQixPQUFPLENBQUMsR0FBRztJQUhiLFlBQ1UsTUFBTSxFQUFFLFVBQVUsRUFDVCxjQUFjLEVBQUUsY0FBYyxFQUN2QyxHQUFHLEdBQUUsTUFBK0MsRUFDMUQ7SUFHRSxnQkFBZ0IsSUFBSSxPQUFPLENBQUMsa0JBQWtCLEdBQUcsU0FBUyxDQUFDLENBb0JoRTtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNHLG9CQUFvQixJQUFJLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0EyQjVDO0lBRUQ7OztPQUdHO0lBQ0csY0FBYyxJQUFJLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBWWxEO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsdUJBQXVCLENBQUMsWUFBWSxFQUFFLE1BQU0sRUFBRSxXQUFXLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0FrQnpFO0NBQ0Y7QUFFRCxvREFBb0Q7QUFDcEQsZUFBTyxNQUFNLGtCQUFrQixZQUFzRSxDQUFDO0FBSXRHOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsd0JBQWdCLCtCQUErQixDQUFDLFlBQVksRUFBRSxNQUFNLEdBQUcsTUFBTSxDQUs1RTtBQW1CRDs7O0dBR0c7QUFDSCxjQUFNLGtCQUFrQjtJQU1wQixPQUFPLENBQUMsUUFBUSxDQUFDLE1BQU07SUFMekIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUM7SUFDM0IsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQU07SUFDN0IsT0FBTyxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQVM7SUFFN0IsWUFDbUIsTUFBTSxFQUFFLFVBQVUsRUFDbkMsR0FBRyxDQUFDLEVBQUUsTUFBTSxFQVViO0lBRUQ7Ozs7O09BS0c7SUFFSCxhQUFhLElBQUksR0FBRyxDQVVuQjtJQUVLLGlCQUFpQixJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FHMUM7SUFFRDs7Ozs7T0FLRztJQUNHLG9CQUFvQixDQUFDLFdBQVcsQ0FBQyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBTWhFO0lBRUQ7Ozs7OztPQU1HO0lBQ0csd0JBQXdCLENBQUMsU0FBUyxHQUFFLE1BQVUsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBMkJyRTtDQUNGIn0=

package/dest/contracts/fee_asset_price_oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fee_asset_price_oracle.d.ts","sourceRoot":"","sources":["../../src/contracts/fee_asset_price_oracle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAElE,OAAO,EAAE,KAAK,GAAG,EAAmE,MAAM,MAAM,CAAC;AAEjG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,8EAA4E;AAC5E,eAAO,MAAM,gCAAgC,OAAO,CAAC;AAErD;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEvE;AAED;;;GAGG;AACH,qBAAa,mBAAmB;IAE5B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,GAAG;IAHb,YACU,MAAM,EAAE,UAAU,EACT,cAAc,EAAE,cAAc,EACvC,GAAG,GAAE,MAA+C,EAC1D;IAGE,gBAAgB,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAoBhE;IAED;;;;;;;;;OASG;IACG,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CA2B5C;IAED;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAYlD;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAkBzE;CACF;AAED,oDAAoD;AACpD,eAAO,MAAM,kBAAkB,YAAsE,CAAC;AAItG;;;;;;;;;;;GAWG;AACH,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAK5E;AAmBD;;;GAGG;AACH,cAAM,kBAAkB;IAMpB,OAAO,CAAC,QAAQ,CAAC,MAAM;IALzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAE7B,YACmB,MAAM,EAAE,UAAU,EACnC,GAAG,CAAC,EAAE,MAAM,EAUb;IAED;;;;;OAKG;IAEH,aAAa,IAAI,GAAG,CAUnB;IAEK,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAG1C;IAED;;;;;OAKG;IACG,oBAAoB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMhE;IAED;;;;;;OAMG;IACG,wBAAwB,CAAC,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CA2BrE;CACF"}