viem 0.2.11 → 0.2.13

package/src/public.ts

@@ -0,0 +1,81 @@
+export {
+  call,
+  createBlockFilter,
+  createEventFilter,
+  createPendingTransactionFilter,
+  estimateGas,
+  getBalance,
+  getBlock,
+  getBlockNumber,
+  getBlockNumberCache,
+  getBlockTransactionCount,
+  getBytecode,
+  getChainId,
+  getFeeHistory,
+  getFilterChanges,
+  getFilterLogs,
+  getLogs,
+  getGasPrice,
+  getTransaction,
+  getTransactionConfirmations,
+  getTransactionCount,
+  getTransactionReceipt,
+  uninstallFilter,
+  waitForTransactionReceipt,
+  watchBlockNumber,
+  watchBlocks,
+  watchEvent,
+  watchPendingTransactions,
+} from './actions/public/index.js'
+export type {
+  CallParameters,
+  CallReturnType,
+  CreateBlockFilterReturnType,
+  CreateEventFilterParameters,
+  CreateEventFilterReturnType,
+  CreatePendingTransactionFilterReturnType,
+  EstimateGasParameters,
+  EstimateGasReturnType,
+  GetBalanceParameters,
+  GetBalanceReturnType,
+  GetBlockParameters,
+  GetBlockNumberParameters,
+  GetBlockNumberReturnType,
+  GetBlockReturnType,
+  GetBlockTransactionCountParameters,
+  GetBlockTransactionCountReturnType,
+  GetBytecodeParameters,
+  GetBytecodeReturnType,
+  GetFeeHistoryParameters,
+  GetFeeHistoryReturnType,
+  GetFilterChangesParameters,
+  GetFilterChangesReturnType,
+  GetFilterLogsParameters,
+  GetFilterLogsReturnType,
+  GetGasPriceReturnType,
+  GetTransactionParameters,
+  GetTransactionConfirmationsParameters,
+  GetTransactionConfirmationsReturnType,
+  GetTransactionCountParameters,
+  GetTransactionCountReturnType,
+  GetTransactionReceiptParameters,
+  GetTransactionReceiptReturnType,
+  GetTransactionReturnType,
+  OnBlock,
+  OnBlockNumberFn,
+  OnBlockNumberParameter,
+  OnBlockParameter,
+  OnLogsFn,
+  OnLogsParameter,
+  OnTransactionsFn,
+  OnTransactionsParameter,
+  ReplacementReason,
+  ReplacementReturnType,
+  UninstallFilterParameters,
+  UninstallFilterReturnType,
+  WaitForTransactionReceiptParameters,
+  WaitForTransactionReceiptReturnType,
+  WatchBlockNumberParameters,
+  WatchBlocksParameters,
+  WatchPendingTransactionsParameters,
+} from './actions/public/index.js'

package/src/test.ts

@@ -0,0 +1,52 @@
+export {
+  dropTransaction,
+  getAutomine,
+  getTxpoolContent,
+  getTxpoolStatus,
+  impersonateAccount,
+  increaseTime,
+  inspectTxpool,
+  mine,
+  removeBlockTimestampInterval,
+  reset,
+  revert,
+  sendUnsignedTransaction,
+  setAutomine,
+  setBalance,
+  setBlockGasLimit,
+  setBlockTimestampInterval,
+  setCode,
+  setCoinbase,
+  setIntervalMining,
+  setLoggingEnabled,
+  setMinGasPrice,
+  setNextBlockBaseFeePerGas,
+  setNextBlockTimestamp,
+  setNonce,
+  setStorageAt,
+  snapshot,
+  setRpcUrl,
+  stopImpersonatingAccount,
+} from './actions/test/index.js'
+export type {
+  DropTransactionParameters,
+  ImpersonateAccountParameters,
+  IncreaseTimeParameters,
+  MineParameters,
+  ResetParameters,
+  RevertParameters,
+  SendUnsignedTransactionParameters,
+  SendUnsignedTransactionReturnType,
+  SetBalanceParameters,
+  SetBlockGasLimitParameters,
+  SetBlockTimestampIntervalParameters,
+  SetCodeParameters,
+  SetCoinbaseParameters,
+  SetIntervalMiningParameters,
+  SetMinGasPriceParameters,
+  SetNextBlockBaseFeePerGasParameters,
+  SetNextBlockTimestampParameters,
+  SetNonceParameters,
+  SetStorageAtParameters,
+  StopImpersonatingAccountParameters,
+} from './actions/test/index.js'

