viem 0.0.0-tsc-and-nodenext-20230405154910 → 0.0.0-w-20230711200108

package/src/errors/rpc.ts

@@ -1,98 +1,416 @@
-import { stringify } from '../utils/index.js'
+import type { Prettify } from '../types/utils.js'
 import { BaseError } from './base.js'
-import { getUrl } from './utils.js'
-
-export class HttpRequestError extends BaseError {
-  name = 'HttpRequestError'
-
-  body: { [key: string]: unknown }
-  headers?: Headers
-  status?: number
-  url: string
-
-  constructor({
-    body,
-    details,
-    headers,
-    status,
-    url,
-  }: {
-    body: { [key: string]: unknown }
-    details?: string
-    headers?: Headers
-    status?: number
-    url: string
-  }) {
-    super('HTTP request failed.', {
-      details,
-      metaMessages: [
-        status && `Status: ${status}`,
-        `URL: ${getUrl(url)}`,
-        `Request body: ${stringify(body)}`,
-      ].filter(Boolean) as string[],
-    })
-    this.body = body
-    this.headers = headers
-    this.status = status
-    this.url = url
-  }
-}
-
-export class WebSocketRequestError extends BaseError {
-  name = 'WebSocketRequestError'
-
-  constructor({
-    body,
-    details,
-    url,
-  }: {
-    body: { [key: string]: unknown }
-    details: string
-    url: string
-  }) {
-    super('WebSocket request failed.', {
-      details,
-      metaMessages: [`URL: ${getUrl(url)}`, `Request body: ${stringify(body)}`],
-    })
-  }
-}
-
-export class RpcError extends BaseError {
-  code: number
-
-  name = 'RpcError'
-
-  constructor({
-    body,
-    error,
-    url,
-  }: {
-    body: { [key: string]: unknown }
-    error: { code: number; message: string }
-    url: string
-  }) {
-    super('RPC Request failed.', {
-      cause: error as any,
-      details: error.message,
-      metaMessages: [`URL: ${getUrl(url)}`, `Request body: ${stringify(body)}`],
-    })
-    this.code = error.code
-  }
-}
-
-export class TimeoutError extends BaseError {
-  name = 'TimeoutError'
-
-  constructor({
-    body,
-    url,
-  }: {
-    body: { [key: string]: unknown }
-    url: string
-  }) {
-    super('The request took too long to respond.', {
-      details: 'The request timed out.',
-      metaMessages: [`URL: ${getUrl(url)}`, `Request body: ${stringify(body)}`],
+import { RpcRequestError } from './request.js'
+
+const unknownErrorCode = -1
+
+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
+}
+
+/**
+ * Error subclass implementing JSON RPC 2.0 errors and Ethereum RPC errors per EIP-1474.
+ *
+ * - EIP https://eips.ethereum.org/EIPS/eip-1474
+ */
+export class RpcError<TCode extends number = RpcErrorCode> extends BaseError {
+  override name = 'RpcError'
+
+  code: TCode | (number & {})
+
+  constructor(
+    cause: Error,
+    { code, docsPath, metaMessages, shortMessage }: RpcErrorOptions<TCode>,
+  ) {
+    super(shortMessage, {
+      cause,
+      docsPath,
+      metaMessages:
+        metaMessages || (cause as { metaMessages?: string[] })?.metaMessages,
+    })
+    this.name = cause.name
+    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<ProviderRpcErrorCode> {
+  override name = 'ProviderRpcError'
+
+  data?: T
+
+  constructor(
+    cause: Error,
+    options: Prettify<
+      RpcErrorOptions<ProviderRpcErrorCode> & {
+        data?: T
+      }
+    >,
+  ) {
+    super(cause, options)
+
+    this.data = options.data
+  }
+}
+
+/**
+ * Subclass for a "Parse error" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class ParseRpcError extends RpcError {
+  override name = 'ParseRpcError'
+  static code = -32700 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: ParseRpcError.code,
+      shortMessage:
+        'Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Invalid request" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class InvalidRequestRpcError extends RpcError {
+  override name = 'InvalidRequestRpcError'
+  static code = -32600 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: InvalidRequestRpcError.code,
+      shortMessage: 'JSON is not a valid request object.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Method not found" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class MethodNotFoundRpcError extends RpcError {
+  override name = 'MethodNotFoundRpcError'
+  static code = -32601 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: MethodNotFoundRpcError.code,
+      shortMessage: 'The method does not exist / is not available.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Invalid params" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class InvalidParamsRpcError extends RpcError {
+  override name = 'InvalidParamsRpcError'
+  static code = -32602 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: InvalidParamsRpcError.code,
+      shortMessage: [
+        'Invalid parameters were provided to the RPC method.',
+        'Double check you have provided the correct parameters.',
+      ].join('\n'),
+    })
+  }
+}
+
+/**
+ * Subclass for an "Internal error" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class InternalRpcError extends RpcError {
+  override name = 'InternalRpcError'
+  static code = -32603 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: InternalRpcError.code,
+      shortMessage: 'An internal error was received.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Invalid input" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class InvalidInputRpcError extends RpcError {
+  override name = 'InvalidInputRpcError'
+  static code = -32000 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: InvalidInputRpcError.code,
+      shortMessage: [
+        'Missing or invalid parameters.',
+        'Double check you have provided the correct parameters.',
+      ].join('\n'),
+    })
+  }
+}
+
+/**
+ * Subclass for a "Resource not found" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class ResourceNotFoundRpcError extends RpcError {
+  override name = 'ResourceNotFoundRpcError'
+  static code = -32001 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: ResourceNotFoundRpcError.code,
+      shortMessage: 'Requested resource not found.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Resource unavailable" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class ResourceUnavailableRpcError extends RpcError {
+  override name = 'ResourceUnavailableRpcError'
+  static code = -32002 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: ResourceUnavailableRpcError.code,
+      shortMessage: 'Requested resource not available.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Transaction rejected" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class TransactionRejectedRpcError extends RpcError {
+  override name = 'TransactionRejectedRpcError'
+  static code = -32003 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: TransactionRejectedRpcError.code,
+      shortMessage: 'Transaction creation failed.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Method not supported" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class MethodNotSupportedRpcError extends RpcError {
+  override name = 'MethodNotSupportedRpcError'
+  static code = -32004 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: MethodNotSupportedRpcError.code,
+      shortMessage: 'Method is not implemented.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "Limit exceeded" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class LimitExceededRpcError extends RpcError {
+  override name = 'LimitExceededRpcError'
+  static code = -32005 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: LimitExceededRpcError.code,
+      shortMessage: 'Request exceeds defined limit.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "JSON-RPC version not supported" EIP-1474 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export class JsonRpcVersionUnsupportedError extends RpcError {
+  override name = 'JsonRpcVersionUnsupportedError'
+  static code = -32006 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: JsonRpcVersionUnsupportedError.code,
+      shortMessage: 'Version of JSON-RPC protocol is not supported.',
+    })
+  }
+}
+
+/**
+ * Subclass for a "User Rejected Request" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class UserRejectedRequestError extends ProviderRpcError {
+  override name = 'UserRejectedRequestError'
+  static code = 4001 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: UserRejectedRequestError.code,
+      shortMessage: 'User rejected the request.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Unauthorized" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class UnauthorizedProviderError extends ProviderRpcError {
+  override name = 'UnauthorizedProviderError'
+  static code = 4100 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: UnauthorizedProviderError.code,
+      shortMessage:
+        'The requested method and/or account has not been authorized by the user.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Unsupported Method" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class UnsupportedProviderMethodError extends ProviderRpcError {
+  override name = 'UnsupportedProviderMethodError'
+  static code = 4200 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: UnsupportedProviderMethodError.code,
+      shortMessage: 'The Provider does not support the requested method.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Disconnected" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class ProviderDisconnectedError extends ProviderRpcError {
+  override name = 'ProviderDisconnectedError'
+  static code = 4900 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: ProviderDisconnectedError.code,
+      shortMessage: 'The Provider is disconnected from all chains.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Chain Disconnected" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class ChainDisconnectedError extends ProviderRpcError {
+  override name = 'ChainDisconnectedError'
+  static code = 4901 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: ChainDisconnectedError.code,
+      shortMessage: 'The Provider is not connected to the requested chain.',
+    })
+  }
+}
+
+/**
+ * Subclass for an "Switch Chain" EIP-1193 error.
+ *
+ * EIP https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export class SwitchChainError extends ProviderRpcError {
+  override name = 'SwitchChainError'
+  static code = 4902 as const
+
+  constructor(cause: Error) {
+    super(cause, {
+      code: SwitchChainError.code,
+      shortMessage: 'An error occurred when attempting to switch chain.',
+    })
+  }
+}
+
+/**
+ * Subclass for an unknown RPC error.
+ */
+export class UnknownRpcError extends RpcError {
+  override name = 'UnknownRpcError'
+
+  constructor(cause: Error) {
+    super(cause, {
+      shortMessage: 'An unknown RPC error occurred.',
     })
   }
 }

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(
@@ -26,7 +25,7 @@ export function prettyPrint(
 }
 
 export class FeeConflictError extends BaseError {
-  name = 'FeeConflictError'
+  override name = 'FeeConflictError'
   constructor() {
     super(
       [
@@ -38,7 +37,7 @@ export class FeeConflictError extends BaseError {
 }
 
 export class InvalidLegacyVError extends BaseError {
-  name = 'InvalidLegacyVError'
+  override name = 'InvalidLegacyVError'
 
   constructor({ v }: { v: bigint }) {
     super(`Invalid \`v\` value "${v}". Expected 27 or 28.`)
@@ -46,7 +45,7 @@ export class InvalidLegacyVError extends BaseError {
 }
 
 export class InvalidSerializableTransactionError extends BaseError {
-  name = 'InvalidSerializableTransactionError'
+  override name = 'InvalidSerializableTransactionError'
 
   constructor({ transaction }: { transaction: Record<string, unknown> }) {
     super('Cannot infer a transaction type from provided transaction.', {
@@ -67,7 +66,7 @@ export class InvalidSerializableTransactionError extends BaseError {
 }
 
 export class InvalidSerializedTransactionTypeError extends BaseError {
-  name = 'InvalidSerializedTransactionType'
+  override name = 'InvalidSerializedTransactionType'
 
   serializedType: Hex
 
@@ -79,7 +78,7 @@ export class InvalidSerializedTransactionTypeError extends BaseError {
 }
 
 export class InvalidSerializedTransactionError extends BaseError {
-  name = 'InvalidSerializedTransactionError'
+  override name = 'InvalidSerializedTransactionError'
 
   serializedTransaction: Hex
   type: TransactionType
@@ -109,7 +108,7 @@ export class InvalidSerializedTransactionError extends BaseError {
 }
 
 export class InvalidStorageKeySizeError extends BaseError {
-  name = 'InvalidStorageKeySizeError'
+  override name = 'InvalidStorageKeySizeError'
 
   constructor({ storageKey }: { storageKey: Hex }) {
     super(
@@ -121,9 +120,9 @@ export class InvalidStorageKeySizeError extends BaseError {
 }
 
 export class TransactionExecutionError extends BaseError {
-  cause: BaseError
+  override cause: BaseError
 
-  name = 'TransactionExecutionError'
+  override name = 'TransactionExecutionError'
 
   constructor(
     cause: BaseError,
@@ -179,7 +178,7 @@ export class TransactionExecutionError extends BaseError {
 }
 
 export class TransactionNotFoundError extends BaseError {
-  name = 'TransactionNotFoundError'
+  override name = 'TransactionNotFoundError'
   constructor({
     blockHash,
     blockNumber,
@@ -206,7 +205,7 @@ export class TransactionNotFoundError extends BaseError {
 }
 
 export class TransactionReceiptNotFoundError extends BaseError {
-  name = 'TransactionReceiptNotFoundError'
+  override name = 'TransactionReceiptNotFoundError'
   constructor({ hash }: { hash: Hash }) {
     super(
       `Transaction receipt with hash "${hash}" could not be found. The Transaction may not be processed on a block yet.`,
@@ -215,7 +214,7 @@ export class TransactionReceiptNotFoundError extends BaseError {
 }
 
 export class WaitForTransactionReceiptTimeoutError extends BaseError {
-  name = 'WaitForTransactionReceiptTimeoutError'
+  override name = 'WaitForTransactionReceiptTimeoutError'
   constructor({ hash }: { hash: Hash }) {
     super(
       `Timed out while waiting for transaction with hash "${hash}" to be confirmed.`,

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,2 +1 @@
-// NOTE: A replacement for file is automatically generated during the build process (see `scripts/updateVersion.ts`).
-export const version = 'dev'
+export const version = '1.2.12'