viem 0.4.0-main.20230430T213120 → 1.0.1

package/src/contract.ts

@@ -1,71 +1,106 @@
-export type {
-  CreateContractEventFilterParameters,
-  CreateContractEventFilterReturnType,
-  EstimateContractGasParameters,
-  EstimateContractGasReturnType,
-  GetBytecodeParameters,
-  GetBytecodeReturnType,
-  GetStorageAtParameters,
-  GetStorageAtReturnType,
-  MulticallParameters,
-  MulticallReturnType,
-  OnLogsFn,
-  OnLogsParameter,
-  ReadContractParameters,
-  ReadContractReturnType,
-  SimulateContractParameters,
-  SimulateContractReturnType,
-  WatchContractEventParameters,
-} from './actions/public/index.js'
 export {
+  type CreateContractEventFilterParameters,
+  type CreateContractEventFilterReturnType,
   createContractEventFilter,
+} from './actions/public/createContractEventFilter.js'
+export {
+  type EstimateContractGasParameters,
+  type EstimateContractGasReturnType,
   estimateContractGas,
+} from './actions/public/estimateContractGas.js'
+export {
+  type GetBytecodeParameters,
+  type GetBytecodeReturnType,
   getBytecode,
+} from './actions/public/getBytecode.js'
+export {
+  type GetStorageAtParameters,
+  type GetStorageAtReturnType,
   getStorageAt,
+} from './actions/public/getStorageAt.js'
+export {
+  type MulticallParameters,
+  type MulticallReturnType,
   multicall,
+} from './actions/public/multicall.js'
+export {
+  type OnLogsFn,
+  type OnLogsParameter,
+} from './actions/public/watchEvent.js'
+export {
+  type ReadContractParameters,
+  type ReadContractReturnType,
   readContract,
+} from './actions/public/readContract.js'
+export {
+  type SimulateContractParameters,
+  type SimulateContractReturnType,
   simulateContract,
+} from './actions/public/simulateContract.js'
+export {
+  type WatchContractEventParameters,
   watchContractEvent,
-} from './actions/public/index.js'
-
-export type {
-  DeployContractParameters,
-  DeployContractReturnType,
-  WriteContractParameters,
-  WriteContractReturnType,
-} from './actions/wallet/index.js'
-export { deployContract, writeContract } from './actions/wallet/index.js'
-
-export type {
-  DecodeAbiParametersReturnType,
-  DecodeErrorResultParameters,
-  DecodeErrorResultReturnType,
-  DecodeEventLogParameters,
-  DecodeEventLogReturnType,
-  DecodeFunctionDataParameters,
-  DecodeFunctionResultParameters,
-  DecodeFunctionResultReturnType,
-  EncodeAbiParametersReturnType,
-  EncodeDeployDataParameters,
-  EncodeErrorResultParameters,
-  EncodeEventTopicsParameters,
-  EncodeFunctionDataParameters,
-  EncodeFunctionResultParameters,
-  GetAbiItemParameters,
-} from './utils/index.js'
+} from './actions/public/watchContractEvent.js'
+export {
+  type DeployContractParameters,
+  type DeployContractReturnType,
+  deployContract,
+} from './actions/wallet/deployContract.js'
 export {
+  type WriteContractParameters,
+  type WriteContractReturnType,
+  writeContract,
+} from './actions/wallet/writeContract.js'
+export {
+  type DecodeAbiParametersReturnType,
   decodeAbiParameters,
+} from './utils/abi/decodeAbiParameters.js'
+export {
+  type DecodeErrorResultParameters,
+  type DecodeErrorResultReturnType,
   decodeErrorResult,
+} from './utils/abi/decodeErrorResult.js'
+export {
+  type DecodeEventLogParameters,
+  type DecodeEventLogReturnType,
   decodeEventLog,
+} from './utils/abi/decodeEventLog.js'
+export {
+  type DecodeFunctionDataParameters,
   decodeFunctionData,
+} from './utils/abi/decodeFunctionData.js'
+export {
+  type DecodeFunctionResultParameters,
+  type DecodeFunctionResultReturnType,
   decodeFunctionResult,
+} from './utils/abi/decodeFunctionResult.js'
+export {
+  type EncodeAbiParametersReturnType,
   encodeAbiParameters,
+} from './utils/abi/encodeAbiParameters.js'
+export {
+  type EncodeDeployDataParameters,
   encodeDeployData,
+} from './utils/abi/encodeDeployData.js'
+export {
+  type EncodeErrorResultParameters,
   encodeErrorResult,
+} from './utils/abi/encodeErrorResult.js'
+export {
+  type EncodeEventTopicsParameters,
   encodeEventTopics,
+} from './utils/abi/encodeEventTopics.js'
+export {
+  type EncodeFunctionDataParameters,
   encodeFunctionData,
+} from './utils/abi/encodeFunctionData.js'
+export {
+  type EncodeFunctionResultParameters,
   encodeFunctionResult,
-  formatAbiItemWithArgs,
-  formatAbiItem,
+} from './utils/abi/encodeFunctionResult.js'
+export {
+  type GetAbiItemParameters,
   getAbiItem,
-} from './utils/index.js'
+} from './utils/abi/getAbiItem.js'
+export { formatAbiItemWithArgs } from './utils/abi/formatAbiItemWithArgs.js'
+export { formatAbiItem } from './utils/abi/formatAbiItem.js'

