@wagmi/core/src/actions/codegen/createSimulateContract.ts

VanillaJS library for Ethereum

import type {
  Abi,
  Account,
  Address,
  Chain,
  ContractFunctionArgs,
  ContractFunctionName,
  SimulateContractParameters as viem_SimulateContractParameters,
} from 'viem'

import type { Config } from '../../createConfig.js'
import type { SelectChains } from '../../types/chain.js'
import type {
  ChainIdParameter,
  ConnectorParameter,
} from '../../types/properties.js'
import type { UnionCompute, UnionStrictOmit } from '../../types/utils.js'
import { getAccount } from '../getAccount.js'
import { getChainId } from '../getChainId.js'
import {
  type SimulateContractReturnType,
  simulateContract,
} from '../simulateContract.js'

type stateMutability = 'nonpayable' | 'payable'

export type CreateSimulateContractParameters<
  abi extends Abi | readonly unknown[],
  address extends Address | Record<number, Address> | undefined = undefined,
  functionName extends
    | ContractFunctionName<abi, stateMutability>
    | undefined = undefined,
> = {
  abi: abi | Abi | readonly unknown[]
  address?: address | Address | Record<number, Address> | undefined
  functionName?:
    | functionName
    | ContractFunctionName<abi, stateMutability>
    | undefined
}

export type CreateSimulateContractReturnType<
  abi extends Abi | readonly unknown[],
  address extends Address | Record<number, Address> | undefined,
  functionName extends ContractFunctionName<abi, stateMutability> | undefined,
> = <
  config extends Config,
  name extends functionName extends ContractFunctionName<abi, stateMutability>
    ? functionName
    : ContractFunctionName<abi, stateMutability>,
  args extends ContractFunctionArgs<abi, stateMutability, name>,
  chainId extends config['chains'][number]['id'] | undefined = undefined,
  ///
  chains extends readonly Chain[] = SelectChains<config, chainId>,
>(
  config: config,
  parameters: {
    [key in keyof chains]: UnionCompute<
      UnionStrictOmit<
        viem_SimulateContractParameters<
          abi,
          name,
          args,
          chains[key],
          chains[key],
          Account | Address
        >,
        | 'abi'
        | 'chain'
        | (address extends undefined ? never : 'address')
        | (functionName extends undefined ? never : 'functionName')
      >
    > &
      ChainIdParameter<config, chainId> &
      ConnectorParameter & {
        chainId?: address extends Record<number, Address>
          ?
              | keyof address
              | (chainId extends keyof address ? chainId : never)
              | undefined
          : chainId | number | undefined
      }
  }[number],
) => Promise<SimulateContractReturnType<abi, name, args, config, chainId>>

export function createSimulateContract<
  const abi extends Abi | readonly unknown[],
  const address extends
    | Address
    | Record<number, Address>
    | undefined = undefined,
  functionName extends
    | ContractFunctionName<abi, stateMutability>
    | undefined = undefined,
>(
  c: CreateSimulateContractParameters<abi, address, functionName>,
): CreateSimulateContractReturnType<abi, address, functionName> {
  if (c.address !== undefined && typeof c.address === 'object')
    return (config, parameters) => {
      const configChainId = getChainId(config)
      const account = getAccount(config)
      const chainId =
        (parameters as { chainId?: number })?.chainId ??
        account.chainId ??
        configChainId
      return simulateContract(config, {
        ...(parameters as any),
        ...(c.functionName ? { functionName: c.functionName } : {}),
        address: c.address?.[chainId],
        abi: c.abi,
      })
    }

  return (config, parameters) => {
    return simulateContract(config, {
      ...(parameters as any),
      ...(c.address ? { address: c.address } : {}),
      ...(c.functionName ? { functionName: c.functionName } : {}),
      abi: c.abi,
    })
  }
}