viem 0.4.0-main.20230430T213120 → 1.0.0

package/src/types/filter.ts

@@ -1,10 +1,19 @@
 import type { Abi } from 'abitype'
+
 import type { MaybeExtractEventArgsFromAbi } from './contract.js'
+import type { EIP1193RequestFn, PublicRpcSchema } from './eip1193.js'
 import type { Hex } from './misc.js'
-import type { Requests } from './eip1193.js'
+import type { Filter as Filter_ } from './utils.js'
 
 export type FilterType = 'transaction' | 'block' | 'event'
 
+type FilterRpcSchema = Filter_<
+  PublicRpcSchema,
+  {
+    Method: 'eth_getFilterLogs' | 'eth_getFilterChanges' | 'eth_uninstallFilter'
+  }
+>
+
 export type Filter<
   TFilterType extends FilterType = 'event',
   TAbi extends Abi | readonly unknown[] = Abi,
@@ -12,10 +21,10 @@ export type Filter<
   TArgs extends
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = MaybeExtractEventArgsFromAbi<TAbi, TEventName>,
+  TStrict extends boolean | undefined = undefined,
 > = {
   id: Hex
-  // TODO: Narrow `request` to filter-based methods (ie. `eth_getFilterLogs`, etc).
-  request: Requests['request']
+  request: EIP1193RequestFn<FilterRpcSchema>
   type: TFilterType
 } & (TFilterType extends 'event'
   ? TAbi extends Abi
@@ -24,21 +33,25 @@ export type Filter<
           abi: TAbi
           args?: never
           eventName?: never
+          strict: TStrict
         }
       : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
       ? {
           abi: TAbi
           args: TArgs
           eventName: TEventName
+          strict: TStrict
         }
       : {
           abi: TAbi
           args?: never
           eventName: TEventName
+          strict: TStrict
         }
     : {
         abi?: never
         args?: never
         eventName?: never
+        strict?: never
       }
   : {})

package/src/types/log.ts

@@ -1,39 +1,22 @@
-import type { Abi, AbiEvent, Address, ExtractAbiEventNames } from 'abitype'
-import type { GetEventArgs } from './contract.js'
-import type { Hash, Hex } from './misc.js'
+import type {
+  Abi,
+  AbiEvent,
+  Address,
+  ExtractAbiEvent,
+  ExtractAbiEventNames,
+} from 'abitype'
 
-type DecodedAbiEvent<
-  TAbiEvent extends AbiEvent | undefined = undefined,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
-  TEventName extends string | undefined = TAbiEvent extends AbiEvent
-    ? TAbiEvent['name']
-    : undefined,
-> = TAbi extends Abi
-  ? TEventName extends string
-    ? {
-        args: GetEventArgs<
-          TAbi,
-          TEventName,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: TEventName
-      }
-    : {
-        args: GetEventArgs<
-          TAbi,
-          string,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: ExtractAbiEventNames<TAbi>
-      }
-  : {}
+import type {
+  AbiEventParametersToPrimitiveTypes,
+  GetEventArgs,
+} from './contract.js'
+import type { Hash, Hex } from './misc.js'
 
 export type Log<
   TQuantity = bigint,
   TIndex = number,
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TAbi extends Abi | readonly unknown[] = [TAbiEvent],
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
@@ -53,8 +36,93 @@ export type Log<
   transactionHash: Hash | null
   /** Index of the transaction that created this log or `null` if pending */
   transactionIndex: TIndex | null
-  /** List of order-dependent topics */
-  topics: [Hex, ...Hex[]] | []
   /** `true` if this filter has been destroyed and is invalid */
   removed: boolean
