viem 0.0.0-portable-types-20230522163654 → 0.0.0-refactor-generics-20230831161903

package/src/actions/index.ts

@@ -0,0 +1,343 @@
+export {
+  type GetEnsAddressParameters,
+  type GetEnsAddressReturnType,
+  getEnsAddress,
+} from './ens/getEnsAddress.js'
+export {
+  type GetEnsAvatarParameters,
+  type GetEnsAvatarReturnType,
+  getEnsAvatar,
+} from './ens/getEnsAvatar.js'
+export {
+  type GetEnsNameParameters,
+  type GetEnsNameReturnType,
+  getEnsName,
+} from './ens/getEnsName.js'
+export {
+  type GetEnsResolverParameters,
+  type GetEnsResolverReturnType,
+  getEnsResolver,
+} from './ens/getEnsResolver.js'
+export {
+  type GetEnsTextParameters,
+  type GetEnsTextReturnType,
+  getEnsText,
+} from './ens/getEnsText.js'
+export {
+  type CallParameters,
+  type CallReturnType,
+  call,
+} from './public/call.js'
+export {
+  type CreateBlockFilterReturnType,
+  createBlockFilter,
+} from './public/createBlockFilter.js'
+export {
+  type CreateContractEventFilterParameters,
+  type CreateContractEventFilterReturnType,
+  createContractEventFilter,
+} from './public/createContractEventFilter.js'
+export {
+  type CreateEventFilterParameters,
+  type CreateEventFilterReturnType,
+  createEventFilter,
+} from './public/createEventFilter.js'
+export {
+  type CreatePendingTransactionFilterReturnType,
+  createPendingTransactionFilter,
+} from './public/createPendingTransactionFilter.js'
+export {
+  type EstimateContractGasParameters,
+  type EstimateContractGasReturnType,
+  estimateContractGas,
+} from './public/estimateContractGas.js'
+export {
+  type EstimateGasParameters,
+  type EstimateGasReturnType,
+  estimateGas,
+} from './public/estimateGas.js'
+export {
+  type GetBalanceParameters,
+  type GetBalanceReturnType,
+  getBalance,
+} from './public/getBalance.js'
+export {
+  type GetBlockParameters,
+  type GetBlockReturnType,
+  getBlock,
+} from './public/getBlock.js'
+export {
+  type GetBlockNumberParameters,
+  type GetBlockNumberReturnType,
+  getBlockNumber,
+} from './public/getBlockNumber.js'
+export {
+  type GetBlockTransactionCountParameters,
+  type GetBlockTransactionCountReturnType,
+  getBlockTransactionCount,
+} from './public/getBlockTransactionCount.js'
+export {
+  type GetBytecodeParameters,
+  type GetBytecodeReturnType,
+  getBytecode,
+} from './public/getBytecode.js'
+export { type GetChainIdReturnType, getChainId } from './public/getChainId.js'
+export {
+  type GetFeeHistoryParameters,
+  type GetFeeHistoryReturnType,
+  getFeeHistory,
+} from './public/getFeeHistory.js'
+export {
+  type GetFilterChangesParameters,
+  type GetFilterChangesReturnType,
+  getFilterChanges,
+} from './public/getFilterChanges.js'
+export {
+  type GetFilterLogsParameters,
+  type GetFilterLogsReturnType,
+  getFilterLogs,
+} from './public/getFilterLogs.js'
+export {
+  type GetGasPriceReturnType,
+  getGasPrice,
+} from './public/getGasPrice.js'
+export {
+  type GetLogsParameters,
+  type GetLogsReturnType,
+  getLogs,
+} from './public/getLogs.js'
+export {
+  type GetStorageAtParameters,
+  type GetStorageAtReturnType,
+  getStorageAt,
+} from './public/getStorageAt.js'
+export {
+  type GetTransactionConfirmationsParameters,
+  type GetTransactionConfirmationsReturnType,
+  getTransactionConfirmations,
+} from './public/getTransactionConfirmations.js'
+export {
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+  getTransactionCount,
+} from './public/getTransactionCount.js'
+export {
+  type GetTransactionParameters,
+  type GetTransactionReturnType,
+  getTransaction,
+} from './public/getTransaction.js'
+export {
+  type GetTransactionReceiptParameters,
+  type GetTransactionReceiptReturnType,
+  getTransactionReceipt,
+} from './public/getTransactionReceipt.js'
+export {
+  type ImpersonateAccountParameters,
+  impersonateAccount,
+} from './test/impersonateAccount.js'
+export {
+  type IncreaseTimeParameters,
+  increaseTime,
+} from './test/increaseTime.js'
+export { type MineParameters, mine } from './test/mine.js'
+export {
+  type MulticallParameters,
+  type MulticallReturnType,
+  multicall,
+} from './public/multicall.js'
+export {
+  type OnBlock,
+  type OnBlockParameter,
+  type WatchBlocksParameters,
+  type WatchBlocksReturnType,
+  watchBlocks,
+} from './public/watchBlocks.js'
+export {
+  type OnBlockNumberFn,
+  type OnBlockNumberParameter,
+  type WatchBlockNumberParameters,
+  type WatchBlockNumberReturnType,
+  watchBlockNumber,
+} from './public/watchBlockNumber.js'
+export {
+  type WatchEventOnLogsFn,
+  /** @deprecated - use `WatchEventOnLogsFn` instead. */
+  type WatchEventOnLogsFn as OnLogsFn,
+  type WatchEventOnLogsParameter,
+  /** @deprecated - use `WatchEventOnLogsParameter` instead. */
+  type WatchEventOnLogsParameter as OnLogsParameter,
+  type WatchEventParameters,
+  type WatchEventReturnType,
+  watchEvent,
+} from './public/watchEvent.js'
+export {
+  type OnTransactionsFn,
+  type OnTransactionsParameter,
+  type WatchPendingTransactionsParameters,
+  type WatchPendingTransactionsReturnType,
+  watchPendingTransactions,
+} from './public/watchPendingTransactions.js'
+export {
+  type ReadContractParameters,
+  type ReadContractReturnType,
+  readContract,
+} from './public/readContract.js'
+export {
+  type GetPermissionsReturnType,
+  getPermissions,
+} from './wallet/getPermissions.js'
+export {
+  type ReplacementReason,
+  type ReplacementReturnType,
+  type WaitForTransactionReceiptParameters,
+  type WaitForTransactionReceiptReturnType,
+  waitForTransactionReceipt,
+} from './public/waitForTransactionReceipt.js'
+export {
+  type RequestAddressesReturnType,
+  requestAddresses,
+} from './wallet/requestAddresses.js'
+export {
+  type RequestPermissionsReturnType,
+  type RequestPermissionsParameters,
+  requestPermissions,
+} from './wallet/requestPermissions.js'
+export {
+  type DropTransactionParameters,
+  dropTransaction,
+} from './test/dropTransaction.js'
+export {
+  type GetAutomineReturnType,
+  getAutomine,
+} from './test/getAutomine.js'
+export {
+  type GetTxpoolContentReturnType,
+  getTxpoolContent,
+} from './test/getTxpoolContent.js'
+export {
+  type GetTxpoolStatusReturnType,
+  getTxpoolStatus,
+} from './test/getTxpoolStatus.js'
+export {
+  type InspectTxpoolReturnType,
+  inspectTxpool,
+} from './test/inspectTxpool.js'
+export { type ResetParameters, reset } from './test/reset.js'
+export { type RevertParameters, revert } from './test/revert.js'
+export {
+  type PrepareTransactionRequestParameters,
+  type PrepareTransactionRequestReturnType,
+  prepareTransactionRequest,
+} from './wallet/prepareTransactionRequest.js'
+export {
+  type SendTransactionParameters,
+  type SendTransactionReturnType,
+  sendTransaction,
+} from './wallet/sendTransaction.js'
+export {
+  type SignTransactionParameters,
+  type SignTransactionReturnType,
+  signTransaction,
+} from './wallet/signTransaction.js'
+export {
+  type SendRawTransactionParameters,
+  type SendRawTransactionReturnType,
+  sendRawTransaction,
+} from './wallet/sendRawTransaction.js'
+export {
+  type SendUnsignedTransactionParameters,
+  type SendUnsignedTransactionReturnType,
+  sendUnsignedTransaction,
+} from './test/sendUnsignedTransaction.js'
+export { type SetBalanceParameters, setBalance } from './test/setBalance.js'
+export { setAutomine } from './test/setAutomine.js'
+export {
+  type SetBlockGasLimitParameters,
+  setBlockGasLimit,
+} from './test/setBlockGasLimit.js'
+export {
+  type SetBlockTimestampIntervalParameters,
+  setBlockTimestampInterval,
+} from './test/setBlockTimestampInterval.js'
+export { type SetCodeParameters, setCode } from './test/setCode.js'
+export { type SetCoinbaseParameters, setCoinbase } from './test/setCoinbase.js'
+export {
+  type SetIntervalMiningParameters,
+  setIntervalMining,
+} from './test/setIntervalMining.js'
+export {
+  type SetMinGasPriceParameters,
+  setMinGasPrice,
+} from './test/setMinGasPrice.js'
+export {
+  type SetNextBlockBaseFeePerGasParameters,
+  setNextBlockBaseFeePerGas,
+} from './test/setNextBlockBaseFeePerGas.js'
+export {
+  type SetNextBlockTimestampParameters,
+  setNextBlockTimestamp,
+} from './test/setNextBlockTimestamp.js'
+export { type SetNonceParameters, setNonce } from './test/setNonce.js'
+export {
+  type SetStorageAtParameters,
+  setStorageAt,
+} from './test/setStorageAt.js'
+export { snapshot } from './test/snapshot.js'
+export {
+  type SignMessageParameters,
+  type SignMessageReturnType,
+  signMessage,
+} from './wallet/signMessage.js'
+export {
+  type SignTypedDataParameters,
+  type SignTypedDataReturnType,
+  signTypedData,
+} from './wallet/signTypedData.js'
+export {
+  type SimulateContractParameters,
+  type SimulateContractReturnType,
+  simulateContract,
+} from './public/simulateContract.js'
+export {
+  type StopImpersonatingAccountParameters,
+  stopImpersonatingAccount,
+} from './test/stopImpersonatingAccount.js'
+export {
+  type SwitchChainParameters,
+  switchChain,
+} from './wallet/switchChain.js'
+export {
+  type UninstallFilterParameters,
+  type UninstallFilterReturnType,
+  uninstallFilter,
+} from './public/uninstallFilter.js'
+export {
+  type VerifyHashParameters,
+  type VerifyHashReturnType,
+  verifyHash,
+} from './public/verifyHash.js'
+export {
+  type VerifyMessageParameters,
+  type VerifyMessageReturnType,
+  verifyMessage,
+} from './public/verifyMessage.js'
+export {
+  type VerifyTypedDataParameters,
+  type VerifyTypedDataReturnType,
+  verifyTypedData,
+} from './public/verifyTypedData.js'
+export {
+  type WatchAssetParameters,
+  type WatchAssetReturnType,
+  watchAsset,
+} from './wallet/watchAsset.js'
+export {
+  type WatchContractEventParameters,
+  type WatchContractEventReturnType,
+  watchContractEvent,
+} from './public/watchContractEvent.js'
+export {
+  type WriteContractParameters,
+  type WriteContractReturnType,
+  writeContract,
+} from './wallet/writeContract.js'

