viem 2.7.5 → 2.7.6

package/_types/chains/opStack/decorators/publicL2.d.ts

@@ -0,0 +1,312 @@
+import type { Abi, Address } from 'abitype';
+import type { Client } from '../../../clients/createClient.js';
+import type { Transport } from '../../../clients/transports/createTransport.js';
+import type { Account } from '../../../types/account.js';
+import type { Chain } from '../../../types/chain.js';
+import type { ContractFunctionArgs, ContractFunctionName } from '../../../types/contract.js';
+import { type BuildDepositTransactionParameters, type BuildDepositTransactionReturnType } from '../actions/buildDepositTransaction.js';
+import { type BuildProveWithdrawalParameters, type BuildProveWithdrawalReturnType } from '../actions/buildProveWithdrawal.js';
+import { type EstimateContractL1FeeParameters, type EstimateContractL1FeeReturnType } from '../actions/estimateContractL1Fee.js';
+import { type EstimateContractL1GasParameters, type EstimateContractL1GasReturnType } from '../actions/estimateContractL1Gas.js';
+import { type EstimateContractTotalFeeParameters, type EstimateContractTotalFeeReturnType } from '../actions/estimateContractTotalFee.js';
+import { type EstimateContractTotalGasParameters, type EstimateContractTotalGasReturnType } from '../actions/estimateContractTotalGas.js';
+import { type EstimateInitiateWithdrawalGasParameters, type EstimateInitiateWithdrawalGasReturnType } from '../actions/estimateInitiateWithdrawalGas.js';
+import { type EstimateL1FeeParameters, type EstimateL1FeeReturnType } from '../actions/estimateL1Fee.js';
+import { type EstimateL1GasParameters, type EstimateL1GasReturnType } from '../actions/estimateL1Gas.js';
+import { type EstimateTotalFeeParameters, type EstimateTotalFeeReturnType } from '../actions/estimateTotalFee.js';
+import { type EstimateTotalGasParameters, type EstimateTotalGasReturnType } from '../actions/estimateTotalGas.js';
+export type PublicActionsL2<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
+    /**
+     * 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
+     *
+     * @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'
+     *
+     * const client = createWalletClient({
+     *   chain: base,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const args = await client.buildDepositTransaction({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: parseEther('1'),
+     * })
+     */
+    buildDepositTransaction: <chainOverride extends Chain | undefined = undefined, accountOverride extends Account | Address | undefined = undefined>(parameters: BuildDepositTransactionParameters<chain, account, chainOverride, accountOverride>) => Promise<BuildDepositTransactionReturnType<account, accountOverride>>;
+    /**
+     * Builds the transaction that proves a withdrawal was initiated on an L2. Used in the Withdrawal flow.
+     *
+     * - Docs: https://viem.sh/op-stack/actions/buildProveWithdrawal
+     *
+     * @param client - Client to use
+     * @param parameters - {@link BuildProveWithdrawalParameters}
+     * @returns The prove withdraw transaction request. {@link BuildProveWithdrawalReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const publicClientL2 = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const args = await publicClientL2.buildProveWithdrawal({
+     *   output: { ... },
+     *   withdrawal: { ... },
+     * })
+     */
+    buildProveWithdrawal: <chainOverride extends Chain | undefined = undefined, accountOverride extends Account | Address | undefined = undefined>(parameters: BuildProveWithdrawalParameters<chain, account, chainOverride, accountOverride>) => Promise<BuildProveWithdrawalReturnType<chain, account, chainOverride, accountOverride>>;
+    /**
+     * Estimates the L1 data fee required to execute an L2 contract write.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateContractL1FeeParameters}
+     * @returns The gas estimate (in wei). {@link EstimateContractL1FeeReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseAbi } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const l1Fee = await client.estimateContractL1Fee({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint() public']),
+     *   functionName: 'mint',
+     *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+     * })
+     */
+    estimateContractL1Fee: <const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>, args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>, chainOverride extends Chain | undefined = undefined>(parameters: EstimateContractL1FeeParameters<abi, functionName, args, chain, account, chainOverride>) => Promise<EstimateContractL1FeeReturnType>;
+    /**
+     * Estimates the L1 data gas required to successfully execute a contract write function call.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateContractL1GasParameters}
+     * @returns The gas estimate (in wei). {@link EstimateContractL1GasReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseAbi } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const l1Gas = await client.estimateContractL1Gas({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint() public']),
+     *   functionName: 'mint',
+     *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+     * })
+     */
+    estimateContractL1Gas: <const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>, args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>, chainOverride extends Chain | undefined = undefined>(parameters: EstimateContractL1GasParameters<abi, functionName, args, chain, account, chainOverride>) => Promise<EstimateContractL1GasReturnType>;
+    /**
+     * Estimates the L1 + L2 fee to execute an L2 contract write.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateContractTotalFeeParameters}
+     * @returns The gas estimate (in wei). {@link EstimateContractTotalFeeReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseAbi } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const totalFee = await client.estimateContractTotalFee({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint() public']),
+     *   functionName: 'mint',
+     *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+     * })
+     */
+    estimateContractTotalFee: <const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>, args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>, chainOverride extends Chain | undefined = undefined>(parameters: EstimateContractTotalFeeParameters<abi, functionName, args, chain, account, chainOverride>) => Promise<EstimateContractTotalFeeReturnType>;
+    /**
+     * Estimates the L1 data gas + L2 gas required to successfully execute a contract write function call.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateContractTotalGasParameters}
+     * @returns The gas estimate (in wei). {@link EstimateContractTotalGasReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseAbi } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const totalGas = await client.estimateContractTotalGas({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint() public']),
+     *   functionName: 'mint',
+     *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+     * })
+     */
+    estimateContractTotalGas: <const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>, args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>, chainOverride extends Chain | undefined = undefined>(parameters: EstimateContractTotalGasParameters<abi, functionName, args, chain, account, chainOverride>) => Promise<EstimateContractTotalGasReturnType>;
+    /**
+     * Estimates gas required to initiate a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) on an L2 to the L1.
+     *
+     * - Docs: https://viem.sh/op-stack/actions/estimateInitiateWithdrawalGas
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateInitiateWithdrawalGasParameters}
+     * @returns The gas required. {@link EstimateInitiateWithdrawalGasReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseEther } from 'viem'
+     * import { base, mainnet } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: mainnet,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const hash = await client.estimateInitiateWithdrawalGas({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   request: {
+     *     gas: 21_000n,
+     *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *     value: parseEther('1'),
+     *   },
+     * })
+     */
+    estimateInitiateWithdrawalGas: <chainOverride extends Chain | undefined = undefined>(parameters: EstimateInitiateWithdrawalGasParameters<chain, account, chainOverride>) => Promise<EstimateInitiateWithdrawalGasReturnType>;
+    /**
+     * Estimates the L1 data fee required to execute an L2 transaction.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateL1FeeParameters}
+     * @returns The fee (in wei). {@link EstimateL1FeeReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseEther } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const l1Fee = await client.estimateL1Fee({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: parseEther('1'),
+     * })
+     */
+    estimateL1Fee: <chainOverride extends Chain | undefined = undefined>(parameters: EstimateL1FeeParameters<chain, account, chainOverride>) => Promise<EstimateL1FeeReturnType>;
+    /**
+     * Estimates the amount of L1 data gas required to execute an L2 transaction.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateL1GasParameters}
+     * @returns The gas estimate. {@link EstimateL1GasReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseEther } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const l1Gas = await client.estimateL1Gas({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: parseEther('1'),
+     * })
+     */
+    estimateL1Gas: <chainOverride extends Chain | undefined = undefined>(parameters: EstimateL1GasParameters<chain, account, chainOverride>) => Promise<EstimateL1GasReturnType>;
+    /**
+     * Estimates the L1 data fee + L2 fee to execute an L2 transaction.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateTotalFeeParameters}
+     * @returns The gas estimate. {@link EstimateTotalFeeReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseEther } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const totalFee = await client.estimateTotalFee({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: parseEther('1'),
+     * })
+     */
+    estimateTotalFee: <chainOverride extends Chain | undefined = undefined>(parameters: EstimateTotalFeeParameters<chain, account, chainOverride>) => Promise<EstimateTotalFeeReturnType>;
+    /**
+     * Estimates the total amount of combined L1 data gas + L2 gas required to execute an L2 transaction.
+     *
+     * @param client - Client to use
+     * @param parameters - {@link EstimateTotalGasParameters}
+     * @returns The gas estimate. {@link EstimateTotalGasReturnType}
+     *
+     * @example
+     * import { createPublicClient, http, parseEther } from 'viem'
+     * import { optimism } from 'viem/chains'
+     * import { publicActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createPublicClient({
+     *   chain: optimism,
+     *   transport: http(),
+     * }).extend(publicActionsL2())
+     *
+     * const totalGas = await client.estimateTotalGas({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: parseEther('1'),
+     * })
+     */
+    estimateTotalGas: <chainOverride extends Chain | undefined = undefined>(parameters: EstimateTotalGasParameters<chain, account, chainOverride>) => Promise<EstimateTotalGasReturnType>;
+};
+/**
+ * A suite of Public Actions for suited for development with Layer 2 (OP Stack) chains.
+ *
+ * - Docs: https://viem.sh/op-stack/client
+ *
+ * @example
+ * import { publicActionsL2 } from 'viem/op-stack'
+ * import { optimism } from 'viem/chains'
+ * import { buildDepositTransaction } from 'viem/wallet'
+ *
+ * export const opStackPublicClientL1 = createWalletClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * }).extend(publicActionsL1())
+ */
+export declare function publicActionsL2(): <TTransport extends Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>) => PublicActionsL2<TChain, TAccount>;
+//# sourceMappingURL=publicL2.d.ts.map