package/src/ens.ts

@@ -1,26 +1,28 @@
-export type {
-  GetEnsAddressParameters,
-  GetEnsAddressReturnType,
-  GetEnsAvatarParameters,
-  GetEnsAvatarReturnType,
-  GetEnsNameParameters,
-  GetEnsNameReturnType,
-  GetEnsResolverParameters,
-  GetEnsResolverReturnType,
-  GetEnsTextParameters,
-  GetEnsTextReturnType,
-} from './actions/ens/index.js'
+export { normalize } from './utils/ens/normalize.js'
 export {
+  type GetEnsAddressParameters,
+  type GetEnsAddressReturnType,
   getEnsAddress,
+} from './actions/ens/getEnsAddress.js'
+export {
+  type GetEnsAvatarParameters,
+  type GetEnsAvatarReturnType,
   getEnsAvatar,
+} from './actions/ens/getEnsAvatar.js'
+export {
+  type GetEnsNameParameters,
+  type GetEnsNameReturnType,
   getEnsName,
+} from './actions/ens/getEnsName.js'
+export {
+  type GetEnsResolverParameters,
+  type GetEnsResolverReturnType,
   getEnsResolver,
-  getEnsText,
-} from './actions/ens/index.js'
-
+} from './actions/ens/getEnsResolver.js'
 export {
-  labelhash,
-  namehash,
-} from './utils/ens/index.js'
-
-export { normalize } from './utils/ens/normalize.js'
+  type GetEnsTextParameters,
+  type GetEnsTextReturnType,
+  getEnsText,
+} from './actions/ens/getEnsText.js'
+export { labelhash } from './utils/ens/labelhash.js'
+export { namehash } from './utils/ens/namehash.js'

package/src/errors/abi.ts