package/src/actions/public/call.ts

@@ -2,7 +2,7 @@ import type { Address } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
 import { parseAccount } from '../../accounts/utils/parseAccount.js'
-import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { multicall3Abi } from '../../constants/abis.js'
 import { aggregate3Signature } from '../../constants/contract.js'
@@ -14,35 +14,31 @@ import {
 import { RawContractError } from '../../errors/contract.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
-import type { Formatter } from '../../types/formatter.js'
 import type { Hex } from '../../types/misc.js'
 import type { RpcTransactionRequest } from '../../types/rpc.js'
 import type { TransactionRequest } from '../../types/transaction.js'
-import type { MergeIntersectionProperties } from '../../types/utils.js'
+import type { UnionOmit } from '../../types/utils.js'
 import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
 import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import { getChainContractAddress } from '../../utils/chain.js'
 import { numberToHex } from '../../utils/encoding/toHex.js'
 import { getCallError } from '../../utils/errors/getCallError.js'
 import { extract } from '../../utils/formatters/extract.js'
-import { type Formatted, format } from '../../utils/formatters/format.js'
 import {
-  type TransactionRequestFormatter,
+  type FormattedTransactionRequest,
   formatTransactionRequest,
 } from '../../utils/formatters/transactionRequest.js'
 import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js'
 import { assertRequest } from '../../utils/transaction/assertRequest.js'
+import type { AssertRequestParameters } from '../../utils/transaction/assertRequest.js'
 
 export type FormattedCall<
-  TFormatter extends Formatter | undefined = Formatter,
-> = MergeIntersectionProperties<
-  Omit<Formatted<TFormatter, TransactionRequest, true>, 'from'>,
-  TransactionRequest
->
+  TChain extends Chain | undefined = Chain | undefined,
+> = FormattedTransactionRequest<TChain>
 
 export type CallParameters<
   TChain extends Chain | undefined = Chain | undefined,
-> = FormattedCall<TransactionRequestFormatter<TChain>> & {
+> = UnionOmit<FormattedCall<TChain>, 'from'> & {
   account?: Account | Address
   batch?: boolean
 } & (
@@ -89,11 +85,11 @@ export type CallReturnType = { data: Hex | undefined }
  * })
  */
 export async function call<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   args: CallParameters<TChain>,
 ): Promise<CallReturnType> {
   const {
-    account: account_,
+    account: account_ = client.account,
     batch = Boolean(client.batch?.multicall),
     blockNumber,
     blockTag = 'latest',
@@ -111,31 +107,28 @@ export async function call<TChain extends Chain | undefined>(
   const account = account_ ? parseAccount(account_) : undefined
 
   try {
-    assertRequest(args)
+    assertRequest(args as AssertRequestParameters)
 
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
     const block = blockNumberHex || blockTag
 
-    const formatter = client.chain?.formatters?.transactionRequest
-    const request = format(
-      {
-        from: account?.address,
-        accessList,
-        data,
-        gas,
-        gasPrice,
-        maxFeePerGas,
-        maxPriorityFeePerGas,
-        nonce,
-        to,
-        value,
-        // Pick out extra data that might exist on the chain's transaction request type.
-        ...extract(rest, { formatter }),
-      } as TransactionRequest,
-      {
-        formatter: formatter || formatTransactionRequest,
-      },
-    ) as TransactionRequest
+    const format =
+      client.chain?.formatters?.transactionRequest?.format ||
+      formatTransactionRequest
+    const request = format({
+      // Pick out extra data that might exist on the chain's transaction request type.
+      ...extract(rest, { format }),
+      from: account?.address,
+      accessList,
+      data,
+      gas,
+      gasPrice,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      nonce,
+      to,
+      value,
+    } as TransactionRequest) as TransactionRequest
 
     if (batch && shouldPerformMulticall({ request })) {
       try {
@@ -203,12 +196,12 @@ type ScheduleMulticallParameters<TChain extends Chain | undefined> = Pick<
   to: Address
 }
 
-async function scheduleMulticall<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+async function scheduleMulticall<TChain extends Chain | undefined,>(
+  client: Client<Transport>,
   args: ScheduleMulticallParameters<TChain>,
 ) {
   const { batchSize = 1024, wait = 0 } =
-    typeof client.batch?.multicall === 'object' ? client.batch?.multicall : {}
+    typeof client.batch?.multicall === 'object' ? client.batch.multicall : {}
   const {
     blockNumber,
     blockTag = 'latest',

package/src/actions/public/createBlockFilter.ts

@@ -1,4 +1,4 @@
-import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import type { Filter } from '../../types/filter.js'
@@ -7,7 +7,7 @@ import { createFilterRequestScope } from '../../utils/filters/createFilterReques
 export type CreateBlockFilterReturnType = Filter<'block'>
 
 /**
- * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges).
+ * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
  *
  * - Docs: https://viem.sh/docs/actions/public/createBlockFilter.html
  * - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter)
@@ -28,7 +28,7 @@ export type CreateBlockFilterReturnType = Filter<'block'>
  * // { id: "0x345a6572337856574a76364e457a4366", type: 'block' }
  */
 export async function createBlockFilter<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
 ): Promise<CreateBlockFilterReturnType> {
   const getRequest = createFilterRequestScope(client, {
     method: 'eth_newBlockFilter',

package/src/actions/public/createContractEventFilter.ts

@@ -1,6 +1,6 @@
-import type { Abi, Address, Narrow } from 'abitype'
+import type { Abi, Address } from 'abitype'
 
-import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
@@ -9,6 +9,7 @@ import type {
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
 import type { Filter } from '../../types/filter.js'
+import type { Hex } from '../../types/misc.js'
 import {
   type EncodeEventTopicsParameters,
   encodeEventTopics,
@@ -22,12 +23,20 @@ export type CreateContractEventFilterParameters<
   TArgs extends
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
 > = {
   address?: Address | Address[]
-  abi: Narrow<TAbi>
+  abi: TAbi
   eventName?: InferEventName<TAbi, TEventName>
-  fromBlock?: BlockNumber | BlockTag
-  toBlock?: BlockNumber | BlockTag
+  fromBlock?: TFromBlock | BlockNumber | BlockTag
+  /**
+   * Whether or not the logs must match the indexed/non-indexed arguments in the event ABI item.
+   * @default false
+   */
+  strict?: TStrict
+  toBlock?: TToBlock | BlockNumber | BlockTag
 } & (undefined extends TEventName
   ? {
       args?: never
@@ -49,10 +58,13 @@ export type CreateContractEventFilterReturnType<
   TArgs extends
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = undefined,
-> = Filter<'event', TAbi, TEventName, TArgs>
+  TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
+> = Filter<'event', TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>
 
 /**
- * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs).
+ * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html).
  *
  * - Docs: https://viem.sh/docs/contract/createContractEventFilter.html
  *
@@ -75,20 +87,40 @@ export type CreateContractEventFilterReturnType<
  */
 export async function createContractEventFilter<
   TChain extends Chain | undefined,
-  TAbi extends Abi | readonly unknown[],
+  const TAbi extends Abi | readonly unknown[],
   TEventName extends string | undefined,
   TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
+  TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
 >(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     address,
     abi,
     args,
     eventName,
     fromBlock,
+    strict,
     toBlock,
-  }: CreateContractEventFilterParameters<TAbi, TEventName, TArgs>,
-): Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs>> {
+  }: CreateContractEventFilterParameters<
+    TAbi,
+    TEventName,
+    TArgs,
+    TStrict,
+    TFromBlock,
+    TToBlock
+  >,
+): Promise<
+  CreateContractEventFilterReturnType<
+    TAbi,
+    TEventName,
+    TArgs,
+    TStrict,
+    TFromBlock,
+    TToBlock
+  >
+> {
   const getRequest = createFilterRequestScope(client, {
     method: 'eth_newFilter',
   })
@@ -100,7 +132,7 @@ export async function createContractEventFilter<
         eventName,
       } as unknown as EncodeEventTopicsParameters)
     : undefined
-  const id = await client.request({
+  const id: Hex = await client.request({
     method: 'eth_newFilter',
     params: [
       {
@@ -119,6 +151,14 @@ export async function createContractEventFilter<
     eventName,
     id,
     request: getRequest(id),
+    strict,
     type: 'event',
-  } as unknown as CreateContractEventFilterReturnType<TAbi, TEventName, TArgs>
+  } as unknown as CreateContractEventFilterReturnType<
+    TAbi,
+    TEventName,
+    TArgs,
+    TStrict,
+    TFromBlock,
+    TToBlock
+  >
 }