starknet 6.4.2 → 6.5.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [6.5.0](https://github.com/starknet-io/starknet.js/compare/v6.4.2...v6.5.0) (2024-03-14)
+
+### Bug Fixes
+
+- adjust max amount bound calculation for RPC v0.7.0 ([dd34cdb](https://github.com/starknet-io/starknet.js/commit/dd34cdb8b9817a55a16a97d960b1544d75c0059a))
+
+### Features
+
+- make fee margins configurable ([cedd984](https://github.com/starknet-io/starknet.js/commit/cedd984e1106db5b73d17630e282eb956d344a97))
+
 ## [6.4.2](https://github.com/starknet-io/starknet.js/compare/v6.4.1...v6.4.2) (2024-03-14)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -2450,6 +2450,11 @@ declare enum TransactionHashPrefix {
     INVOKE = "0x696e766f6b65",// encodeShortString('invoke'),
     L1_HANDLER = "0x6c315f68616e646c6572"
 }
+declare const enum feeMarginPercentage {
+    L1_BOUND_MAX_AMOUNT = 50,
+    L1_BOUND_MAX_PRICE_PER_UNIT = 50,
+    MAX_FEE = 50
+}
 declare const UDC: {
     ADDRESS: string;
     ENTRYPOINT: string;
@@ -2479,8 +2484,10 @@ type constants_TransactionHashPrefix = TransactionHashPrefix;
 declare const constants_TransactionHashPrefix: typeof TransactionHashPrefix;
 declare const constants_UDC: typeof UDC;
 declare const constants_ZERO: typeof ZERO;
+type constants_feeMarginPercentage = feeMarginPercentage;
+declare const constants_feeMarginPercentage: typeof feeMarginPercentage;
 declare namespace constants {
-  export { constants_ADDR_BOUND as ADDR_BOUND, constants_API_VERSION as API_VERSION, constants_BaseUrl as BaseUrl, constants_IS_BROWSER as IS_BROWSER, constants_MASK_250 as MASK_250, constants_MAX_STORAGE_ITEM_SIZE as MAX_STORAGE_ITEM_SIZE, constants_NetworkName as NetworkName, constants_RPC_DEFAULT_VERSION as RPC_DEFAULT_VERSION, constants_RPC_NODES as RPC_NODES, constants_StarknetChainId as StarknetChainId, constants_TEXT_TO_FELT_MAX_LEN as TEXT_TO_FELT_MAX_LEN, ETransactionVersion as TRANSACTION_VERSION, constants_TransactionHashPrefix as TransactionHashPrefix, constants_UDC as UDC, constants_ZERO as ZERO };
+  export { constants_ADDR_BOUND as ADDR_BOUND, constants_API_VERSION as API_VERSION, constants_BaseUrl as BaseUrl, constants_IS_BROWSER as IS_BROWSER, constants_MASK_250 as MASK_250, constants_MAX_STORAGE_ITEM_SIZE as MAX_STORAGE_ITEM_SIZE, constants_NetworkName as NetworkName, constants_RPC_DEFAULT_VERSION as RPC_DEFAULT_VERSION, constants_RPC_NODES as RPC_NODES, constants_StarknetChainId as StarknetChainId, constants_TEXT_TO_FELT_MAX_LEN as TEXT_TO_FELT_MAX_LEN, ETransactionVersion as TRANSACTION_VERSION, constants_TransactionHashPrefix as TransactionHashPrefix, constants_UDC as UDC, constants_ZERO as ZERO, constants_feeMarginPercentage as feeMarginPercentage };
 }
 
 declare const ec_weierstrass: typeof weierstrass;
@@ -3007,6 +3014,11 @@ type RpcProviderOptions = {
     specVersion?: string;
     default?: boolean;
     waitMode?: boolean;
+    feeMarginPercentage?: {
+        l1BoundMaxAmount: number;
+        l1BoundMaxPricePerUnit: number;
+        maxFee: number;
+    };
 };
 
 type Simplify<T> = {

package/dist/index.global.js

@@ -12766,7 +12766,8 @@ var starknet = (() => {
     TRANSACTION_VERSION: () => ETransactionVersion4,
     TransactionHashPrefix: () => TransactionHashPrefix,
     UDC: () => UDC,
-    ZERO: () => ZERO
+    ZERO: () => ZERO,
+    feeMarginPercentage: () => feeMarginPercentage
   });
 
   // src/types/api/index.ts
@@ -13251,6 +13252,12 @@ var starknet = (() => {
     TransactionHashPrefix2["L1_HANDLER"] = "0x6c315f68616e646c6572";
     return TransactionHashPrefix2;
   })(TransactionHashPrefix || {});
+  var feeMarginPercentage = /* @__PURE__ */ ((feeMarginPercentage2) => {
+    feeMarginPercentage2[feeMarginPercentage2["L1_BOUND_MAX_AMOUNT"] = 50] = "L1_BOUND_MAX_AMOUNT";
+    feeMarginPercentage2[feeMarginPercentage2["L1_BOUND_MAX_PRICE_PER_UNIT"] = 50] = "L1_BOUND_MAX_PRICE_PER_UNIT";
+    feeMarginPercentage2[feeMarginPercentage2["MAX_FEE"] = 50] = "MAX_FEE";
+    return feeMarginPercentage2;
+  })(feeMarginPercentage || {});
   var UDC = {
     ADDRESS: "0x041a78e741e5af2fec34b695679bc6891742439f7afb8484ecd7766661ad02bf",
     ENTRYPOINT: "deployContract"
@@ -22997,10 +23004,10 @@ var starknet = (() => {
   function signatureToHexArray(sig) {
     return bigNumberishArrayToHexadecimalStringArray(formatSignature(sig));
   }
-  function estimatedFeeToMaxFee(estimatedFee, overhead = 0.5) {
-    return addPercent(estimatedFee, overhead * 100);
+  function estimatedFeeToMaxFee(estimatedFee, overhead = 50 /* MAX_FEE */) {
+    return addPercent(estimatedFee, overhead);
   }
-  function estimateFeeToBounds(estimate, amountOverhead = 10, priceOverhead = 50) {
+  function estimateFeeToBounds(estimate, amountOverhead = 50 /* L1_BOUND_MAX_AMOUNT */, priceOverhead = 50 /* L1_BOUND_MAX_PRICE_PER_UNIT */) {
     if (typeof estimate === "bigint") {
       return {
         l2_gas: { max_amount: "0x0", max_price_per_unit: "0x0" },
@@ -23010,7 +23017,7 @@ var starknet = (() => {
     if (typeof estimate.gas_consumed === "undefined" || typeof estimate.gas_price === "undefined") {
       throw Error("estimateFeeToBounds: estimate is undefined");
     }
-    const maxUnits = toHex(addPercent(estimate.gas_consumed, amountOverhead));
+    const maxUnits = estimate.data_gas_consumed !== void 0 && estimate.data_gas_price !== void 0 ? toHex(addPercent(BigInt(estimate.overall_fee) / BigInt(estimate.gas_price), amountOverhead)) : toHex(addPercent(estimate.gas_consumed, amountOverhead));
     const maxUnitPrice = toHex(addPercent(estimate.gas_price, priceOverhead));
     return {
       l2_gas: { max_amount: "0x0", max_price_per_unit: "0x0" },
@@ -24523,6 +24530,20 @@ var starknet = (() => {
 
   // src/utils/responseParser/rpc.ts
   var RPCResponseParser = class {
+    margin;
+    constructor(margin) {
+      this.margin = margin;
+    }
+    estimatedFeeToMaxFee(estimatedFee) {
+      return estimatedFeeToMaxFee(estimatedFee, this.margin?.maxFee);
+    }
+    estimateFeeToBounds(estimate) {
+      return estimateFeeToBounds(
+        estimate,
+        this.margin?.l1BoundMaxAmount,
+        this.margin?.l1BoundMaxPricePerUnit
+      );
+    }
     parseGetBlockResponse(res) {
       return { status: "PENDING", ...res };
     }
@@ -24545,8 +24566,8 @@ var starknet = (() => {
         gas_consumed: toBigInt(val.gas_consumed),
         gas_price: toBigInt(val.gas_price),
         unit: val.unit,
-        suggestedMaxFee: estimatedFeeToMaxFee(val.overall_fee),
-        resourceBounds: estimateFeeToBounds(val)
+        suggestedMaxFee: this.estimatedFeeToMaxFee(val.overall_fee),
+        resourceBounds: this.estimateFeeToBounds(val)
       };
     }
     parseFeeEstimateBulkResponse(res) {
@@ -24555,16 +24576,16 @@ var starknet = (() => {
         gas_consumed: toBigInt(val.gas_consumed),
         gas_price: toBigInt(val.gas_price),
         unit: val.unit,
-        suggestedMaxFee: estimatedFeeToMaxFee(val.overall_fee),
-        resourceBounds: estimateFeeToBounds(val)
+        suggestedMaxFee: this.estimatedFeeToMaxFee(val.overall_fee),
+        resourceBounds: this.estimateFeeToBounds(val)
       }));
     }
     parseSimulateTransactionResponse(res) {
       return res.map((it) => {
         return {
           ...it,
-          suggestedMaxFee: estimatedFeeToMaxFee(BigInt(it.fee_estimation.overall_fee)),
-          resourceBounds: estimateFeeToBounds(it.fee_estimation)
+          suggestedMaxFee: this.estimatedFeeToMaxFee(it.fee_estimation.overall_fee),
+          resourceBounds: this.estimateFeeToBounds(it.fee_estimation)
         };
       });
     }
@@ -24578,13 +24599,15 @@ var starknet = (() => {
 
   // src/provider/rpc.ts
   var RpcProvider = class {
-    responseParser = new RPCResponseParser();
+    responseParser;
     channel;
     constructor(optionsOrProvider) {
       if (optionsOrProvider && "channel" in optionsOrProvider) {
         this.channel = optionsOrProvider.channel;
+        this.responseParser = optionsOrProvider.responseParser;
       } else {
         this.channel = new RpcChannel2({ ...optionsOrProvider, waitMode: false });
+        this.responseParser = new RPCResponseParser(optionsOrProvider?.feeMarginPercentage);
       }
     }
     fetch(method, params, id = 0) {
@@ -24677,7 +24700,7 @@ var starknet = (() => {
      * - skipFeeCharge (default true)<br/>
      */
     async getSimulateTransaction(invocations, options) {
-      return this.channel.simulateTransaction(invocations, options).then(this.responseParser.parseSimulateTransactionResponse);
+      return this.channel.simulateTransaction(invocations, options).then((r) => this.responseParser.parseSimulateTransactionResponse(r));
     }
     async waitForTransaction(txHash, options) {
       return this.channel.waitForTransaction(txHash, options);
@@ -24734,7 +24757,7 @@ var starknet = (() => {
           }
         ],
         { blockIdentifier, skipValidate }
-      ).then(this.responseParser.parseFeeEstimateResponse);
+      ).then((r) => this.responseParser.parseFeeEstimateResponse(r));
     }
     async getDeclareEstimateFee(invocation, details, blockIdentifier, skipValidate) {
       return this.channel.getEstimateFee(
@@ -24746,7 +24769,7 @@ var starknet = (() => {
           }
         ],
         { blockIdentifier, skipValidate }
-      ).then(this.responseParser.parseFeeEstimateResponse);
+      ).then((r) => this.responseParser.parseFeeEstimateResponse(r));
     }
     async getDeployAccountEstimateFee(invocation, details, blockIdentifier, skipValidate) {
       return this.channel.getEstimateFee(
@@ -24758,10 +24781,10 @@ var starknet = (() => {
           }
         ],
         { blockIdentifier, skipValidate }
-      ).then(this.responseParser.parseFeeEstimateResponse);
+      ).then((r) => this.responseParser.parseFeeEstimateResponse(r));
     }
     async getEstimateFeeBulk(invocations, options) {
-      return this.channel.getEstimateFee(invocations, options).then(this.responseParser.parseFeeEstimateBulkResponse);
+      return this.channel.getEstimateFee(invocations, options).then((r) => this.responseParser.parseFeeEstimateBulkResponse(r));
     }
     async invokeFunction(functionInvocation, details) {
       return this.channel.invoke(functionInvocation, details);