@aztec/ethereum 2.0.3 → 2.1.0-rc.2

package/dest/l1_tx_utils/index.d.ts

@@ -0,0 +1,10 @@
+export * from './config.js';
+export * from './constants.js';
+export * from './factory.js';
+export * from './interfaces.js';
+export * from './l1_tx_utils.js';
+export * from './readonly_l1_tx_utils.js';
+export * from './signer.js';
+export * from './types.js';
+export * from './utils.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/l1_tx_utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/l1_tx_utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dest/l1_tx_utils/index.js

@@ -0,0 +1,10 @@
+export * from './config.js';
+export * from './constants.js';
+export * from './factory.js';
+export * from './interfaces.js';
+export * from './l1_tx_utils.js';
+export * from './readonly_l1_tx_utils.js';
+export * from './signer.js';
+export * from './types.js';
+export * from './utils.js'; // Note: We intentionally do not export l1_tx_utils_with_blobs.js
+ // to avoid accidentally importing blob-lib dependency.

package/dest/l1_tx_utils/interfaces.d.ts

@@ -0,0 +1,76 @@
+import type { L1BlobInputs, L1TxState } from './types.js';
+/**
+ * Interface for L1 transaction state storage.
+ * Implementations handle persistence of transaction states across restarts.
+ */
+export interface IL1TxStore {
+    /**
+     * Gets the next available state ID for an account.
+     */
+    consumeNextStateId(account: string): Promise<number>;
+    /**
+     * Saves a single transaction state for a specific account.
+     * Does not save blob data (see saveBlobs).
+     * @param account - The sender account address
+     * @param state - Transaction state to save
+     */
+    saveState(account: string, state: L1TxState): Promise<L1TxState>;
+    /**
+     * Saves blobs for a given state.
+     * @param account - The sender account address
+     * @param stateId - The state ID
+     * @param blobInputs - Blob inputs to save
+     */
+    saveBlobs(account: string, stateId: number, blobInputs: L1BlobInputs | undefined): Promise<void>;
+    /**
+     * Loads all transaction states for a specific account.
+     * @param account - The sender account address
+     * @returns Array of transaction states with their IDs
+     */
+    loadStates(account: string): Promise<L1TxState[]>;
+    /**
+     * Loads a single state by ID.
+     * @param account - The sender account address
+     * @param stateId - The state ID
+     * @returns The transaction state or undefined if not found
+     */
+    loadState(account: string, stateId: number): Promise<L1TxState | undefined>;
+    /**
+     * Deletes a specific state and its associated blobs.
+     * @param account - The sender account address
+     * @param stateId - The state ID to delete
+     */
+    deleteState(account: string, stateId: number): Promise<void>;
+    /**
+     * Clears all transaction states for a specific account.
+     * @param account - The sender account address
+     */
+    clearStates(account: string): Promise<void>;
+    /**
+     * Gets all accounts that have stored states.
+     * @returns Array of account addresses
+     */
+    getAllAccounts(): Promise<string[]>;
+    /**
+     * Closes the store.
+     */
+    close(): Promise<void>;
+}
+/**
+ * Interface for L1 transaction metrics recording.
+ * Implementations handle tracking of transaction lifecycle and gas costs.
+ */
+export interface IL1TxMetrics {
+    /**
+     * Records metrics when a transaction is mined
+     * @param state - The L1 transaction state
+     * @param l1Timestamp - The current L1 timestamp
+     */
+    recordMinedTx(state: L1TxState, l1Timestamp: Date): void;
+    /**
+     * Records metrics when a transaction is dropped
+     * @param state - The L1 transaction state
+     */
+    recordDroppedTx(state: L1TxState): void;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dest/l1_tx_utils/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/l1_tx_utils/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAErD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjG;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAElD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE5E;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CACzC"}

package/dest/l1_tx_utils/interfaces.js

@@ -0,0 +1,4 @@
+/**
+ * Interface for L1 transaction metrics recording.
+ * Implementations handle tracking of transaction lifecycle and gas costs.
+ */ export { };

package/dest/l1_tx_utils/l1_tx_utils.d.ts

@@ -0,0 +1,95 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { type Logger } from '@aztec/foundation/log';
+import { DateProvider } from '@aztec/foundation/timer';
+import { type Abi, type BlockOverrides, type Hex, type NonceManager, type PrepareTransactionRequestRequest, type StateOverride, type TransactionReceipt } from 'viem';
+import type { ViemClient } from '../types.js';
+import { type L1TxUtilsConfig } from './config.js';
+import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
+import { ReadOnlyL1TxUtils } from './readonly_l1_tx_utils.js';
+import { type L1BlobInputs, type L1TxConfig, type L1TxRequest, type L1TxState, type SigningCallback, TxUtilsState } from './types.js';
+export declare class L1TxUtils extends ReadOnlyL1TxUtils {
+    client: ViemClient;
+    address: EthAddress;
+    protected signer: SigningCallback;
+    protected store?: IL1TxStore | undefined;
+    protected metrics?: IL1TxMetrics | undefined;
+    protected nonceManager: NonceManager;
+    protected txs: L1TxState[];
+    constructor(client: ViemClient, address: EthAddress, signer: SigningCallback, logger?: Logger, dateProvider?: DateProvider, config?: Partial<L1TxUtilsConfig>, debugMaxGasLimit?: boolean, store?: IL1TxStore | undefined, metrics?: IL1TxMetrics | undefined);
+    get state(): TxUtilsState;
+    get lastMinedAtBlockNumber(): bigint | undefined;
+    protected updateState(l1TxState: L1TxState, newState: TxUtilsState.MINED, l1Timestamp: number): Promise<void>;
+    protected updateState(l1TxState: L1TxState, newState: TxUtilsState, l1Timestamp?: undefined): Promise<void>;
+    updateConfig(newConfig: Partial<L1TxUtilsConfig>): void;
+    getSenderAddress(): EthAddress;
+    getSenderBalance(): Promise<bigint>;
+    /**
+     * Rehydrates transaction states from the store and resumes monitoring for pending transactions.
+     * This should be called on startup to restore state and resume monitoring of any in-flight transactions.
+     */
+    loadStateAndResumeMonitoring(): Promise<void>;
+    private signTransaction;
+    protected prepareSignedTransaction(txData: PrepareTransactionRequestRequest): Promise<`0x${string}`>;
+    /**
+     * 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, gasConfigOverrides?: L1TxConfig, blobInputs?: L1BlobInputs, stateChange?: TxUtilsState): Promise<{
+        txHash: Hex;
+        state: L1TxState;
+    }>;
+    private tryGetTxReceipt;
+    /**
+     * Returns whether a given tx should be considered as timed out and no longer monitored.
+     * Relies on the txTimeout setting for user txs, and on the txCancellationTimeout for cancel txs.
+     * @remarks We check against the latestBlockTimestamp as opposed to the current time to avoid a race condition where
+     * the tx is mined in a block with the same timestamp as txTimeoutAt, but our execution node has not yet processed it,
+     * or the loop here has not yet checked the tx before that timeout.
+     */
+    private isTxTimedOut;
+    /**
+     * Monitors a transaction until completion, handling speed-ups if needed
+     */
+    protected monitorTransaction(state: L1TxState): Promise<TransactionReceipt>;
+    /**
+     * Creates tx data to be signed by viem signTransaction method, using the state as input.
+     * If isCancelTx is true, creates a 0-value tx to self with 21k gas and no data instead,
+     * and an empty blob input if the original tx also had blobs.
+     */
+    private makeTxData;
+    /** Returns when all monitor loops have stopped. */
+    waitMonitoringStopped(timeoutSeconds?: number): Promise<void>;
+    /**
+     * 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?: L1TxConfig, blobInputs?: L1BlobInputs): Promise<{
+        receipt: TransactionReceipt;
+        state: L1TxState;
+    }>;
+    simulate(request: L1TxRequest & {
+        gas?: bigint;
+        from?: Hex;
+    }, _blockOverrides?: BlockOverrides<bigint, number>, stateOverrides?: StateOverride, abi?: Abi, _gasConfig?: L1TxUtilsConfig & {
+        fallbackGasEstimate?: bigint;
+        ignoreBlockGasLimit?: boolean;
+    }): Promise<{
+        gasUsed: bigint;
+        result: `0x${string}`;
+    }>;
+    /**
+     * Attempts to cancel a transaction by sending a 0-value tx to self with same nonce but higher gas prices
+     * Only sends the cancellation if the original tx is still pending, not if it was dropped
+     * @returns The hash of the cancellation transaction
+     */
+    protected attemptTxCancellation(state: L1TxState): Promise<void>;
+    /** Returns L1 timestamps in milliseconds */
+    private getL1Timestamp;
+    /** Makes empty blob inputs for the cancellation tx. To be overridden in L1TxUtilsWithBlobs. */
+    protected makeEmptyBlobInputs(_maxFeePerBlobGas: bigint): Required<L1BlobInputs>;
+}
+//# sourceMappingURL=l1_tx_utils.d.ts.map

package/dest/l1_tx_utils/l1_tx_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"l1_tx_utils.d.ts","sourceRoot":"","sources":["../../src/l1_tx_utils/l1_tx_utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAGlE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAIvD,OAAO,EACL,KAAK,GAAG,EACR,KAAK,cAAc,EACnB,KAAK,GAAG,EACR,KAAK,YAAY,EACjB,KAAK,gCAAgC,EACrC,KAAK,aAAa,EAClB,KAAK,kBAAkB,EAKxB,MAAM,MAAM,CAAC;AAGd,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,KAAK,eAAe,EAA2B,MAAM,aAAa,CAAC;AAE5E,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,eAAe,EAEpB,YAAY,EAEb,MAAM,YAAY,CAAC;AAIpB,qBAAa,SAAU,SAAQ,iBAAiB;IAK5B,MAAM,EAAE,UAAU;IAC3B,OAAO,EAAE,UAAU;IAC1B,SAAS,CAAC,MAAM,EAAE,eAAe;IAKjC,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU;IAC5B,SAAS,CAAC,OAAO,CAAC,EAAE,YAAY;IAZlC,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;IACrC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,CAAM;gBAGd,MAAM,EAAE,UAAU,EAC3B,OAAO,EAAE,UAAU,EAChB,MAAM,EAAE,eAAe,EACjC,MAAM,GAAE,MAA2C,EACnD,YAAY,GAAE,YAAiC,EAC/C,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,EACjC,gBAAgB,GAAE,OAAe,EACvB,KAAK,CAAC,EAAE,UAAU,YAAA,EAClB,OAAO,CAAC,EAAE,YAAY,YAAA;IAMlC,IAAW,KAAK,iBAEf;IAED,IAAW,sBAAsB,uBAGhC;cAEe,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cACnG,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB1G,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC;IAQhD,gBAAgB;IAIhB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAM1C;;;OAGG;IACU,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;YAsC5C,eAAe;cAKb,wBAAwB,CAAC,MAAM,EAAE,gCAAgC;IAKjF;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,WAAW,EACpB,kBAAkB,CAAC,EAAE,UAAU,EAC/B,UAAU,CAAC,EAAE,YAAY,EACzB,WAAW,GAAE,YAAgC,GAC5C,OAAO,CAAC;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;YA8F/B,eAAe;IA6B7B;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAyCpB;;OAEG;cACa,kBAAkB,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsLjF;;;;OAIG;IACH,OAAO,CAAC,UAAU;IA8BlB,mDAAmD;IACtC,qBAAqB,CAAC,cAAc,SAAK;IAUtD;;;;;OAKG;IACU,yBAAyB,CACpC,OAAO,EAAE,WAAW,EACpB,SAAS,CAAC,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,YAAY,GACxB,OAAO,CAAC;QAAE,OAAO,EAAE,kBAAkB,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;IAMvC,QAAQ,CAC5B,OAAO,EAAE,WAAW,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAE,EACnD,eAAe,GAAE,cAAc,CAAC,MAAM,EAAE,MAAM,CAAM,EACpD,cAAc,GAAE,aAAkB,EAClC,GAAG,GAAE,GAAe,EACpB,UAAU,CAAC,EAAE,eAAe,GAAG;QAAE,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7F,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;KAAE,CAAC;IAsBtD;;;;OAIG;cACa,qBAAqB,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA8EtE,4CAA4C;YAC9B,cAAc;IAK5B,+FAA+F;IAC/F,SAAS,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC;CAGjF"}