viem 2.0.0-beta.6 → 2.0.0-beta.9

package/_types/chains/opStack/abis.d.ts

@@ -111,4 +111,439 @@ export declare const gasPriceOracleAbi: readonly [{
     readonly stateMutability: "view";
     readonly type: "function";
 }];
+export declare const portalAbi: readonly [{
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "version";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+        readonly indexed: false;
+    }];
+    readonly name: "Initialized";
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: false;
+    }];
+    readonly name: "Paused";
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "to";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "version";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+        readonly indexed: true;
+    }, {
+        readonly name: "opaqueData";
+        readonly internalType: "bytes";
+        readonly type: "bytes";
+        readonly indexed: false;
+    }];
+    readonly name: "TransactionDeposited";
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: false;
+    }];
+    readonly name: "Unpaused";
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "withdrawalHash";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+        readonly indexed: true;
+    }, {
+        readonly name: "success";
+        readonly internalType: "bool";
+        readonly type: "bool";
+        readonly indexed: false;
+    }];
+    readonly name: "WithdrawalFinalized";
+}, {
+    readonly type: "event";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "withdrawalHash";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+        readonly indexed: true;
+    }, {
+        readonly name: "from";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "to";
+        readonly internalType: "address";
+        readonly type: "address";
+        readonly indexed: true;
+    }];
+    readonly name: "WithdrawalProven";
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "GUARDIAN";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "L2_ORACLE";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "contract L2OutputOracle";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "SYSTEM_CONFIG";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "contract SystemConfig";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "payable";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_to";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "_value";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "_gasLimit";
+        readonly internalType: "uint64";
+        readonly type: "uint64";
+    }, {
+        readonly name: "_isCreation";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }, {
+        readonly name: "_data";
+        readonly internalType: "bytes";
+        readonly type: "bytes";
+    }];
+    readonly name: "depositTransaction";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "payable";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "donateETH";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_tx";
+        readonly internalType: "struct Types.WithdrawalTransaction";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "nonce";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "sender";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "target";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "value";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "gasLimit";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly name: "finalizeWithdrawalTransaction";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "finalizedWithdrawals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "guardian";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_l2Oracle";
+        readonly internalType: "contract L2OutputOracle";
+        readonly type: "address";
+    }, {
+        readonly name: "_guardian";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "_systemConfig";
+        readonly internalType: "contract SystemConfig";
+        readonly type: "address";
+    }, {
+        readonly name: "_paused";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly name: "initialize";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_l2OutputIndex";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "isOutputFinalized";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "l2Oracle";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "contract L2OutputOracle";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "l2Sender";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "pure";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_byteCount";
+        readonly internalType: "uint64";
+        readonly type: "uint64";
+    }];
+    readonly name: "minimumGasLimit";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "uint64";
+        readonly type: "uint64";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "params";
+    readonly outputs: readonly [{
+        readonly name: "prevBaseFee";
+        readonly internalType: "uint128";
+        readonly type: "uint128";
+    }, {
+        readonly name: "prevBoughtGas";
+        readonly internalType: "uint64";
+        readonly type: "uint64";
+    }, {
+        readonly name: "prevBlockNum";
+        readonly internalType: "uint64";
+        readonly type: "uint64";
+    }];
+}, {
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "pause";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "paused";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+}, {
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "_tx";
+        readonly internalType: "struct Types.WithdrawalTransaction";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "nonce";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "sender";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "target";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "value";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "gasLimit";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+    }, {
+        readonly name: "_l2OutputIndex";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "_outputRootProof";
+        readonly internalType: "struct Types.OutputRootProof";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "version";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "stateRoot";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "messagePasserStorageRoot";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "latestBlockhash";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }];
+    }, {
+        readonly name: "_withdrawalProof";
+        readonly internalType: "bytes[]";
+        readonly type: "bytes[]";
+    }];
+    readonly name: "proveWithdrawalTransaction";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "provenWithdrawals";
+    readonly outputs: readonly [{
+        readonly name: "outputRoot";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "timestamp";
+        readonly internalType: "uint128";
+        readonly type: "uint128";
+    }, {
+        readonly name: "l2OutputIndex";
+        readonly internalType: "uint128";
+        readonly type: "uint128";
+    }];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "systemConfig";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "contract SystemConfig";
+        readonly type: "address";
+    }];
+}, {
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "unpause";
+    readonly outputs: readonly [];
+}, {
+    readonly stateMutability: "view";
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "version";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "string";
+        readonly type: "string";
+    }];
+}, {
+    readonly stateMutability: "payable";
+    readonly type: "receive";
+}];
 //# sourceMappingURL=abis.d.ts.map

