viem 0.0.0-portable-types-20230523145621 → 0.0.0-refactor-generics-20230831161903

package/src/public.ts

@@ -53,6 +53,11 @@ export {
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
 } from './actions/public/getFeeHistory.js'
+export {
+  estimateFeesPerGas,
+  type EstimateFeesPerGasParameters,
+  type EstimateFeesPerGasReturnType,
+} from './actions/public/estimateFeesPerGas.js'
 export {
   getFilterChanges,
   type GetFilterChangesParameters,
@@ -68,6 +73,11 @@ export {
   getGasPrice,
   type GetGasPriceReturnType,
 } from './actions/public/getGasPrice.js'
+export {
+  estimateMaxPriorityFeePerGas,
+  type EstimateMaxPriorityFeePerGasParameters,
+  type EstimateMaxPriorityFeePerGasReturnType,
+} from './actions/public/estimateMaxPriorityFeePerGas.js'
 export {
   getTransaction,
   type GetTransactionParameters,
@@ -114,8 +124,12 @@ export {
 } from './actions/public/watchBlocks.js'
 export {
   watchEvent,
-  type OnLogsFn,
-  type OnLogsParameter,
+  type WatchEventOnLogsFn,
+  /** @deprecated - use `WatchEventOnLogsFn` instead. */
+  type WatchEventOnLogsFn as OnLogsFn,
+  type WatchEventOnLogsParameter,
+  /** @deprecated - use `WatchEventOnLogsParameter` instead. */
+  type WatchEventOnLogsParameter as OnLogsParameter,
 } from './actions/public/watchEvent.js'
 export {
   watchPendingTransactions,

package/src/test.ts

@@ -2,9 +2,18 @@ export {
   dropTransaction,
   type DropTransactionParameters,
 } from './actions/test/dropTransaction.js'
-export { getAutomine } from './actions/test/getAutomine.js'
-export { getTxpoolContent } from './actions/test/getTxpoolContent.js'
-export { getTxpoolStatus } from './actions/test/getTxpoolStatus.js'
+export {
+  getAutomine,
+  type GetAutomineReturnType,
+} from './actions/test/getAutomine.js'
+export {
+  getTxpoolContent,
+  type GetTxpoolContentReturnType,
+} from './actions/test/getTxpoolContent.js'
+export {
+  getTxpoolStatus,
+  type GetTxpoolStatusReturnType,
+} from './actions/test/getTxpoolStatus.js'
 export {
   impersonateAccount,
   type ImpersonateAccountParameters,
@@ -13,7 +22,10 @@ export {
   increaseTime,
   type IncreaseTimeParameters,
 } from './actions/test/increaseTime.js'
-export { inspectTxpool } from './actions/test/inspectTxpool.js'
+export {
+  inspectTxpool,
+  type InspectTxpoolReturnType,
+} from './actions/test/inspectTxpool.js'
 export { mine, type MineParameters } from './actions/test/mine.js'
 export { removeBlockTimestampInterval } from './actions/test/removeBlockTimestampInterval.js'
 export { reset, type ResetParameters } from './actions/test/reset.js'

package/src/types/account.ts

@@ -2,7 +2,7 @@ import type { Address } from 'abitype'
 
 import type { Account, JsonRpcAccount } from '../accounts/types.js'
 
-import type { IsUndefined } from './utils.js'
+import type { IsUndefined, Prettify } from './utils.js'
 
 export type GetAccountParameter<
   TAccount extends Account | undefined = Account | undefined,
@@ -10,19 +10,23 @@ export type GetAccountParameter<
   ? { account: Account | Address }
   : { account?: Account | Address }
 
-export type ParseAccount<TAccount extends Account | Address | undefined> =
-  | (TAccount extends Account ? TAccount : never)
-  | (TAccount extends Address ? JsonRpcAccount : never)
-  | (TAccount extends undefined ? undefined : never)
+export type ParseAccount<
+  TAccountOrAddress extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = TAccountOrAddress extends Address
+  ? Prettify<JsonRpcAccount<TAccountOrAddress>>
+  : TAccountOrAddress
 
-export {
-  type Account,
-  type AccountSource,
-  type CustomSource,
-  type HDAccount,
-  type HDOptions,
-  type JsonRpcAccount,
-  type LocalAccount,
-  type PrivateKeyAccount,
+export type {
+  Account,
+  AccountSource,
+  CustomSource,
+  HDAccount,
+  HDOptions,
+  JsonRpcAccount,
+  LocalAccount,
+  PrivateKeyAccount,
 } from '../accounts/types.js'
 export type { HDKey } from '@scure/bip32'

package/src/types/block.ts

@@ -3,7 +3,16 @@ import type { Address } from 'abitype'
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
 
-export type Block<TQuantity = bigint, TTransaction = Transaction> = {
+export type Block<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = {
   /** Base fee per gas */
   baseFeePerGas: TQuantity | null
   /** Difficulty for this block */
@@ -15,17 +24,17 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total used gas by all transactions in this block */
   gasUsed: TQuantity
   /** Block hash or `null` if pending */
-  hash: Hash | null
+  hash: TBlockTag extends 'pending' ? null : Hash
   /** Logs bloom filter or `null` if pending */
-  logsBloom: Hex | null
+  logsBloom: TBlockTag extends 'pending' ? null : Hex
   /** Address that received this block’s mining rewards */
   miner: Address
   /** Unique identifier for the block. */
   mixHash: Hash
   /** Proof-of-work hash or `null` if pending */
-  nonce: Hex | null
+  nonce: TBlockTag extends 'pending' ? null : Hex
   /** Block number or `null` if pending */
-  number: TQuantity | null
+  number: TBlockTag extends 'pending' ? null : TQuantity
   /** Parent block hash */
   parentHash: Hash
   /** Root of the this block’s receipts trie */
@@ -42,7 +51,7 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total difficulty of the chain until this block */
   totalDifficulty: TQuantity | null
   /** List of transaction objects or hashes */
-  transactions: Hash[] | TTransaction[]
+  transactions: TIncludeTransactions extends true ? TTransaction[] : Hash[]
   /** Root of this block’s transaction trie */
   transactionsRoot: Hash
   /** List of uncle hashes */
@@ -67,7 +76,13 @@ export type BlockNumber<TQuantity = bigint> = TQuantity
 
 export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
 
-export type Uncle<TQuantity = bigint, TTransaction = Transaction> = Block<
-  TQuantity,
-  TTransaction
->
+export type Uncle<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = Block<TQuantity, TIncludeTransactions, TBlockTag, TTransaction>

package/src/types/chain.ts

@@ -1,11 +1,67 @@
-import type { Chain as Chain_ } from '@wagmi/chains'
 import type { Address } from 'abitype'
 
-import type { Formatters } from './formatter.js'
-import type { IsUndefined } from './utils.js'
+import type { EstimateFeesPerGasReturnType } from '../actions/public/estimateFeesPerGas.js'
+import type { PrepareTransactionRequestParameters } from '../actions/wallet/prepareTransactionRequest.js'
+import type { Client } from '../clients/createClient.js'
+import type { Transport } from '../clients/transports/createTransport.js'
+import type { Account } from '../types/account.js'
+import type { FeeValuesType } from '../types/fee.js'
+import type {
+  TransactionSerializable,
+  TransactionSerializableGeneric,
+} from '../types/transaction.js'
+import type { IsUndefined, Prettify } from '../types/utils.js'
+import type { FormattedBlock } from '../utils/formatters/block.js'
+import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js'
 
-export type Chain<TFormatters extends Formatters = Formatters> = Chain_ & {
-  formatters?: TFormatters
+export type Chain<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = ChainConstants & ChainConfig<formatters>
+
+/////////////////////////////////////////////////////////////////////
+// Constants
+
+export type ChainBlockExplorer = {
+  name: string
+  url: string
+}
+
+export type ChainConstants = {
+  /** Collection of block explorers */
+  blockExplorers?: {
+    default: ChainBlockExplorer
+    etherscan?: ChainBlockExplorer
+  }
+  /** Collection of contracts */
+  contracts?: {
+    ensRegistry?: ChainContract
+    ensUniversalResolver?: ChainContract
+    multicall3?: ChainContract
+  }
+  /** ID in number form */
+  id: number
+  /** Human-readable name */
+  name: string
+  /**
+   * Internal network name
+   * @deprecated will be removed in v2 - use `id` instead.
+   */
+  network: string
+  /** Currency used by chain */
+  nativeCurrency: ChainNativeCurrency
+  /** Collection of RPC endpoints */
+  rpcUrls: {
+    [key: string]: ChainRpcUrls
+    default: ChainRpcUrls
+    public: ChainRpcUrls
+  }
+  /** Source Chain ID (ie. the L1 chain) */
+  sourceId?: number
+  /** Flag for test networks */
+  testnet?: boolean
+
+  // TODO(v2): remove `rpcUrls` in favor of `publicRpcUrls`.
+  // publicRpcUrls: ChainRpcUrls,
 }
 
 export type ChainContract = {
@@ -13,9 +69,165 @@ export type ChainContract = {
   blockCreated?: number
 }
 
+export type ChainNativeCurrency = {
+  name: string
+  /** 2-6 characters long */
+  symbol: string
+  decimals: number
+}
+
+export type ChainRpcUrls = {
+  http: readonly string[]
+  webSocket?: readonly string[]
+}
+
+/////////////////////////////////////////////////////////////////////
+// Config
+
+export type ChainConfig<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /**
+   * Modifies how chain data structures (ie. Blocks, Transactions, etc)
+   * are formatted & typed.
+   */
+  formatters?: formatters | undefined
+  /** Modifies how data (ie. Transactions) is serialized. */
+  serializers?: ChainSerializers<formatters> | undefined
+  /** Modifies how fees are derived. */
+  fees?: ChainFees<formatters> | undefined
+}
+
+export type ChainFees<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /**
+   * The fee multiplier to use to account for fee fluctuations.
+   * Used in the [`estimateFeesPerGas` Action](/docs/actions/public/estimateFeesPerGas).
+   *
+   * @default 1.2
+   */
+  baseFeeMultiplier?:
+    | number
+    | ((args: ChainFeesFnParameters<formatters>) => Promise<number> | number)
+  /**
+   * The default `maxPriorityFeePerGas` to use when a priority
+   * fee is not defined upon sending a transaction.
+   *
+   * Overrides the return value in the [`estimateMaxPriorityFeePerGas` Action](/docs/actions/public/estimateMaxPriorityFeePerGas).
+   */
+  defaultPriorityFee?:
+    | bigint
+    | ((args: ChainFeesFnParameters<formatters>) => Promise<bigint> | bigint)
+  /**
+   * Allows customization of fee per gas values (e.g. `maxFeePerGas`/`maxPriorityFeePerGas`).
+   *
+   * Overrides the return value in the [`estimateFeesPerGas` Action](/docs/actions/public/estimateFeesPerGas).
+   */
+  estimateFeesPerGas?: (
+    args: ChainEstimateFeesPerGasFnParameters<formatters>,
+  ) => Promise<EstimateFeesPerGasReturnType> | bigint
+}
+
+export type ChainFormatters = {
+  /** Modifies how the Block structure is formatted & typed. */
+  block?: ChainFormatter<'block'>
+  /** Modifies how the Transaction structure is formatted & typed. */
+  transaction?: ChainFormatter<'transaction'>
+  /** Modifies how the TransactionReceipt structure is formatted & typed. */
+  transactionReceipt?: ChainFormatter<'transactionReceipt'>
+  /** Modifies how the TransactionRequest structure is formatted & typed. */
+  transactionRequest?: ChainFormatter<'transactionRequest'>
+}
+
+export type ChainFormatter<type extends string = string> = {
+  format: (args: any) => any
+  type: type
+}
+
+export type ChainSerializers<
+  formatters extends ChainFormatters | undefined = undefined,
+> = {
+  /** Modifies how Transactions are serialized. */
+  transaction?: SerializeTransactionFn<
+    formatters extends ChainFormatters
+      ? formatters['transactionRequest'] extends ChainFormatter
+        ? TransactionSerializableGeneric &
+            Parameters<formatters['transactionRequest']['format']>[0]
+        : TransactionSerializable
+      : TransactionSerializable
+  >
+}
+
+/////////////////////////////////////////////////////////////////////
+// Parameters
+
+export type ChainFeesFnParameters<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /** The latest block. */
+  block: Prettify<FormattedBlock<{ formatters: formatters }>>
+  client: Client<Transport, Chain>
+  /**
+   * A transaction request. This value will be undefined if the caller
+   * is outside of a transaction request context (e.g. a direct call to
+   * the `estimateFeesPerGas` Action).
+   */
+  request?: PrepareTransactionRequestParameters<
+    Omit<Chain, 'formatters'> & { formatters: formatters },
+    Account | undefined,
+    undefined
+  >
+}
+
+export type ChainEstimateFeesPerGasFnParameters<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /**
+   * A function to multiply the base fee based on the `baseFeeMultiplier` value.
+   */
+  multiply(x: bigint): bigint
+  /**
+   * The type of fees to return.
+   */
+  type: FeeValuesType
+} & ChainFeesFnParameters<formatters>
+
+/////////////////////////////////////////////////////////////////////
+// Utils
+
+export type ExtractChainFormatterExclude<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends { exclude: infer Exclude }
+    ? Extract<Exclude, string[]>[number]
+    : ''
+  : ''
+
+export type ExtractChainFormatterParameters<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+  fallback,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends ChainFormatter
+    ? Parameters<_Formatters[type]['format']>[0]
+    : fallback
+  : fallback
+
+export type ExtractChainFormatterReturnType<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+  fallback,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends ChainFormatter
+    ? ReturnType<_Formatters[type]['format']>
+    : fallback
+  : fallback
+
 export type GetChain<
-  TChain extends Chain | undefined,
-  TChainOverride extends Chain | undefined = undefined,
-> = IsUndefined<TChain> extends true
-  ? { chain: TChainOverride | null }
-  : { chain?: TChainOverride | null }
+  chain extends Chain | undefined,
+  chainOverride extends Chain | undefined = undefined,
+> = IsUndefined<chain> extends true
+  ? { chain: chainOverride | null }
+  : { chain?: chainOverride | null }