viem 0.4.0-main.20230430T212953 → 1.0.0

package/src/utils/index.ts

@@ -1,222 +1,248 @@
-export type {
-  DecodeAbiParametersReturnType,
-  DecodeErrorResultParameters,
-  DecodeErrorResultReturnType,
-  DecodeEventLogParameters,
-  DecodeEventLogReturnType,
-  DecodeFunctionDataParameters,
-  DecodeFunctionResultParameters,
-  DecodeFunctionResultReturnType,
-  EncodeAbiParametersReturnType,
-  EncodeDeployDataParameters,
-  EncodeErrorResultParameters,
-  EncodeEventTopicsParameters,
-  EncodeFunctionDataParameters,
-  EncodeFunctionResultParameters,
-  GetAbiItemParameters,
-  ParseAbi,
-  ParseAbiItem,
-  ParseAbiParameter,
-  ParseAbiParameters,
-} from './abi/index.js'
+export { buildRequest } from './buildRequest.js'
+
 export {
+  ccipFetch,
+  offchainLookup,
+  offchainLookupAbiItem,
+  offchainLookupSignature,
+} from './ccip.js'
+
+export {
+  type AssertCurrentChainParameters,
+  assertCurrentChain,
+  defineChain,
+  getChainContractAddress,
+} from './chain.js'
+export { arrayRegex, bytesRegex, integerRegex } from './regex.js'
+
+export {
+  type HttpOptions,
+  type HttpReturnType,
+  type RpcRequest,
+  type RpcResponse,
+  type Socket,
+  type WebSocketAsyncOptions,
+  type WebSocketAsyncReturnType,
+  type WebSocketOptions,
+  type WebSocketReturnType,
+  getSocket,
+  rpc,
+} from './rpc.js'
+export { stringify } from './stringify.js'
+export { validateTypedData } from './typedData.js'
+export {
+  type DecodeAbiParametersReturnType,
   decodeAbiParameters,
+} from './abi/decodeAbiParameters.js'
+export {
+  type DecodeErrorResultParameters,
+  type DecodeErrorResultReturnType,
   decodeErrorResult,
+} from './abi/decodeErrorResult.js'
+export {
+  type DecodeEventLogParameters,
+  type DecodeEventLogReturnType,
   decodeEventLog,
+} from './abi/decodeEventLog.js'
+export {
+  type DecodeFunctionDataParameters,
   decodeFunctionData,
+} from './abi/decodeFunctionData.js'
+export {
+  type DecodeFunctionResultParameters,
+  type DecodeFunctionResultReturnType,
   decodeFunctionResult,
+} from './abi/decodeFunctionResult.js'
+export {
+  type EncodeAbiParametersReturnType,
   encodeAbiParameters,
+} from './abi/encodeAbiParameters.js'
+export {
+  type EncodeDeployDataParameters,
   encodeDeployData,
+} from './abi/encodeDeployData.js'
+export {
+  type EncodeErrorResultParameters,
   encodeErrorResult,
+} from './abi/encodeErrorResult.js'
+export {
+  type EncodeEventTopicsParameters,
   encodeEventTopics,
+} from './abi/encodeEventTopics.js'
+export {
+  type EncodeFunctionDataParameters,
   encodeFunctionData,
+} from './abi/encodeFunctionData.js'
+export {
+  type EncodeFunctionResultParameters,
   encodeFunctionResult,
-  encodePacked,
-  formatAbiItemWithArgs,
-  formatAbiItem,
-  formatAbiParams,
-  getAbiItem,
+} from './abi/encodeFunctionResult.js'
+export { type GetAbiItemParameters, getAbiItem } from './abi/getAbiItem.js'
+export {
+  type ParseAbi,
+  type ParseAbiItem,
+  type ParseAbiParameter,
+  type ParseAbiParameters,
   parseAbi,
   parseAbiItem,
   parseAbiParameter,
   parseAbiParameters,
-} from './abi/index.js'
-
-export { parseAccount, publicKeyToAddress } from './accounts.js'
-
-export type {
-  GetContractAddressOptions,
-  GetCreate2AddressOptions,
-  GetCreateAddressOptions,
-} from './address/index.js'
+} from 'abitype'
+export { encodePacked } from './abi/encodePacked.js'
+export { formatAbiItemWithArgs } from './abi/formatAbiItemWithArgs.js'
+export { formatAbiItem, formatAbiParams } from './abi/formatAbiItem.js'
+export { parseAccount } from '../accounts/utils/parseAccount.js'
+export { publicKeyToAddress } from '../accounts/utils/publicKeyToAddress.js'
 export {
-  getAddress,
+  type GetContractAddressOptions,
+  type GetCreate2AddressOptions,
+  type GetCreateAddressOptions,
   getContractAddress,
   getCreateAddress,
   getCreate2Address,
-  isAddress,
-  isAddressEqual,
-} from './address/index.js'
-
-export { buildRequest } from './buildRequest.js'
-
-export {
-  ccipFetch,
-  offchainLookup,
-  offchainLookupAbiItem,
-  offchainLookupSignature,
-} from './ccip.js'
-
-export { defineChain, getChainContractAddress } from './chain.js'
-
+} from './address/getContractAddress.js'
+export { getAddress } from './address/getAddress.js'
+export { isAddress } from './address/isAddress.js'
+export { isAddressEqual } from './address/isAddressEqual.js'
 export {
   extractFunctionName,
   extractFunctionParams,
   extractFunctionType,
   extractFunctionParts,
-} from './contract/index.js'
-
-export {
-  concat,
-  concatBytes,
-  concatHex,
-  isBytes,
-  isHex,
-  pad,
-  padBytes,
-  padHex,
-  size,
-  slice,
-  sliceBytes,
-  sliceHex,
-  trim,
-} from './data/index.js'
-
-export type {
-  BlockFormatter,
-  ExtractFormatter,
-  Formatted,
-  FormattedBlock,
-  FormattedTransaction,
-  FormattedTransactionReceipt,
-  FormattedTransactionRequest,
-  TransactionFormatter,
-  TransactionReceiptFormatter,
-  TransactionRequestFormatter,
-} from './formatters/index.js'
+} from './contract/extractFunctionParts.js'
+export { concat, concatBytes, concatHex } from './data/concat.js'
+export { isBytes } from './data/isBytes.js'
+export { isHex } from './data/isHex.js'
+export { pad, padBytes, padHex } from './data/pad.js'
+export { size } from './data/size.js'
+export { slice, sliceBytes, sliceHex } from './data/slice.js'
+export { trim } from './data/trim.js'
 export {
+  type BlockFormatter,
+  type FormattedBlock,
   defineBlock,
+  formatBlock,
+} from './formatters/block.js'
+export {
+  type ExtractFormatter,
+  type Formatted,
   defineFormatter,
+  format,
+} from './formatters/format.js'
+export {
+  type FormattedTransaction,
+  type TransactionFormatter,
   defineTransaction,
+  formatTransaction,
+  transactionType,
+} from './formatters/transaction.js'
+export {
+  type FormattedTransactionReceipt,
+  type TransactionReceiptFormatter,
   defineTransactionReceipt,
+} from './formatters/transactionReceipt.js'
+export {
+  type FormattedTransactionRequest,
+  type TransactionRequestFormatter,
   defineTransactionRequest,
-  extract,
-  format,
-  formatBlock,
-  formatTransaction,
   formatTransactionRequest,
-  transactionType,
-} from './formatters/index.js'
-
-export type { ToRlpReturnType } from './encoding/index.js'
+} from './formatters/transactionRequest.js'
+export { extract } from './formatters/extract.js'
+export { type ToRlpReturnType, toRlp } from './encoding/toRlp.js'
 export {
   boolToBytes,
+  toBytes,
+  hexToBytes,
+  numberToBytes,
+  stringToBytes,
+} from './encoding/toBytes.js'
+export {
   boolToHex,
+  bytesToHex,
+  toHex,
+  numberToHex,
+  stringToHex,
+} from './encoding/toHex.js'
+export {
   bytesToBigint,
   bytesToBool,
-  bytesToHex,
   bytesToNumber,
   bytesToString,
   fromBytes,
+} from './encoding/fromBytes.js'
+export {
   fromHex,
-  fromRlp,
-  toBytes,
-  toHex,
-  toRlp,
   hexToBool,
   hexToBigInt,
-  hexToBytes,
   hexToNumber,
   hexToString,
-  numberToBytes,
-  numberToHex,
-  stringToBytes,
-  stringToHex,
-} from './encoding/index.js'
-
+} from './encoding/fromHex.js'
+export { fromRlp } from './encoding/fromRlp.js'
+export { containsNodeError, getNodeError } from './errors/getNodeError.js'
+export { getCallError } from './errors/getCallError.js'
+export { getContractError } from './errors/getContractError.js'
+export { getEstimateGasError } from './errors/getEstimateGasError.js'
+export { getTransactionError } from './errors/getTransactionError.js'
+export { getEventSelector } from './hash/getEventSelector.js'
+export { getFunctionSelector } from './hash/getFunctionSelector.js'
+export { isHash } from './hash/isHash.js'
+export { keccak256 } from './hash/keccak256.js'
 export {
-  containsNodeError,
-  getCallError,
-  getContractError,
-  getEstimateGasError,
-  getNodeError,
-  getTransactionError,
-} from './errors/index.js'
-
-export {
-  getEventSelector,
-  getFunctionSelector,
-  isHash,
-  keccak256,
-} from './hash/index.js'
-
-export { arrayRegex, bytesRegex, integerRegex } from './regex.js'
-
-export type { HttpOptions, RpcResponse, Socket } from './rpc.js'
-export { getSocket, rpc } from './rpc.js'
-
-export type {
-  HashTypedDataParameters,
-  HashTypedDataReturnType,
-  RecoverAddressParameters,
-  RecoverAddressReturnType,
-  RecoverMessageAddressParameters,
-  RecoverMessageAddressReturnType,
-  RecoverPublicKeyParameters,
-  RecoverPublicKeyReturnType,
-  RecoverTypedDataAddressParameters,
-  RecoverTypedDataAddressReturnType,
-  VerifyMessageParameters,
-  VerifyMessageReturnType,
-  VerifyTypedDataParameters,
-  VerifyTypedDataReturnType,
-} from './signature/index.js'
-export {
-  hashMessage,
+  type HashTypedDataParameters,
+  type HashTypedDataReturnType,
   hashTypedData,
+} from './signature/hashTypedData.js'
+export {
+  type RecoverAddressParameters,
+  type RecoverAddressReturnType,
   recoverAddress,
+} from './signature/recoverAddress.js'
+export {
+  type RecoverMessageAddressParameters,
+  type RecoverMessageAddressReturnType,
   recoverMessageAddress,
+} from './signature/recoverMessageAddress.js'
+export {
+  type RecoverPublicKeyParameters,
+  type RecoverPublicKeyReturnType,
   recoverPublicKey,
+} from './signature/recoverPublicKey.js'
+export {
+  type RecoverTypedDataAddressParameters,
+  type RecoverTypedDataAddressReturnType,
   recoverTypedDataAddress,
+} from './signature/recoverTypedDataAddress.js'
+export {
+  type VerifyMessageParameters,
+  type VerifyMessageReturnType,
   verifyMessage,
+} from './signature/verifyMessage.js'
+export {
+  type VerifyTypedDataParameters,
+  type VerifyTypedDataReturnType,
   verifyTypedData,
-} from './signature/index.js'
-
-export { stringify } from './stringify.js'
-
-export type {
-  GetSerializedTransactionType,
-  GetTransactionType,
-} from './transaction/index.js'
+} from './signature/verifyTypedData.js'
+export { hashMessage } from './signature/hashMessage.js'
 export {
-  assertRequest,
-  assertTransactionEIP1559,
-  assertTransactionEIP2930,
-  assertTransactionLegacy,
+  type GetSerializedTransactionType,
   getSerializedTransactionType,
+} from './transaction/getSerializedTransactionType.js'
+export {
+  type GetTransactionType,
   getTransactionType,
-  parseTransaction,
-  prepareRequest,
-  serializeTransaction,
-} from './transaction/index.js'
-
-export { validateTypedData } from './typedData.js'
-
+} from './transaction/getTransactionType.js'
+export { assertRequest } from './transaction/assertRequest.js'
 export {
-  formatEther,
-  formatGwei,
-  formatUnits,
-  parseUnits,
-  parseEther,
-  parseGwei,
-} from './unit/index.js'
+  assertTransactionEIP1559,
+  assertTransactionEIP2930,
+  assertTransactionLegacy,
+} from './transaction/assertTransaction.js'
+export { parseTransaction } from './transaction/parseTransaction.js'
+export { prepareRequest } from './transaction/prepareRequest.js'
+export { serializeTransaction } from './transaction/serializeTransaction.js'
+export { formatEther } from './unit/formatEther.js'
+export { formatGwei } from './unit/formatGwei.js'
+export { formatUnits } from './unit/formatUnits.js'
+export { parseUnits } from './unit/parseUnits.js'
+export { parseEther } from './unit/parseEther.js'
+export { parseGwei } from './unit/parseGwei.js'