package/_types/chains/opStack/abis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"abis.d.ts","sourceRoot":"","sources":["../../../chains/opStack/abis.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwEpB,CAAA"}
+{"version":3,"file":"abis.d.ts","sourceRoot":"","sources":["../../../chains/opStack/abis.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwEpB,CAAA;AAEV,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4TZ,CAAA"}

package/_types/chains/opStack/actions/buildDepositTransaction.d.ts

@@ -0,0 +1,63 @@
+import type { Address } from 'abitype';
+import { type ParseAccountErrorType } from '../../../accounts/utils/parseAccount.js';
+import { type PrepareTransactionRequestErrorType } from '../../../actions/wallet/prepareTransactionRequest.js';
+import type { Client } from '../../../clients/createClient.js';
+import type { Transport } from '../../../clients/transports/createTransport.js';
+import type { ErrorType } from '../../../errors/utils.js';
+import type { Account, GetAccountParameter } from '../../../types/account.js';
+import type { Chain, DeriveChain, GetChainParameter } from '../../../types/chain.js';
+import type { Hex } from '../../../types/misc.js';
+import type { Prettify, UnionOmit } from '../../../types/utils.js';
+import type { DepositTransactionParameters } from './depositTransaction.js';
+export type BuildDepositTransactionParameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, chainOverride extends Chain | undefined = Chain | undefined, accountOverride extends Account | Address | undefined = Account | Address | undefined, _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>> = GetAccountParameter<account, accountOverride, false> & GetChainParameter<chain, chainOverride> & {
+    /** Gas limit for transaction execution on the L2. */
+    gas?: bigint;
+    /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
+    mint?: bigint;
+    /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+    value?: bigint;
+} & ({
+    /** Encoded contract method & arguments. */
+    data?: Hex;
+    /** Whether or not this is a contract deployment transaction. */
+    isCreation?: false;
+    /** L2 Transaction recipient. */
+    to?: Address;
+} | {
+    /** Contract deployment bytecode. Required for contract deployment transactions. */
+    data: Hex;
+    /** Whether or not this is a contract deployment transaction. */
+    isCreation: true;
+    /** L2 Transaction recipient. Cannot exist for contract deployment transactions. */
+    to?: never;
+});
+export type BuildDepositTransactionReturnType<account extends Account | undefined = Account | undefined, accountOverride extends Account | Address | undefined = Account | Address | undefined> = Prettify<UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> & GetAccountParameter<account, accountOverride>>;
+export type BuildDepositTransactionErrorType = ParseAccountErrorType | PrepareTransactionRequestErrorType | ErrorType;
+/**
+ * Prepares parameters for a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) to be initiated on an L1.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/buildDepositTransaction.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link BuildDepositTransactionParameters}
+ * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, http, parseEther } from 'viem'
+ * import { base } from 'viem/chains'
+ * import { publicActionsL2 } from 'viem/op-stack'
+ * import { buildDepositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: base,
+ *   transport: http(),
+ * }).extend(publicActionsL2())
+ *
+ * const request = await buildDepositTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
+ */
+export declare function buildDepositTransaction<chain extends Chain | undefined, account extends Account | undefined, chainOverride extends Chain | undefined = undefined, accountOverride extends Account | Address | undefined = undefined>(client: Client<Transport, chain, account>, args: BuildDepositTransactionParameters<chain, account, chainOverride, accountOverride>): Promise<BuildDepositTransactionReturnType<account, accountOverride>>;
+//# sourceMappingURL=buildDepositTransaction.d.ts.map

package/_types/chains/opStack/actions/buildDepositTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildDepositTransaction.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/actions/buildDepositTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EACL,KAAK,kCAAkC,EAGxC,MAAM,sDAAsD,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAC/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,iBAAiB,EAClB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AAE3E,MAAM,MAAM,iCAAiC,CAC3C,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACzD,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAC3D,eAAe,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GACjD,OAAO,GACP,OAAO,GACP,SAAS,EACb,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,WAAW,CAAC,KAAK,EAAE,aAAa,CAAC,IACzE,mBAAmB,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,GACtD,iBAAiB,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG;IACxC,qDAAqD;IACrD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sFAAsF;IACtF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+FAA+F;IAC/F,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,GAAG,CACA;IACE,2CAA2C;IAC3C,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,gEAAgE;IAChE,UAAU,CAAC,EAAE,KAAK,CAAA;IAClB,gCAAgC;IAChC,EAAE,CAAC,EAAE,OAAO,CAAA;CACb,GACD;IACE,mFAAmF;IACnF,IAAI,EAAE,GAAG,CAAA;IACT,gEAAgE;IAChE,UAAU,EAAE,IAAI,CAAA;IAChB,mFAAmF;IACnF,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,CACJ,CAAA;AAEH,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACzD,eAAe,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GACjD,OAAO,GACP,OAAO,GACP,SAAS,IACX,QAAQ,CACV,SAAS,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,GACvE,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAChD,CAAA;AAED,MAAM,MAAM,gCAAgC,GACxC,qBAAqB,GACrB,kCAAkC,GAClC,SAAS,CAAA;AAEb;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,uBAAuB,CAC3C,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACnD,eAAe,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAEjE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,IAAI,EAAE,iCAAiC,CACrC,KAAK,EACL,OAAO,EACP,aAAa,EACb,eAAe,CAChB,GACA,OAAO,CAAC,iCAAiC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAoCtE"}

package/_types/chains/opStack/actions/depositTransaction.d.ts

@@ -0,0 +1,96 @@
+import type { Address } from 'abitype';
+import { type WriteContractErrorType } from '../../../actions/wallet/writeContract.js';
+import type { Client } from '../../../clients/createClient.js';
+import type { Transport } from '../../../clients/transports/createTransport.js';
+import type { ErrorType } from '../../../errors/utils.js';
+import type { Account, GetAccountParameter } from '../../../types/account.js';
+import type { Chain, DeriveChain, GetChainParameter } from '../../../types/chain.js';
+import type { Hash, Hex } from '../../../types/misc.js';
+import type { UnionEvaluate, UnionOmit } from '../../../types/utils.js';
+import type { FormattedTransactionRequest } from '../../../utils/formatters/transactionRequest.js';
+import type { GetContractAddressParameter } from '../types/contract.js';
+export type DepositTransactionParameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, chainOverride extends Chain | undefined = Chain | undefined, _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>> = UnionEvaluate<UnionOmit<FormattedTransactionRequest<_derivedChain>, 'accessList' | 'data' | 'from' | 'gas' | 'gasPrice' | 'to' | 'type' | 'value'>> & GetAccountParameter<account, Account | Address> & GetChainParameter<chain, chainOverride> & GetContractAddressParameter<_derivedChain, 'portal'> & {
+    /** Arguments supplied to the L2 transaction. */
+    args: {
+        /** Gas limit for transaction execution on the L2. */
+        gas: bigint;
+        /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
+        mint?: bigint;
+        /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+        value?: bigint;
+    } & ({
+        /** Encoded contract method & arguments. */
+        data?: Hex;
+        /** Whether or not this is a contract deployment transaction. */
+        isCreation?: false;
+        /** L2 Transaction recipient. */
+        to?: Address;
+    } | {
+        /** Contract deployment bytecode. Required for contract deployment transactions. */
+        data: Hex;
+        /** Whether or not this is a contract deployment transaction. */
+        isCreation: true;
+        /** L2 Transaction recipient. Cannot exist for contract deployment transactions. */
+        to?: never;
+    });
+};
+export type DepositTransactionReturnType = Hash;
+export type DepositTransactionErrorType = WriteContractErrorType | ErrorType;
+/**
+ * Initiates a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) on an L1, which executes a transaction on L2.
+ *
+ * Internally performs a contract write to the [`depositTransaction` function](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L378)
+ * on the [Optimism Portal contract](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol).
+ *
+ * - Docs: https://viem.sh/op-stack/actions/depositTransaction.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link DepositTransactionParameters}
+ * @returns The L1 transaction hash. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom, parseEther } from 'viem'
+ * import { base, mainnet } from 'viem/chains'
+ * import { walletActionsL1 } from 'viem/op-stack'
+ * import { depositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await depositTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   args: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { base, mainnet } from 'viem/chains'
+ * import { walletActionsL1 } from 'viem/op-stack'
+ * import { depositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await depositTransaction(client, {
+ *   args: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ */
+export declare function depositTransaction<chain extends Chain | undefined, account extends Account | undefined, chainOverride extends Chain | undefined = undefined>(client: Client<Transport, chain, account>, args: DepositTransactionParameters<chain, account, chainOverride>): Promise<`0x${string}`>;
+//# sourceMappingURL=depositTransaction.d.ts.map

package/_types/chains/opStack/actions/depositTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"depositTransaction.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/actions/depositTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EACL,KAAK,sBAAsB,EAE5B,MAAM,0CAA0C,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAE/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,iBAAiB,EAClB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAA;AAElG,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAA;AAEvE,MAAM,MAAM,4BAA4B,CACtC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACzD,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAC3D,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,WAAW,CAAC,KAAK,EAAE,aAAa,CAAC,IACzE,aAAa,CACf,SAAS,CACP,2BAA2B,CAAC,aAAa,CAAC,EACxC,YAAY,GACZ,MAAM,GACN,MAAM,GACN,KAAK,GACL,UAAU,GACV,IAAI,GACJ,MAAM,GACN,OAAO,CACV,CACF,GACC,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAC/C,iBAAiB,CAAC,KAAK,EAAE,aAAa,CAAC,GACvC,2BAA2B,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG;IACrD,gDAAgD;IAChD,IAAI,EAAE;QACJ,qDAAqD;QACrD,GAAG,EAAE,MAAM,CAAA;QACX,sFAAsF;QACtF,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,+FAA+F;QAC/F,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,CACA;QACE,2CAA2C;QAC3C,IAAI,CAAC,EAAE,GAAG,CAAA;QACV,gEAAgE;QAChE,UAAU,CAAC,EAAE,KAAK,CAAA;QAClB,gCAAgC;QAChC,EAAE,CAAC,EAAE,OAAO,CAAA;KACb,GACD;QACE,mFAAmF;QACnF,IAAI,EAAE,GAAG,CAAA;QACT,gEAAgE;QAChE,UAAU,EAAE,IAAI,CAAA;QAChB,mFAAmF;QACnF,EAAE,CAAC,EAAE,KAAK,CAAA;KACX,CACJ,CAAA;CACF,CAAA;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAA;AAC/C,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,GAAG,SAAS,CAAA;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,IAAI,EAAE,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,0BAoClE"}

