viem 0.0.0-main.20240316T233602 → 0.0.0-main.20240317T053608

package/clients/transports/fallback.ts

@@ -20,13 +20,13 @@ export type OnResponseFn = (
     transport: ReturnType<Transport>
   } & (
     | {
-        error?: never
+        error?: never | undefined
         response: unknown
         status: 'success'
       }
     | {
         error: Error
-        response?: never
+        response?: never | undefined
         status: 'error'
       }
   ),
@@ -37,45 +37,47 @@ type RankOptions = {
    * The polling interval (in ms) at which the ranker should ping the RPC URL.
    * @default client.pollingInterval
    */
-  interval?: number
+  interval?: number | undefined
   /**
    * The number of previous samples to perform ranking on.
    * @default 10
    */
-  sampleCount?: number
+  sampleCount?: number | undefined
   /**
    * Timeout when sampling transports.
    * @default 1_000
    */
-  timeout?: number
+  timeout?: number | undefined
   /**
    * Weights to apply to the scores. Weight values are proportional.
    */
-  weights?: {
-    /**
-     * The weight to apply to the latency score.
-     * @default 0.3
-     */
-    latency?: number
-    /**
-     * The weight to apply to the stability score.
-     * @default 0.7
-     */
-    stability?: number
-  }
+  weights?:
+    | {
+        /**
+         * The weight to apply to the latency score.
+         * @default 0.3
+         */
+        latency?: number | undefined
+        /**
+         * The weight to apply to the stability score.
+         * @default 0.7
+         */
+        stability?: number | undefined
+      }
+    | undefined
 }
 
 export type FallbackTransportConfig = {
   /** The key of the Fallback transport. */
-  key?: TransportConfig['key']
+  key?: TransportConfig['key'] | undefined
   /** The name of the Fallback transport. */
-  name?: TransportConfig['name']
+  name?: TransportConfig['name'] | undefined
   /** Toggle to enable ranking, or rank options. */
-  rank?: boolean | RankOptions
+  rank?: boolean | RankOptions | undefined
   /** The max number of times to retry. */
-  retryCount?: TransportConfig['retryCount']
+  retryCount?: TransportConfig['retryCount'] | undefined
   /** The base delay (in ms) between retries. */
-  retryDelay?: TransportConfig['retryDelay']
+  retryDelay?: TransportConfig['retryDelay'] | undefined
 }
 
 export type FallbackTransport = Transport<
