@aztec/ethereum 0.0.0-test.0

package/dest/l1_reader.js

@@ -0,0 +1,27 @@
+import { getConfigFromMappings, numberConfigHelper } from '@aztec/foundation/config';
+import { l1ContractAddressesMapping } from './l1_contract_addresses.js';
+export const l1ReaderConfigMappings = {
+    l1RpcUrls: {
+        env: 'ETHEREUM_HOSTS',
+        description: 'The RPC Url of the ethereum host.',
+        parseEnv: (val)=>val.split(',').map((url)=>url.trim())
+    },
+    l1ChainId: {
+        env: 'L1_CHAIN_ID',
+        parseEnv: (val)=>+val,
+        defaultValue: 31337,
+        description: 'The chain ID of the ethereum host.'
+    },
+    l1Contracts: {
+        description: 'The deployed L1 contract addresses',
+        nested: l1ContractAddressesMapping
+    },
+    viemPollingIntervalMS: {
+        env: 'L1_READER_VIEM_POLLING_INTERVAL_MS',
+        description: 'The polling interval viem uses in ms',
+        ...numberConfigHelper(1_000)
+    }
+};
+export function getL1ReaderConfigFromEnv() {
+    return getConfigFromMappings(l1ReaderConfigMappings);
+}

package/dest/l1_tx_utils.d.ts

