viem 0.0.0-main.20230809T145104 → 0.0.0-main.20230810T034510

package/src/utils/transaction/prepareRequest.ts

@@ -15,24 +15,34 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import { AccountNotFoundError } from '../../errors/account.js'
 import { BaseError } from '../../errors/base.js'
 import type { GetAccountParameter } from '../../types/account.js'
-import type { Chain } from '../../types/chain.js'
-
+import type { Chain, GetChain } from '../../types/chain.js'
+import type { UnionOmit } from '../../types/utils.js'
+import type { FormattedTransactionRequest } from '../index.js'
 import { type AssertRequestParameters, assertRequest } from './assertRequest.js'
 
 export type PrepareRequestParameters<
-  TAccount extends Account | undefined = undefined,
-> = GetAccountParameter<TAccount> & {
-  gas?: SendTransactionParameters['gas']
-  gasPrice?: SendTransactionParameters['gasPrice']
-  maxFeePerGas?: SendTransactionParameters['maxFeePerGas']
-  maxPriorityFeePerGas?: SendTransactionParameters['maxPriorityFeePerGas']
-  nonce?: SendTransactionParameters['nonce']
-}
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends Chain | undefined = Chain | undefined,
+> = UnionOmit<
+  FormattedTransactionRequest<
+    TChainOverride extends Chain ? TChainOverride : TChain
+  >,
+  'from'
+> &
+  GetAccountParameter<TAccount> &
+  GetChain<TChain, TChainOverride>
 
 export type PrepareRequestReturnType<