@@ -198,13 +200,13 @@ export function rankTransports({
   transports,
   weights = {},
 }: {
-  chain?: Chain
+  chain?: Chain | undefined
   interval: RankOptions['interval']
   onTransports: (transports: Transport[]) => void
-  sampleCount?: RankOptions['sampleCount']
-  timeout?: RankOptions['timeout']
+  sampleCount?: RankOptions['sampleCount'] | undefined
+  timeout?: RankOptions['timeout'] | undefined
   transports: Transport[]
-  weights?: RankOptions['weights']
+  weights?: RankOptions['weights'] | undefined
 }) {
   const { stability: stabilityWeight = 0.7, latency: latencyWeight = 0.3 } =
     weights

package/clients/transports/http.ts

@@ -20,9 +20,9 @@ import {
 
 export type BatchOptions = {
   /** The maximum number of JSON-RPC requests to send in a batch. @default 1_000 */
-  batchSize?: number
+  batchSize?: number | undefined
   /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
-  wait?: number
+  wait?: number | undefined
 }
 
 export type HttpTransportConfig = {
@@ -30,33 +30,33 @@ export type HttpTransportConfig = {
    * Whether to enable Batch JSON-RPC.
    * @link https://www.jsonrpc.org/specification#batch
    */
-  batch?: boolean | BatchOptions
+  batch?: boolean | BatchOptions | undefined
   /**
    * Request configuration to pass to `fetch`.
    * @link https://developer.mozilla.org/en-US/docs/Web/API/fetch
    */
-  fetchOptions?: HttpRpcClientOptions['fetchOptions']
+  fetchOptions?: HttpRpcClientOptions['fetchOptions'] | undefined
   /**
    * A callback to handle the response from `fetch`.
    */
-  onFetchResponse?: HttpRpcClientOptions['onResponse']
+  onFetchResponse?: HttpRpcClientOptions['onResponse'] | undefined
   /** The key of the HTTP transport. */
-  key?: TransportConfig['key']
+  key?: TransportConfig['key'] | undefined
   /** The name of the HTTP transport. */
-  name?: TransportConfig['name']
+  name?: TransportConfig['name'] | undefined
   /** The max number of times to retry. */
-  retryCount?: TransportConfig['retryCount']
+  retryCount?: TransportConfig['retryCount'] | undefined
   /** The base delay (in ms) between retries. */
-  retryDelay?: TransportConfig['retryDelay']
+  retryDelay?: TransportConfig['retryDelay'] | undefined
   /** The timeout (in ms) for the HTTP request. Default: 10_000 */
-  timeout?: TransportConfig['timeout']
+  timeout?: TransportConfig['timeout'] | undefined
 }
 
 export type HttpTransport = Transport<
   'http',
   {
-    fetchOptions?: HttpTransportConfig['fetchOptions']
-    url?: string
+    fetchOptions?: HttpTransportConfig['fetchOptions'] | undefined
+    url?: string | undefined
   }
 >
 
@@ -70,7 +70,7 @@ export type HttpTransportErrorType =
  */
 export function http(
   /** URL of the JSON-RPC API. Defaults to the chain's public RPC URL. */
-  url?: string,
+  url?: string | undefined,
   config: HttpTransportConfig = {},
 ): HttpTransport {
   const {

package/clients/transports/ipc.ts

@@ -13,7 +13,7 @@ import {
 
 type IpcTransportSubscribeParameters = {
   onData: (data: RpcResponse) => void
-  onError?: (error: any) => void
+  onError?: ((error: any) => void) | undefined
 }
 
 type IpcTransportSubscribeReturnType = {
@@ -35,15 +35,15 @@ type IpcTransportSubscribe = {
 
 export type IpcTransportConfig = {
   /** The key of the Ipc transport. */
-  key?: TransportConfig['key']
+  key?: TransportConfig['key'] | undefined
   /** The name of the Ipc transport. */
-  name?: TransportConfig['name']
+  name?: TransportConfig['name'] | undefined
   /** The max number of times to retry. */
-  retryCount?: TransportConfig['retryCount']
+  retryCount?: TransportConfig['retryCount'] | undefined
   /** The base delay (in ms) between retries. */
-  retryDelay?: TransportConfig['retryDelay']
+  retryDelay?: TransportConfig['retryDelay'] | undefined
   /** The timeout (in ms) for async Ipc requests. Default: 10_000 */
-  timeout?: TransportConfig['timeout']
+  timeout?: TransportConfig['timeout'] | undefined
 }
 
 export type IpcTransport = Transport<

package/clients/transports/webSocket.ts

@@ -18,7 +18,7 @@ import {
 
 type WebSocketTransportSubscribeParameters = {
   onData: (data: RpcResponse) => void
-  onError?: (error: any) => void
+  onError?: ((error: any) => void) | undefined
 }
 
 type WebSocketTransportSubscribeReturnType = {
@@ -40,15 +40,15 @@ type WebSocketTransportSubscribe = {
 
 export type WebSocketTransportConfig = {
   /** The key of the WebSocket transport. */
-  key?: TransportConfig['key']
+  key?: TransportConfig['key'] | undefined
   /** The name of the WebSocket transport. */
-  name?: TransportConfig['name']
+  name?: TransportConfig['name'] | undefined
   /** The max number of times to retry. */
-  retryCount?: TransportConfig['retryCount']
+  retryCount?: TransportConfig['retryCount'] | undefined
   /** The base delay (in ms) between retries. */
-  retryDelay?: TransportConfig['retryDelay']
+  retryDelay?: TransportConfig['retryDelay'] | undefined
   /** The timeout (in ms) for async WebSocket requests. Default: 10_000 */
-  timeout?: TransportConfig['timeout']
+  timeout?: TransportConfig['timeout'] | undefined
 }
 
 export type WebSocketTransport = Transport<

package/errors/abi.ts

@@ -198,7 +198,10 @@ export type AbiErrorNotFoundErrorType = AbiErrorNotFoundError & {
 }
 export class AbiErrorNotFoundError extends BaseError {
   override name = 'AbiErrorNotFoundError'
-  constructor(errorName?: string, { docsPath }: { docsPath?: string } = {}) {
+  constructor(
+    errorName?: string | undefined,
+    { docsPath }: { docsPath?: string | undefined } = {},
+  ) {
     super(
       [
         `Error ${errorName ? `"${errorName}" ` : ''}not found on ABI.`,
@@ -273,7 +276,10 @@ export type AbiEventNotFoundErrorType = AbiEventNotFoundError & {
 }
 export class AbiEventNotFoundError extends BaseError {
   override name = 'AbiEventNotFoundError'
-  constructor(eventName?: string, { docsPath }: { docsPath?: string } = {}) {
+  constructor(
+    eventName?: string | undefined,
+    { docsPath }: { docsPath?: string | undefined } = {},
+  ) {
     super(
       [
         `Event ${eventName ? `"${eventName}" ` : ''}not found on ABI.`,
@@ -291,7 +297,10 @@ export type AbiFunctionNotFoundErrorType = AbiFunctionNotFoundError & {
 }
 export class AbiFunctionNotFoundError extends BaseError {
   override name = 'AbiFunctionNotFoundError'
-  constructor(functionName?: string, { docsPath }: { docsPath?: string } = {}) {
+  constructor(
+    functionName?: string | undefined,
+    { docsPath }: { docsPath?: string | undefined } = {},
+  ) {
     super(
       [
         `Function ${functionName ? `"${functionName}" ` : ''}not found on ABI.`,

package/errors/account.ts

@@ -5,7 +5,7 @@ export type AccountNotFoundErrorType = AccountNotFoundError & {
 }
 export class AccountNotFoundError extends BaseError {
   override name = 'AccountNotFoundError'
-  constructor({ docsPath }: { docsPath?: string } = {}) {
+  constructor({ docsPath }: { docsPath?: string | undefined } = {}) {
     super(
       [
         'Could not find an Account to execute with this Action.',

package/errors/base.ts

@@ -1,25 +1,25 @@
 import { getVersion } from './utils.js'
 
 type BaseErrorParameters = {
-  docsPath?: string
-  docsSlug?: string
-  metaMessages?: string[]
+  docsPath?: string | undefined
+  docsSlug?: string | undefined
+  metaMessages?: string[] | undefined
 } & (
   | {
-      cause?: never
-      details?: string
+      cause?: never | undefined
+      details?: string | undefined
     }
   | {
-      cause: BaseError | Error
-      details?: never
+      cause: BaseError | Error | undefined
+      details?: never | undefined
     }
 )
 
 export type BaseErrorType = BaseError & { name: 'ViemError' }
 export class BaseError extends Error {
   details: string
-  docsPath?: string
-  metaMessages?: string[]
+  docsPath?: string | undefined
+  metaMessages?: string[] | undefined
   shortMessage: string
 
   override name = 'ViemError'
@@ -68,7 +68,10 @@ export class BaseError extends Error {
   }
 }
 
-function walk(err: unknown, fn?: (err: unknown) => boolean): unknown {
+function walk(
+  err: unknown,
+  fn?: ((err: unknown) => boolean) | undefined,
+): unknown {
   if (fn?.(err)) return err
   if (err && typeof err === 'object' && 'cause' in err)
     return walk(err.cause, fn)

package/errors/block.ts

@@ -11,8 +11,8 @@ export class BlockNotFoundError extends BaseError {
     blockHash,
     blockNumber,
   }: {
-    blockHash?: Hash
-    blockNumber?: bigint
+    blockHash?: Hash | undefined
+    blockNumber?: bigint | undefined
   }) {
     let identifier = 'Block'
     if (blockHash) identifier = `Block at hash "${blockHash}"`

package/errors/chain.ts

@@ -13,9 +13,9 @@ export class ChainDoesNotSupportContract extends BaseError {
     chain,
     contract,
   }: {
-    blockNumber?: bigint
+    blockNumber?: bigint | undefined
     chain: Chain
-    contract: { name: string; blockCreated?: number }
+    contract: { name: string; blockCreated?: number | undefined }
   }) {
     super(
       `Chain "${chain.name}" does not support contract "${contract.name}".`,
@@ -96,7 +96,7 @@ export type InvalidChainIdErrorType = InvalidChainIdError & {
 export class InvalidChainIdError extends BaseError {
   override name = 'InvalidChainIdError'
 
-  constructor({ chainId }: { chainId?: number }) {
+  constructor({ chainId }: { chainId?: number | undefined }) {
     super(
       typeof chainId === 'number'
         ? `Chain ID "${chainId}" is invalid.`

package/errors/contract.ts

@@ -44,7 +44,10 @@ export class CallExecutionError extends BaseError {
       to,
       value,
       stateOverride,
-    }: CallParameters & { chain?: Chain; docsPath?: string },
+    }: CallParameters & {
+      chain?: Chain | undefined
+      docsPath?: string | undefined
+    },
   ) {
     const account = account_ ? parseAccount(account_) : undefined
     let prettyArgs = prettyPrint({
@@ -89,12 +92,12 @@ export type ContractFunctionExecutionErrorType =
   }
 export class ContractFunctionExecutionError extends BaseError {
   abi: Abi
-  args?: unknown[]
+  args?: unknown[] | undefined
   override cause: BaseError
-  contractAddress?: Address
-  formattedArgs?: string
+  contractAddress?: Address | undefined
+  formattedArgs?: string | undefined
   functionName: string
-  sender?: Address
+  sender?: Address | undefined
 
   override name = 'ContractFunctionExecutionError'
 
@@ -109,11 +112,11 @@ export class ContractFunctionExecutionError extends BaseError {
       sender,
     }: {
       abi: Abi
-      args?: any
-      contractAddress?: Address
-      docsPath?: string
+      args?: any | undefined
+      contractAddress?: Address | undefined
+      docsPath?: string | undefined
       functionName: string
-      sender?: Address
+      sender?: Address | undefined
     },
   ) {
     const abiItem = getAbiItem({ abi, args, name: functionName })
@@ -170,16 +173,21 @@ export type ContractFunctionRevertedErrorType =
 export class ContractFunctionRevertedError extends BaseError {
   override name = 'ContractFunctionRevertedError'
 
-  data?: DecodeErrorResultReturnType
-  reason?: string
-  signature?: Hex
+  data?: DecodeErrorResultReturnType | undefined
+  reason?: string | undefined
+  signature?: Hex | undefined
 
   constructor({
     abi,
     data,
     functionName,
     message,
-  }: { abi: Abi; data?: Hex; functionName: string; message?: string }) {
+  }: {
+    abi: Abi
+    data?: Hex | undefined
+    functionName: string
+    message?: string | undefined
+  }) {
     let cause: Error | undefined
     let decodedData: DecodeErrorResultReturnType | undefined = undefined
     let metaMessages: string[] | undefined
@@ -277,12 +285,15 @@ export class RawContractError extends BaseError {
   code = 3
   override name = 'RawContractError'
 
-  data?: Hex | { data?: Hex }
+  data?: Hex | { data?: Hex | undefined } | undefined
 
   constructor({
     data,
     message,
-  }: { data?: Hex | { data?: Hex }; message?: string }) {
+  }: {
+    data?: Hex | { data?: Hex | undefined } | undefined
+    message?: string | undefined
+  }) {
     super(message || '')
     this.data = data
   }

package/errors/encoding.ts

@@ -14,10 +14,10 @@ export class IntegerOutOfRangeError extends BaseError {
     size,
     value,
   }: {
-    max?: string
+    max?: string | undefined
     min: string
-    signed?: boolean
-    size?: number
+    signed?: boolean | undefined
+    size?: number | undefined
     value: string
   }) {
     super(

package/errors/estimateGas.ts

@@ -30,9 +30,9 @@ export class EstimateGasExecutionError extends BaseError {
       to,
       value,
     }: Omit<EstimateGasParameters<any>, 'account'> & {
-      account?: Account
-      chain?: Chain
-      docsPath?: string
+      account?: Account | undefined
+      chain?: Chain | undefined
+      docsPath?: string | undefined
     },
   ) {
     const prettyArgs = prettyPrint({

package/errors/node.ts

@@ -24,7 +24,7 @@ export class ExecutionRevertedError extends BaseError {
   constructor({
     cause,
     message,
-  }: { cause?: BaseError; message?: string } = {}) {
+  }: { cause?: BaseError | undefined; message?: string | undefined } = {}) {
     const reason = message
       ?.replace('execution reverted: ', '')
       ?.replace('execution reverted', '')
@@ -49,7 +49,10 @@ export class FeeCapTooHighError extends BaseError {
   constructor({
     cause,
     maxFeePerGas,
-  }: { cause?: BaseError; maxFeePerGas?: bigint } = {}) {
+  }: {
+    cause?: BaseError | undefined
+    maxFeePerGas?: bigint | undefined
+  } = {}) {
     super(
       `The fee cap (\`maxFeePerGas\`${
         maxFeePerGas ? ` = ${formatGwei(maxFeePerGas)} gwei` : ''
@@ -71,7 +74,10 @@ export class FeeCapTooLowError extends BaseError {
   constructor({
     cause,
     maxFeePerGas,
-  }: { cause?: BaseError; maxFeePerGas?: bigint } = {}) {
+  }: {
+    cause?: BaseError | undefined
+    maxFeePerGas?: bigint | undefined
+  } = {}) {
     super(
       `The fee cap (\`maxFeePerGas\`${
         maxFeePerGas ? ` = ${formatGwei(maxFeePerGas)}` : ''
@@ -89,7 +95,10 @@ export type NonceTooHighErrorType = NonceTooHighError & {
 export class NonceTooHighError extends BaseError {
   static nodeMessage = /nonce too high/
   override name = 'NonceTooHighError'
-  constructor({ cause, nonce }: { cause?: BaseError; nonce?: number } = {}) {
+  constructor({
+    cause,
+    nonce,
+  }: { cause?: BaseError | undefined; nonce?: number | undefined } = {}) {
     super(
       `Nonce provided for the transaction ${
         nonce ? `(${nonce}) ` : ''
@@ -106,7 +115,10 @@ export class NonceTooLowError extends BaseError {
   static nodeMessage =
     /nonce too low|transaction already imported|already known/
   override name = 'NonceTooLowError'
-  constructor({ cause, nonce }: { cause?: BaseError; nonce?: number } = {}) {
+  constructor({
+    cause,
+    nonce,
+  }: { cause?: BaseError | undefined; nonce?: number | undefined } = {}) {
     super(
       [
         `Nonce provided for the transaction ${
@@ -125,7 +137,10 @@ export type NonceMaxValueErrorType = NonceMaxValueError & {
 export class NonceMaxValueError extends BaseError {
   static nodeMessage = /nonce has max value/
   override name = 'NonceMaxValueError'
-  constructor({ cause, nonce }: { cause?: BaseError; nonce?: number } = {}) {
+  constructor({
+    cause,
+    nonce,
+  }: { cause?: BaseError | undefined; nonce?: number | undefined } = {}) {
     super(
       `Nonce provided for the transaction ${
         nonce ? `(${nonce}) ` : ''
@@ -141,7 +156,7 @@ export type InsufficientFundsErrorType = InsufficientFundsError & {
 export class InsufficientFundsError extends BaseError {
   static nodeMessage = /insufficient funds/
   override name = 'InsufficientFundsError'
-  constructor({ cause }: { cause?: BaseError } = {}) {
+  constructor({ cause }: { cause?: BaseError | undefined } = {}) {
     super(
       [
         'The total cost (gas * gas fee + value) of executing this transaction exceeds the balance of the account.',
@@ -169,7 +184,10 @@ export type IntrinsicGasTooHighErrorType = IntrinsicGasTooHighError & {
 export class IntrinsicGasTooHighError extends BaseError {
   static nodeMessage = /intrinsic gas too high|gas limit reached/
   override name = 'IntrinsicGasTooHighError'
-  constructor({ cause, gas }: { cause?: BaseError; gas?: bigint } = {}) {
+  constructor({
+    cause,
+    gas,
+  }: { cause?: BaseError | undefined; gas?: bigint | undefined } = {}) {
     super(
       `The amount of gas ${
         gas ? `(${gas}) ` : ''
@@ -187,7 +205,10 @@ export type IntrinsicGasTooLowErrorType = IntrinsicGasTooLowError & {
 export class IntrinsicGasTooLowError extends BaseError {
   static nodeMessage = /intrinsic gas too low/
   override name = 'IntrinsicGasTooLowError'
-  constructor({ cause, gas }: { cause?: BaseError; gas?: bigint } = {}) {
+  constructor({
+    cause,
+    gas,
+  }: { cause?: BaseError | undefined; gas?: bigint | undefined } = {}) {
     super(
       `The amount of gas ${
         gas ? `(${gas}) ` : ''
@@ -206,7 +227,7 @@ export type TransactionTypeNotSupportedErrorType =
 export class TransactionTypeNotSupportedError extends BaseError {
   static nodeMessage = /transaction type not valid/
   override name = 'TransactionTypeNotSupportedError'
-  constructor({ cause }: { cause?: BaseError }) {
+  constructor({ cause }: { cause?: BaseError | undefined }) {
     super('The transaction type is not supported for this chain.', {
       cause,
     })
@@ -225,9 +246,9 @@ export class TipAboveFeeCapError extends BaseError {
     maxPriorityFeePerGas,
     maxFeePerGas,
   }: {
-    cause?: BaseError
-    maxPriorityFeePerGas?: bigint
-    maxFeePerGas?: bigint
+    cause?: BaseError | undefined
+    maxPriorityFeePerGas?: bigint | undefined
+    maxFeePerGas?: bigint | undefined
   } = {}) {
     super(
       [
@@ -252,7 +273,7 @@ export type UnknownNodeErrorType = UnknownNodeError & {
 export class UnknownNodeError extends BaseError {
   override name = 'UnknownNodeError'
 
-  constructor({ cause }: { cause?: BaseError }) {
+  constructor({ cause }: { cause?: BaseError | undefined }) {
     super(`An error occurred while executing: ${cause?.shortMessage}`, {
       cause,
     })

package/errors/request.ts

@@ -9,9 +9,9 @@ export type HttpRequestErrorType = HttpRequestError & {
 export class HttpRequestError extends BaseError {
   override name = 'HttpRequestError'
 
-  body?: { [x: string]: unknown } | { [y: string]: unknown }[]
-  headers?: Headers
-  status?: number
+  body?: { [x: string]: unknown } | { [y: string]: unknown }[] | undefined
+  headers?: Headers | undefined
+  status?: number | undefined
   url: string
 
   constructor({
@@ -21,10 +21,10 @@ export class HttpRequestError extends BaseError {
     status,
     url,
   }: {
-    body?: { [x: string]: unknown } | { [y: string]: unknown }[]
-    details?: string
-    headers?: Headers
-    status?: number
+    body?: { [x: string]: unknown } | { [y: string]: unknown }[] | undefined
+    details?: string | undefined
+    headers?: Headers | undefined
+    status?: number | undefined
     url: string
   }) {
     super('HTTP request failed.', {

package/errors/rpc.ts

@@ -21,9 +21,9 @@ export type RpcErrorCode =
   | -32042 // Method not found
 
 type RpcErrorOptions<TCode extends number = RpcErrorCode> = {
-  code?: TCode | (number & {})
-  docsPath?: string
-  metaMessages?: string[]
+  code?: TCode | (number & {}) | undefined
+  docsPath?: string | undefined
+  metaMessages?: string[] | undefined
   shortMessage: string
 }
 
@@ -76,13 +76,13 @@ export class ProviderRpcError<
 > extends RpcError<ProviderRpcErrorCode> {
   override name = 'ProviderRpcError'
 
-  data?: T
+  data?: T | undefined
 
   constructor(
     cause: Error,
     options: Prettify<
       RpcErrorOptions<ProviderRpcErrorCode> & {
-        data?: T
+        data?: T | undefined
       }
     >,
   ) {