@@ -0,0 +1,192 @@
+import { type ConfigMappingsType } from '@aztec/foundation/config';
+import { type Logger } from '@aztec/foundation/log';
+import { type Abi, type Account, type Address, type BlockOverrides, type ContractFunctionExecutionError, type Hex, type StateOverride, type TransactionReceipt } from 'viem';
+import type { ViemPublicClient, ViemWalletClient } from './types.js';
+export interface L1TxUtilsConfig {
+    /**
+     * How much to increase calculated gas limit.
+     */
+    gasLimitBufferPercentage?: number;
+    /**
+     * Maximum gas price in gwei
+     */
+    maxGwei?: bigint;
+    /**
+     * Maximum blob fee per gas in gwei
+     */
+    maxBlobGwei?: bigint;
+    /**
+     * Priority fee bump percentage
+     */
+    priorityFeeBumpPercentage?: number;
+    /**
+     * How much to increase priority fee by each attempt (percentage)
+     */
+    priorityFeeRetryBumpPercentage?: number;
+    /**
+     * Fixed priority fee per gas in Gwei. Overrides any priority fee bump percentage config
+     */
+    fixedPriorityFeePerGas?: number;
+    /**
+     * Maximum number of speed-up attempts
+     */
+    maxAttempts?: number;
+    /**
+     * How often to check tx status
+     */
+    checkIntervalMs?: number;
+    /**
+     * How long before considering tx stalled
+     */
+    stallTimeMs?: number;
+    /**
+     * How long to wait for a tx to be mined before giving up
+     */
+    txTimeoutMs?: number;
+    /**
+     * How many attempts will be done to get a tx after it was sent?
+     * First attempt is done at 1s, second at 2s, third at 3s, etc.
+     */
+    txPropagationMaxQueryAttempts?: number;
+}
+export declare const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig>;
+export declare const defaultL1TxUtilsConfig: L1TxUtilsConfig;
+export interface L1TxRequest {
+    to: Address | null;
+    data?: Hex;
+    value?: bigint;
+}
+export type L1GasConfig = Partial<L1TxUtilsConfig> & {
+    gasLimit?: bigint;
+    txTimeoutAt?: Date;
+};
+export interface L1BlobInputs {
+    blobs: Uint8Array[];
+    kzg: any;
+    maxFeePerBlobGas?: bigint;
+}
+export interface GasPrice {
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    maxFeePerBlobGas?: bigint;
+}
+export type TransactionStats = {
+    /** Address of the sender. */
+    sender: string;
+    /** Hash of the transaction. */
+    transactionHash: string;
+    /** Size in bytes of the tx calldata */
+    calldataSize: number;
+    /** Gas required to pay for the calldata inclusion (depends on size and number of zeros)  */
+    calldataGas: number;
+};
+export declare class L1TxUtils {
+    publicClient: ViemPublicClient;
+    walletClient: ViemWalletClient;
+    protected logger: Logger;
+    private debugMaxGasLimit;
+    readonly config: L1TxUtilsConfig;
+    private interrupted;
+    constructor(publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger?: Logger, config?: Partial<L1TxUtilsConfig>, debugMaxGasLimit?: boolean);
+    interrupt(): void;
+    restart(): void;
+    getSenderAddress(): `0x${string}`;
+    getSenderBalance(): Promise<bigint>;
+    getBlock(): Promise<{
+        number: bigint;
+        hash: `0x${string}`;
+        nonce: `0x${string}`;
+        logsBloom: `0x${string}`;
+        baseFeePerGas: bigint | null;
+        blobGasUsed: bigint;
+        difficulty: bigint;
+        excessBlobGas: bigint;
+        extraData: `0x${string}`;
+        gasLimit: bigint;
+        gasUsed: bigint;
+        miner: `0x${string}`;
+        mixHash: `0x${string}`;
+        parentBeaconBlockRoot?: `0x${string}` | undefined;
+        parentHash: `0x${string}`;
+        receiptsRoot: `0x${string}`;
+        sealFields: `0x${string}`[];
+        sha3Uncles: `0x${string}`;
+        size: bigint;
+        stateRoot: `0x${string}`;
+        timestamp: bigint;
+        totalDifficulty: bigint | null;
+        transactionsRoot: `0x${string}`;
+        uncles: `0x${string}`[];
+        withdrawals?: import("viem").Withdrawal[] | undefined;
+        withdrawalsRoot?: `0x${string}` | undefined;
+        transactions: `0x${string}`[];
+    }>;
+    getBlockNumber(): Promise<bigint>;
+    /**
+     * Sends a transaction with gas estimation and pricing
+     * @param request - The transaction request (to, data, value)
+     * @param gasConfig - Optional gas configuration
+     * @returns The transaction hash and parameters used
+     */
+    sendTransaction(request: L1TxRequest, _gasConfig?: L1GasConfig, blobInputs?: L1BlobInputs): Promise<{
+        txHash: Hex;
+        gasLimit: bigint;
+        gasPrice: GasPrice;
+    }>;
+    /**
+     * Monitors a transaction until completion, handling speed-ups if needed
+     * @param request - Original transaction request (needed for speed-ups)
+     * @param initialTxHash - Hash of the initial transaction
+     * @param params - Parameters used in the initial transaction
+     * @param gasConfig - Optional gas configuration
+     */
+    monitorTransaction(request: L1TxRequest, initialTxHash: Hex, params: {
+        gasLimit: bigint;
+    }, _gasConfig?: Partial<L1TxUtilsConfig> & {
+        txTimeoutAt?: Date;
+    }, _blobInputs?: L1BlobInputs, isCancelTx?: boolean): Promise<TransactionReceipt>;
+    /**
+     * Sends a transaction and monitors it until completion
+     * @param request - The transaction request (to, data, value)
+     * @param gasConfig - Optional gas configuration
+     * @returns The receipt of the successful transaction
+     */
+    sendAndMonitorTransaction(request: L1TxRequest, gasConfig?: L1GasConfig, blobInputs?: L1BlobInputs): Promise<{
+        receipt: TransactionReceipt;
+        gasPrice: GasPrice;
+    }>;
+    /**
+     * Gets the current gas price with bounds checking
+     */
+    getGasPrice(_gasConfig?: L1TxUtilsConfig, isBlobTx?: boolean, attempt?: number, previousGasPrice?: typeof attempt extends 0 ? never : GasPrice): Promise<GasPrice>;
+    /**
+     * Estimates gas and adds buffer
+     */
+    estimateGas(account: Account | Hex, request: L1TxRequest, _gasConfig?: L1TxUtilsConfig, _blobInputs?: L1BlobInputs): Promise<bigint>;
+    getTransactionStats(txHash: string): Promise<TransactionStats | undefined>;
+    tryGetErrorFromRevertedTx(data: Hex, args: {
+        args: readonly any[];
+        functionName: string;
+        abi: Abi;
+        address: Hex;
+    }, blobInputs: (L1BlobInputs & {
+        maxFeePerBlobGas: bigint;
+    }) | undefined, stateOverride?: StateOverride): Promise<string | undefined>;
+    simulateGasUsed(request: L1TxRequest & {
+        gas?: bigint;
+    }, blockOverrides?: BlockOverrides<bigint, number>, stateOverrides?: StateOverride, _gasConfig?: L1TxUtilsConfig & {
+        fallbackGasEstimate?: bigint;
+    }): Promise<bigint>;
+    bumpGasLimit(gasLimit: bigint, _gasConfig?: L1TxUtilsConfig): bigint;
+    /**
+     * Attempts to cancel a transaction by sending a 0-value tx to self with same nonce but higher gas prices
+     * @param nonce - The nonce of the transaction to cancel
+     * @param previousGasPrice - The gas price of the previous transaction
+     * @param attempts - The number of attempts to cancel the transaction
+     * @returns The hash of the cancellation transaction
+     */
+    protected attemptTxCancellation(nonce: number, isBlobTx?: boolean, previousGasPrice?: GasPrice, attempts?: number): Promise<`0x${string}`>;
+}
+export declare function tryGetCustomErrorNameContractFunction(err: ContractFunctionExecutionError): string;
+export declare function getCalldataGasUsage(data: Uint8Array): number;
+//# sourceMappingURL=l1_tx_utils.d.ts.map