-  TAccount extends Account | undefined = undefined,
-  TParameters extends PrepareRequestParameters<TAccount> = PrepareRequestParameters<TAccount>,
-> = TParameters & {
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends Chain | undefined = Chain | undefined,
+  TArgs extends PrepareRequestParameters<
+    TChain,
+    TAccount,
+    TChainOverride
+  > = PrepareRequestParameters<TChain, TAccount, TChainOverride>,
+> = TArgs & {
   from: Address
   gas: SendTransactionParameters['gas']
   gasPrice?: SendTransactionParameters['gasPrice']
@@ -41,18 +51,18 @@ export type PrepareRequestReturnType<
   nonce: SendTransactionParameters['nonce']
 }
 
-export const defaultTip = 1_500_000_000n // 1.5 gwei
-
 export async function prepareRequest<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
-  TParameters extends PrepareRequestParameters<TAccount>,
+  TChainOverride extends Chain | undefined,
+  TArgs extends PrepareRequestParameters<TChain, TAccount, TChainOverride>,
 >(
   client: Client<Transport, TChain, TAccount>,
-  args: TParameters,
-): Promise<PrepareRequestReturnType<TAccount, TParameters>> {
+  args: TArgs,
+): Promise<PrepareRequestReturnType<TChain, TAccount, TChainOverride, TArgs>> {
   const {
     account: account_,
+    chain = client.chain,
     gas,
     gasPrice,
     maxFeePerGas,
@@ -76,22 +86,33 @@ export async function prepareRequest<
     typeof block.baseFeePerGas === 'bigint' &&
     typeof gasPrice === 'undefined'
   ) {
+    let defaultPriorityFee = 1_500_000_000n // 1.5 gwei
+    if (typeof chain?.fees?.defaultPriorityFee !== 'undefined') {
+      defaultPriorityFee =
+        typeof chain.fees.defaultPriorityFee === 'bigint'
+          ? chain.fees.defaultPriorityFee
+          : await chain.fees.defaultPriorityFee({
+              block,
+              request: request as PrepareRequestParameters,
+            })
+    }
+
     // EIP-1559 fees
     if (typeof maxFeePerGas === 'undefined') {
       // Set a buffer of 1.2x on top of the base fee to account for fluctuations.
-      request.maxPriorityFeePerGas = maxPriorityFeePerGas ?? defaultTip
+      request.maxPriorityFeePerGas = maxPriorityFeePerGas ?? defaultPriorityFee
       request.maxFeePerGas =
         (block.baseFeePerGas * 120n) / 100n + request.maxPriorityFeePerGas
     } else {
       if (
         typeof maxPriorityFeePerGas === 'undefined' &&
-        maxFeePerGas < defaultTip
+        maxFeePerGas < defaultPriorityFee
       )
         throw new BaseError(
           '`maxFeePerGas` cannot be less than the default `maxPriorityFeePerGas` (1.5 gwei).',
         )
       request.maxFeePerGas = maxFeePerGas
-      request.maxPriorityFeePerGas = maxPriorityFeePerGas ?? defaultTip
+      request.maxPriorityFeePerGas = maxPriorityFeePerGas ?? defaultPriorityFee
     }
   } else if (typeof gasPrice === 'undefined') {
     // Legacy fees
@@ -113,5 +134,10 @@ export async function prepareRequest<
 
   assertRequest(request as AssertRequestParameters)
 
-  return request as PrepareRequestReturnType<TAccount, TParameters>
+  return request as PrepareRequestReturnType<
+    TChain,
+    TAccount,
+    TChainOverride,
+    TArgs
+  >
 }

package/dist/cjs/types/formatter.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=formatter.js.map

package/dist/cjs/types/formatter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/types/formatter.ts"],"names":[],"mappings":""}

package/dist/cjs/types/serializer.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=serializer.js.map

package/dist/cjs/types/serializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../../../src/types/serializer.ts"],"names":[],"mappings":""}

package/dist/esm/types/formatter.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=formatter.js.map

package/dist/esm/types/formatter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/types/formatter.ts"],"names":[],"mappings":""}

package/dist/esm/types/serializer.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=serializer.js.map

package/dist/esm/types/serializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../../../src/types/serializer.ts"],"names":[],"mappings":""}

package/dist/types/types/formatter.d.ts

@@ -1,17 +0,0 @@
-import type { Chain } from './chain.js';
-export type Formatter<TType extends string = string> = {
-    format: (args: any) => any;
-    type: TType;
-};
-export type Formatters = {
-    block?: Formatter<'block'>;
-    transaction?: Formatter<'transaction'>;
-    transactionReceipt?: Formatter<'transactionReceipt'>;
-    transactionRequest?: Formatter<'transactionRequest'>;
-};
-export type ExtractFormatterExclude<TChain extends Chain | undefined, TType extends keyof Formatters> = TChain extends Chain<infer _Formatters extends Formatters> ? _Formatters[TType] extends {
-    exclude: infer Exclude;
-} ? Extract<Exclude, string[]>[number] : '' : '';
-export type ExtractFormatterParameters<TChain extends Chain | undefined, TType extends keyof Formatters, TFallback> = TChain extends Chain<infer _Formatters extends Formatters> ? _Formatters[TType] extends Formatter ? Parameters<_Formatters[TType]['format']>[0] : TFallback : TFallback;
-export type ExtractFormatterReturnType<TChain extends Chain | undefined, TType extends keyof Formatters, TFallback> = TChain extends Chain<infer _Formatters extends Formatters> ? _Formatters[TType] extends Formatter ? ReturnType<_Formatters[TType]['format']> : TFallback : TFallback;
-//# sourceMappingURL=formatter.d.ts.map

package/dist/types/types/formatter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../../src/types/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;IACrD,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAA;IAC1B,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC1B,WAAW,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC,CAAA;IACtC,kBAAkB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAA;IACpD,kBAAkB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAA;CACrD,CAAA;AAED,MAAM,MAAM,uBAAuB,CACjC,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,KAAK,SAAS,MAAM,UAAU,IAC5B,MAAM,SAAS,KAAK,CAAC,MAAM,WAAW,SAAS,UAAU,CAAC,GAC1D,WAAW,CAAC,KAAK,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,OAAO,CAAA;CAAE,GACnD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAClC,EAAE,GACJ,EAAE,CAAA;AAEN,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,KAAK,SAAS,MAAM,UAAU,EAC9B,SAAS,IACP,MAAM,SAAS,KAAK,CAAC,MAAM,WAAW,SAAS,UAAU,CAAC,GAC1D,WAAW,CAAC,KAAK,CAAC,SAAS,SAAS,GAClC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3C,SAAS,GACX,SAAS,CAAA;AAEb,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,KAAK,SAAS,MAAM,UAAU,EAC9B,SAAS,IACP,MAAM,SAAS,KAAK,CAAC,MAAM,WAAW,SAAS,UAAU,CAAC,GAC1D,WAAW,CAAC,KAAK,CAAC,SAAS,SAAS,GAClC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,GACxC,SAAS,GACX,SAAS,CAAA"}

package/dist/types/types/serializer.d.ts

@@ -1,7 +0,0 @@
-import type { TransactionSerializable, TransactionSerializableGeneric } from '../types/transaction.js';
-import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js';
-import type { Formatter, Formatters } from './formatter.js';
-export type Serializers<TFormatters extends Formatters | undefined = undefined> = {
-    transaction?: SerializeTransactionFn<TFormatters extends Formatters ? TFormatters['transactionRequest'] extends Formatter ? TransactionSerializableGeneric & Parameters<TFormatters['transactionRequest']['format']>[0] : TransactionSerializable : TransactionSerializable>;
-};
-//# sourceMappingURL=serializer.d.ts.map

package/dist/types/types/serializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../../../src/types/serializer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,8BAA8B,EAC/B,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAA;AAC1F,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3D,MAAM,MAAM,WAAW,CACrB,WAAW,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IACpD;IACF,WAAW,CAAC,EAAE,sBAAsB,CAClC,WAAW,SAAS,UAAU,GAC1B,WAAW,CAAC,oBAAoB,CAAC,SAAS,SAAS,GACjD,8BAA8B,GAC5B,UAAU,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAC5D,uBAAuB,GACzB,uBAAuB,CAC5B,CAAA;CACF,CAAA"}

package/src/types/formatter.ts

@@ -1,42 +0,0 @@
-import type { Chain } from './chain.js'
-
-export type Formatter<TType extends string = string> = {
-  format: (args: any) => any
-  type: TType
-}
-
-export type Formatters = {
-  block?: Formatter<'block'>
-  transaction?: Formatter<'transaction'>
-  transactionReceipt?: Formatter<'transactionReceipt'>
-  transactionRequest?: Formatter<'transactionRequest'>
-}
-
-export type ExtractFormatterExclude<
-  TChain extends Chain | undefined,
-  TType extends keyof Formatters,
-> = TChain extends Chain<infer _Formatters extends Formatters>
-  ? _Formatters[TType] extends { exclude: infer Exclude }
-    ? Extract<Exclude, string[]>[number]
-    : ''
-  : ''
-
-export type ExtractFormatterParameters<
-  TChain extends Chain | undefined,
-  TType extends keyof Formatters,
-  TFallback,
-> = TChain extends Chain<infer _Formatters extends Formatters>
-  ? _Formatters[TType] extends Formatter
-    ? Parameters<_Formatters[TType]['format']>[0]
-    : TFallback
-  : TFallback
-
-export type ExtractFormatterReturnType<
-  TChain extends Chain | undefined,
-  TType extends keyof Formatters,
-  TFallback,
-> = TChain extends Chain<infer _Formatters extends Formatters>
-  ? _Formatters[TType] extends Formatter
-    ? ReturnType<_Formatters[TType]['format']>
-    : TFallback
-  : TFallback

package/src/types/serializer.ts

@@ -1,19 +0,0 @@
-import type {
-  TransactionSerializable,
-  TransactionSerializableGeneric,
-} from '../types/transaction.js'
-import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js'
-import type { Formatter, Formatters } from './formatter.js'
-
-export type Serializers<
-  TFormatters extends Formatters | undefined = undefined,
-> = {
-  transaction?: SerializeTransactionFn<
-    TFormatters extends Formatters
-      ? TFormatters['transactionRequest'] extends Formatter
-        ? TransactionSerializableGeneric &
-            Parameters<TFormatters['transactionRequest']['format']>[0]
-        : TransactionSerializable
-      : TransactionSerializable
-  >
-}