viem 2.0.0-beta.8 → 2.0.0-rc.0

package/chains/opStack/abis.ts

@@ -72,6 +72,373 @@ export const gasPriceOracleAbi = [
   },
 ] as const
 
+export const l2OutputOracleAbi = [
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_submissionInterval', type: 'uint256' },
+      { internalType: 'uint256', name: '_l2BlockTime', type: 'uint256' },
+      {
+        internalType: 'uint256',
+        name: '_startingBlockNumber',
+        type: 'uint256',
+      },
+      { internalType: 'uint256', name: '_startingTimestamp', type: 'uint256' },
+      { internalType: 'address', name: '_proposer', type: 'address' },
+      { internalType: 'address', name: '_challenger', type: 'address' },
+      {
+        internalType: 'uint256',
+        name: '_finalizationPeriodSeconds',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: false, internalType: 'uint8', name: 'version', type: 'uint8' },
+    ],
+    name: 'Initialized',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'outputRoot',
+        type: 'bytes32',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'l2OutputIndex',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'l2BlockNumber',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'l1Timestamp',
+        type: 'uint256',
+      },
+    ],
+    name: 'OutputProposed',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'prevNextOutputIndex',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'newNextOutputIndex',
+        type: 'uint256',
+      },
+    ],
+    name: 'OutputsDeleted',
+    type: 'event',
+  },
+  {
+    inputs: [],
+    name: 'CHALLENGER',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'FINALIZATION_PERIOD_SECONDS',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'L2_BLOCK_TIME',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'PROPOSER',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'SUBMISSION_INTERVAL',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_l2BlockNumber', type: 'uint256' },
+    ],
+    name: 'computeL2Timestamp',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_l2OutputIndex', type: 'uint256' },
+    ],
+    name: 'deleteL2Outputs',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_l2OutputIndex', type: 'uint256' },
+    ],
+    name: 'getL2Output',
+    outputs: [
+      {
+        components: [
+          { internalType: 'bytes32', name: 'outputRoot', type: 'bytes32' },
+          { internalType: 'uint128', name: 'timestamp', type: 'uint128' },
+          { internalType: 'uint128', name: 'l2BlockNumber', type: 'uint128' },
+        ],
+        internalType: 'struct Types.OutputProposal',
+        name: '',
+        type: 'tuple',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_l2BlockNumber', type: 'uint256' },
+    ],
+    name: 'getL2OutputAfter',
+    outputs: [
+      {
+        components: [
+          { internalType: 'bytes32', name: 'outputRoot', type: 'bytes32' },
+          { internalType: 'uint128', name: 'timestamp', type: 'uint128' },
+          { internalType: 'uint128', name: 'l2BlockNumber', type: 'uint128' },
+        ],
+        internalType: 'struct Types.OutputProposal',
+        name: '',
+        type: 'tuple',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint256', name: '_l2BlockNumber', type: 'uint256' },
+    ],
+    name: 'getL2OutputIndexAfter',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_startingBlockNumber',
+        type: 'uint256',
+      },
+      { internalType: 'uint256', name: '_startingTimestamp', type: 'uint256' },
+    ],
+    name: 'initialize',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'latestBlockNumber',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'latestOutputIndex',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'nextBlockNumber',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'nextOutputIndex',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes32', name: '_outputRoot', type: 'bytes32' },
+      { internalType: 'uint256', name: '_l2BlockNumber', type: 'uint256' },
+      { internalType: 'bytes32', name: '_l1BlockHash', type: 'bytes32' },
+      { internalType: 'uint256', name: '_l1BlockNumber', type: 'uint256' },
+    ],
+    name: 'proposeL2Output',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'startingBlockNumber',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'startingTimestamp',
+    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 l2ToL1MessagePasserAbi = [
+  { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'nonce',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'sender',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'target',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'value',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'gasLimit',
+        type: 'uint256',
+      },
+      { indexed: false, internalType: 'bytes', name: 'data', type: 'bytes' },
+      {
+        indexed: false,
+        internalType: 'bytes32',
+        name: 'withdrawalHash',
+        type: 'bytes32',
+      },
+    ],
+    name: 'MessagePassed',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'WithdrawerBalanceBurnt',
+    type: 'event',
+  },
+  {
+    inputs: [],
+    name: 'MESSAGE_VERSION',
+    outputs: [{ internalType: 'uint16', name: '', type: 'uint16' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'burn',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: '_target', type: 'address' },
+      { internalType: 'uint256', name: '_gasLimit', type: 'uint256' },
+      { internalType: 'bytes', name: '_data', type: 'bytes' },
+    ],
+    name: 'initiateWithdrawal',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'messageNonce',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes32', name: '', type: 'bytes32' }],
+    name: 'sentMessages',
+    outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'version',
+    outputs: [{ internalType: 'string', name: '', type: 'string' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  { stateMutability: 'payable', type: 'receive' },
+] as const
+
 export const portalAbi = [
   { stateMutability: 'nonpayable', type: 'constructor', inputs: [] },
   {

package/chains/opStack/actions/buildDepositTransaction.ts

@@ -11,7 +11,11 @@ import {
 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 {
+  Account,
+  DeriveAccount,
+  GetAccountParameter,
+} from '../../../types/account.js'
 import type {
   Chain,
   DeriveChain,
@@ -64,8 +68,9 @@ export type BuildDepositTransactionReturnType<
     | Address
     | undefined,
 > = Prettify<
-  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> &
-    GetAccountParameter<account, accountOverride>
+  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> & {
+    account: DeriveAccount<account, accountOverride>
+  }
 >
 
 export type BuildDepositTransactionErrorType =
@@ -93,7 +98,7 @@ export type BuildDepositTransactionErrorType =
  *   transport: http(),
  * }).extend(publicActionsL2())
  *
- * const request = await buildDepositTransaction(client, {
+ * const args = await buildDepositTransaction(client, {
  *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
  *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  *   value: parseEther('1'),
@@ -138,7 +143,7 @@ export async function buildDepositTransaction<
 
   return {
     account,
-    args: {
+    request: {
       data: request.data,
       gas: request.gas,
       mint,
@@ -147,5 +152,5 @@ export async function buildDepositTransaction<
       value: request.value,
     },
     targetChain: chain,
-  } as BuildDepositTransactionReturnType<account, accountOverride>
+  } as unknown as BuildDepositTransactionReturnType<account, accountOverride>
 }

package/chains/opStack/actions/buildInitiateWithdrawal.ts

@@ -0,0 +1,118 @@
+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, GetChainParameter } from '../../../types/chain.js'
+import type { Hex } from '../../../types/misc.js'
+import type { Prettify, UnionOmit } from '../../../types/utils.js'
+import type { InitiateWithdrawalParameters } from './initiateWithdrawal.js'
+
+export type BuildInitiateWithdrawalParameters<
+  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,
+> = GetAccountParameter<account, accountOverride, false> &
+  GetChainParameter<chain, chainOverride> & {
+    /** Encoded contract method & arguments. */
+    data?: Hex
+    /** Gas limit for transaction execution on the L1. */
+    gas?: bigint
+    /** L1 Transaction recipient. */
+    to: Address
+    /** Value in wei to withdrawal to the L1. Debited from the caller's L2 balance. */
+    value?: bigint
+  }
+
+export type BuildInitiateWithdrawalReturnType<
+  account extends Account | undefined = Account | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Prettify<
+  UnionOmit<InitiateWithdrawalParameters<Chain, account, Chain>, 'account'> &
+    GetAccountParameter<account, accountOverride>
+>
+
+export type BuildInitiateWithdrawalErrorType =
+  | ParseAccountErrorType
+  | PrepareTransactionRequestErrorType
+  | ErrorType
+
+/**
+ * Prepares parameters for a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) from an L2 to the L1.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/buildInitiateWithdrawal.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link BuildInitiateWithdrawalParameters}
+ * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseEther } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { buildInitiateWithdrawal } from 'viem/wallet'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const args = await buildInitiateWithdrawal(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
+ */
+export async function buildInitiateWithdrawal<
+  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: BuildInitiateWithdrawalParameters<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >,
+): Promise<BuildInitiateWithdrawalReturnType<account, accountOverride>> {
+  const { account: account_, chain = client.chain, gas, data, to, value } = args
+
+  const account = account_ ? parseAccount(account_) : undefined
+
+  const request = await prepareTransactionRequest(client, {
+    account,
+    chain,
+    gas,
+    data,
+    parameters: ['gas'],
+    to,
+    value,
+  } as PrepareTransactionRequestParameters)
+
+  return {
+    account,
+    request: {
+      data: request.data,
+      gas: request.gas,
+      to: request.to,
+      value: request.value,
+    },
+  } as BuildInitiateWithdrawalReturnType<account, accountOverride>
+}

package/chains/opStack/actions/buildProveWithdrawal.ts

@@ -0,0 +1,149 @@
+import type { Address } from 'abitype'
+import {
+  type GetBlockErrorType,
+  getBlock,
+} from '../../../actions/public/getBlock.js'
+import {
+  type GetProofErrorType,
+  getProof,
+} from '../../../actions/public/getProof.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,
+  DeriveAccount,
+  GetAccountParameter,
+} from '../../../types/account.js'
+import type {
+  Chain,
+  DeriveChain,
+  GetChainParameter,
+} from '../../../types/chain.js'
+import type { Prettify } from '../../../types/utils.js'
+import { contracts } from '../contracts.js'
+import type { Withdrawal } from '../types/withdrawal.js'
+import {
+  type GetWithdrawalHashStorageSlotErrorType,
+  getWithdrawalHashStorageSlot,
+} from '../utils/getWithdrawalHashStorageSlot.js'
+import type { GetL2OutputReturnType } from './getL2Output.js'
+import type { ProveWithdrawalParameters } from './proveWithdrawal.js'
+
+const outputRootProofVersion =
+  '0x0000000000000000000000000000000000000000000000000000000000000000' as const
+
+export type BuildProveWithdrawalParameters<
+  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> & {
+    withdrawal: Withdrawal
+    output: GetL2OutputReturnType
+  }
+
+export type BuildProveWithdrawalReturnType<
+  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,
+> = Prettify<
+  Pick<
+    ProveWithdrawalParameters,
+    'l2OutputIndex' | 'outputRootProof' | 'withdrawalProof' | 'withdrawal'
+  > & {
+    account: DeriveAccount<account, accountOverride>
+    targetChain: DeriveChain<chain, chainOverride>
+  }
+>
+
+export type BuildProveWithdrawalErrorType =
+  | GetBlockErrorType
+  | GetProofErrorType
+  | GetWithdrawalHashStorageSlotErrorType
+  | ErrorType
+
+/**
+ * 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.html
+ *
+ * @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 { buildProveWithdrawal } from 'viem/op-stack'
+ *
+ * const publicClientL2 = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ *
+ * const args = await buildProveWithdrawal(publicClientL2, {
+ *   output: { ... },
+ *   withdrawal: { ... },
+ * })
+ */
+export async function buildProveWithdrawal<
+  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: BuildProveWithdrawalParameters<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >,
+): Promise<
+  BuildProveWithdrawalReturnType<chain, account, chainOverride, accountOverride>
+> {
+  const { account, chain = client.chain, output, withdrawal } = args
+  const { withdrawalHash } = withdrawal
+  const { l2BlockNumber } = output
+
+  const slot = getWithdrawalHashStorageSlot({ withdrawalHash })
+  const [proof, block] = await Promise.all([
+    getProof(client, {
+      address: contracts.l2ToL1MessagePasser.address,
+      storageKeys: [slot],
+      blockNumber: l2BlockNumber,
+    }),
+    getBlock(client, {
+      blockNumber: l2BlockNumber,
+    }),
+  ])
+
+  return {
+    account,
+    l2OutputIndex: output.outputIndex,
+    outputRootProof: {
+      latestBlockhash: block.hash,
+      messagePasserStorageRoot: proof.storageHash,
+      stateRoot: block.stateRoot,
+      version: outputRootProofVersion,
+    },
+    targetChain: chain,
+    withdrawalProof: proof.storageProof[0].proof,
+    withdrawal,
+  } as unknown as BuildProveWithdrawalReturnType<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >
+}