package/_types/chains/opStack/decorators/publicL2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicL2.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/decorators/publicL2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,iCAAiC,EACtC,KAAK,iCAAiC,EAEvC,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,KAAK,8BAA8B,EACnC,KAAK,8BAA8B,EAEpC,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EAErC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EAErC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,kCAAkC,EACvC,KAAK,kCAAkC,EAExC,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,kCAAkC,EACvC,KAAK,kCAAkC,EAExC,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,uCAAuC,EAC5C,KAAK,uCAAuC,EAE7C,MAAM,6CAA6C,CAAA;AACpD,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAEhC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAEhC,MAAM,gCAAgC,CAAA;AAEvC,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,uBAAuB,EAAE,CACvB,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACnD,eAAe,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAEjE,UAAU,EAAE,iCAAiC,CAC3C,KAAK,EACL,OAAO,EACP,aAAa,EACb,eAAe,CAChB,KACE,OAAO,CAAC,iCAAiC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,oBAAoB,EAAE,CACpB,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACnD,eAAe,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAEjE,UAAU,EAAE,8BAA8B,CACxC,KAAK,EACL,OAAO,EACP,aAAa,EACb,eAAe,CAChB,KACE,OAAO,CACV,8BAA8B,CAC5B,KAAK,EACL,OAAO,EACP,aAAa,EACb,eAAe,CAChB,CACF,CAAA;IACD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBAAqB,EAAE,CACrB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,+BAA+B,CACzC,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBAAqB,EAAE,CACrB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,+BAA+B,CACzC,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,wBAAwB,EAAE,CACxB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,kCAAkC,CAC5C,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAChD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,wBAAwB,EAAE,CACxB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,kCAAkC,CAC5C,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,6BAA6B,EAAE,CAC7B,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,uCAAuC,CACjD,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,uCAAuC,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACjE,UAAU,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAC/D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACjE,UAAU,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAC/D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBAAgB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACpE,UAAU,EAAE,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAClE,OAAO,CAAC,0BAA0B,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBAAgB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACpE,UAAU,EAAE,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAClE,OAAO,CAAC,0BAA0B,CAAC,CAAA;CACzC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,wOAyB9B"}

