viem 0.0.0-portable-types-20230518183529 → 0.0.0-portable-types-20230522163654

package/package.json

@@ -12,7 +12,7 @@
     "isomorphic-ws": "5.0.0",
     "ws": "8.12.0"
   },
-  "version": "0.0.0-portable-types-20230518183529",
+  "version": "0.0.0-portable-types-20230522163654",
   "files": [
     "dist",
     "!dist/**/*.tsbuildinfo",
@@ -20,7 +20,18 @@
     "!src/**/*.test.ts",
     "!src/**/*.test-d.ts",
     "!src/**/*.bench.ts",
-    "!src/_test/**/*"
+    "!src/_test/**/*",
+    "abi",
+    "accounts",
+    "chains",
+    "contract",
+    "ens",
+    "ethers",
+    "public",
+    "test",
+    "utils",
+    "wallet",
+    "window"
   ],
   "exports": {
     ".": {

package/public/package.json

@@ -0,0 +1,5 @@
+{
+  "types": "../dist/types/public.d.ts",
+  "module": "../dist/esm/public.js",
+  "main": "../dist/cjs/public.js"
+}

package/src/actions/ens/getEnsAddress.ts

@@ -106,5 +106,5 @@ export async function getEnsAddress<TChain extends Chain | undefined,>(
     data: res[0],
   })
 
-  return trim(address) === '0x0' ? null : address
+  return trim(address) === '0x00' ? null : address
 }

package/src/actions/public/getTransactionReceipt.ts

@@ -24,7 +24,7 @@ export type GetTransactionReceiptReturnType<
  *
  * - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt.html
  * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
- * - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt)
+ * - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionreceipt)
  *
  * @param client - Client to use
  * @param parameters - {@link GetTransactionReceiptParameters}

package/src/actions/public/waitForTransactionReceipt.ts

@@ -9,6 +9,8 @@ import type { Chain } from '../../types/chain.js'
 import type { Hash } from '../../types/misc.js'
 import type { Transaction } from '../../types/transaction.js'
 import { observe } from '../../utils/observe.js'
+import { withRetry } from '../../utils/promise/withRetry.js'
+import { stringify } from '../../utils/stringify.js'
 
 import { getBlock } from './getBlock.js'
 import {
@@ -106,16 +108,12 @@ export async function waitForTransactionReceipt<
     timeout,
   }: WaitForTransactionReceiptParameters<TChain>,
 ): Promise<WaitForTransactionReceiptReturnType<TChain>> {
-  const observerId = JSON.stringify([
-    'waitForTransactionReceipt',
-    client.uid,
-    hash,
-  ])
+  const observerId = stringify(['waitForTransactionReceipt', client.uid, hash])
 
   let transaction: GetTransactionReturnType<TChain> | undefined
   let replacedTransaction: GetTransactionReturnType<TChain> | undefined
   let receipt: GetTransactionReceiptReturnType<TChain>
-  let retries = 0
+  let retrying = false
 
   return new Promise((resolve, reject) => {
     if (timeout)
@@ -133,7 +131,11 @@ export async function waitForTransactionReceipt<
           emitOnBegin: true,
           poll: true,
           pollingInterval,
-          async onBlockNumber(blockNumber) {
+          async onBlockNumber(blockNumber_) {
+            if (retrying) return
+
+            let blockNumber = blockNumber_
+
             const done = async (fn: () => void) => {
               unwatch()
               fn()
@@ -152,13 +154,34 @@ export async function waitForTransactionReceipt<
               }
 
               // Get the transaction to check if it's been replaced.
-              transaction = await getTransaction(client, { hash })
+              // We need to retry as some RPC Providers may be slow to sync
+              // up mined transactions.
+              if (!transaction) {
+                retrying = true
+                await withRetry(
+                  async () => {
+                    transaction = await getTransaction(client, { hash })
+                    if (transaction.blockNumber)
+                      blockNumber = transaction.blockNumber
+                  },
+                  {
+                    // exponential backoff
+                    delay: ({ count }) => ~~(1 << count) * 200,
+                    retryCount: 6,
+                  },
+                )
+                retrying = false
+              }
 
               // Get the receipt to check if it's been processed.
               receipt = await getTransactionReceipt(client, { hash })
 
               // Check if we have enough confirmations. If not, continue polling.
-              if (blockNumber - receipt.blockNumber + 1n < confirmations) return
+              if (
+                confirmations > 0 &&
+                blockNumber - receipt.blockNumber + 1n < confirmations
+              )
+                return
 
               done(() => emit.resolve(receipt))
             } catch (err) {
@@ -220,8 +243,7 @@ export async function waitForTransactionReceipt<
                   emit.resolve(receipt)
                 })
               } else {
-                if (retries > 2) done(() => emit.reject(err))
-                retries++
+                done(() => emit.reject(err))
               }
             }
           },

