viem 0.0.0-w-20230822145918 → 0.0.0-w-20230828183856

package/src/chains/celo/serializers.ts

@@ -1,17 +1,10 @@
-import type { Address } from 'abitype'
-
 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 {
-  AccessList,
-  TransactionSerializable,
-  TransactionSerializableBase,
-} from '../../types/transaction.js'
+import type { TransactionSerializable } from '../../types/transaction.js'
 import { isAddress } from '../../utils/address/isAddress.js'
 import { concatHex } from '../../utils/data/concat.js'
 import { trim } from '../../utils/data/trim.js'
@@ -22,6 +15,11 @@ import {
   type SerializeTransactionFn,
   serializeTransaction,
 } from '../../utils/transaction/serializeTransaction.js'
+import type {
+  CeloTransactionSerializable,
+  TransactionSerializableCIP42,
+  TransactionSerializedCIP42,
+} from './types.js'
 
 export const serializeTransactionCelo: SerializeTransactionFn<
   CeloTransactionSerializable
@@ -41,39 +39,18 @@ export const serializersCelo = {
   transaction: serializeTransactionCelo,
 } as const satisfies ChainSerializers
 
-//////////////////////////////////////////////////////////////////////////////
-// Types
-
-export type TransactionSerializableCIP42<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> &
-  FeeValuesEIP1559<TQuantity> & {
-    accessList?: AccessList
-    gasPrice?: never
-    feeCurrency?: Address
-    gatewayFeeRecipient?: Address
-    gatewayFee?: TQuantity
-    chainId: number
-    type?: 'cip42'
-  }
-
-export type CeloTransactionSerializable =
-  | TransactionSerializableCIP42
-  | TransactionSerializable
-
-export type SerializedCIP42TransactionReturnType = `0x7c${string}`
-
 //////////////////////////////////////////////////////////////////////////////
 // Serializers
 
+export type SerializeTransactionCIP42ReturnType = TransactionSerializedCIP42
+
 // There shall be a typed transaction with the code 0x7c that has the following format:
 // 0x7c || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, feecurrency, gatewayFeeRecipient, gatewayfee, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s]).
 // This will be in addition to the type 0x02 transaction as specified in EIP-1559.
 function serializeTransactionCIP42(
   transaction: TransactionSerializableCIP42,
   signature?: Signature,
-): SerializedCIP42TransactionReturnType {
+): SerializeTransactionCIP42ReturnType {
   assertTransactionCIP42(transaction)
   const {
     chainId,
@@ -116,7 +93,7 @@ function serializeTransactionCIP42(
   return concatHex([
     '0x7c',
     toRlp(serializedTransaction),
-  ]) as SerializedCIP42TransactionReturnType
+  ]) as SerializeTransactionCIP42ReturnType
 }
 
 //////////////////////////////////////////////////////////////////////////////