package/_types/chains/opStack/decorators/walletL1.d.ts

@@ -0,0 +1,136 @@
+import type { Client } from '../../../clients/createClient.js';
+import type { Transport } from '../../../clients/transports/createTransport.js';
+import type { Account } from '../../../types/account.js';
+import type { Chain } from '../../../types/chain.js';
+import { type DepositTransactionParameters, type DepositTransactionReturnType } from '../actions/depositTransaction.js';
+import { type FinalizeWithdrawalParameters, type FinalizeWithdrawalReturnType } from '../actions/finalizeWithdrawal.js';
+import { type ProveWithdrawalParameters, type ProveWithdrawalReturnType } from '../actions/proveWithdrawal.js';
+export type WalletActionsL1<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
+    /**
+     * 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
+     *
+     * @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'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * }).extend(walletActionsL1())
+     *
+     * const hash = await client.depositTransaction({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   request: {
+     *     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'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * }).extend(walletActionsL1())
+     *
+     * const hash = await client.depositTransaction({
+     *   request: {
+     *     gas: 21_000n,
+     *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *     value: parseEther('1'),
+     *   },
+     *   targetChain: base,
+     * })
+     */
+    depositTransaction: <chainOverride extends Chain | undefined = undefined>(parameters: DepositTransactionParameters<chain, account, chainOverride>) => Promise<DepositTransactionReturnType>;
+    /**
+     * Finalizes a withdrawal that occurred on an L2. Used in the Withdrawal flow.
+     *
+     * - Docs: https://viem.sh/op-stack/actions/finalizeWithdrawal
+     *
+     * @param client - Client to use
+     * @param parameters - {@link FinalizeWithdrawalParameters}
+     * @returns The finalize transaction hash. {@link FinalizeWithdrawalReturnType}
+     *
+     * @example
+     * import { createWalletClient, http } from 'viem'
+     * import { mainnet, optimism } from 'viem/chains'
+     * import { walletActionsL1 } from 'viem/op-stack'
+     *
+     * const walletClientL1 = createWalletClient({
+     *   chain: mainnet,
+     *   transport: http(),
+     * }).extend(walletActionsL1)
+     *
+     * const hash = await walletClientL1.finalizeWithdrawal({
+     *   targetChain: optimism,
+     *   withdrawal: { ... },
+     * })
+     */
+    finalizeWithdrawal: <chainOverride extends Chain | undefined = undefined>(parameters: FinalizeWithdrawalParameters<chain, account, chainOverride>) => Promise<FinalizeWithdrawalReturnType>;
+    /**
+     * Proves a withdrawal that occurred on an L2. Used in the Withdrawal flow.
+     *
+     * - Docs: https://viem.sh/op-stack/actions/proveWithdrawal
+     *
+     * @param client - Client to use
+     * @param parameters - {@link ProveWithdrawalParameters}
+     * @returns The prove transaction hash. {@link ProveWithdrawalReturnType}
+     *
+     * @example
+     * import { createWalletClient, http } from 'viem'
+     * import { mainnet, optimism } from 'viem/chains'
+     * import { walletActionsL1 } from 'viem/op-stack'
+     *
+     * const walletClientL1 = createWalletClient({
+     *   chain: mainnet,
+     *   transport: http(),
+     * }).extend(walletActionsL1())
+     *
+     * const hash = await walletClientL1.proveWithdrawal({
+     *   l2OutputIndex: 4529n,
+     *   outputRootProof: { ... },
+     *   targetChain: optimism,
+     *   withdrawalProof: [ ... ],
+     *   withdrawalTransaction: { ... },
+     * })
+     */
+    proveWithdrawal: <chainOverride extends Chain | undefined = undefined>(parameters: ProveWithdrawalParameters<chain, account, chainOverride>) => Promise<ProveWithdrawalReturnType>;
+};
+/**
+ * A suite of Wallet Actions for suited for development with Layer 2 (OP Stack) chains.
+ *
+ * - Docs: https://viem.sh/op-stack/client
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { walletActionsL1 } from 'viem/op-stack'
+ *
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await walletClient.depositTransaction({...})
+ */
+export declare function walletActionsL1(): <TTransport extends Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>) => WalletActionsL1<TChain, TAccount>;
+//# sourceMappingURL=walletL1.d.ts.map