package/src/types/account.ts

@@ -0,0 +1,26 @@
+import type { Address } from 'abitype'
+import type { Account, JsonRpcAccount } from '../accounts/index.js'
+import type { IsUndefined } from './utils.js'
+
+export type {
+  Account,
+  AccountSource,
+  CustomSource,
+  HDAccount,
+  HDKey,
+  HDOptions,
+  JsonRpcAccount,
+  LocalAccount,
+  PrivateKeyAccount,
+} from '../accounts/index.js'
+
+export type GetAccountParameter<
+  TAccount extends Account | undefined = Account | undefined,
+> = IsUndefined<TAccount> extends true
+  ? { account: Account | Address }
+  : { account?: Account | Address }
+
+export type ParseAccount<TAccount extends Account | Address | undefined> =
+  | (TAccount extends Account ? TAccount : never)
+  | (TAccount extends Address ? JsonRpcAccount : never)
+  | (TAccount extends undefined ? undefined : never)

package/src/types/block.ts

@@ -0,0 +1,72 @@
+import type { Address } from 'abitype'
+import type { Hash, Hex } from './misc.js'
+import type { Transaction } from './transaction.js'
+
+export type Block<TQuantity = bigint, TTransaction = Transaction> = {
+  /** Base fee per gas */
+  baseFeePerGas: TQuantity | null
+  /** Difficulty for this block */
+  difficulty: TQuantity
+  /** "Extra data" field of this block */
+  extraData: Hex
+  /** Maximum gas allowed in this block */
+  gasLimit: TQuantity
+  /** Total used gas by all transactions in this block */
+  gasUsed: TQuantity
+  /** Block hash or `null` if pending */
+  hash: Hash | null
+  /** Logs bloom filter or `null` if pending */
+  logsBloom: Hex | null
+  /** Address that received this block’s mining rewards */
+  miner: Address
+  /** Unique identifier for the block. */
+  mixHash: Hash
+  /** Proof-of-work hash or `null` if pending */
+  nonce: Hex | null
+  /** Block number or `null` if pending */
+  number: TQuantity | null
+  /** Parent block hash */
+  parentHash: Hash
+  /** Root of the this block’s receipts trie */
+  receiptsRoot: Hex
+  sealFields: Hex[]
+  /** SHA3 of the uncles data in this block */
+  sha3Uncles: Hash
+  /** Size of this block in bytes */
+  size: TQuantity
+  /** Root of this block’s final state trie */
+  stateRoot: Hash
+  /** Unix timestamp of when this block was collated */
+  timestamp: TQuantity
+  /** Total difficulty of the chain until this block */
+  totalDifficulty: TQuantity | null
+  /** List of transaction objects or hashes */
+  transactions: Hash[] | TTransaction[]
+  /** Root of this block’s transaction trie */
+  transactionsRoot: Hash
+  /** List of uncle hashes */
+  uncles: Hash[]
+}
+
+export type BlockIdentifier<TQuantity = bigint> = {
+  /** Whether or not to throw an error if the block is not in the canonical chain as described below. Only allowed in conjunction with the blockHash tag. Defaults to false. */
+  requireCanonical?: boolean
+} & (
+  | {
+      /** The block in the canonical chain with this number */
+      blockNumber: BlockNumber<TQuantity>
+    }
+  | {
+      /** The block uniquely identified by this hash. The `blockNumber` and `blockHash` properties are mutually exclusive; exactly one of them must be set. */
+      blockHash: Hash
+    }
+)
+
+export type BlockNumber<TQuantity = bigint> = TQuantity
+
+export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
+
+export type Uncle<TQuantity = bigint, TTransaction = Transaction> = Block<
+  TQuantity,
+  TTransaction
+>