@@ -1,6 +1,9 @@
-import type { AbiParameter } from 'abitype'
-import type { AbiItem, Hex } from '../types/index.js'
-import { formatAbiItem, formatAbiParams, size } from '../utils/index.js'
+import type { AbiEvent, AbiParameter } from 'abitype'
+
+import type { Hex } from '../types/misc.js'
+import { formatAbiItem, formatAbiParams } from '../utils/abi/formatAbiItem.js'
+import { size } from '../utils/data/size.js'
+
 import { BaseError } from './base.js'
 
 export class AbiConstructorNotFoundError extends BaseError {
@@ -145,10 +148,10 @@ export class AbiErrorInputsNotFoundError extends BaseError {
 
 export class AbiErrorNotFoundError extends BaseError {
   override name = 'AbiErrorNotFoundError'
-  constructor(errorName: string, { docsPath }: { docsPath: string }) {
+  constructor(errorName?: string, { docsPath }: { docsPath?: string } = {}) {
     super(
       [
-        `Error "${errorName}" not found on ABI.`,
+        `Error ${errorName ? `"${errorName}" ` : ''}not found on ABI.`,
         'Make sure you are using the correct ABI and that the error exists on it.',
       ].join('\n'),
       {
@@ -201,10 +204,10 @@ export class AbiEventSignatureNotFoundError extends BaseError {
 
 export class AbiEventNotFoundError extends BaseError {
   override name = 'AbiEventNotFoundError'
-  constructor(eventName: string, { docsPath }: { docsPath: string }) {
+  constructor(eventName?: string, { docsPath }: { docsPath?: string } = {}) {
     super(
       [
-        `Event "${eventName}" not found on ABI.`,
+        `Event ${eventName ? `"${eventName}" ` : ''}not found on ABI.`,
         'Make sure you are using the correct ABI and that the event exists on it.',
       ].join('\n'),
       {
@@ -216,10 +219,10 @@ export class AbiEventNotFoundError extends BaseError {
 
 export class AbiFunctionNotFoundError extends BaseError {
   override name = 'AbiFunctionNotFoundError'
-  constructor(functionName: string, { docsPath }: { docsPath: string }) {
+  constructor(functionName?: string, { docsPath }: { docsPath?: string } = {}) {
     super(
       [
-        `Function "${functionName}" not found on ABI.`,
+        `Function ${functionName ? `"${functionName}" ` : ''}not found on ABI.`,
         'Make sure you are using the correct ABI and that the function exists on it.',
       ].join('\n'),
       {
@@ -274,29 +277,35 @@ export class BytesSizeMismatchError extends BaseError {
 export class DecodeLogDataMismatch extends BaseError {
   override name = 'DecodeLogDataMismatch'
 
+  abiItem: AbiEvent
   data: Hex
   params: readonly AbiParameter[]
   size: number
 
   constructor({
+    abiItem,
     data,
     params,
     size,
-  }: { data: Hex; params: readonly AbiParameter[]; size: number }) {
+  }: {
+    abiItem: AbiEvent
+    data: Hex
+    params: readonly AbiParameter[]
+    size: number
+  }) {
     super(
       [
         `Data size of ${size} bytes is too small for non-indexed event parameters.`,
       ].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)`,
         ],
       },
     )
 
+    this.abiItem = abiItem
     this.data = data
     this.params = params
     this.size = size
@@ -305,11 +314,14 @@ export class DecodeLogDataMismatch extends BaseError {
 
 export class DecodeLogTopicsMismatch extends BaseError {
   override name = 'DecodeLogTopicsMismatch'
+
+  abiItem: AbiEvent
+
   constructor({
     abiItem,
     param,
   }: {
-    abiItem: AbiItem
+    abiItem: AbiEvent
     param: AbiParameter & { indexed: boolean }
   }) {
     super(
@@ -319,6 +331,8 @@ export class DecodeLogTopicsMismatch extends BaseError {
         } on event "${formatAbiItem(abiItem, { includeName: true })}".`,
       ].join('\n'),
     )
+
+    this.abiItem = abiItem
   }
 }
 

package/src/errors/block.ts

@@ -1,4 +1,5 @@
-import type { Hash } from '../types/index.js'
+import type { Hash } from '../types/misc.js'
+
 import { BaseError } from './base.js'
 
 export class BlockNotFoundError extends BaseError {

package/src/errors/ccip.ts

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

package/src/errors/chain.ts

@@ -1,4 +1,5 @@
-import type { Chain } from '../types/index.js'
+import type { Chain } from '../types/chain.js'
+
 import { BaseError } from './base.js'
 
 export class ChainDoesNotSupportContract extends BaseError {

package/src/errors/contract.ts

@@ -1,17 +1,20 @@
-import type { Abi } from 'abitype'
-import type { CallParameters } from '../actions/index.js'
-import { panicReasons } from '../constants/index.js'
-import type { Address, Chain, Hex } from '../types/index.js'
+import type { Abi, Address } from 'abitype'
+
+import { parseAccount } from '../accounts/utils/parseAccount.js'
+import type { CallParameters } from '../actions/public/call.js'
+import { panicReasons } from '../constants/solidity.js'
+import type { Chain } from '../types/chain.js'
+import type { Hex } from '../types/misc.js'
 import {
+  type DecodeErrorResultReturnType,
   decodeErrorResult,
-  formatAbiItem,
-  formatAbiItemWithArgs,
-  formatEther,
-  formatGwei,
-  getAbiItem,
-  parseAccount,
-} from '../utils/index.js'
-import type { DecodeErrorResultReturnType } from '../utils/index.js'
+} from '../utils/abi/decodeErrorResult.js'
+import { formatAbiItem } from '../utils/abi/formatAbiItem.js'
+import { formatAbiItemWithArgs } from '../utils/abi/formatAbiItemWithArgs.js'
+import { getAbiItem } from '../utils/abi/getAbiItem.js'
+import { formatEther } from '../utils/unit/formatEther.js'
+import { formatGwei } from '../utils/unit/formatGwei.js'
+
 import { BaseError } from './base.js'
 import { prettyPrint } from './transaction.js'
 import { getContractAddress } from './utils.js'
@@ -169,18 +172,19 @@ export class ContractFunctionRevertedError extends BaseError {
       } else if (errorName === 'Panic') {
         const [firstArg] = errorArgs as [number]
         reason = panicReasons[firstArg as keyof typeof panicReasons]
-      } else if (errorArgs) {
+      } else {
         const errorWithParams = abiItem
           ? formatAbiItem(abiItem, { includeName: true })
           : undefined
-        const formattedArgs = abiItem
-          ? formatAbiItemWithArgs({
-              abiItem,
-              args: errorArgs,
-              includeFunctionName: false,
-              includeName: false,
-            })
-          : undefined
+        const formattedArgs =
+          abiItem && errorArgs
+            ? formatAbiItemWithArgs({
+                abiItem,
+                args: errorArgs,
+                includeFunctionName: false,
+                includeName: false,
+              })
+            : undefined
 
         metaMessages = [
           errorWithParams ? `Error: ${errorWithParams}` : '',
@@ -228,9 +232,12 @@ export class RawContractError extends BaseError {
   code = 3
   override name = 'RawContractError'
 
-  data?: Hex
+  data?: Hex | { data?: Hex }
 
-  constructor({ data, message }: { data?: Hex; message?: string }) {
+  constructor({
+    data,
+    message,
+  }: { data?: Hex | { data?: Hex }; message?: string }) {
     super(message || '')
     this.data = data
   }

package/src/errors/data.ts

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

package/src/errors/encoding.ts

@@ -1,4 +1,5 @@
-import type { ByteArray, Hex } from '../types/index.js'
+import type { ByteArray, Hex } from '../types/misc.js'
+
 import { BaseError } from './base.js'
 
 export class DataLengthTooLongError extends BaseError {

package/src/errors/estimateGas.ts

@@ -1,6 +1,9 @@
-import type { EstimateGasParameters } from '../actions/index.js'
-import type { Account, Chain } from '../types/index.js'
-import { formatEther, formatGwei } from '../utils/index.js'
+import type { Account } from '../accounts/types.js'
+import type { EstimateGasParameters } from '../actions/public/estimateGas.js'
+import type { Chain } from '../types/chain.js'
+import { formatEther } from '../utils/unit/formatEther.js'
+import { formatGwei } from '../utils/unit/formatGwei.js'
+
 import { BaseError } from './base.js'
 import { prettyPrint } from './transaction.js'
 

package/src/errors/node.ts

@@ -1,4 +1,5 @@
-import { formatGwei } from '../utils/index.js'
+import { formatGwei } from '../utils/unit/formatGwei.js'
+
 import { BaseError } from './base.js'
 
 /**

package/src/errors/request.ts

@@ -1,11 +1,12 @@
-import { stringify } from '../utils/index.js'
+import { stringify } from '../utils/stringify.js'
+
 import { BaseError } from './base.js'
 import { getUrl } from './utils.js'
 
 export class HttpRequestError extends BaseError {
   override name = 'HttpRequestError'
 
-  body?: { [key: string]: unknown }
+  body?: { [x: string]: unknown } | { [y: string]: unknown }[]
   headers?: Headers
   status?: number
   url: string
@@ -17,7 +18,7 @@ export class HttpRequestError extends BaseError {
     status,
     url,
   }: {
-    body?: { [key: string]: unknown }
+    body?: { [x: string]: unknown } | { [y: string]: unknown }[]
     details?: string
     headers?: Headers
     status?: number
@@ -67,7 +68,7 @@ export class RpcRequestError extends BaseError {
     error,
     url,
   }: {
-    body: { [key: string]: unknown }
+    body: { [x: string]: unknown } | { [y: string]: unknown }[]
     error: { code: number; message: string }
     url: string
   }) {
@@ -87,7 +88,7 @@ export class TimeoutError extends BaseError {
     body,
     url,
   }: {
-    body: { [key: string]: unknown }
+    body: { [x: string]: unknown } | { [y: string]: unknown }[]
     url: string
   }) {
     super('The request took too long to respond.', {

package/src/errors/rpc.ts

@@ -1,10 +1,27 @@
+import type { Prettify } from '../types/utils.js'
 import { BaseError } from './base.js'
 import { RpcRequestError } from './request.js'
 
 const unknownErrorCode = -1
 
-type RpcErrorOptions = {
-  code?: number
+export type RpcErrorCode =
+  | -1
+  | -32700 // Parse error
+  | -32600 // Invalid request
+  | -32601 // Method not found
+  | -32602 // Invalid params
+  | -32603 // Internal error
+  | -32000 // Invalid input
+  | -32001 // Resource not found
+  | -32002 // Resource unavailable
+  | -32003 // Transaction rejected
+  | -32004 // Method not supported
+  | -32005 // Limit exceeded
+  | -32006 // JSON-RPC version not supported
+  | -32042 // Method not found
+
+type RpcErrorOptions<TCode extends number = RpcErrorCode> = {
+  code?: TCode | (number & {})
   docsPath?: string
   metaMessages?: string[]
   shortMessage: string
@@ -15,17 +32,14 @@ type RpcErrorOptions = {
  *
  * - EIP https://eips.ethereum.org/EIPS/eip-1474
  */
-export class RpcError extends BaseError {
-  code: number
+export class RpcError<TCode extends number = RpcErrorCode> extends BaseError {
+  override name = 'RpcError'
+
+  code: TCode | (number & {})
 
   constructor(
     cause: Error,
-    {
-      code = unknownErrorCode,
-      docsPath,
-      metaMessages,
-      shortMessage,
-    }: RpcErrorOptions,
+    { code, docsPath, metaMessages, shortMessage }: RpcErrorOptions<TCode>,
   ) {
     super(shortMessage, {
       cause,
@@ -34,25 +48,39 @@ export class RpcError extends BaseError {
         metaMessages || (cause as { metaMessages?: string[] })?.metaMessages,
     })
     this.name = cause.name
-    this.code = cause instanceof RpcRequestError ? cause.code : code
+    this.code = (
+      cause instanceof RpcRequestError ? cause.code : code ?? unknownErrorCode
+    ) as TCode
   }
 }
 
+export type ProviderRpcErrorCode =
+  | 4001 // User Rejected Request
+  | 4100 // Unauthorized
+  | 4200 // Unsupported Method
+  | 4900 // Disconnected
+  | 4901 // Chain Disconnected
+  | 4902 // Chain Not Recongnized
+
 /**
  * Error subclass implementing Ethereum Provider errors per EIP-1193.
  *
  * - EIP https://eips.ethereum.org/EIPS/eip-1193
  */
-export class ProviderRpcError<T = undefined> extends RpcError {
+export class ProviderRpcError<
+  T = undefined,
+> extends RpcError<ProviderRpcErrorCode> {
   override name = 'ProviderRpcError'
 
   data?: T
 
   constructor(
     cause: Error,
-    options: RpcErrorOptions & {
-      data?: T
-    },
+    options: Prettify<
+      RpcErrorOptions<ProviderRpcErrorCode> & {
+        data?: T
+      }
+    >,
   ) {
     super(cause, options)
 

package/src/errors/transaction.ts

@@ -1,13 +1,12 @@
-import type {
-  Account,
-  BlockTag,
-  Hash,
-  TransactionType,
-  Chain,
-  Hex,
-} from '../types/index.js'
-import { formatEther, formatGwei } from '../utils/index.js'
-import type { SendTransactionParameters } from '../wallet.js'
+import type { Account } from '../accounts/types.js'
+import type { SendTransactionParameters } from '../actions/wallet/sendTransaction.js'
+import type { BlockTag } from '../types/block.js'
+import type { Chain } from '../types/chain.js'
+import type { Hash, Hex } from '../types/misc.js'
+import type { TransactionType } from '../types/transaction.js'
+import { formatEther } from '../utils/unit/formatEther.js'
+import { formatGwei } from '../utils/unit/formatGwei.js'
+
 import { BaseError } from './base.js'
 
 export function prettyPrint(

package/src/errors/utils.ts

@@ -1,4 +1,5 @@
 import type { Address } from 'abitype'
+
 import { version } from './version.js'
 
 export const getContractAddress = (address: Address) => address

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '0.4.0-main.20230430T213120'
+export const version = '1.0.1'