package/_types/chains/opStack/decorators/walletL1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"walletL1.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/decorators/walletL1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAElC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAElC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAE/B,MAAM,+BAA+B,CAAA;AAEtC,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,kBAAkB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACtE,UAAU,EAAE,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KACpE,OAAO,CAAC,4BAA4B,CAAC,CAAA;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,kBAAkB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACtE,UAAU,EAAE,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KACpE,OAAO,CAAC,4BAA4B,CAAC,CAAA;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,eAAe,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACnE,UAAU,EAAE,yBAAyB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KACjE,OAAO,CAAC,yBAAyB,CAAC,CAAA;CACxC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,wOAc9B"}

package/_types/chains/opStack/decorators/walletL2.d.ts

@@ -0,0 +1,79 @@
+import type { Client } from '../../../clients/createClient.js';
+import type { Transport } from '../../../clients/transports/createTransport.js';
+import type { Account } from '../../../types/account.js';
+import type { Chain } from '../../../types/chain.js';
+import { type InitiateWithdrawalParameters, type InitiateWithdrawalReturnType } from '../actions/initiateWithdrawal.js';
+export type WalletActionsL2<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
+    /**
+     * Initiates a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) on an L2 to the L1.
+     *
+     * Internally performs a contract write to the [`initiateWithdrawal` function](https://github.com/ethereum-optimism/optimism/blob/283f0aa2e3358ced30ff7cbd4028c0c0c3faa140/packages/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol#L73)
+     * on the [Optimism L2ToL1MessagePasser predeploy contract](https://github.com/ethereum-optimism/optimism/blob/283f0aa2e3358ced30ff7cbd4028c0c0c3faa140/packages/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol).
+     *
+     * - Docs: https://viem.sh/op-stack/actions/initiateWithdrawal
+     *
+     * @param client - Client to use
+     * @param parameters - {@link InitiateWithdrawalParameters}
+     * @returns The L2 transaction hash. {@link InitiateWithdrawalReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom, parseEther } from 'viem'
+     * import { base, mainnet } from 'viem/chains'
+     * import { walletActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * }).extend(walletActionsL2())
+     *
+     * const hash = await client.initiateWithdrawal({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   args: {
+     *     gas: 21_000n,
+     *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *     value: parseEther('1'),
+     *   },
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { base, mainnet } from 'viem/chains'
+     * import { walletActionsL2 } from 'viem/op-stack'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * }).extend(walletActionsL2())
+     *
+     * const hash = await client.initiateWithdrawal({
+     *   args: {
+     *     gas: 21_000n,
+     *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *     value: parseEther('1'),
+     *   },
+     * })
+     */
+    initiateWithdrawal: <chainOverride extends Chain | undefined = undefined>(parameters: InitiateWithdrawalParameters<chain, account, chainOverride>) => Promise<InitiateWithdrawalReturnType>;
+};
+/**
+ * A suite of Wallet Actions for suited for development with Layer 2 (OP Stack) chains.
+ *
+ * - Docs: https://viem.sh/op-stack/client
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { walletActionsL1 } from 'viem/op-stack'
+ *
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await walletClient.depositTransaction({...})
+ */
+export declare function walletActionsL2(): <TTransport extends Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>) => WalletActionsL2<TChain, TAccount>;
+//# sourceMappingURL=walletL2.d.ts.map