package/dest/l1_tx_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"l1_tx_utils.d.ts","sourceRoot":"","sources":["../src/l1_tx_utils.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,kBAAkB,EAIxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAIlE,OAAO,EACL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,OAAO,EAEZ,KAAK,cAAc,EACnB,KAAK,8BAA8B,EAEnC,KAAK,GAAG,EAGR,KAAK,aAAa,EAClB,KAAK,kBAAkB,EAIxB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAuBrE,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED,eAAO,MAAM,uBAAuB,EAAE,kBAAkB,CAAC,eAAe,CAwDvE,CAAC;AAEF,eAAO,MAAM,sBAAsB,iBAA6D,CAAC;AAEjG,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/F,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,GAAG,EAAE,GAAG,CAAC;IACT,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,4FAA4F;IAC5F,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,qBAAa,SAAS;IAKX,YAAY,EAAE,gBAAgB;IAC9B,YAAY,EAAE,gBAAgB;IACrC,SAAS,CAAC,MAAM,EAAE,MAAM;IAExB,OAAO,CAAC,gBAAgB;IAR1B,SAAgB,MAAM,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,WAAW,CAAS;gBAGnB,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC3B,MAAM,GAAE,MAAkC,EACpD,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,EACzB,gBAAgB,GAAE,OAAe;IASpC,SAAS;IAIT,OAAO;IAIP,gBAAgB;IAIhB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAMnC,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIR,cAAc;IAIrB;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,WAAW,EACxB,UAAU,CAAC,EAAE,YAAY,GACxB,OAAO,CAAC;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IAuDjE;;;;;;OAMG;IACU,kBAAkB,CAC7B,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,GAAG,EAClB,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,EAC5B,UAAU,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG;QAAE,WAAW,CAAC,EAAE,IAAI,CAAA;KAAE,EAC9D,WAAW,CAAC,EAAE,YAAY,EAC1B,UAAU,GAAE,OAAe,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAkK9B;;;;;OAKG;IACU,yBAAyB,CACpC,OAAO,EAAE,WAAW,EACpB,SAAS,CAAC,EAAE,WAAW,EACvB,UAAU,CAAC,EAAE,YAAY,GACxB,OAAO,CAAC;QAAE,OAAO,EAAE,kBAAkB,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IAM/D;;OAEG;IACU,WAAW,CACtB,UAAU,CAAC,EAAE,eAAe,EAC5B,QAAQ,GAAE,OAAe,EACzB,OAAO,GAAE,MAAU,EACnB,gBAAgB,CAAC,EAAE,OAAO,OAAO,SAAS,CAAC,GAAG,KAAK,GAAG,QAAQ,GAC7D,OAAO,CAAC,QAAQ,CAAC;IA8GpB;;OAEG;IACU,WAAW,CACtB,OAAO,EAAE,OAAO,GAAG,GAAG,EACtB,OAAO,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,eAAe,EAC5B,WAAW,CAAC,EAAE,YAAY,GACzB,OAAO,CAAC,MAAM,CAAC;IA0BZ,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAcnE,yBAAyB,CACpC,IAAI,EAAE,GAAG,EACT,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,GAAG,CAAC;KACd,EACD,UAAU,EAAE,CAAC,YAAY,GAAG;QAAE,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,SAAS,EACrE,aAAa,GAAE,aAAkB;IAmDtB,eAAe,CAC1B,OAAO,EAAE,WAAW,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EACvC,cAAc,GAAE,cAAc,CAAC,MAAM,EAAE,MAAM,CAAM,EACnD,cAAc,GAAE,aAAkB,EAClC,UAAU,CAAC,EAAE,eAAe,GAAG;QAAE,mBAAmB,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9D,OAAO,CAAC,MAAM,CAAC;IAoDX,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,eAAe,GAAG,MAAM;IAK3E;;;;;;OAMG;cACa,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,UAAQ,EAAE,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,SAAI;CA8CjH;AAED,wBAAgB,qCAAqC,CAAC,GAAG,EAAE,8BAA8B,UAExF;AAOD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,UAEnD"}