viem 2.0.0-beta.1 → 2.0.0-beta.11

package/chains/opStack/abis.ts

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

package/chains/opStack/actions/buildDepositTransaction.ts

@@ -0,0 +1,151 @@
+import type { Address } from 'abitype'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../../accounts/utils/parseAccount.js'
+import {
+  type PrepareTransactionRequestErrorType,
+  type PrepareTransactionRequestParameters,
+  prepareTransactionRequest,
+} 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 async 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>> {
+  const {
+    account: account_,
+    chain = client.chain,
+    gas,
+    data,
+    isCreation,
+    mint,
+    to,
+    value,
+  } = args
+
+  const account = account_ ? parseAccount(account_) : undefined
+
+  const request = await prepareTransactionRequest(client, {
+    account: mint ? undefined : account,
+    chain,
+    gas,
+    data,
+    parameters: ['gas'],
+    to,
+    value,
+  } as PrepareTransactionRequestParameters)
+
+  return {
+    account,
+    args: {
+      data: request.data,
+      gas: request.gas,
+      mint,
+      isCreation,
+      to: request.to,
+      value: request.value,
+    },
+    targetChain: chain,
+  } as BuildDepositTransactionReturnType<account, accountOverride>
+}