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

package/src/chains/index.ts

@@ -0,0 +1,133 @@
+export type { Chain } from '../types/chain.js'
+
+export { arbitrum } from './definitions/arbitrum.js'
+export { arbitrumGoerli } from './definitions/arbitrumGoerli.js'
+export { arbitrumNova } from './definitions/arbitrumNova.js'
+export { aurora } from './definitions/aurora.js'
+export { auroraTestnet } from './definitions/auroraTestnet.js'
+export { avalanche } from './definitions/avalanche.js'
+export { avalancheFuji } from './definitions/avalancheFuji.js'
+export { base } from './definitions/base.js'
+export { baseGoerli } from './definitions/baseGoerli.js'
+export { bearNetworkChainMainnet } from './definitions/bearNetworkChainMainnet.js'
+export { bearNetworkChainTestnet } from './definitions/bearNetworkChainTestnet.js'
+export { boba } from './definitions/boba.js'
+export { bronos } from './definitions/bronos.js'
+export { bronosTestnet } from './definitions/bronosTestnet.js'
+export { bsc } from './definitions/bsc.js'
+export { bscTestnet } from './definitions/bscTestnet.js'
+export { bxn } from './definitions/bxn.js'
+export { bxnTestnet } from './definitions/bxnTestnet.js'
+export { canto } from './definitions/canto.js'
+export { celo } from './definitions/celo.js'
+export { celoAlfajores } from './definitions/celoAlfajores.js'
+export { celoCannoli } from './definitions/celoCannoli.js'
+export { classic } from './definitions/classic.js'
+export { confluxESpace } from './definitions/confluxESpace.js'
+export { cronos } from './definitions/cronos.js'
+export { cronosTestnet } from './definitions/cronosTestnet.js'
+export { crossbell } from './definitions/crossbell.js'
+export { dfk } from './definitions/dfk.js'
+export { dogechain } from './definitions/dogechain.js'
+export { edgeware } from './definitions/edgeware.js'
+export { edgewareTestnet } from './definitions/edgewareTestnet.js'
+export { eos } from './definitions/eos.js'
+export { eosTestnet } from './definitions/eosTestnet.js'
+export { evmos } from './definitions/evmos.js'
+export { evmosTestnet } from './definitions/evmosTestnet.js'
+export { ekta } from './definitions/ekta.js'
+export { ektaTestnet } from './definitions/ektaTestnet.js'
+export { fantom } from './definitions/fantom.js'
+export { fantomTestnet } from './definitions/fantomTestnet.js'
+export { fibo } from './definitions/fibo.js'
+export { filecoin } from './definitions/filecoin.js'
+export { filecoinCalibration } from './definitions/filecoinCalibration.js'
+export { filecoinHyperspace } from './definitions/filecoinHyperspace.js'
+export { flare } from './definitions/flare.js'
+export { flareTestnet } from './definitions/flareTestnet.js'
+export { foundry } from './definitions/foundry.js'
+export { fuse } from './definitions/fuse.js'
+export { fuseSparknet } from './definitions/fuseSparknet.js'
+export { iotex } from './definitions/iotex.js'
+export { iotexTestnet } from './definitions/iotexTestnet.js'
+export { gobi } from './definitions/gobi.js'
+export { goerli } from './definitions/goerli.js'
+export { gnosis } from './definitions/gnosis.js'
+export { gnosisChiado } from './definitions/gnosisChiado.js'
+export { hardhat } from './definitions/hardhat.js'
+export { harmonyOne } from './definitions/harmonyOne.js'
+export { haqqMainnet } from './definitions/haqqMainnet.js'
+export { haqqTestedge2 } from './definitions/haqqTestedge2.js'
+export { klaytn } from './definitions/klaytn.js'
+export { linea } from './definitions/linea.js'
+export { lineaTestnet } from './definitions/lineaTestnet.js'
+export { localhost } from './definitions/localhost.js'
+export { mainnet } from './definitions/mainnet.js'
+export { mantle } from './definitions/mantle.js'
+export { mantleTestnet } from './definitions/mantleTestnet.js'
+export { metis } from './definitions/metis.js'
+export { metisGoerli } from './definitions/metisGoerli.js'
+export { mev } from './definitions/mev.js'
+export { mevTestnet } from './definitions/mevTestnet.js'
+export { modeTestnet } from './definitions/modeTestnet.js'
+export { moonbaseAlpha } from './definitions/moonbaseAlpha.js'
+export { moonbeam } from './definitions/moonbeam.js'
+export { moonriver } from './definitions/moonriver.js'
+export { neonDevnet } from './definitions/neonDevnet.js'
+export { nexi } from './definitions/nexi.js'
+export { nexilix } from './definitions/nexilix.js'
+export { oasys } from './definitions/oasys.js'
+export { okc } from './definitions/okc.js'
+export { optimism } from './definitions/optimism.js'
+export { optimismGoerli } from './definitions/optimismGoerli.js'
+export { polygon } from './definitions/polygon.js'
+export { polygonMumbai } from './definitions/polygonMumbai.js'
+export { polygonZkEvmTestnet } from './definitions/polygonZkEvmTestnet.js'
+export { polygonZkEvm } from './definitions/polygonZkEvm.js'
+export { pulsechain } from './definitions/pulsechain.js'
+export { pulsechainV4 } from './definitions/pulsechainV4.js'
+export { qMainnet } from './definitions/qMainnet.js'
+export { qTestnet } from './definitions/qTestnet.js'
+export { rollux } from './definitions/rollux.js'
+export { rolluxTestnet } from './definitions/rolluxTestnet.js'
+export { ronin } from './definitions/ronin.js'
+export { saigon } from './definitions/saigon.js'
+export { scrollSepolia } from './definitions/scrollSepolia.js'
+export { scrollTestnet } from './definitions/scrollTestnet.js'
+export { sepolia } from './definitions/sepolia.js'
+export { skaleBlockBrawlers } from './definitions/skale/brawl.js'
+export { skaleCalypso } from './definitions/skale/calypso.js'
+export { skaleCalypsoTestnet } from './definitions/skale/calypsoTestnet.js'
+export { skaleChaosTestnet } from './definitions/skale/chaosTestnet.js'
+export { skaleCryptoBlades } from './definitions/skale/cryptoBlades.js'
+export { skaleCryptoColosseum } from './definitions/skale/cryptoColosseum.js'
+export { skaleEuropa } from './definitions/skale/europa.js'
+export { skaleEuropaTestnet } from './definitions/skale/europaTestnet.js'
+export { skaleExorde } from './definitions/skale/exorde.js'
+export { skaleHumanProtocol } from './definitions/skale/humanProtocol.js'
+export { skaleNebula } from './definitions/skale/nebula.js'
+export { skaleNebulaTestnet } from './definitions/skale/nebulaTestnet.js'
+export { skaleRazor } from './definitions/skale/razor.js'
+export { skaleTitan } from './definitions/skale/titan.js'
+export { skaleTitanTestnet } from './definitions/skale/titanTestnet.js'
+export { songbird } from './definitions/songbird.js'
+export { songbirdTestnet } from './definitions/songbirdTestnet.js'
+export { shardeumSphinx } from './definitions/shardeumSphinx.js'
+export { syscoin } from './definitions/syscoin.js'
+export { syscoinTestnet } from './definitions/syscoinTestnet.js'
+export { taraxa } from './definitions/taraxa.js'
+export { taikoTestnetSepolia } from './definitions/taikoTestnetSepolia.js'
+export { taraxaTestnet } from './definitions/taraxaTestnet.js'
+export { telos } from './definitions/telos.js'
+export { telosTestnet } from './definitions/telosTestnet.js'
+export { thunderTestnet } from './definitions/thunderTestnet.js'
+export { wanchain } from './definitions/wanchain.js'
+export { wanchainTestnet } from './definitions/wanchainTestnet.js'
+export { xdc } from './definitions/xdc.js'
+export { xdcTestnet } from './definitions/xdcTestnet.js'
+export { zhejiang } from './definitions/zhejiang.js'
+export { zkSync } from './definitions/zkSync.js'
+export { zkSyncTestnet } from './definitions/zkSyncTestnet.js'
+export { zetachainAthensTestnet } from './definitions/zetachainAthensTestnet.js'
+export { zora } from './definitions/zora.js'
+export { zoraTestnet } from './definitions/zoraTestnet.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,45 @@
+export { formattersCelo } from './celo/formatters.js'
+export {
+  serializeTransactionCelo,
+  serializersCelo,
+} from './celo/serializers.js'
+export { parseTransactionCelo } from './celo/parsers.js'
+export type {
+  CeloBlock,
+  CeloBlockOverrides,
+  CeloRpcBlock,
+  CeloRpcBlockOverrides,
+  CeloRpcTransaction,
+  CeloRpcTransactionReceipt,
+  CeloRpcTransactionReceiptOverrides,
+  CeloRpcTransactionRequest,
+  CeloTransaction,
+  CeloTransactionReceipt,
+  CeloTransactionReceiptOverrides,
+  CeloTransactionRequest,
+  CeloTransactionSerializable,
+  CeloTransactionSerialized,
+  CeloTransactionType,
+  RpcTransactionCIP42,
+  RpcTransactionRequestCIP42,
+  TransactionCIP42,
+  TransactionRequestCIP42,
+  TransactionSerializableCIP42,
+  TransactionSerializedCIP42,
+} 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