@@ -139,7 +116,9 @@ function isCIP42(transaction: CeloTransactionSerializable) {
 const MAX_MAX_FEE_PER_GAS =
   115792089237316195423570985008687907853269984665640564039457584007913129639935n
 
-function assertTransactionCIP42(transaction: TransactionSerializableCIP42) {
+export function assertTransactionCIP42(
+  transaction: TransactionSerializableCIP42,
+) {
   const {
     chainId,
     maxPriorityFeePerGas,

package/src/chains/celo/types.ts

@@ -1,17 +1,27 @@
 import type { Address } from 'abitype'
 
 import type { Block, BlockTag } from '../../types/block.js'
+import type { FeeValuesEIP1559 } from '../../types/fee.js'
 import type { Hex } from '../../types/misc.js'
 import type {
+  Index,
+  Quantity,
   RpcBlock,
-  RpcTransaction,
+  RpcTransaction as RpcTransaction_,
   RpcTransactionReceipt,
-  RpcTransactionRequest,
+  RpcTransactionRequest as RpcTransactionRequest_,
+  TransactionType,
 } from '../../types/rpc.js'
 import type {
-  Transaction,
+  AccessList,
+  Transaction as Transaction_,
+  TransactionBase,
   TransactionReceipt,
-  TransactionRequest,
+  TransactionRequest as TransactionRequest_,
+  TransactionRequestBase,
+  TransactionSerializable,
+  TransactionSerializableBase,
+  TransactionSerialized,
 } from '../../types/transaction.js'
 import type { NeverBy } from '../../types/utils.js'
 import type { OptimismRpcTransaction } from '../optimism/types.js'
@@ -62,13 +72,9 @@ export type CeloRpcBlock<
 > &
   CeloRpcBlockOverrides
 
-export type CeloRpcTransactionOverrides = {
-  feeCurrency: Address | null
-  gatewayFee: Hex | null
-  gatewayFeeRecipient: Address | null
-}
 export type CeloRpcTransaction<TPending extends boolean = boolean> =
-  RpcTransaction<TPending> & CeloRpcTransactionOverrides
+  | RpcTransaction<TPending>
+  | RpcTransactionCIP42<TPending>
 
 export type CeloRpcTransactionReceiptOverrides = {
   feeCurrency: Address | null
@@ -78,21 +84,13 @@ export type CeloRpcTransactionReceiptOverrides = {
 export type CeloRpcTransactionReceipt = RpcTransactionReceipt &
   CeloRpcTransactionReceiptOverrides
 
-export type CeloRpcTransactionRequestOverrides = {
-  feeCurrency?: Address
-  gatewayFee?: Hex
-  gatewayFeeRecipient?: Address
-}
-export type CeloRpcTransactionRequest = RpcTransactionRequest &
-  CeloRpcTransactionRequestOverrides
+export type CeloRpcTransactionRequest =
+  | RpcTransactionRequest
+  | RpcTransactionRequestCIP42
 
-export type CeloTransactionOverrides = {
-  feeCurrency: Address | null
-  gatewayFee: bigint | null
-  gatewayFeeRecipient: Address | null
-}
 export type CeloTransaction<TPending extends boolean = boolean> =
-  Transaction<TPending> & CeloTransactionOverrides
+  | Transaction<TPending>
+  | TransactionCIP42<TPending>
 
 export type CeloTransactionReceiptOverrides = {
   feeCurrency: Address | null
@@ -102,10 +100,100 @@ export type CeloTransactionReceiptOverrides = {
 export type CeloTransactionReceipt = TransactionReceipt &
   CeloTransactionReceiptOverrides
 
-export type CeloTransactionRequestOverrides = {
+export type CeloTransactionRequest =
+  | TransactionRequest
+  | TransactionRequestCIP42
+
+export type CeloTransactionSerializable =
+  | TransactionSerializableCIP42
+  | TransactionSerializable
+
+export type CeloTransactionSerialized<
+  TType extends CeloTransactionType = 'legacy',
+> = TransactionSerialized<TType> | TransactionSerializedCIP42
+
+export type CeloTransactionType = TransactionType | 'cip42'
+
+type RpcTransaction<TPending extends boolean = boolean> =
+  RpcTransaction_<TPending> & {
+    feeCurrency: Address | null
+    gatewayFee: Hex | null
+    gatewayFeeRecipient: Address | null
+  }
+
+type RpcTransactionRequest = RpcTransactionRequest_ & {
+  feeCurrency?: Address
+  gatewayFee?: Hex
+  gatewayFeeRecipient?: Address
+}
+
+export type RpcTransactionCIP42<TPending extends boolean = boolean> =
+  TransactionBase<Quantity, Index, TPending> &
+    FeeValuesEIP1559<Quantity> & {
+      feeCurrency: Address | null
+      gatewayFee: Hex | null
+      gatewayFeeRecipient: Address | null
+      type: '0x7c'
+    }
+
+export type RpcTransactionRequestCIP42 = TransactionRequestBase<
+  Quantity,
+  Index
+> &
+  Partial<FeeValuesEIP1559<Quantity>> & {
+    accessList?: AccessList
+    feeCurrency?: Address
+    gatewayFee?: Hex
+    gatewayFeeRecipient?: Address
+    type?: '0x7c'
+  }
+
+type Transaction<TPending extends boolean = boolean> = Transaction_<
+  bigint,
+  number,
+  TPending
+> & {
+  feeCurrency: Address | null
+  gatewayFee: bigint | null
+  gatewayFeeRecipient: Address | null
+}
+
+export type TransactionCIP42<TPending extends boolean = boolean> =
+  TransactionBase<bigint, number, TPending> &
+    FeeValuesEIP1559 & {
+      feeCurrency: Address | null
+      gatewayFee: bigint | null
+      gatewayFeeRecipient: Address | null
+      type: 'cip42'
+    }
+
+type TransactionRequest = TransactionRequest_ & {
   feeCurrency?: Address
   gatewayFee?: bigint
   gatewayFeeRecipient?: Address
 }
-export type CeloTransactionRequest = TransactionRequest &
-  CeloTransactionRequestOverrides
+
+export type TransactionRequestCIP42 = TransactionRequestBase &
+  Partial<FeeValuesEIP1559> & {
+    accessList?: AccessList
+    feeCurrency?: Address
+    gatewayFee?: bigint
+    gatewayFeeRecipient?: Address
+    type?: 'cip42'
+  }
+
+export type TransactionSerializableCIP42<
+  TQuantity = bigint,
+  TIndex = number,
+> = TransactionSerializableBase<TQuantity, TIndex> &
+  FeeValuesEIP1559<TQuantity> & {
+    accessList?: AccessList
+    gasPrice?: never
+    feeCurrency?: Address
+    gatewayFeeRecipient?: Address
+    gatewayFee?: TQuantity
+    chainId: number
+    type?: 'cip42'
+  }
+
+export type TransactionSerializedCIP42 = `0x7c${string}`

package/src/chains/index.ts

@@ -66,6 +66,7 @@ export const haqqTestedge2 = /*#__PURE__*/ defineChain(chains.haqqTestedge2)
 export const hardhat = /*#__PURE__*/ defineChain(chains.hardhat)
 export const harmonyOne = /*#__PURE__*/ defineChain(chains.harmonyOne)
 export const klaytn = /*#__PURE__*/ defineChain(chains.klaytn)
+export const linea = /*#__PURE__*/ defineChain(chains.linea)
 export const lineaTestnet = /*#__PURE__*/ defineChain(chains.lineaTestnet)
 export const localhost = /*#__PURE__*/ defineChain(chains.localhost)
 export const mainnet = /*#__PURE__*/ defineChain(chains.mainnet)

package/src/chains/utils.ts

@@ -1,27 +1,31 @@
 export { formattersCelo } from './celo/formatters.js'
 export {
-  type CeloTransactionSerializable,
-  type TransactionSerializableCIP42,
   serializeTransactionCelo,
   serializersCelo,
 } from './celo/serializers.js'
+export { parseTransactionCelo } from './celo/parsers.js'
 export type {
   CeloBlock,
   CeloBlockOverrides,
   CeloRpcBlock,
   CeloRpcBlockOverrides,
   CeloRpcTransaction,
-  CeloRpcTransactionOverrides,
   CeloRpcTransactionReceipt,
   CeloRpcTransactionReceiptOverrides,
   CeloRpcTransactionRequest,
-  CeloRpcTransactionRequestOverrides,
   CeloTransaction,
-  CeloTransactionOverrides,
   CeloTransactionReceipt,
   CeloTransactionReceiptOverrides,
   CeloTransactionRequest,
-  CeloTransactionRequestOverrides,
+  CeloTransactionSerializable,
+  CeloTransactionSerialized,
+  CeloTransactionType,
+  RpcTransactionCIP42,
+  RpcTransactionRequestCIP42,
+  TransactionCIP42,
+  TransactionRequestCIP42,
+  TransactionSerializableCIP42,
+  TransactionSerializedCIP42,
 } from './celo/types.js'
 
 export { formattersOptimism } from './optimism/formatters.js'

package/src/clients/createTestClient.ts

@@ -1,3 +1,5 @@
+import type { Address } from 'abitype'
+
 import type { Account } from '../accounts/types.js'
 import type { ParseAccount } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
@@ -6,7 +8,6 @@ import type { Prettify } from '../types/utils.js'
 import { type Client, type ClientConfig, createClient } from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
-import type { Address } from 'abitype'
 
 export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 

package/src/clients/decorators/public.ts

@@ -53,11 +53,21 @@ import {
   type EstimateContractGasReturnType,
   estimateContractGas,
 } from '../../actions/public/estimateContractGas.js'
+import {
+  type EstimateFeesPerGasParameters,
+  type EstimateFeesPerGasReturnType,
+  estimateFeesPerGas,
+} from '../../actions/public/estimateFeesPerGas.js'
 import {
   type EstimateGasParameters,
   type EstimateGasReturnType,
   estimateGas,
 } from '../../actions/public/estimateGas.js'
+import {
+  type EstimateMaxPriorityFeePerGasParameters,
+  type EstimateMaxPriorityFeePerGasReturnType,
+  estimateMaxPriorityFeePerGas,
+} from '../../actions/public/estimateMaxPriorityFeePerGas.js'
 import {
   type GetBalanceParameters,
   type GetBalanceReturnType,
@@ -196,6 +206,16 @@ import {
   type WatchPendingTransactionsReturnType,
   watchPendingTransactions,
 } from '../../actions/public/watchPendingTransactions.js'
+import {
+  type PrepareTransactionRequestParameters,
+  type PrepareTransactionRequestReturnType,
+  prepareTransactionRequest,
+} from '../../actions/wallet/prepareTransactionRequest.js'
+import {
+  type SendRawTransactionParameters,
+  type SendRawTransactionReturnType,
+  sendRawTransaction,
+} from '../../actions/wallet/sendRawTransaction.js'
 import type { Account } from '../../types/account.js'
 import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
@@ -205,6 +225,7 @@ import type {
   MaybeAbiEventName,
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
+import type { FeeValuesType } from '../../types/fee.js'
 import type { FilterType } from '../../types/filter.js'
 import type { Client } from '../createClient.js'
 import type { Transport } from '../transports/createTransport.js'
@@ -776,6 +797,33 @@ export type PublicActions<
   getFeeHistory: (
     args: GetFeeHistoryParameters,
   ) => Promise<GetFeeHistoryReturnType>
+  /**
+   * Returns an estimate for the fees per gas for a transaction to be included
+   * in the next block.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas.html
+   *
+   * @param client - Client to use
+   * @param parameters - {@link EstimateFeesPerGasParameters}
+   * @returns An estimate (in wei) for the fees per gas. {@link EstimateFeesPerGasReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const maxPriorityFeePerGas = await client.estimateFeesPerGas()
+   * // { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
+   */
+  estimateFeesPerGas: <
+    TChainOverride extends Chain | undefined,
+    TType extends FeeValuesType = 'eip1559',
+  >(
+    args?: EstimateFeesPerGasParameters<TChain, TChainOverride, TType>,
+  ) => Promise<EstimateFeesPerGasReturnType>
   /**
    * Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called.
    *
@@ -982,6 +1030,29 @@ export type PublicActions<
   ) => Promise<
     GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
   >
+  /**
+   * Returns an estimate for the max priority fee per gas (in wei) for a transaction
+   * to be included in the next block.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas.html
+   *
+   * @param client - Client to use
+   * @returns An estimate (in wei) for the max priority fee per gas. {@link EstimateMaxPriorityFeePerGasReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
+   * // 10000000n
+   */
+  estimateMaxPriorityFeePerGas: <TChainOverride extends Chain | undefined,>(
+    args?: EstimateMaxPriorityFeePerGasParameters<TChain, TChainOverride>,
+  ) => Promise<EstimateMaxPriorityFeePerGasReturnType>
   /**
    * Returns the value from a storage slot at a given address.
    *
@@ -1150,6 +1221,47 @@ export type PublicActions<
   >(
     args: MulticallParameters<contracts, allowFailure>,
   ) => Promise<MulticallReturnType<contracts, allowFailure>>
+  /**
+   * Prepares a transaction request for signing.
+   *
+   * - Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest.html
+   *
+   * @param args - {@link PrepareTransactionRequestParameters}
+   * @returns The transaction request. {@link PrepareTransactionRequestReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * })
+   * const request = await client.prepareTransactionRequest({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   to: '0x0000000000000000000000000000000000000000',
+   *   value: 1n,
+   * })
+   *
+   * @example
+   * // Account Hoisting
+   * import { createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * })
+   * const request = await client.prepareTransactionRequest({
+   *   to: '0x0000000000000000000000000000000000000000',
+   *   value: 1n,
+   * })
+   */
+  prepareTransactionRequest: <TChainOverride extends Chain | undefined,>(
+    args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,
+  ) => Promise<PrepareTransactionRequestReturnType>
   /**
    * Calls a read-only function on a contract, and returns the response.
    *
@@ -1188,6 +1300,33 @@ export type PublicActions<
   >(
     args: ReadContractParameters<abi, functionName, args>,
   ) => Promise<ReadContractReturnType<abi, functionName, args>>
+  /**
+   * Sends a **signed** transaction to the network
+   *
+   * - Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction.html
+   * - JSON-RPC Method: [`eth_sendRawTransaction`](https://ethereum.github.io/execution-apis/api-documentation/)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link SendRawTransactionParameters}
+   * @returns The transaction hash. {@link SendRawTransactionReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { sendRawTransaction } from 'viem/wallet'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * })
+   *
+   * const hash = await client.sendRawTransaction({
+   *   serializedTransaction: '0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33'
+   * })
+   */
+  sendRawTransaction: (
+    args: SendRawTransactionParameters,
+  ) => Promise<SendRawTransactionReturnType>
   /**
    * Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions.
    *
@@ -1511,10 +1650,13 @@ export function publicActions<
     getEnsResolver: (args) => getEnsResolver(client, args),
     getEnsText: (args) => getEnsText(client, args),
     getFeeHistory: (args) => getFeeHistory(client, args),
+    estimateFeesPerGas: (args) => estimateFeesPerGas(client, args),
     getFilterChanges: (args) => getFilterChanges(client, args),
     getFilterLogs: (args) => getFilterLogs(client, args),
     getGasPrice: () => getGasPrice(client),
     getLogs: (args) => getLogs(client, args as any),
+    estimateMaxPriorityFeePerGas: (args) =>
+      estimateMaxPriorityFeePerGas(client, args),
     getStorageAt: (args) => getStorageAt(client, args),
     getTransaction: (args) => getTransaction(client, args),
     getTransactionConfirmations: (args) =>
@@ -1522,7 +1664,10 @@ export function publicActions<
     getTransactionCount: (args) => getTransactionCount(client, args),
     getTransactionReceipt: (args) => getTransactionReceipt(client, args),
     multicall: (args) => multicall(client, args),
+    prepareTransactionRequest: (args) =>
+      prepareTransactionRequest(client as any, args as any),
     readContract: (args) => readContract(client, args),
+    sendRawTransaction: (args) => sendRawTransaction(client, args),
     simulateContract: (args) => simulateContract(client, args),
     verifyMessage: (args) => verifyMessage(client, args),
     verifyTypedData: (args) => verifyTypedData(client, args),