feat: made the gas calculator using gas heuristics the default one for the MsgBroadcasterWithPk when broadcasting without simulation

Author: aarmoa

pyinjective/core/broadcaster.py

@@ -124,6 +124,36 @@ def new_without_simulation(
     ):
         """Creates a new broadcaster instance that uses message-based gas estimation without simulation.
 
+        Args:
+            network (Network): The network configuration to use (mainnet, testnet, etc.)
+            private_key (str): The private key in hex format for signing transactions
+            gas_price (Optional[int]): Custom gas price in chain format (e.g. 500000000000000000 for 0.5 INJ).
+                Defaults to None
+            client (Optional[AsyncClient]): Custom AsyncClient instance. Defaults to None
+            composer (Optional[Composer]): Custom Composer instance. Defaults to None
+
+        Returns:
+            MsgBroadcasterWithPk: A configured broadcaster instance using message-based fee calculation
+        """
+        return cls.new_using_gas_heuristics(
+            network=network,
+            private_key=private_key,
+            gas_price=gas_price,
+            client=client,
+            composer=composer,
+        )
+
+    @classmethod
+    def new_using_gas_heuristics(
+        cls,
+        network: Network,
+        private_key: str,
+        gas_price: Optional[int] = None,
+        client: Optional[AsyncClient] = None,
+        composer: Optional[Composer] = None,
+    ):
+        """Creates a new broadcaster instance that uses gas heuristics for gas calculation
+
         Args:
             network (Network): The network configuration to use (mainnet, testnet, etc.)
             private_key (str): The private key in hex format for signing transactions
@@ -138,7 +168,11 @@ def new_without_simulation(
         client = client or AsyncClient(network=network)
         composer = composer or Composer(network=client.network.string())
         account_config = StandardAccountBroadcasterConfig(private_key=private_key)
-        fee_calculator = MessageBasedTransactionFeeCalculator(client=client, composer=composer, gas_price=gas_price)
+        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_heuristics(
+            client=client,
+            composer=composer,
+            gas_price=gas_price,
+        )
         instance = cls(
             network=network,
             account_config=account_config,
@@ -149,7 +183,7 @@ def new_without_simulation(
         return instance
 
     @classmethod
-    def new_using_gas_heuristics(
+    def new_using_estimate_gas(
         cls,
         network: Network,
         private_key: str,
@@ -173,7 +207,7 @@ def new_using_gas_heuristics(
         client = client or AsyncClient(network=network)
         composer = composer or Composer(network=client.network.string())
         account_config = StandardAccountBroadcasterConfig(private_key=private_key)
-        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_heuristics(
+        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_estimation(
             client=client,
             composer=composer,
             gas_price=gas_price,
@@ -232,8 +266,38 @@ def new_for_grantee_account_without_simulation(
         client: Optional[AsyncClient] = None,
         composer: Optional[Composer] = None,
     ):
-        """Creates a new broadcaster instance for a grantee account that uses message-based gas estimation without
-            simulation.
+        """Creates a new broadcaster instance for a grantee account that uses gas estimator using gas heuristics.
+
+        Args:
+            network (Network): The network configuration to use (mainnet, testnet, etc.)
+            grantee_private_key (str): The grantee's private key in hex format for signing transactions
+            gas_price (Optional[int]): Custom gas price in chain format (e.g. 500000000000000000 for 0.5 INJ).
+                Defaults to None
+            client (Optional[AsyncClient]): Custom AsyncClient instance. Defaults to None
+            composer (Optional[Composer]): Custom Composer instance. Defaults to None
+
+        Returns:
+            MsgBroadcasterWithPk: A configured broadcaster instance using message-based fee calculation for a grantee
+            account
+        """
+        return cls.new_for_grantee_account_using_gas_heuristics(
+            network=network,
+            grantee_private_key=grantee_private_key,
+            gas_price=gas_price,
+            client=client,
+            composer=composer,
+        )
+
+    @classmethod
+    def new_for_grantee_account_using_gas_heuristics(
+        cls,
+        network: Network,
+        grantee_private_key: str,
+        gas_price: Optional[int] = None,
+        client: Optional[AsyncClient] = None,
+        composer: Optional[Composer] = None,
+    ):
+        """Creates a new broadcaster instance for a grantee account that uses gas heuristics.
 
         Args:
             network (Network): The network configuration to use (mainnet, testnet, etc.)
@@ -250,7 +314,11 @@ def new_for_grantee_account_without_simulation(
         client = client or AsyncClient(network=network)
         composer = composer or Composer(network=client.network.string())
         account_config = GranteeAccountBroadcasterConfig(grantee_private_key=grantee_private_key, composer=composer)
-        fee_calculator = MessageBasedTransactionFeeCalculator(client=client, composer=composer, gas_price=gas_price)
+        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_heuristics(
+            client=client,
+            composer=composer,
+            gas_price=gas_price,
+        )
         instance = cls(
             network=network,
             account_config=account_config,
@@ -261,7 +329,7 @@ def new_for_grantee_account_without_simulation(
         return instance
 
     @classmethod
-    def new_for_grantee_account_using_gas_heuristics(
+    def new_for_grantee_account_using_estimated_gas(
         cls,
         network: Network,
         grantee_private_key: str,
@@ -287,7 +355,7 @@ def new_for_grantee_account_using_gas_heuristics(
         client = client or AsyncClient(network=network)
         composer = composer or Composer(network=client.network.string())
         account_config = GranteeAccountBroadcasterConfig(grantee_private_key=grantee_private_key, composer=composer)
-        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_heuristics(
+        fee_calculator = MessageBasedTransactionFeeCalculator.new_using_gas_estimation(
             client=client,
             composer=composer,
             gas_price=gas_price,
@@ -465,6 +533,10 @@ def new_using_gas_heuristics(cls, client: AsyncClient, composer: Composer, gas_p
             client=client, composer=composer, gas_price=gas_price, estimator_class=GasHeuristicsGasLimitEstimator
         )
 
+    @classmethod
+    def new_using_gas_estimation(cls, client: AsyncClient, composer: Composer, gas_price: Optional[int] = None):
+        return cls(client=client, composer=composer, gas_price=gas_price, estimator_class=GasLimitEstimator)
+
     async def configure_gas_fee_for_transaction(
         self,
         transaction: Transaction,