viem 0.0.0-portable-types-20230522163654 → 0.0.0-portable-types-20230523145621

package/src/clients/decorators/test.ts

@@ -390,7 +390,7 @@ export type TestActions = {
    */
   setBlockGasLimit: (args: SetBlockGasLimitParameters) => Promise<void>
   /**
-   * Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`.
+   * Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime.html), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`.
    *
    * - Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval.html
    *
@@ -641,7 +641,7 @@ export type TestActions = {
    */
   snapshot: () => Promise<Quantity>
   /**
-   * Stop impersonating an account after having previously used [`impersonateAccount`](https://viem.sh/docs/actions/test/impersonateAccount).
+   * Stop impersonating an account after having previously used [`impersonateAccount`](https://viem.sh/docs/actions/test/impersonateAccount.html).
    *
    * - Docs: https://viem.sh/docs/actions/test/stopImpersonatingAccount.html
    *

package/src/clients/decorators/wallet.ts

@@ -93,7 +93,7 @@ export type WalletActions<
    * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/deploying-contracts
    *
    * @param args - {@link DeployContractParameters}
-   * @returns The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link DeployContractReturnType}
+   * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link DeployContractReturnType}
    *
    * @example
    * import { createWalletClient, http } from 'viem'
@@ -276,8 +276,8 @@ export type WalletActions<
    *   - Local Accounts: Signs locally. No JSON-RPC request.
    *
    * With the calculated signature, you can:
-   * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage) to verify the signature,
-   * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress) to recover the signing address from a signature.
+   * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage.html) to verify the signature,
+   * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress.html) to recover the signing address from a signature.
    *
    * @param args - {@link SignMessageParameters}
    * @returns The signed message. {@link SignMessageReturnType}
@@ -467,14 +467,14 @@ export type WalletActions<
    * - Docs: https://viem.sh/docs/contract/writeContract.html
    * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
    *
-   * A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms) is needed to be broadcast in order to change the state.
+   * A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms.html) is needed to be broadcast in order to change the state.
    *
-   * Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
+   * Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet.html) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
    *
    * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
    *
    * @param args - {@link WriteContractParameters}
-   * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms#hash). {@link WriteContractReturnType}
+   * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms.html#hash). {@link WriteContractReturnType}
    *
    * @example
    * import { createWalletClient, custom, parseAbi } from 'viem'

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
   docsPath?: string
   metaMessages?: string[]
   shortMessage: string
@@ -15,17 +32,13 @@ 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
 
   constructor(
     cause: Error,
-    {
-      code = unknownErrorCode,
-      docsPath,
-      metaMessages,
-      shortMessage,
-    }: RpcErrorOptions,
+    { code, docsPath, metaMessages, shortMessage }: RpcErrorOptions<TCode>,
   ) {
     super(shortMessage, {
       cause,
@@ -34,25 +47,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/version.ts

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

package/src/index.ts

@@ -23,6 +23,10 @@ export {
   type DeployContractReturnType,
 } from './actions/wallet/deployContract.js'
 export type { DropTransactionParameters } from './actions/test/dropTransaction.js'
+export {
+  type EstimateContractGasParameters,
+  type EstimateContractGasReturnType,
+} from './actions/public/estimateContractGas.js'
 export {
   type EstimateGasParameters,
   type EstimateGasReturnType,
@@ -288,9 +292,11 @@ export {
   ParseRpcError,
   ProviderDisconnectedError,
   ProviderRpcError,
+  type ProviderRpcErrorCode,
   ResourceNotFoundRpcError,
   ResourceUnavailableRpcError,
   RpcError,
+  type RpcErrorCode,
   TransactionRejectedRpcError,
   SwitchChainError,
   UnauthorizedProviderError,
@@ -436,11 +442,10 @@ export {
 export type { Chain } from './types/chain.js'
 export type {
   EIP1193Provider,
-  RpcErrorCode,
-  RpcError as RpcError_,
+  ProviderRpcError as EIP1193ProviderRpcError,
   ProviderConnectInfo,
   ProviderMessage,
-  Chain as Chain_,
+  AddEthereumChainParameter,
   NetworkSync,
   PublicRequests,
   Requests,

package/src/types/eip1193.ts

@@ -23,17 +23,11 @@ export type EIP1193Provider = Requests & Events
 //////////////////////////////////////////////////
 // Errors
 
-// rome-ignore format: no formatting
-export type RpcErrorCode =
-  // https://eips.ethereum.org/EIPS/eip-1193#provider-errors
-  | 4_001 | 4_100 | 4_200 | 4_900 | 4_901
-  // https://eips.ethereum.org/EIPS/eip-1474#error-codes
-  | -32700 | -32600 | -32601 | -32602 | -32603 | -32000 | -32001 | -32002 | -32003 | -32004 | -32005 | -32006
-export class RpcError extends Error {
-  code: RpcErrorCode | (number & {})
+export class ProviderRpcError extends Error {
+  code: number
   details: string
 
-  constructor(code: RpcErrorCode | (number & {}), message: string) {
+  constructor(code: number, message: string) {
     super(message)
     this.code = code
     this.details = message
@@ -57,7 +51,7 @@ export type Events = {
     event: 'connect',
     listener: (connectInfo: ProviderConnectInfo) => void,
   ): void
-  on(event: 'disconnect', listener: (error: RpcError) => void): void
+  on(event: 'disconnect', listener: (error: ProviderRpcError) => void): void
   on(event: 'chainChanged', listener: (chainId: string) => void): void
   on(event: 'accountsChanged', listener: (accounts: string[]) => void): void
   on(event: 'message', listener: (message: ProviderMessage) => void): void
@@ -66,7 +60,10 @@ export type Events = {
     event: 'connect',
     listener: (connectInfo: ProviderConnectInfo) => void,
   ): void
-  removeListener(event: 'disconnect', listener: (error: RpcError) => void): void
+  removeListener(
+    event: 'disconnect',
+    listener: (error: ProviderRpcError) => void,
+  ): void
   removeListener(
     event: 'chainChanged',
     listener: (chainId: string) => void,
@@ -84,7 +81,7 @@ export type Events = {
 //////////////////////////////////////////////////
 // Provider Requests
 
-export type Chain = {
+export type AddEthereumChainParameter = {
   /** A 0x-prefixed hexadecimal string */
   chainId: string
   /** The chain name. */
@@ -1034,7 +1031,7 @@ export type WalletRequests = {
      * // => { ... }
      */
     method: 'wallet_addEthereumChain'
-    params: [chain: Chain]
+    params: [chain: AddEthereumChainParameter]
   }): Promise<null>
   request(args: {
     /**

package/src/utils/buildRequest.ts

@@ -12,9 +12,11 @@ import {
   MethodNotSupportedRpcError,
   ParseRpcError,
   ProviderDisconnectedError,
+  type ProviderRpcErrorCode,
   ResourceNotFoundRpcError,
   ResourceUnavailableRpcError,
   type RpcError,
+  type RpcErrorCode,
   SwitchChainError,
   TransactionRejectedRpcError,
   UnauthorizedProviderError,
@@ -66,7 +68,9 @@ export function buildRequest<TRequest extends (args: any) => Promise<any>>(
         try {
           return await request(args)
         } catch (err_) {
-          const err = err_ as unknown as RpcError
+          const err = err_ as unknown as RpcError<
+            RpcErrorCode | ProviderRpcErrorCode
+          >
           if (err.code === -32700) throw new ParseRpcError(err)
           if (err.code === -32600) throw new InvalidRequestRpcError(err)
           if (err.code === -32601) throw new MethodNotFoundRpcError(err)

package/src/utils/transaction/prepareRequest.ts

@@ -17,7 +17,6 @@ import { AccountNotFoundError } from '../../errors/account.js'
 import { BaseError } from '../../errors/base.js'
 import type { GetAccountParameter } from '../../types/account.js'
 import type { Chain } from '../../types/chain.js'
-import { parseGwei } from '../unit/parseGwei.js'
 
 import { assertRequest } from './assertRequest.js'
 
@@ -43,7 +42,7 @@ export type PrepareRequestReturnType<
   nonce: SendTransactionParameters['nonce']
 }
 
-export const defaultTip = parseGwei('1.5')
+export const defaultTip = 1_500_000_000n // 1.5 gwei
 
 export async function prepareRequest<
   TChain extends Chain | undefined,