package/_types/chains/opStack/actions/estimateL1Fee.d.ts

@@ -5,20 +5,20 @@ import type { Client } from '../../../clients/createClient.js';
 import type { Transport } from '../../../clients/transports/createTransport.js';
 import type { ErrorType } from '../../../errors/utils.js';
 import type { Account, GetAccountParameter } from '../../../types/account.js';
-import { type Chain, type GetChain } from '../../../types/chain.js';
+import { type Chain, type GetChainParameter } from '../../../types/chain.js';
 import type { TransactionRequestEIP1559 } from '../../../types/transaction.js';
 import type { RequestErrorType } from '../../../utils/buildRequest.js';
 import { type HexToNumberErrorType } from '../../../utils/encoding/fromHex.js';
 import { type AssertRequestErrorType } from '../../../utils/transaction/assertRequest.js';
 import { type SerializeTransactionErrorType } from '../../../utils/transaction/serializeTransaction.js';
-export type EstimateL1FeeParameters<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = undefined> = Omit<TransactionRequestEIP1559, 'from'> & GetAccountParameter<TAccount> & GetChain<TChain, TChainOverride> & {
+export type EstimateL1FeeParameters<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = undefined> = Omit<TransactionRequestEIP1559, 'from'> & GetAccountParameter<TAccount> & GetChainParameter<TChain, TChainOverride> & {
     /** Gas price oracle address. */
     gasPriceOracleAddress?: Address;
 };
 export type EstimateL1FeeReturnType = bigint;
 export type EstimateL1FeeErrorType = RequestErrorType | PrepareTransactionRequestErrorType | AssertRequestErrorType | SerializeTransactionErrorType | HexToNumberErrorType | ReadContractErrorType | ErrorType;
 /**
- * Estimates the L1 fee required to execute an L2 transaction.
+ * Estimates the L1 data fee required to execute an L2 transaction.
  *
  * @param client - Client to use
  * @param parameters - {@link EstimateL1FeeParameters}

package/_types/chains/opStack/actions/estimateL1Fee.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"estimateL1Fee.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/actions/estimateL1Fee.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAGtC,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EACL,KAAK,kCAAkC,EAGxC,MAAM,sDAAsD,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAE/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAEnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAEtE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AAE9E,OAAO,EACL,KAAK,sBAAsB,EAE5B,MAAM,6CAA6C,CAAA;AACpD,OAAO,EACL,KAAK,6BAA6B,EAEnC,MAAM,oDAAoD,CAAA;AAI3D,MAAM,MAAM,uBAAuB,CACjC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,IAClD,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,GACzC,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG;IACjC,gCAAgC;IAChC,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAA;AAE5C,MAAM,MAAM,sBAAsB,GAC9B,gBAAgB,GAChB,kCAAkC,GAClC,sBAAsB,GACtB,6BAA6B,GAC7B,oBAAoB,GACpB,qBAAqB,GACrB,SAAS,CAAA;AAQb;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,aAAa,CACjC,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEpD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC3C,IAAI,EAAE,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,GAC9D,OAAO,CAAC,uBAAuB,CAAC,CA6ClC"}
+{"version":3,"file":"estimateL1Fee.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/actions/estimateL1Fee.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAGtC,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EACL,KAAK,kCAAkC,EAGxC,MAAM,sDAAsD,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAE/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAE5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAEtE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,oCAAoC,CAAA;AAE9E,OAAO,EACL,KAAK,sBAAsB,EAE5B,MAAM,6CAA6C,CAAA;AACpD,OAAO,EACL,KAAK,6BAA6B,EAEnC,MAAM,oDAAoD,CAAA;AAI3D,MAAM,MAAM,uBAAuB,CACjC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,IAClD,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,GACzC,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG;IAC1C,gCAAgC;IAChC,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAA;AAE5C,MAAM,MAAM,sBAAsB,GAC9B,gBAAgB,GAChB,kCAAkC,GAClC,sBAAsB,GACtB,6BAA6B,GAC7B,oBAAoB,GACpB,qBAAqB,GACrB,SAAS,CAAA;AAQb;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,aAAa,CACjC,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEpD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC3C,IAAI,EAAE,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,GAC9D,OAAO,CAAC,uBAAuB,CAAC,CA6ClC"}

package/_types/chains/opStack/actions/estimateL1Gas.d.ts

@@ -5,13 +5,13 @@ import type { Client } from '../../../clients/createClient.js';
 import type { Transport } from '../../../clients/transports/createTransport.js';
 import type { ErrorType } from '../../../errors/utils.js';
 import type { Account, GetAccountParameter } from '../../../types/account.js';
-import { type Chain, type GetChain } from '../../../types/chain.js';
+import { type Chain, type GetChainParameter } from '../../../types/chain.js';
 import type { TransactionRequestEIP1559 } from '../../../types/transaction.js';
 import type { RequestErrorType } from '../../../utils/buildRequest.js';
 import { type HexToNumberErrorType } from '../../../utils/encoding/fromHex.js';
 import { type AssertRequestErrorType } from '../../../utils/transaction/assertRequest.js';
 import { type SerializeTransactionErrorType } from '../../../utils/transaction/serializeTransaction.js';
-export type EstimateL1GasParameters<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = Chain | undefined> = Omit<TransactionRequestEIP1559, 'from'> & GetAccountParameter<TAccount> & GetChain<TChain, TChainOverride> & {
+export type EstimateL1GasParameters<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = Chain | undefined> = Omit<TransactionRequestEIP1559, 'from'> & GetAccountParameter<TAccount> & GetChainParameter<TChain, TChainOverride> & {
     /** Gas price oracle address. */
     gasPriceOracleAddress?: Address;
 };