package/src/actions/public/watchBlockNumber.ts

@@ -5,6 +5,7 @@ import type { GetTransportConfig } from '../../types/transport.js'
 import { hexToBigInt } from '../../utils/encoding/fromHex.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
 
 import {
   type GetBlockNumberReturnType,
@@ -92,7 +93,7 @@ export function watchBlockNumber<
   let prevBlockNumber: GetBlockNumberReturnType | undefined
 
   const pollBlockNumber = () => {
-    const observerId = JSON.stringify([
+    const observerId = stringify([
       'watchBlockNumber',
       client.uid,
       emitOnBegin,

package/src/actions/public/watchBlocks.ts

@@ -5,6 +5,7 @@ import type { Chain } from '../../types/chain.js'
 import type { GetTransportConfig } from '../../types/transport.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
 
 import { type GetBlockReturnType, getBlock } from './getBlock.js'
 
@@ -100,7 +101,7 @@ export function watchBlocks<
   let prevBlock: GetBlockReturnType<TChain> | undefined
 
   const pollBlocks = () => {
-    const observerId = JSON.stringify([
+    const observerId = stringify([
       'watchBlocks',
       client.uid,
       emitMissed,

package/src/actions/public/watchContractEvent.ts

@@ -12,6 +12,7 @@ import {
 } from '../../utils/abi/getAbiItem.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
 
 import {
   type CreateContractEventFilterParameters,
@@ -103,7 +104,7 @@ export function watchContractEvent<
     pollingInterval = client.pollingInterval,
   }: WatchContractEventParameters<TAbi, TEventName>,
 ): WatchContractEventReturnType {
-  const observerId = JSON.stringify([
+  const observerId = stringify([
     'watchContractEvent',
     address,
     args,

package/src/actions/public/watchEvent.ts

@@ -11,6 +11,7 @@ import type { Filter } from '../../types/filter.js'
 import type { Log } from '../../types/log.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
 
 import {
   type CreateEventFilterParameters,
@@ -108,7 +109,7 @@ export function watchEvent<
     pollingInterval = client.pollingInterval,
   }: WatchEventParameters<TAbiEvent>,
 ): WatchEventReturnType {
-  const observerId = JSON.stringify([
+  const observerId = stringify([
     'watchEvent',
     address,
     args,

package/src/actions/public/watchPendingTransactions.ts

@@ -6,6 +6,7 @@ import type { Hash } from '../../types/misc.js'
 import type { GetTransportConfig } from '../../types/transport.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
 
 import { createPendingTransactionFilter } from './createPendingTransactionFilter.js'
 import { getFilterChanges } from './getFilterChanges.js'
@@ -104,7 +105,7 @@ export function watchPendingTransactions<
     typeof poll_ !== 'undefined' ? poll_ : client.transport.type !== 'webSocket'
 
   const pollPendingTransactions = () => {
-    const observerId = JSON.stringify([
+    const observerId = stringify([
       'watchPendingTransactions',
       client.uid,
       batch,

package/src/clients/createTestClient.ts

@@ -5,7 +5,7 @@ import { type Client, type ClientConfig, createClient } from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
 
-export type TestClientMode = 'anvil' | 'hardhat'
+export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 
 export type TestClientConfig<
   TMode extends TestClientMode = TestClientMode,
@@ -15,7 +15,7 @@ export type TestClientConfig<
   ClientConfig<TTransport, TChain>,
   'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
 > & {
-  /** Mode of the test client. Available: "anvil" | "hardhat" */
+  /** Mode of the test client. Available: "anvil" | "hardhat" | "ganache" */
   mode: TMode
 }
 

package/src/errors/abi.ts

@@ -293,8 +293,6 @@ export class DecodeLogDataMismatch extends BaseError {
       ].join('\n'),
       {
         metaMessages: [
-          'This error is usually caused if the ABI event has too many non-indexed event parameters for the emitted log.',
-          '',
           `Params: (${formatAbiParams(params, { includeName: true })})`,
           `Data:   ${data} (${size} bytes)`,
         ],

package/src/errors/ccip.ts

@@ -1,6 +1,7 @@
 import type { Address } from 'abitype'
 
 import type { Hex } from '../types/misc.js'
+import { stringify } from '../utils/stringify.js'
 
 import { BaseError } from './base.js'
 import { getUrl } from './utils.js'
@@ -53,7 +54,7 @@ export class OffchainLookupResponseMalformedError extends BaseError {
       {
         metaMessages: [
           `Gateway URL: ${getUrl(url)}`,
-          `Response: ${JSON.stringify(result)}`,
+          `Response: ${stringify(result)}`,
         ],
       },
     )

package/src/errors/data.ts

@@ -2,9 +2,15 @@ import { BaseError } from './base.js'
 
 export class SliceOffsetOutOfBoundsError extends BaseError {
   override name = 'SliceOffsetOutOfBoundsError'
-  constructor({ offset, size }: { offset: number; size: number }) {
+  constructor({
+    offset,
+    position,
+    size,
+  }: { offset: number; position: 'start' | 'end'; size: number }) {
     super(
-      `Slice starting at offset "${offset}" is out-of-bounds (size: ${size}).`,
+      `Slice ${
+        position === 'start' ? 'starting' : 'ending'
+      } at offset "${offset}" is out-of-bounds (size: ${size}).`,
     )
   }
 }

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '0.3.24'
+export const version = '0.3.33'

package/src/types/contract.ts

@@ -20,7 +20,7 @@ import type {
 
 import type { Hex, LogTopic } from './misc.js'
 import type { TransactionRequest } from './transaction.js'
-import type { Filter, MaybeRequired, NoUndefined, Prettify } from './utils.js'
+import type { Filter, NoUndefined } from './utils.js'
 
 export type AbiItem = Abi[number]
 
@@ -236,7 +236,10 @@ export type GetEventArgsFromTopics<
   TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
     ? ExtractAbiEvent<TAbi, TEventName>
     : AbiEvent & { type: 'event' },
-  TArgs = AbiEventTopicsToPrimitiveTypes<TAbiEvent['inputs'], TTopics, TData>,
+  TArgs = AbiEventParametersToPrimitiveTypes<
+    TAbiEvent['inputs'],
+    { EnableUnion: false; IndexedOnly: false }
+  >,
 > = TTopics extends readonly []
   ? TData extends undefined
     ? { args?: never }
@@ -249,12 +252,10 @@ export type GetEventArgsFromTopics<
 type EventParameterOptions = {
   EnableUnion?: boolean
   IndexedOnly?: boolean
-  Required?: boolean
 }
 type DefaultEventParameterOptions = {
   EnableUnion: true
   IndexedOnly: true
-  Required: false
 }
 
 type HashedEventTypes = 'bytes' | 'string' | 'tuple' | `${string}[${string}]`
@@ -326,13 +327,11 @@ export type AbiEventParametersToPrimitiveTypes<
               >
             },
           ]
-        | (Options['Required'] extends true
-            ? never
-            : // Distribute over tuple to represent optional parameters
-            Filtered extends readonly [
-                ...infer Head extends readonly AbiParameter[],
-                infer _,
-              ]
+        // 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
@@ -347,81 +346,6 @@ export type AbiEventParametersToPrimitiveTypes<
             ? Name
             : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
       } extends infer Mapped
-    ? MaybeRequired<
-        Mapped,
-        Options['Required'] extends boolean ? Options['Required'] : false
-      >
+    ? Mapped
     : 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 } ? {} : [],
-> = Prettify<
-  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
->

package/src/types/log.ts

@@ -93,7 +93,7 @@ type GetInferredLogValues<
         args: GetEventArgs<
           TAbi,
           TEventName,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
+          { EnableUnion: false; IndexedOnly: false }
         >
         /** The event name decoded from `topics`. */
         eventName: TEventName
@@ -105,7 +105,7 @@ type GetInferredLogValues<
           args: GetEventArgs<
             TAbi,
             string,
-            { EnableUnion: false; IndexedOnly: false; Required: true }
+            { EnableUnion: false; IndexedOnly: false }
           >
           /** The event name decoded from `topics`. */
           eventName: TName

package/src/utils/abi/decodeAbiParameters.ts

@@ -6,7 +6,6 @@ import type {
 } from 'abitype'
 
 import {
-  AbiDecodingDataSizeInvalidError,
   AbiDecodingDataSizeTooSmallError,
   AbiDecodingZeroDataError,
   InvalidAbiDecodingTypeError,
@@ -38,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[],
@@ -102,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 })
   }
@@ -139,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>[] = []
@@ -169,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,
@@ -210,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 }
 }
 
@@ -238,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 }
 }
@@ -266,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/decodeEventLog.ts

@@ -93,8 +93,8 @@ export function decodeEventLog<
   let args: any = isUnnamed ? [] : {}
 
   // Decode topics (indexed args).
+  const indexedInputs = inputs.filter((x) => 'indexed' in x && x.indexed)
   if (argTopics.length > 0) {
-    const indexedInputs = inputs.filter((x) => 'indexed' in x && x.indexed)
     for (let i = 0; i < indexedInputs.length; i++) {
       const param = indexedInputs[i]
       const topic = argTopics[i]
@@ -108,15 +108,15 @@ export function decodeEventLog<
   }
 
   // Decode data (non-indexed args).
+  const nonIndexedInputs = inputs.filter((x) => !('indexed' in x && x.indexed))
   if (data && data !== '0x') {
-    const params = inputs.filter((x) => !('indexed' in x && x.indexed))
     try {
-      const decodedData = decodeAbiParameters(params, data)
+      const decodedData = decodeAbiParameters(nonIndexedInputs, data)
       if (decodedData) {
         if (isUnnamed) args = [...args, ...decodedData]
         else {
-          for (let i = 0; i < params.length; i++) {
-            args[params[i].name!] = decodedData[i]
+          for (let i = 0; i < nonIndexedInputs.length; i++) {
+            args[nonIndexedInputs[i].name!] = decodedData[i]
           }
         }
       }

package/src/utils/data/isHex.ts

@@ -1,7 +1,10 @@
 import type { Hex } from '../../types/misc.js'
 
-export function isHex(value: unknown): value is Hex {
+export function isHex(
+  value: unknown,
+  { strict = true }: { strict?: boolean } = {},
+): value is Hex {
   if (!value) return false
   if (typeof value !== 'string') return false
-  return /^0x[0-9a-fA-F]*$/.test(value)
+  return strict ? /^0x[0-9a-fA-F]*$/.test(value) : value.startsWith('0x')
 }

package/src/utils/data/size.ts

@@ -9,6 +9,6 @@ import { isHex } from './isHex.js'
  * @returns The size of the value (in bytes).
  */
 export function size(value: Hex | ByteArray) {
-  if (isHex(value)) return Math.ceil((value.length - 2) / 2)
+  if (isHex(value, { strict: false })) return Math.ceil((value.length - 2) / 2)
   return value.length
 }