-} & DecodedAbiEvent<TAbiEvent, TAbi, TEventName>
+} & GetInferredLogValues<TAbiEvent, TAbi, TEventName, TStrict>
+
+type Topics<
+  THead extends AbiEvent['inputs'],
+  TBase = [Hex],
+> = THead extends readonly [
+  infer _Head,
+  ...infer Tail extends AbiEvent['inputs'],
+]
+  ? _Head extends { indexed: true }
+    ? [Hex, ...Topics<Tail>]
+    : Topics<Tail>
+  : TBase
+
+type GetTopics<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TEventName extends string | undefined = TAbiEvent extends AbiEvent
+    ? TAbiEvent['name']
+    : undefined,
+  _AbiEvent extends AbiEvent | undefined = TAbi extends Abi
+    ? TEventName extends string
+      ? ExtractAbiEvent<TAbi, TEventName>
+      : undefined
+    : undefined,
+  _Args = _AbiEvent extends AbiEvent
+    ? AbiEventParametersToPrimitiveTypes<_AbiEvent['inputs']>
+    : never,
+  _FailedToParseArgs =
+    | ([_Args] extends [never] ? true : false)
+    | (readonly unknown[] extends _Args ? true : false),
+> = true extends _FailedToParseArgs
+  ? [Hex, ...Hex[]] | []
+  : TAbiEvent extends AbiEvent
+  ? Topics<TAbiEvent['inputs']>
+  : _AbiEvent extends AbiEvent
+  ? Topics<_AbiEvent['inputs']>
+  : [Hex, ...Hex[]] | []
+
+type GetInferredLogValues<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TEventName extends string | undefined = TAbiEvent extends AbiEvent
+    ? TAbiEvent['name']
+    : undefined,
+  TStrict extends boolean | undefined = undefined,
+  _EventNames extends string = TAbi extends Abi
+    ? Abi extends TAbi
+      ? string
+      : ExtractAbiEventNames<TAbi>
+    : string,
+> = TAbi extends Abi
+  ? TEventName extends string
+    ? {
+        args: GetEventArgs<
+          TAbi,
+          TEventName,
+          {
+            EnableUnion: false
+            IndexedOnly: false
+            Required: TStrict extends boolean ? TStrict : false
+          }
+        >
+        /** The event name decoded from `topics`. */
+        eventName: TEventName
+        /** List of order-dependent topics */
+        topics: GetTopics<TAbiEvent, TAbi, TEventName>
+      }
+    : {
+        [TName in _EventNames]: {
+          args: GetEventArgs<
+            TAbi,
+            string,
+            {
+              EnableUnion: false
+              IndexedOnly: false
+              Required: TStrict extends boolean ? TStrict : false
+            }
+          >
+          /** The event name decoded from `topics`. */
+          eventName: TName
+          /** List of order-dependent topics */
+          topics: GetTopics<TAbiEvent, TAbi, TName>
+        }
+      }[_EventNames]
+  : {
+      topics: [Hex, ...Hex[]] | []
+    }

package/src/types/misc.ts

@@ -2,6 +2,12 @@ export type ByteArray = Uint8Array
 export type Hex = `0x${string}`
 export type Hash = `0x${string}`
 export type LogTopic = Hex | Hex[] | null
