viem 0.0.0-w-20230725184008 → 0.0.0-w-20230810155401

package/src/chains/{serializers/celo.ts → celo/serializers.ts}

@@ -4,9 +4,9 @@ import { InvalidAddressError } from '../../errors/address.js'
 import { BaseError } from '../../errors/base.js'
 import { InvalidChainIdError } from '../../errors/chain.js'
 import { FeeCapTooHighError, TipAboveFeeCapError } from '../../errors/node.js'
+import type { ChainSerializers } from '../../types/chain.js'
 import type { FeeValuesEIP1559 } from '../../types/fee.js'
 import type { Signature } from '../../types/misc.js'
-import type { Serializers } from '../../types/serializer.js'
 import type {
   AccessList,
   TransactionSerializable,
@@ -24,7 +24,7 @@ import {
 } from '../../utils/transaction/serializeTransaction.js'
 
 export const serializeTransactionCelo: SerializeTransactionFn<
-  TransactionSerializableCelo
+  CeloTransactionSerializable
 > = (tx, signature) => {
   // Handle CIP-42 transactions
   if (isCIP42(tx))
@@ -39,7 +39,7 @@ export const serializeTransactionCelo: SerializeTransactionFn<
 
 export const serializersCelo = {
   transaction: serializeTransactionCelo,
-} as const satisfies Serializers
+} as const satisfies ChainSerializers
 
 //////////////////////////////////////////////////////////////////////////////
 // Types
@@ -58,7 +58,7 @@ export type TransactionSerializableCIP42<
     type?: 'cip42'
   }
 
-export type TransactionSerializableCelo =
+export type CeloTransactionSerializable =
   | TransactionSerializableCIP42
   | TransactionSerializable
 
