@rhinestone/service-sdk 0.2.10 → 0.2.11

package/README.md

@@ -1 +1,22 @@
-# service-sdk
+# service-sdk
+
+## Gas fee estimation
+
+```ts
+import { estimateGasFees } from '@rhinestone/service-sdk/chains'
+
+const fees = await estimateGasFees(client, chainId)
+const legacyFees = await estimateGasFees(client, chainId, { mode: 'legacy' })
+```
+
+With no options, `estimateGasFees` retains its chain-aware fee estimation
+behavior. Legacy mode takes precedence over all chain-specific logic and calls
+`client.estimateFeesPerGas({ type: 'legacy' })` without requesting fee history.
+
+The return type remains EIP-1559-shaped in both modes. Legacy `gasPrice` is
+normalized to
+`{ maxFeePerGas: gasPrice, maxPriorityFeePerGas: gasPrice }`. Equal caps
+preserve the legacy effective-price ceiling when the result is used as EIP-1559
+fees. On a no-priority local fork where `baseFee == gasPrice`, the max-fee cap
+means the actual paid tip is still zero. The mode selects the estimation source
+only; it does not select or modify a transaction type.

package/dist/chains.d.ts

@@ -1,5 +1,27 @@
 import type { FeeValuesEIP1559, PublicClient } from 'viem';
-type FeeEstimationClient = Pick<PublicClient, 'estimateFeesPerGas' | 'getFeeHistory'>;
-export declare function estimateGasFees(client: FeeEstimationClient, chainId: number): Promise<FeeValuesEIP1559>;
-export {};
+/** Client methods required to estimate gas fees. */
+export type FeeEstimationClient = Pick<PublicClient, 'estimateFeesPerGas' | 'getFeeHistory'>;
+/** Options for {@link estimateGasFees}. */
+export type EstimateGasFeesOptions = {
+    /**
+     * Uses the RPC's legacy gas-price estimate when set to `legacy`.
+     *
+     * The legacy price is returned as equal EIP-1559 fee caps, preserving it as
+     * the effective-price ceiling for EIP-1559 consumers.
+     *
+     * Omit this option to retain the chain-aware EIP-1559 estimation strategy.
+     */
+    mode?: 'legacy';
+};
+/**
+ * Estimates gas fees for a chain and returns EIP-1559-shaped fee values.
+ *
+ * Pass `{ mode: 'legacy' }` to source the estimate from the RPC's legacy gas
+ * price. The price is used for both EIP-1559 fee caps so it remains the
+ * effective-price ceiling. On a no-priority local fork where the base fee
+ * equals the gas price, the max-fee cap still limits the actual paid tip to
+ * zero. This changes fee estimation only; it does not select a transaction
+ * type.
+ */
+export declare function estimateGasFees(client: FeeEstimationClient, chainId: number, options?: EstimateGasFeesOptions): Promise<FeeValuesEIP1559>;
 //# sourceMappingURL=chains.d.ts.map

package/dist/chains.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chains.d.ts","sourceRoot":"","sources":["../src/chains.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAa1D,KAAK,mBAAmB,GAAG,IAAI,CAC7B,YAAY,EACZ,oBAAoB,GAAG,eAAe,CACvC,CAAA;AA0GD,wBAAsB,eAAe,CACnC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,CAAC,CAU3B"}
+{"version":3,"file":"chains.d.ts","sourceRoot":"","sources":["../src/chains.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAmB,YAAY,EAAE,MAAM,MAAM,CAAA;AAa3E,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,YAAY,EACZ,oBAAoB,GAAG,eAAe,CACvC,CAAA;AAED,2CAA2C;AAC3C,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,CAAA;AA8GD;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,gBAAgB,CAAC,CAsB3B"}

package/dist/chains.js

@@ -73,7 +73,27 @@ const TIP_FLOOR_WEI = {
 const WINDOWED_TIP_CHAINS = new Set([chains_1.polygon.id, chains_1.base.id]);
 const WINDOWED_TIP_HISTORY_BLOCKS = 20;
 const WINDOWED_TIP_PERCENTILE = 50; // p50 per block, nearest-rank across the window
-async function estimateGasFees(client, chainId) {
+/**
+ * Estimates gas fees for a chain and returns EIP-1559-shaped fee values.
+ *
+ * Pass `{ mode: 'legacy' }` to source the estimate from the RPC's legacy gas
+ * price. The price is used for both EIP-1559 fee caps so it remains the
+ * effective-price ceiling. On a no-priority local fork where the base fee
+ * equals the gas price, the max-fee cap still limits the actual paid tip to
+ * zero. This changes fee estimation only; it does not select a transaction
+ * type.
+ */
+async function estimateGasFees(client, chainId, options) {
+    if (options?.mode === 'legacy') {
+        const legacyClient = client;
+        const { gasPrice } = await legacyClient.estimateFeesPerGas({
+            type: 'legacy',
+        });
+        // Equal caps preserve gasPrice as the effective-price ceiling. If a
+        // no-priority local fork reports baseFee == gasPrice, the max-fee cap means
+        // the actual paid tip remains zero despite this priority-fee allowance.
+        return { maxFeePerGas: gasPrice, maxPriorityFeePerGas: gasPrice };
+    }
     if (HISTORICAL_FEE_CHAINS.has(chainId)) {
         const config = { ...DEFAULT_FEE_CONFIG, ...FEE_CONFIG_OVERRIDES[chainId] };
         return estimateFeeHistoryGasFees(client, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhinestone/service-sdk",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "description": "Shared SDK for Rhinestone services",
   "author": {
     "name": "Rhinestone",