viem 2.9.2 → 2.9.4

package/chains/celo/utils.ts

@@ -1,81 +0,0 @@
-import type { Address } from 'abitype'
-import { trim } from '../../utils/data/trim.js'
-import type {
-  CeloTransactionRequest,
-  CeloTransactionSerializable,
-  TransactionSerializableCIP42,
-  TransactionSerializableCIP64,
-} from './types.js'
-
-export function isEmpty(
-  value: string | undefined | number | BigInt,
-): value is undefined {
-  return (
-    value === 0 ||
-    value === 0n ||
-    value === undefined ||
-    value === null ||
-    value === '0' ||
-    value === '' ||
-    (typeof value === 'string' &&
-      (trim(value as Address).toLowerCase() === '0x' ||
-        trim(value as Address).toLowerCase() === '0x00'))
-  )
-}
-
-export function isPresent(
-  value: string | undefined | number | BigInt,
-): value is string | number | BigInt {
-  return !isEmpty(value)
-}
-
-export function isEIP1559(
-  transaction: CeloTransactionSerializable | CeloTransactionRequest,
-): boolean {
-  return (
-    typeof transaction.maxFeePerGas !== 'undefined' &&
-    typeof transaction.maxPriorityFeePerGas !== 'undefined'
-  )
-}
-
-// process as CIP42 if any of these fields are present. realistically gatewayfee is not used but is part of spec
-export function isCIP42(
-  transaction: CeloTransactionSerializable | CeloTransactionRequest,
-): transaction is TransactionSerializableCIP42 {
-  // Enable end-user to force the tx to be considered as a cip42
-  if (transaction.type === 'cip42') {
-    return true
-  }
-
-  return (
-    isEIP1559(transaction) &&
-    (isPresent(transaction.feeCurrency) ||
-      isPresent(transaction.gatewayFeeRecipient) ||
-      isPresent(transaction.gatewayFee))
-  )
-}
-
-export function isCIP64(
-  transaction: CeloTransactionSerializable | CeloTransactionRequest,
-): transaction is TransactionSerializableCIP64 {
-  /*
-   * Enable end user to force the tx to be considered as a CIP-64.
-   *
-   * The preliminary type will be determined as "eip1559" by src/utils/transaction/getTransactionType.ts
-   * and so we need the logic below to check for the specific value instead of checking if just any
-   * transaction type is provided. If that's anything else than "cip64" then we need to reevaluate the
-   * type based on the transaction fields.
-   *
-   * Modify with caution and according to https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0064.md
-   */
-  if (transaction.type === 'cip64') {
-    return true
-  }
-
-  return (
-    isEIP1559(transaction) &&
-    isPresent(transaction.feeCurrency) &&
-    isEmpty(transaction.gatewayFee) &&
-    isEmpty(transaction.gatewayFeeRecipient)
-  )
-}

package/chains/opStack/actions/buildDepositTransaction.ts

@@ -1,156 +0,0 @@
-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,
-  DeriveAccount,
-  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 | undefined
-    /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
-    mint?: bigint | undefined
-    /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
-    value?: bigint | undefined
-  } & (
-    | {
-        /** Encoded contract method & arguments. */
-        data?: Hex | undefined
-        /** Whether or not this is a contract deployment transaction. */
-        isCreation?: false | undefined
-        /** L2 Transaction recipient. */
-        to?: Address | undefined
-      }
-    | {
-        /** 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 | undefined
-      }
-  )
-
-export type BuildDepositTransactionReturnType<
-  account extends Account | undefined = Account | undefined,
-  accountOverride extends Account | Address | undefined =
-    | Account
-    | Address
-    | undefined,
-> = Prettify<
-  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> & {
-    account: DeriveAccount<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
- *
- * @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 args = 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,
-    request: {
-      data: request.data,
-      gas: request.gas,
-      mint,
-      isCreation,
-      to: request.to,
-      value: request.value,
-    },
-    targetChain: chain,
-  } as unknown as BuildDepositTransactionReturnType<account, accountOverride>
-}

package/chains/opStack/actions/buildInitiateWithdrawal.ts

@@ -1,118 +0,0 @@
-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 | undefined
-    /** Gas limit for transaction execution on the L1. */
-    gas?: bigint | undefined
-    /** L1 Transaction recipient. */
-    to: Address
-    /** Value in wei to withdrawal to the L1. Debited from the caller's L2 balance. */
-    value?: bigint | undefined
-  }
-
-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
- *
- * @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

@@ -1,180 +0,0 @@
-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 Hex } from '../../../types/misc.js'
-import type { OneOf, Prettify } from '../../../types/utils.js'
-import { fromRlp } from '../../../utils/encoding/fromRlp.js'
-import { toRlp } from '../../../utils/encoding/toRlp.js'
-import { keccak256 } from '../../../utils/hash/keccak256.js'
-import { contracts } from '../contracts.js'
-import type { Withdrawal } from '../types/withdrawal.js'
-import {
-  type GetWithdrawalHashStorageSlotErrorType,
-  getWithdrawalHashStorageSlot,
-} from '../utils/getWithdrawalHashStorageSlot.js'
-import { type GetGameReturnType } from './getGame.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
-  } & OneOf<{ output: GetL2OutputReturnType } | { game: GetGameReturnType }>
-
-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
- *
- * @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, game, output, withdrawal } = args
-
-  const { withdrawalHash } = withdrawal
-  const { l2BlockNumber } = game ?? 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: game?.index ?? output?.outputIndex,
-    outputRootProof: {
-      latestBlockhash: block.hash,
-      messagePasserStorageRoot: proof.storageHash,
-      stateRoot: block.stateRoot,
-      version: outputRootProofVersion,
-    },
-    targetChain: chain,
-    withdrawalProof: maybeAddProofNode(
-      keccak256(slot),
-      proof.storageProof[0].proof,
-    ),
-    withdrawal,
-  } as unknown as BuildProveWithdrawalReturnType<
-    chain,
-    account,
-    chainOverride,
-    accountOverride
-  >
-}
-
-export function maybeAddProofNode(key: string, proof: readonly Hex[]) {
-  const lastProofRlp = proof[proof.length - 1]
-  const lastProof = fromRlp(lastProofRlp)
-  if (lastProof.length !== 17) return proof
-
-  const modifiedProof = [...proof]
-  for (const item of lastProof) {
-    // Find any nodes located inside of the branch node.
-    if (!Array.isArray(item)) continue
-    // Check if the key inside the node matches the key we're looking for. We remove the first
-    // two characters (0x) and then we remove one more character (the first nibble) since this
-    // is the identifier for the type of node we're looking at. In this case we don't actually
-    // care what type of node it is because a branch node would only ever be the final proof
-    // element if (1) it includes the leaf node we're looking for or (2) it stores the value
-    // within itself. If (1) then this logic will work, if (2) then this won't find anything
-    // and we won't append any proof elements, which is exactly what we would want.
-    const suffix = item[0].slice(3)
-    if (typeof suffix !== 'string' || !key.endsWith(suffix)) continue
-    modifiedProof.push(toRlp(item))
-  }
-  return modifiedProof
-}