package/_types/chains/opStack/decorators/walletL2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"walletL2.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/decorators/walletL2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAElC,MAAM,kCAAkC,CAAA;AAEzC,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,kBAAkB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACtE,UAAU,EAAE,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KACpE,OAAO,CAAC,4BAA4B,CAAC,CAAA;CAC3C,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,wOAY9B"}

package/_types/chains/opStack/errors/withdrawal.d.ts

@@ -0,0 +1,12 @@
+import { BaseError } from '../../../errors/base.js';
+import type { Hex } from '../../../types/misc.js';
+export type ReceiptContainsNoWithdrawalsErrorType = ReceiptContainsNoWithdrawalsError & {
+    name: 'ReceiptContainsNoWithdrawalsError';
+};
+export declare class ReceiptContainsNoWithdrawalsError extends BaseError {
+    name: string;
+    constructor({ hash }: {
+        hash: Hex;
+    });
+}
+//# sourceMappingURL=withdrawal.d.ts.map

package/_types/chains/opStack/errors/withdrawal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/errors/withdrawal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAA;AAEjD,MAAM,MAAM,qCAAqC,GAC/C,iCAAiC,GAAG;IAClC,IAAI,EAAE,mCAAmC,CAAA;CAC1C,CAAA;AACH,qBAAa,iCAAkC,SAAQ,SAAS;IACrD,IAAI,SAAsC;gBACvC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,GAAG,CAAA;KAAE;CAKpC"}