+export type SignableMessage =
+  | string
+  | {
+      /** Raw data representation of the message. */
+      raw: Hex | ByteArray
+    }
 export type Signature = {
   r: Hex
   s: Hex

package/src/types/multicall.ts

@@ -1,4 +1,5 @@
 import type { Abi } from 'abitype'
+
 import type {
   ContractFunctionConfig,
   ContractFunctionResult,

package/src/types/transaction.ts

@@ -1,5 +1,7 @@
 import type { Address } from 'abitype'
-import type { transactionType } from '../utils/index.js'
+
+import type { transactionType } from '../utils/formatters/transaction.js'
+
 import type { FeeValuesEIP1559, FeeValuesLegacy } from './fee.js'
 import type { Log } from './log.js'
 import type { Hash, Hex, Signature } from './misc.js'
@@ -50,8 +52,6 @@ export type TransactionBase<TQuantity = bigint, TIndex = number> = {
   blockHash: Hash | null
   /** Number of block containing this transaction or `null` if pending */
   blockNumber: TQuantity | null
-  /** Chain ID. */
-  chainId: TIndex
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
@@ -82,6 +82,7 @@ export type TransactionLegacy<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesLegacy<TQuantity> & {
     accessList?: never
+    chainId?: TIndex
     type: TType
   }
 export type TransactionEIP2930<
@@ -91,6 +92,7 @@ export type TransactionEIP2930<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesLegacy<TQuantity> & {
     accessList: AccessList
+    chainId: TIndex
     type: TType
   }
 export type TransactionEIP1559<
@@ -100,6 +102,7 @@ export type TransactionEIP1559<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesEIP1559<TQuantity> & {
     accessList: AccessList
+    chainId: TIndex
     type: TType
   }
 export type Transaction<TQuantity = bigint, TIndex = number> =

package/src/types/transport.ts

@@ -1,4 +1,4 @@
-import type { Transport } from '../clients/index.js'
+import type { Transport } from '../clients/transports/createTransport.js'
 
 export type GetTransportConfig<TTransport extends Transport> =
   ReturnType<TTransport>['config']

package/src/types/utils.ts

@@ -106,6 +106,21 @@ export type MaybeRequired<T, TRequired extends boolean> = TRequired extends true
   ? Required<T>
   : T
 
+/**
+ * @description Makes the attribute on the type T allow undefined if TUndefinedish is true.
+ *
+ * @example
+ * MaybeUndefined<string, true>
+ * => string | undefined
+ *
+ * MaybeUndefined<string, false>
+ * => string
+ */
+export type MaybeUndefined<
+  T,
+  TUndefinedish extends boolean,
+> = TUndefinedish extends true ? T | undefined : T
+
 /**
  * @description Merges the intersection properties of T and U.
  *

package/src/utils/abi/decodeAbiParameters.ts

@@ -1,25 +1,27 @@
 import type {
   AbiParameter,
-  AbiParametersToPrimitiveTypes,
   AbiParameterToPrimitiveType,
+  AbiParametersToPrimitiveTypes,
   Narrow,
 } from 'abitype'
 
 import {
-  AbiDecodingDataSizeInvalidError,
   AbiDecodingDataSizeTooSmallError,
   AbiDecodingZeroDataError,
   InvalidAbiDecodingTypeError,
-} from '../../errors/index.js'
-import type { Hex } from '../../types/index.js'
-import { checksumAddress } from '../address/index.js'
-import { size, slice, trim } from '../data/index.js'
+} from '../../errors/abi.js'
+import type { Hex } from '../../types/misc.js'
+import { checksumAddress } from '../address/getAddress.js'
+import { size } from '../data/size.js'
+import { slice } from '../data/slice.js'
+import { trim } from '../data/trim.js'
 import {
   hexToBigInt,
   hexToBool,
   hexToNumber,
   hexToString,
-} from '../encoding/index.js'
+} from '../encoding/fromHex.js'
+
 import { getArrayComponents } from './encodeAbiParameters.js'
 
 export type DecodeAbiParametersReturnType<
@@ -35,8 +37,12 @@ export function decodeAbiParameters<
 >(params: Narrow<TParams>, data: Hex): DecodeAbiParametersReturnType<TParams> {
   if (data === '0x' && (params as unknown[]).length > 0)
     throw new AbiDecodingZeroDataError()
-  if (size(data) % 32 !== 0)
-    throw new AbiDecodingDataSizeInvalidError({ data, size: size(data) })
+  if (size(data) && size(data) < 32)
+    throw new AbiDecodingDataSizeTooSmallError({
+      data,
+      params: params as readonly AbiParameter[],
+      size: size(data),
+    })
   return decodeParams({
     data,
     params: params as readonly AbiParameter[],
@@ -99,7 +105,7 @@ function decodeParam({
     return decodeBytes(data, { param, position })
   }
 
-  const value = slice(data, position, position + 32) as Hex
+  const value = slice(data, position, position + 32, { strict: true }) as Hex
   if (param.type.startsWith('uint') || param.type.startsWith('int')) {
     return decodeNumber(value, { param })
   }
@@ -136,9 +142,13 @@ function decodeArray<TParam extends AbiParameter>(
   // we will need to decode the offset of the array data.
   if (!length) {
     // Get the offset of the array data.
-    const offset = hexToNumber(slice(data, position, position + 32))
+    const offset = hexToNumber(
+      slice(data, position, position + 32, { strict: true }),
+    )
     // Get the length of the array from the offset.
-    const length = hexToNumber(slice(data, offset, offset + 32))
+    const length = hexToNumber(
+      slice(data, offset, offset + 32, { strict: true }),
+    )
 
     let consumed = 0
     const value: AbiParameterToPrimitiveType<TParam>[] = []
@@ -166,7 +176,9 @@ function decodeArray<TParam extends AbiParameter>(
     let consumed = 0
     const value: AbiParameterToPrimitiveType<TParam>[] = []
     for (let i = 0; i < length; ++i) {
-      const offset = hexToNumber(slice(data, position, position + 32))
+      const offset = hexToNumber(
+        slice(data, position, position + 32, { strict: true }),
+      )
       const decodedChild = decodeParam({
         data: slice(data, offset),
         param,
@@ -207,15 +219,23 @@ function decodeBytes<TParam extends AbiParameter>(
   if (!size) {
     // If we don't have a size, we're dealing with a dynamic-size array
     // so we need to read the offset of the data part first.
-    const offset = hexToNumber(slice(data, position, position + 32))
-    const length = hexToNumber(slice(data, offset, offset + 32))
+    const offset = hexToNumber(
+      slice(data, position, position + 32, { strict: true }),
+    )
+    const length = hexToNumber(
+      slice(data, offset, offset + 32, { strict: true }),
+    )
     // If there is no length, we have zero data.
     if (length === 0) return { consumed: 32, value: '0x' }
-    const value = slice(data, offset + 32, offset + 32 + length)
+    const value = slice(data, offset + 32, offset + 32 + length, {
+      strict: true,
+    })
     return { consumed: 32, value }
   }
 
-  const value = slice(data, position, position + parseInt(size))
+  const value = slice(data, position, position + parseInt(size), {
+    strict: true,
+  })
   return { consumed: 32, value }
 }
 
@@ -235,12 +255,14 @@ function decodeNumber<TParam extends AbiParameter>(
 }
 
 function decodeString(data: Hex, { position }: { position: number }) {
-  const offset = hexToNumber(slice(data, position, position + 32))
-  const length = hexToNumber(slice(data, offset, offset + 32))
+  const offset = hexToNumber(
+    slice(data, position, position + 32, { strict: true }),
+  )
+  const length = hexToNumber(slice(data, offset, offset + 32, { strict: true }))
   // If there is no length, we have zero data (empty string).
   if (length === 0) return { consumed: 32, value: '' }
   const value = hexToString(
-    trim(slice(data, offset + 32, offset + 32 + length)),
+    trim(slice(data, offset + 32, offset + 32 + length, { strict: true })),
   )
   return { consumed: 32, value }
 }
@@ -263,7 +285,9 @@ function decodeTuple<
   // If the tuple has a dynamic child, we must first decode the offset to the
   // tuple data.
   if (hasDynamicChild(param)) {
-    const offset = hexToNumber(slice(data, position, position + 32))
+    const offset = hexToNumber(
+      slice(data, position, position + 32, { strict: true }),
+    )
     // Decode each component of the tuple, starting at the offset.
     for (let i = 0; i < param.components.length; ++i) {
       const component = param.components[i]

package/src/utils/abi/decodeDeployData.ts

@@ -1,10 +1,12 @@
-import type { Abi } from 'abitype'
+import type { Abi, Narrow } from 'abitype'
 
 import {
   AbiConstructorNotFoundError,
   AbiConstructorParamsNotFoundError,
-} from '../../errors/index.js'
-import type { Hex } from '../../types/index.js'
+} from '../../errors/abi.js'
+import type { GetConstructorArgs } from '../../types/contract.js'
+import type { Hex } from '../../types/misc.js'
+
 import { decodeAbiParameters } from './decodeAbiParameters.js'
 
 const docsPath = '/docs/contract/decodeDeployData'
@@ -12,21 +14,22 @@ const docsPath = '/docs/contract/decodeDeployData'
 export type DecodeDeployDataParameters<
   TAbi extends Abi | readonly unknown[] = Abi,
 > = {
-  abi: TAbi
+  abi: Narrow<TAbi>
   bytecode: Hex
   data: Hex
 }
-export type DecodeDeployDataReturnType = {
-  args?: readonly unknown[] | undefined
+export type DecodeDeployDataReturnType<
+  TAbi extends Abi | readonly unknown[] = Abi,
+> = {
   bytecode: Hex
-}
+} & GetConstructorArgs<TAbi>
 
 export function decodeDeployData<TAbi extends Abi | readonly unknown[]>({
   abi,
   bytecode,
   data,
-}: DecodeDeployDataParameters<TAbi>): DecodeDeployDataReturnType {
-  if (data === bytecode) return { bytecode }
+}: DecodeDeployDataParameters<TAbi>): DecodeDeployDataReturnType<TAbi> {
+  if (data === bytecode) return { bytecode } as DecodeDeployDataReturnType<TAbi>
 
   const description = (abi as Abi).find(
     (x) => 'type' in x && x.type === 'constructor',
@@ -41,5 +44,5 @@ export function decodeDeployData<TAbi extends Abi | readonly unknown[]>({
     description.inputs,
     `0x${data.replace(bytecode, '')}`,
   )
-  return { args, bytecode }
+  return { args, bytecode } as unknown as DecodeDeployDataReturnType<TAbi>
 }

package/src/utils/abi/decodeErrorResult.ts

@@ -1,31 +1,50 @@
-import type { Abi } from 'abitype'
-import { solidityError, solidityPanic } from '../../constants/index.js'
+import type {
+  Abi,
+  ExtractAbiError,
+  ExtractAbiErrorNames,
+  Narrow,
+} from 'abitype'
+
+import { solidityError, solidityPanic } from '../../constants/solidity.js'
 import {
   AbiDecodingZeroDataError,
   AbiErrorSignatureNotFoundError,
-} from '../../errors/index.js'
-import type { AbiItem, Hex } from '../../types/index.js'
-import { slice } from '../data/index.js'
-import { getFunctionSelector } from '../hash/index.js'
+} from '../../errors/abi.js'
+import type { AbiItem, GetErrorArgs } from '../../types/contract.js'
+import type { Hex } from '../../types/misc.js'
+import { slice } from '../data/slice.js'
+import { getFunctionSelector } from '../hash/getFunctionSelector.js'
+
 import { decodeAbiParameters } from './decodeAbiParameters.js'
 import { formatAbiItem } from './formatAbiItem.js'
 
-export type DecodeErrorResultParameters = { abi?: Abi; data: Hex }
+export type DecodeErrorResultParameters<
+  TAbi extends Abi | readonly unknown[] = Abi,
+> = { abi?: Narrow<TAbi>; data: Hex }
 
-export type DecodeErrorResultReturnType = {
-  abiItem: AbiItem
-  errorName: string
-  args?: readonly unknown[]
-}
+export type DecodeErrorResultReturnType<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  _ErrorNames extends string = TAbi extends Abi
+    ? Abi extends TAbi
+      ? string
+      : ExtractAbiErrorNames<TAbi>
+    : string,
+> = {
+  [TName in _ErrorNames]: {
+    abiItem: TAbi extends Abi ? ExtractAbiError<TAbi, TName> : AbiItem
+    args: GetErrorArgs<TAbi, TName>['args']
+    errorName: TName
+  }
+}[_ErrorNames]
 
-export function decodeErrorResult({
+export function decodeErrorResult<TAbi extends Abi | readonly unknown[]>({
   abi,
   data,
-}: DecodeErrorResultParameters): DecodeErrorResultReturnType {
+}: DecodeErrorResultParameters<TAbi>): DecodeErrorResultReturnType<TAbi> {
   const signature = slice(data, 0, 4)
   if (signature === '0x') throw new AbiDecodingZeroDataError()
 
-  const abi_ = [...(abi || []), solidityError, solidityPanic]
+  const abi_ = [...((abi as Abi) || []), solidityError, solidityPanic]
   const abiItem = abi_.find(
     (x) =>
       x.type === 'error' && signature === getFunctionSelector(formatAbiItem(x)),
@@ -40,5 +59,5 @@ export function decodeErrorResult({
       ? decodeAbiParameters(abiItem.inputs, slice(data, 4))
       : undefined) as readonly unknown[] | undefined,
     errorName: (abiItem as { name: string }).name,
-  }
+  } as DecodeErrorResultReturnType<TAbi>
 }