package/src/types/chain.ts

@@ -0,0 +1,20 @@
+import type { Chain as Chain_ } from '@wagmi/chains'
+import type { Address } from 'abitype'
+import type { Formatters } from './formatter.js'
+import type { IsUndefined } from './utils.js'
+
+export type Chain<TFormatters extends Formatters = Formatters> = Chain_ & {
+  formatters?: TFormatters
+}
+
+export type ChainContract = {
+  address: Address
+  blockCreated?: number
+}
+
+export type GetChain<
+  TChain extends Chain | undefined,
+  TChainOverride extends Chain | undefined = undefined,
+> = IsUndefined<TChain> extends true
+  ? { chain: TChainOverride | null }
+  : { chain?: TChainOverride | null }

package/src/types/contract.ts

@@ -0,0 +1,424 @@
+import type {
+  Abi,
+  AbiError,
+  AbiEvent,
+  AbiFunction,
+  AbiParameter,
+  AbiParameterToPrimitiveType,
+  AbiParametersToPrimitiveTypes,
+  AbiStateMutability,
+  Address,
+  ExtractAbiFunction,
+  ExtractAbiEvent,
+  ExtractAbiEventNames,
+  ExtractAbiError,
+  ExtractAbiErrorNames,
+  ExtractAbiFunctionNames,
+  Narrow,
+  AbiConstructor,
+} from 'abitype'
+import type { Hex, LogTopic } from './misc.js'
+import type { TransactionRequest } from './transaction.js'
+import type { Filter, MaybeRequired } from './utils.js'
+
+export type AbiItem = Abi[number]
+
+export type EventDefinition = `${string}(${string})`
+
+export type ContractFunctionConfig<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
+  TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
+> = {
+  /** Contract ABI */
+  abi: Narrow<TAbi>
+  /** Contract address */
+  address: Address
+  /** Function to invoke on the contract */
+  functionName: InferFunctionName<TAbi, TFunctionName, TAbiStateMutability>
+} & GetFunctionArgs<TAbi, TFunctionName>
+
+export type ContractFunctionResult<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
+  TAbiFunction extends AbiFunction & {
+    type: 'function'
+  } = TAbi extends Abi ? ExtractAbiFunction<TAbi, TFunctionName> : AbiFunction,
+  TArgs = AbiParametersToPrimitiveTypes<TAbiFunction['outputs']>,
+  FailedToParseArgs =
+    | ([TArgs] extends [never] ? true : false)
+    | (readonly unknown[] extends TArgs ? true : false),
+> = true extends FailedToParseArgs
+  ? unknown
+  : TArgs extends readonly []
+  ? void
+  : TArgs extends readonly [infer Arg]
+  ? Arg
+  : TArgs
+
+export type GetValue<
+  TAbi extends Abi | readonly unknown[],
+  TFunctionName extends string,
+  TValueType = TransactionRequest['value'],
+  TAbiFunction extends AbiFunction = TAbi extends Abi
+    ? ExtractAbiFunction<TAbi, TFunctionName>
+    : AbiFunction,
+> = TAbiFunction['stateMutability'] extends 'payable'
+  ? { value?: TValueType }
+  : TAbiFunction['payable'] extends true
+  ? { value?: TValueType }
+  : { value?: never }
+
+export type MaybeAbiEventName<TAbiEvent extends AbiEvent | undefined> =
+  TAbiEvent extends AbiEvent ? TAbiEvent['name'] : undefined
+
+export type MaybeExtractEventArgsFromAbi<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TEventName extends string | undefined = undefined,
+> = TEventName extends string ? GetEventArgs<TAbi, TEventName> : undefined
+
+//////////////////////////////////////////////////////////////////////
+// ABI item name
+
+export type InferErrorName<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TErrorName extends string = string,
+> = TAbi extends Abi
+  ? ExtractAbiErrorNames<TAbi> extends infer AbiErrorNames
+    ?
+        | AbiErrorNames
+        | (TErrorName extends AbiErrorNames ? TErrorName : never)
+        | (Abi extends TAbi ? string : never)
+    : never
+  : TErrorName
+
+export type InferEventName<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TEventName extends string | undefined = string,
+> = TAbi extends Abi
+  ? ExtractAbiEventNames<TAbi> extends infer AbiEventNames
+    ? AbiEventNames | (TEventName extends AbiEventNames ? TEventName : never)
+    : never
+  : TEventName
+
+export type InferFunctionName<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
+  TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
+> = TAbi extends Abi
+  ? ExtractAbiFunctionNames<
+      TAbi,
+      TAbiStateMutability
+    > extends infer AbiFunctionNames
+    ?
+        | AbiFunctionNames
+        | (TFunctionName extends AbiFunctionNames ? TFunctionName : never)
+        | (Abi extends TAbi ? string : never)
+    : never
+  : TFunctionName
+
+export type InferItemName<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TName extends string = string,
+> = TAbi extends Abi
+  ? ExtractAbiItemNames<TAbi> extends infer AbiNames
+    ?
+        | AbiNames
+        | (TName extends AbiNames ? TName : never)
+        | (Abi extends TAbi ? string : never)
+    : never
+  : TName
+type ExtractAbiItemNames<TAbi extends Abi> =
+  | ExtractAbiFunctionNames<TAbi>
+  | ExtractAbiEventNames<TAbi>
+  | ExtractAbiErrorNames<TAbi>
+
+//////////////////////////////////////////////////////////////////////
+// ABI item args
+
+export type GetFunctionArgs<
+  TAbi extends Abi | readonly unknown[],
+  TFunctionName extends string,
+  TAbiFunction extends AbiFunction = TAbi extends Abi
+    ? ExtractAbiFunction<TAbi, TFunctionName>
+    : AbiFunction,
+  TArgs = AbiParametersToPrimitiveTypes<TAbiFunction['inputs']>,
+  FailedToParseArgs =
+    | ([TArgs] extends [never] ? true : false)
+    | (readonly unknown[] extends TArgs ? true : false),
+> = true extends FailedToParseArgs
+  ? {
+      /**
+       * Arguments to pass contract method
+       *
+       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
+       */
+      args?: readonly unknown[]
+    }
+  : TArgs extends readonly []
+  ? { args?: never }
+  : {
+      /** Arguments to pass contract method */ args: TArgs
+    }
+
+export type GetConstructorArgs<
+  TAbi extends Abi | readonly unknown[],
+  TAbiConstructor extends AbiConstructor = TAbi extends Abi
+    ? Extract<TAbi[number], { type: 'constructor' }>
+    : AbiConstructor,
+  TArgs = AbiParametersToPrimitiveTypes<TAbiConstructor['inputs']>,
+  FailedToParseArgs =
+    | ([TArgs] extends [never] ? true : false)
+    | (readonly unknown[] extends TArgs ? true : false),
+> = true extends FailedToParseArgs
+  ? {
+      /**
+       * Arguments to pass contract constructor
+       *
+       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
+       */
+      args?: readonly unknown[]
+    }
+  : TArgs extends readonly []
+  ? { args?: never }
+  : {
+      /** Arguments to pass contract constructor */ args: TArgs
+    }
+
+export type GetErrorArgs<
+  TAbi extends Abi | readonly unknown[],
+  TErrorName extends string,
+  TAbiError extends AbiError = TAbi extends Abi
+    ? ExtractAbiError<TAbi, TErrorName>
+    : AbiError,
+  TArgs = AbiParametersToPrimitiveTypes<TAbiError['inputs']>,
+  FailedToParseArgs =
+    | ([TArgs] extends [never] ? true : false)
+    | (readonly unknown[] extends TArgs ? true : false),
+> = true extends FailedToParseArgs
+  ? {
+      /**
+       * Arguments to pass contract method
+       *
+       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
+       */
+      args?: readonly unknown[]
+    }
+  : TArgs extends readonly []
+  ? { args?: never }
+  : {
+      /** Arguments to pass contract method */ args: TArgs
+    }
+
+export type GetEventArgs<
+  TAbi extends Abi | readonly unknown[],
+  TEventName extends string,
+  TConfig extends EventParameterOptions = DefaultEventParameterOptions,
+  TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
+    ? ExtractAbiEvent<TAbi, TEventName>
+    : AbiEvent & { type: 'event' },
+  TArgs = AbiEventParametersToPrimitiveTypes<TAbiEvent['inputs'], TConfig>,
+  FailedToParseArgs =
+    | ([TArgs] extends [never] ? true : false)
+    | (readonly unknown[] extends TArgs ? true : false),
+> = true extends FailedToParseArgs
+  ? readonly unknown[]
+  : TArgs extends readonly []
+  ? never
+  : TArgs
+
+export type GetEventArgsFromTopics<
+  TAbi extends Abi | readonly unknown[],
+  TEventName extends string,
+  TTopics extends LogTopic[],
+  TData extends Hex | undefined,
+  TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
+    ? ExtractAbiEvent<TAbi, TEventName>
+    : AbiEvent & { type: 'event' },
+  TArgs = AbiEventTopicsToPrimitiveTypes<TAbiEvent['inputs'], TTopics, TData>,
+> = TTopics extends readonly []
+  ? TData extends undefined
+    ? { args?: never }
+    : { args?: TArgs }
+  : { args?: TArgs }
+
+//////////////////////////////////////////////////////////////////////
+// ABI event types
+
+type EventParameterOptions = {
+  EnableUnion?: boolean
+  IndexedOnly?: boolean
+  Required?: boolean
+}
+type DefaultEventParameterOptions = {
+  EnableUnion: true
+  IndexedOnly: true
+  Required: false
+}
+
+type HashedEventTypes = 'bytes' | 'string' | 'tuple' | `${string}[${string}]`
+
+// TODO: Speed up by returning immediately as soon as named parameter is found.
+type _HasUnnamedAbiParameter<TAbiParameters extends readonly AbiParameter[]> =
+  TAbiParameters extends readonly [
+    infer Head extends AbiParameter,
+    ...infer Tail extends readonly AbiParameter[],
+  ]
+    ? Head extends { name: string }
+      ? Head['name'] extends ''
+        ? true
+        : _HasUnnamedAbiParameter<Tail>
+      : true
+    : false
+
+/**
+ * @internal
+ */
+export type LogTopicType<
+  TPrimitiveType = Hex,
+  TTopic extends LogTopic = LogTopic,
+> = TTopic extends Hex
+  ? TPrimitiveType
+  : TTopic extends Hex[]
+  ? TPrimitiveType[]
+  : TTopic extends null
+  ? null
+  : never
+
+/**
+ * @internal
+ */
+export type AbiEventParameterToPrimitiveType<
+  TAbiParameter extends AbiParameter,
+  Options extends EventParameterOptions = DefaultEventParameterOptions,
+  _Type = AbiParameterToPrimitiveType<TAbiParameter>,
+> = Options['EnableUnion'] extends true ? LogTopicType<_Type> : _Type
+
+/**
+ * @internal
+ */
+export type AbiEventTopicToPrimitiveType<
+  TAbiParameter extends AbiParameter,
+  TTopic extends LogTopic,
+  TPrimitiveType = TAbiParameter['type'] extends HashedEventTypes
+    ? TTopic
+    : AbiParameterToPrimitiveType<TAbiParameter>,
+> = LogTopicType<TPrimitiveType, TTopic>
+
+export type AbiEventParametersToPrimitiveTypes<
+  TAbiParameters extends readonly AbiParameter[],
+  Options extends EventParameterOptions = DefaultEventParameterOptions,
+  // Remove non-indexed parameters based on `Options['IndexedOnly']`
+> = TAbiParameters extends readonly []
+  ? readonly []
+  : Filter<
+      TAbiParameters,
+      Options['IndexedOnly'] extends true ? { indexed: true } : object
+    > extends infer Filtered extends readonly AbiParameter[]
+  ? _HasUnnamedAbiParameter<Filtered> extends true
+    ? // Has unnamed tuple parameters so return as array
+        | readonly [
+            ...{
+              [K in keyof Filtered]: AbiEventParameterToPrimitiveType<
+                Filtered[K],
+                Options
+              >
+            },
+          ]
+        | (Options['Required'] extends true
+            ? never
+            : // Distribute over tuple to represent optional parameters
+            Filtered extends readonly [
+                ...infer Head extends readonly AbiParameter[],
+                infer _,
+              ]
+            ? AbiEventParametersToPrimitiveTypes<
+                readonly [...{ [K in keyof Head]: Omit<Head[K], 'name'> }],
+                Options
+              >
+            : never)
+    : // All tuple parameters are named so return as object
+    {
+        [Parameter in
+          Filtered[number] as Parameter extends {
+            name: infer Name extends string
+          }
+            ? Name
+            : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
+      } extends infer Mapped
+    ? MaybeRequired<
+        Mapped,
+        Options['Required'] extends boolean ? Options['Required'] : false
+      >
+    : never
+  : never
+
+/**
+ * @internal
+ */
+// TODO(@tmm): Simplify this type
+export type AbiEventTopicsToPrimitiveTypes<
+  TAbiParameters extends readonly AbiParameter[],
+  TTopics extends LogTopic[] | undefined = undefined,
+  TData extends Hex | undefined = undefined,
+  TBase = TAbiParameters[0] extends { name: string } ? {} : [],
+> = TAbiParameters extends readonly [
+  infer Head extends AbiParameter,
+  ...infer Tail,
+]
+  ? TTopics extends readonly [infer TopicHead, ...infer TopicTail]
+    ? Head extends { indexed: true }
+      ? Head extends { name: infer Name extends string }
+        ? {
+            [_ in Name]: TopicHead extends LogTopic
+              ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+              : never
+          } & (Tail extends readonly []
+            ? {}
+            : Tail extends readonly AbiParameter[]
+            ? TopicTail extends LogTopic[]
+              ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+              : {}
+            : {})
+        : [
+            TopicHead extends LogTopic
+              ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+              : never,
+            ...(Tail extends readonly []
+              ? []
+              : Tail extends readonly AbiParameter[]
+              ? TopicTail extends LogTopic[]
+                ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+                : []
+              : []),
+          ]
+      : TBase
+    : TTopics extends readonly []
+    ? TData extends '0x'
+      ? TBase
+      : TData extends Hex
+      ? Head extends AbiParameter
+        ? Head extends { indexed: true }
+          ? Tail extends readonly AbiParameter[]
+            ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+            : TBase
+          : Head extends { name: infer Name extends string }
+          ? {
+              [_ in Name]: AbiParameterToPrimitiveType<Head>
+            } & (Tail extends readonly []
+              ? {}
+              : Tail extends readonly AbiParameter[]
+              ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+              : {})
+          : [
+              AbiParameterToPrimitiveType<Head>,
+              ...(Tail extends readonly []
+                ? []
+                : Tail extends readonly AbiParameter[]
+                ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                : []),
+            ]
+        : TBase
+      : TBase
+    : TBase
+  : undefined