@@ -1,40 +1,93 @@
-import type { Chain } from '../types/chain.js'
-import type { Requests } from '../types/eip1193.js'
-import { uid } from '../utils/uid.js'
+import type { Address } from 'abitype'
 
+import type { Account, JsonRpcAccount } from '../accounts/types.js'
+import type { Chain } from '../types/chain.js'
 import type {
-  BaseRpcRequests,
-  Transport,
-} from './transports/createTransport.js'
+  EIP1193RequestFn,
+  EIP1474Methods,
+  RpcSchema,
+} from '../types/eip1193.js'
+import type { Prettify } from '../types/utils.js'
+import { parseAccount } from '../utils/accounts.js'
+import { uid } from '../utils/uid.js'
+import type { Transport } from './transports/createTransport.js'
 
 export type ClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
 > = {
+  /** The Account to use for the Client. This will be used for Actions that require an account as an argument. */
+  account?: accountOrAddress | Account | Address | undefined
+  /** Flags for batch settings. */
+  batch?:
+    | {
+        /** Toggle to enable `eth_call` multicall aggregation. */
+        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?: TChain
+  chain?: Chain | undefined | chain
   /** A key for the client. */
-  key?: string
+  key?: string | undefined
   /** A name for the client. */
-  name?: string
+  name?: string | undefined
   /**
    * Frequency (in ms) for polling enabled actions & events.
    * @default 4_000
    */
-  pollingInterval?: number
+  pollingInterval?: number | undefined
   /** The RPC transport */
-  transport: TTransport
+  transport: transport
   /** The type of client. */
-  type?: string
+  type?: string | undefined
 }
 
+// TODO: Move `transport` to slot index 2 since `chain` and `account` used more frequently.
+// Otherwise, we end up with a lot of `Client<Transport, chain, account>` in actions.
 export type Client<
-  TTransport extends Transport = Transport,
-  TRequests extends BaseRpcRequests = Requests,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+  extended extends Extended | undefined = Extended | undefined,
+> = Client_Base<transport, chain, account, rpcSchema> &
+  (extended extends Extended ? extended : unknown) & {
+    extend: <const client extends Extended>(
+      fn: (
+        client: Client<transport, chain, account, rpcSchema, extended>,
+      ) => client,
+    ) => Client<
+      transport,
+      chain,
+      account,
+      rpcSchema,
+      Prettify<client> & (extended extends Extended ? extended : unknown)
+    >
+  }
+
+type Client_Base<
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
 > = {
+  /** The Account of the Client. */
+  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: TChain
+  chain: chain
   /** A key for the client. */
   key: string
   /** A name for the client. */
@@ -42,39 +95,93 @@ export type Client<
   /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
   pollingInterval: number
   /** Request function wrapped with friendly error handling */
-  request: TRequests['request']
+  request: EIP1193RequestFn<
+    rpcSchema extends undefined ? EIP1474Methods : rpcSchema
+  >
   /** The RPC transport */
-  transport: ReturnType<TTransport>['config'] & ReturnType<TTransport>['value']
+  transport: ReturnType<transport>['config'] & ReturnType<transport>['value']
   /** The type of client. */
   type: string
   /** A unique ID for the client. */
   uid: string
 }
 
+type Extended = Prettify<
+  // disallow redefining base properties
+  { [K in keyof Client_Base]?: undefined } & {
+    [key: string]: unknown
+  }
+>
+
+export type MulticallBatchOptions = {
+  /** The maximum size (in bytes) for each calldata chunk. @default 1_024 */
+  batchSize?: number | undefined
+  /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
+  wait?: number | undefined
+}
+
 /**
- * @description Creates a base client with the given transport.
+ * Creates a base client with the given transport.
  */
 export function createClient<
-  TTransport extends Transport,
-  TRequests extends BaseRpcRequests,
-  TChain extends Chain | undefined = undefined,
->({
-  chain,
-  key = 'base',
-  name = 'Base Client',
-  pollingInterval = 4_000,
-  transport,
-  type = 'base',
-}: ClientConfig<TTransport, TChain>): Client<TTransport, TRequests, TChain> {
-  const { config, request, value } = transport({ chain, pollingInterval })
-  return {
-    chain: chain as TChain,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: ClientConfig<transport, chain, accountOrAddress>,
+): Prettify<
+  Client<
+    transport,
+    chain,
+    accountOrAddress extends Address
+      ? Prettify<JsonRpcAccount<accountOrAddress>>
+      : accountOrAddress
+  >
+>
+
+export function createClient(parameters: ClientConfig): Client {
+  const {
+    batch,
+    cacheTime = parameters.pollingInterval ?? 4_000,
+    key = 'base',
+    name = 'Base Client',
+    pollingInterval = 4_000,
+    type = 'base',
+  } = parameters
+
+  const chain = parameters.chain
+  const account = parameters.account
+    ? parseAccount(parameters.account)
+    : undefined
+  const { config, request, value } = parameters.transport({
+    chain,
+    pollingInterval,
+  })
+  const transport = { ...config, ...value }
+
+  const client = {
+    account,
+    batch,
+    cacheTime,
+    chain,
     key,
     name,
     pollingInterval,
     request,
-    transport: { ...config, ...value },
+    transport,
     type,
     uid: uid(),
   }
+
+  function extend(base: typeof client) {
+    type ExtendFn = (base: typeof client) => unknown
+    return (extendFn: ExtendFn) => {
+      const extended = extendFn(base) as Extended
+      for (const key in client) delete extended[key]
+      const combined = { ...base, ...extended }
+      return Object.assign(combined, { extend: extend(combined) })
+    }
+  }
+
+  return Object.assign(client, { extend: extend(client) as any })
 }