package/src/utils/promise/createBatchScheduler.ts

@@ -10,6 +10,25 @@ type PendingPromise<TReturnType extends readonly unknown[] = any> = {
 
 type SchedulerItem = { args: unknown; pendingPromise: PendingPromise }
 
+export type CreateBatchSchedulerArguments<
+  TParameters = unknown,
+  TReturnType extends readonly unknown[] = readonly unknown[],
+> = {
+  fn: (args: TParameters[]) => Promise<TReturnType>
+  id: number | string
+  shouldSplitBatch?: (args: TParameters[]) => boolean
+  wait?: number
+}
+export type CreateBatchSchedulerReturnType<
+  TParameters = unknown,
+  TReturnType extends readonly unknown[] = readonly unknown[],
+> = {
+  flush: () => void
+  schedule: TParameters extends undefined
+    ? (args?: TParameters) => Promise<Resolved<TReturnType>>
+    : (args: TParameters) => Promise<Resolved<TReturnType>>
+}
+
 const schedulerCache = new Map<number | string, SchedulerItem[]>()
 
 export function createBatchScheduler<
@@ -20,12 +39,10 @@ export function createBatchScheduler<
   id,
   shouldSplitBatch,
   wait = 0,
-}: {
-  fn: (args: TParameters[]) => Promise<TReturnType>
-  id: number | string
-  shouldSplitBatch?: (args: TParameters[]) => boolean
-  wait?: number
-}) {
+}: CreateBatchSchedulerArguments<
+  TParameters,
+  TReturnType
+>): CreateBatchSchedulerReturnType<TParameters, TReturnType> {
   const exec = async () => {
     const scheduler = getScheduler()
     flush()
@@ -78,5 +95,5 @@ export function createBatchScheduler<
       setTimeout(exec, wait)
       return promise
     },
-  }
+  } as unknown as CreateBatchSchedulerReturnType<TParameters, TReturnType>
 }

package/src/utils/promise/withCache.ts

@@ -59,15 +59,17 @@ export async function withCache<TData>(
     cache.promise.set(promise)
   }
 
-  const data = await promise
+  try {
+    const data = await promise
 
-  // Clear the promise cache so that subsequent invocations will
-  // invoke the promise again.
-  cache.promise.clear()
+    // Store the response in the cache so that subsequent invocations
+    // will return the same response.
+    cache.response.set({ created: new Date(), data })
 
-  // Store the response in the cache so that subsequent invocations
-  // will return the same response.
-  cache.response.set({ created: new Date(), data })
-
-  return data
+    return data
+  } finally {
+    // Clear the promise cache so that subsequent invocations will
+    // invoke the promise again.
+    cache.promise.clear()
+  }
 }