@@ -123,7 +123,7 @@ function serializeTransactionCIP42(
 // Utilities
 
 // process as CIP42 if any of these fields are present. realistically gatewayfee is not used but is part of spec
-function isCIP42(transaction: TransactionSerializableCelo) {
+function isCIP42(transaction: CeloTransactionSerializable) {
   if (
     'maxFeePerGas' in transaction &&
     'maxPriorityFeePerGas' in transaction &&

package/src/chains/celo/types.ts

@@ -0,0 +1,111 @@
+import type { Address } from 'abitype'
+
+import type { Block, BlockTag } from '../../types/block.js'
+import type { Hex } from '../../types/misc.js'
+import type {
+  RpcBlock,
+  RpcTransaction,
+  RpcTransactionReceipt,
+  RpcTransactionRequest,
+} from '../../types/rpc.js'
+import type {
+  Transaction,
+  TransactionReceipt,
+  TransactionRequest,
+} from '../../types/transaction.js'
+import type { NeverBy } from '../../types/utils.js'
+import type { OptimismRpcTransaction } from '../optimism/types.js'
+
+type CeloBlockExclude =
+  | 'difficulty'
+  | 'gasLimit'
+  | 'mixHash'
+  | 'nonce'
+  | 'uncles'
+
+export type CeloBlockOverrides = {
+  randomness: {
+    committed: Hex
+    revealed: Hex
+  }
+}
+export type CeloBlock<
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+> = NeverBy<
+  Block<
+    bigint,
+    TIncludeTransactions,
+    TBlockTag,
+    CeloTransaction<TBlockTag extends 'pending' ? true : false>
+  >,
+  CeloBlockExclude
+> &
+  CeloBlockOverrides
+
+export type CeloRpcBlockOverrides = {
+  randomness: {
+    committed: Hex
+    revealed: Hex
+  }
+}
+export type CeloRpcBlock<
+  TBlockTag extends BlockTag = BlockTag,
+  TIncludeTransactions extends boolean = boolean,
+> = NeverBy<
+  RpcBlock<
+    TBlockTag,
+    TIncludeTransactions,
+    OptimismRpcTransaction<TBlockTag extends 'pending' ? true : false>
+  >,
+  CeloBlockExclude
+> &
+  CeloRpcBlockOverrides
+
+export type CeloRpcTransactionOverrides = {
+  feeCurrency: Address | null
+  gatewayFee: Hex | null
+  gatewayFeeRecipient: Address | null
+}
+export type CeloRpcTransaction<TPending extends boolean = boolean> =
+  RpcTransaction<TPending> & CeloRpcTransactionOverrides
+
+export type CeloRpcTransactionReceiptOverrides = {
+  feeCurrency: Address | null
+  gatewayFee: Hex | null
+  gatewayFeeRecipient: Address | null
+}
+export type CeloRpcTransactionReceipt = RpcTransactionReceipt &
+  CeloRpcTransactionReceiptOverrides
+
+export type CeloRpcTransactionRequestOverrides = {
+  feeCurrency?: Address
+  gatewayFee?: Hex
+  gatewayFeeRecipient?: Address
+}
+export type CeloRpcTransactionRequest = RpcTransactionRequest &
+  CeloRpcTransactionRequestOverrides
+
+export type CeloTransactionOverrides = {
+  feeCurrency: Address | null
+  gatewayFee: bigint | null
+  gatewayFeeRecipient: Address | null
+}
+export type CeloTransaction<TPending extends boolean = boolean> =
+  Transaction<TPending> & CeloTransactionOverrides
+
+export type CeloTransactionReceiptOverrides = {
+  feeCurrency: Address | null
+  gatewayFee: bigint | null
+  gatewayFeeRecipient: Address | null
+}
+export type CeloTransactionReceipt = TransactionReceipt &
+  CeloTransactionReceiptOverrides
+
+export type CeloTransactionRequestOverrides = {
+  feeCurrency?: Address
+  gatewayFee?: bigint
+  gatewayFeeRecipient?: Address
+}
+export type CeloTransactionRequest = TransactionRequest &
+  CeloTransactionRequestOverrides

package/src/chains/index.ts

@@ -1,9 +1,10 @@
 import * as chains from '@wagmi/chains'
 
 import { defineChain } from '../utils/chain.js'
-import { formattersCelo } from './formatters/celo.js'
-import { formattersOptimism } from './formatters/optimism.js'
-import { serializersCelo } from './serializers/celo.js'
+import { formattersCelo } from './celo/formatters.js'
+import { serializersCelo } from './celo/serializers.js'
+import { feesOptimism } from './optimism/fees.js'
+import { formattersOptimism } from './optimism/formatters.js'
 
 export const arbitrum = /*#__PURE__*/ defineChain(chains.arbitrum)
 export const arbitrumGoerli = /*#__PURE__*/ defineChain(chains.arbitrumGoerli)
@@ -11,8 +12,14 @@ export const aurora = /*#__PURE__*/ defineChain(chains.aurora)
 export const auroraTestnet = /*#__PURE__*/ defineChain(chains.auroraTestnet)
 export const avalanche = /*#__PURE__*/ defineChain(chains.avalanche)
 export const avalancheFuji = /*#__PURE__*/ defineChain(chains.avalancheFuji)
-export const base = /*#__PURE__*/ defineChain(chains.base)
-export const baseGoerli = /*#__PURE__*/ defineChain(chains.baseGoerli)
+export const base = /*#__PURE__*/ defineChain(chains.base, {
+  fees: feesOptimism,
+  formatters: formattersOptimism,
+})
+export const baseGoerli = /*#__PURE__*/ defineChain(chains.baseGoerli, {
+  fees: feesOptimism,
+  formatters: formattersOptimism,
+})
 export const boba = /*#__PURE__*/ defineChain(chains.boba)
 export const bronos = /*#__PURE__*/ defineChain(chains.bronos)
 export const bronosTestnet = /*#__PURE__*/ defineChain(chains.bronosTestnet)
@@ -72,9 +79,11 @@ export const moonriver = /*#__PURE__*/ defineChain(chains.moonriver)
 export const nexi = /*#__PURE__*/ defineChain(chains.nexi)
 export const okc = /*#__PURE__*/ defineChain(chains.okc)
 export const optimism = /*#__PURE__*/ defineChain(chains.optimism, {
+  fees: feesOptimism,
   formatters: formattersOptimism,
 })
 export const optimismGoerli = /*#__PURE__*/ defineChain(chains.optimismGoerli, {
+  fees: feesOptimism,
   formatters: formattersOptimism,
 })
 export const polygon = /*#__PURE__*/ defineChain(chains.polygon)
@@ -136,7 +145,13 @@ export const xdcTestnet = /*#__PURE__*/ defineChain(chains.xdcTestnet)
 export const zhejiang = /*#__PURE__*/ defineChain(chains.zhejiang)
 export const zkSync = /*#__PURE__*/ defineChain(chains.zkSync)
 export const zkSyncTestnet = /*#__PURE__*/ defineChain(chains.zkSyncTestnet)
-export const zora = /*#__PURE__*/ defineChain(chains.zora)
-export const zoraTestnet = /*#__PURE__*/ defineChain(chains.zoraTestnet)
+export const zora = /*#__PURE__*/ defineChain(chains.zora, {
+  fees: feesOptimism,
+  formatters: formattersOptimism,
+})
+export const zoraTestnet = /*#__PURE__*/ defineChain(chains.zoraTestnet, {
+  fees: feesOptimism,
+  formatters: formattersOptimism,
+})
 
 export type { Chain } from '../types/chain.js'

package/src/chains/optimism/fees.ts

@@ -0,0 +1,5 @@
+import type { ChainFees } from '../../types/chain.js'
+
+export const feesOptimism = {
+  defaultPriorityFee: 1_000_000n, // 0.001 gwei
+} as const satisfies ChainFees

package/src/chains/optimism/formatters.ts

@@ -0,0 +1,74 @@
+import { type ChainFormatters } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import { type RpcTransaction } from '../../types/rpc.js'
+import { hexToBigInt } from '../../utils/encoding/fromHex.js'
+import { defineBlock } from '../../utils/formatters/block.js'
+import {
+  defineTransaction,
+  formatTransaction,
+} from '../../utils/formatters/transaction.js'
+import { defineTransactionReceipt } from '../../utils/formatters/transactionReceipt.js'
+import type {
+  OptimismBlockOverrides,
+  OptimismRpcBlockOverrides,
+  OptimismRpcTransaction,
+  OptimismRpcTransactionReceiptOverrides,
+  OptimismTransaction,
+  OptimismTransactionReceiptOverrides,
+} from './types.js'
+
+export const formattersOptimism = {
+  block: /*#__PURE__*/ defineBlock({
+    format(
+      args: OptimismRpcBlockOverrides & {
+        transactions: Hash[] | OptimismRpcTransaction[]
+      },
+    ): OptimismBlockOverrides & {
+      transactions: Hash[] | OptimismTransaction[]
+    } {
+      const transactions = args.transactions?.map((transaction) => {
+        if (typeof transaction === 'string') return transaction
+        const formatted = formatTransaction(
+          transaction as RpcTransaction,
+        ) as OptimismTransaction
+        if (formatted.typeHex === '0x7e') {
+          formatted.isSystemTx = transaction.isSystemTx
+          formatted.mint = transaction.mint
+            ? hexToBigInt(transaction.mint)
+            : undefined
+          formatted.sourceHash = transaction.sourceHash
+          formatted.type = 'deposit'
+        }
+        return formatted
+      }) as Hash[] | OptimismTransaction[]
+      return {
+        transactions,
+        stateRoot: args.stateRoot,
+      }
+    },
+  }),
+  transaction: /*#__PURE__*/ defineTransaction({
+    format(args: OptimismRpcTransaction): OptimismTransaction {
+      const transaction = {} as OptimismTransaction
+      if (args.type === '0x7e') {
+        transaction.isSystemTx = args.isSystemTx
+        transaction.mint = args.mint ? hexToBigInt(args.mint) : undefined
+        transaction.sourceHash = args.sourceHash
+        transaction.type = 'deposit'
+      }
+      return transaction
+    },
+  }),
+  transactionReceipt: /*#__PURE__*/ defineTransactionReceipt({
+    format(
+      args: OptimismRpcTransactionReceiptOverrides,
+    ): OptimismTransactionReceiptOverrides {
+      return {
+        l1GasPrice: args.l1GasPrice ? hexToBigInt(args.l1GasPrice) : null,
+        l1GasUsed: args.l1GasUsed ? hexToBigInt(args.l1GasUsed) : null,
+        l1Fee: args.l1Fee ? hexToBigInt(args.l1Fee) : null,
+        l1FeeScalar: args.l1FeeScalar ? Number(args.l1FeeScalar) : null,
+      }
+    },
+  }),
+} as const satisfies ChainFormatters

package/src/chains/optimism/types.ts

@@ -0,0 +1,102 @@
+import type { Block, BlockTag } from '../../types/block.js'
+import type { FeeValuesEIP1559 } from '../../types/fee.js'
+import type { Hash, Hex } from '../../types/misc.js'
+import type {
+  Index,
+  Quantity,
+  RpcBlock,
+  RpcTransaction as RpcTransaction_,
+  RpcTransactionReceipt,
+} from '../../types/rpc.js'
+import type {
+  Transaction as Transaction_,
+  TransactionBase,
+  TransactionReceipt,
+} from '../../types/transaction.js'
+
+export type OptimismBlockOverrides = {
+  stateRoot: Hash
+}
+export type OptimismBlock<
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+> = Block<
+  bigint,
+  TIncludeTransactions,
+  TBlockTag,
+  OptimismTransaction<TBlockTag extends 'pending' ? true : false>
+> &
+  OptimismBlockOverrides
+
+export type OptimismRpcBlockOverrides = {
+  stateRoot: Hash
+}
+export type OptimismRpcBlock<
+  TBlockTag extends BlockTag = BlockTag,
+  TIncludeTransactions extends boolean = boolean,
+> = RpcBlock<
+  TBlockTag,
+  TIncludeTransactions,
+  OptimismRpcTransaction<TBlockTag extends 'pending' ? true : false>
+> &
+  OptimismRpcBlockOverrides
+
+type RpcTransaction<TPending extends boolean = boolean> =
+  RpcTransaction_<TPending> & {
+    isSystemTx?: undefined
+    mint?: undefined
+    sourceHash?: undefined
+  }
+
+export type OptimismRpcDepositTransaction<TPending extends boolean = boolean> =
+  Omit<TransactionBase<Quantity, Index, TPending>, 'typeHex'> &
+    FeeValuesEIP1559<Quantity> & {
+      isSystemTx?: boolean
+      mint?: Hex
+      sourceHash: Hex
+      type: '0x7e'
+    }
+export type OptimismRpcTransaction<TPending extends boolean = boolean> =
+  | RpcTransaction<TPending>
+  | OptimismRpcDepositTransaction<TPending>
+
+export type OptimismRpcTransactionReceiptOverrides = {
+  l1GasPrice: Hex | null
+  l1GasUsed: Hex | null
+  l1Fee: Hex | null
+  l1FeeScalar: `${number}` | null
+}
+export type OptimismRpcTransactionReceipt = RpcTransactionReceipt &
+  OptimismRpcTransactionReceiptOverrides
+
+type Transaction<TPending extends boolean = boolean> = Transaction_<
+  bigint,
+  number,
+  TPending
+> & {
+  isSystemTx?: undefined
+  mint?: undefined
+  sourceHash?: undefined
+}
+
+export type OptimismDepositTransaction<TPending extends boolean = boolean> =
+  TransactionBase<bigint, number, TPending> &
+    FeeValuesEIP1559 & {
+      isSystemTx?: boolean
+      mint?: bigint
+      sourceHash: Hex
+      type: 'deposit'
+    }
+
+export type OptimismTransaction<TPending extends boolean = boolean> =
+  | Transaction<TPending>
+  | OptimismDepositTransaction<TPending>
+
+export type OptimismTransactionReceiptOverrides = {
+  l1GasPrice: bigint | null
+  l1GasUsed: bigint | null
+  l1Fee: bigint | null
+  l1FeeScalar: number | null
+}
+export type OptimismTransactionReceipt = TransactionReceipt &
+  OptimismTransactionReceiptOverrides

package/src/chains/utils.ts

@@ -0,0 +1,41 @@
+export { formattersCelo } from './celo/formatters.js'
+export {
+  type CeloTransactionSerializable,
+  type TransactionSerializableCIP42,
+  serializeTransactionCelo,
+  serializersCelo,
+} from './celo/serializers.js'
+export type {
+  CeloBlock,
+  CeloBlockOverrides,
+  CeloRpcBlock,
+  CeloRpcBlockOverrides,
+  CeloRpcTransaction,
+  CeloRpcTransactionOverrides,
+  CeloRpcTransactionReceipt,
+  CeloRpcTransactionReceiptOverrides,
+  CeloRpcTransactionRequest,
+  CeloRpcTransactionRequestOverrides,
+  CeloTransaction,
+  CeloTransactionOverrides,
+  CeloTransactionReceipt,
+  CeloTransactionReceiptOverrides,
+  CeloTransactionRequest,
+  CeloTransactionRequestOverrides,
+} from './celo/types.js'
+
+export { formattersOptimism } from './optimism/formatters.js'
+export type {
+  OptimismBlock,
+  OptimismBlockOverrides,
+  OptimismDepositTransaction,
+  OptimismRpcBlock,
+  OptimismRpcBlockOverrides,
+  OptimismRpcDepositTransaction,
+  OptimismRpcTransaction,
+  OptimismRpcTransactionReceipt,
+  OptimismRpcTransactionReceiptOverrides,
+  OptimismTransaction,
+  OptimismTransactionReceipt,
+  OptimismTransactionReceiptOverrides,
+} from './optimism/types.js'

package/src/clients/createClient.ts

@@ -29,6 +29,11 @@ export type ClientConfig<
         multicall?: boolean | Prettify<MulticallBatchOptions> | undefined
       }
     | undefined
+  /**
+   * Time (in ms) that cached data will remain in memory.
+   * @default 4_000
+   */
+  cacheTime?: number | undefined
   /** Chain for the client. */
   chain?: Chain | undefined | chain
   /** A key for the client. */
@@ -79,6 +84,8 @@ type Client_Base<
   account: account
   /** Flags for batch settings. */
   batch?: ClientConfig['batch']
+  /** Time (in ms) that cached data will remain in memory. */
+  cacheTime: number
   /** Chain for the client. */
   chain: chain
   /** A key for the client. */
@@ -135,6 +142,7 @@ export function createClient<
 export function createClient(parameters: ClientConfig): Client {
   const {
     batch,
+    cacheTime = parameters.pollingInterval ?? 4_000,
     key = 'base',
     name = 'Base Client',
     pollingInterval = 4_000,
@@ -154,6 +162,7 @@ export function createClient(parameters: ClientConfig): Client {
   const client = {
     account,
     batch,
+    cacheTime,
     chain,
     key,
     name,

package/src/clients/createPublicClient.ts

@@ -11,7 +11,13 @@ export type PublicClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain>,
-    'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'batch'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   >
 >
 

package/src/clients/createTestClient.ts

@@ -21,7 +21,13 @@ export type TestClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain, accountOrAddress>,
-    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'account'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   > & {
     /** Mode of the test client. */
     mode: mode | ('anvil' | 'hardhat' | 'ganache') // TODO: Type utility that expands `TestClientMode`

package/src/clients/createWalletClient.ts

@@ -19,7 +19,13 @@ export type WalletClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain, accountOrAddress>,
-    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'account'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   >
 >