Cp 235/update gas estimator for fixed exchange gas (#375)

* feat: updated changelog and version number for v1.9.0 release

* fix: updated the oracle stream prices script to send the oracle type always in lowercase

* fix: added quantization in the functions that convert notional values to chain format

* cp-235: updated the gas limit estimator logic to reflect the new logic for gas heuristics in exchange module (chain v1.15)

* cp-235: updated all proto definitions with the candidate indexer and chain core versions for v1.15 chain upgrade

* feat: added a new message based fee calculator supporting the Exchange module gas heuristics

* fix: fix broadcaster creation example scripts

* fix: pointed to the correct injective-core branch for the proto generation

* fix: updated gas heuristics per message gas cost to sync with latest changes on chain

* fix: added cleanup code in AsyncClient for the object destruction phase

* feat: updated proto definitions for chain v1.15 upgrade and Indexer v1.14.48

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

* fix: fixed gas calculation using heuristics to not duplicate the required gas for post only orders

Author: aarmoa

CHANGELOG.md

@@ -2,7 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.9.0] - 9999-99-99
+## [1.10.0] - 9999-99-99
+### Changed
+- Update in the implementation of the gas limit estimator to use the same values as the chain for the fixed gas messages
+
+## [1.9.1] - 2025-03-03
+### Fixed
+- Added quantization in the functions that convert notional values to chain format
+
+## [1.9.0] - 2025-02-13
 ### Added
 - Added support for all new queries and messages from the new Permissions module
 

Makefile

@@ -31,7 +31,7 @@ clean-all:
 	$(call clean_repos)
 
 clone-injective-indexer:
-	git clone https://github.com/InjectiveLabs/injective-indexer.git -b v1.13.117_RC1 --depth 1 --single-branch
+	git clone https://github.com/InjectiveLabs/injective-indexer.git -b v1.14.48 --depth 1 --single-branch
 
 clone-all: clone-injective-indexer
 

buf.gen.yaml

@@ -12,18 +12,18 @@ inputs:
   - module: buf.build/googleapis/googleapis
   - module: buf.build/cosmos/ics23
   - git_repo: https://github.com/InjectiveLabs/cosmos-sdk
-    tag: v0.50.9-inj-2
+    tag: v0.50.9-inj-4
   - git_repo: https://github.com/InjectiveLabs/ibc-go
-    tag: v8.3.2-inj-0
+    tag: v8.6.1-inj
   - git_repo: https://github.com/InjectiveLabs/wasmd
-    tag: v0.53.2-inj-1
+    tag: v0.53.2-inj.2
 #  - git_repo: https://github.com/InjectiveLabs/wasmd
 #    branch: v0.51.x-inj
-#    subdir: proto
-#  - git_repo: https://github.com/InjectiveLabs/injective-core
-#    tag: v1.13.0
 #    subdir: proto
   - git_repo: https://github.com/InjectiveLabs/injective-core
-    branch: testnet
+    tag: v1.15.0-beta.2
     subdir: proto
+#  - git_repo: https://github.com/InjectiveLabs/injective-core
+#    branch: release/v1.15.x
+#    subdir: proto
   - directory: proto

examples/chain_client/1_LocalOrderHash.py

@@ -6,7 +6,7 @@
 import dotenv
 
 from pyinjective.async_client import AsyncClient
-from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT, GAS_PRICE
+from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT
 from pyinjective.core.network import Network
 from pyinjective.orderhash import OrderHashManager
 from pyinjective.transaction import Transaction
@@ -111,7 +111,11 @@ async def main() -> None:
         .with_account_num(client.get_number())
         .with_chain_id(network.chain_id)
     )
-    gas_price = GAS_PRICE
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     base_gas = 85000
     gas_limit = base_gas + GAS_FEE_BUFFER_AMOUNT  # add buffer for gas fee computation
     gas_fee = "{:.18f}".format((gas_price * gas_limit) / pow(10, 18)).rstrip("0")
@@ -148,7 +152,11 @@ async def main() -> None:
         .with_account_num(client.get_number())
         .with_chain_id(network.chain_id)
     )
-    gas_price = GAS_PRICE
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     base_gas = 85000
     gas_limit = base_gas + GAS_FEE_BUFFER_AMOUNT  # add buffer for gas fee computation
     gas_fee = "{:.18f}".format((gas_price * gas_limit) / pow(10, 18)).rstrip("0")
@@ -240,7 +248,11 @@ async def main() -> None:
         .with_account_num(client.get_number())
         .with_chain_id(network.chain_id)
     )
-    gas_price = GAS_PRICE
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     base_gas = 85000
     gas_limit = base_gas + GAS_FEE_BUFFER_AMOUNT  # add buffer for gas fee computation
     gas_fee = "{:.18f}".format((gas_price * gas_limit) / pow(10, 18)).rstrip("0")

examples/chain_client/3_MessageBroadcaster.py

@@ -1,11 +1,12 @@
 import asyncio
+import json
 import os
 import uuid
 from decimal import Decimal
 
 import dotenv
 
-from pyinjective.composer import Composer as ProtoMsgComposer
+from pyinjective.async_client import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import PrivateKey
@@ -17,11 +18,20 @@ async def main() -> None:
 
     # select network: local, testnet, mainnet
     network = Network.testnet()
-    composer = ProtoMsgComposer(network=network.string())
+
+    client = AsyncClient(network)
+    composer = await client.composer()
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
 
     message_broadcaster = MsgBroadcasterWithPk.new_using_simulation(
         network=network,
         private_key=private_key_in_hexa,
+        gas_price=gas_price,
+        client=client,
+        composer=composer,
     )
 
     priv_key = PrivateKey.from_hex(private_key_in_hexa)
@@ -64,7 +74,12 @@ async def main() -> None:
     # broadcast the transaction
     result = await message_broadcaster.broadcast([msg])
     print("---Transaction Response---")
-    print(result)
+    print(json.dumps(result, indent=2))
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+    message_broadcaster.update_gas_price(gas_price=gas_price)
 
 
 if __name__ == "__main__":

examples/chain_client/4_MessageBroadcasterWithGranteeAccount.py

@@ -1,12 +1,12 @@
 import asyncio
+import json
 import os
 import uuid
 from decimal import Decimal
 
 import dotenv
 
 from pyinjective.async_client import AsyncClient
-from pyinjective.composer import Composer as ProtoMsgComposer
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import Address, PrivateKey
@@ -19,20 +19,27 @@ async def main() -> None:
 
     # select network: local, testnet, mainnet
     network = Network.testnet()
-    composer = ProtoMsgComposer(network=network.string())
 
     # initialize grpc client
     client = AsyncClient(network)
+    composer = await client.composer()
     await client.sync_timeout_height()
 
     # load account
     priv_key = PrivateKey.from_hex(private_key_in_hexa)
     pub_key = priv_key.to_public_key()
     address = pub_key.to_address()
 
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     message_broadcaster = MsgBroadcasterWithPk.new_for_grantee_account_using_simulation(
         network=network,
         grantee_private_key=private_key_in_hexa,
+        gas_price=gas_price,
+        client=client,
+        composer=composer,
     )
 
     # prepare tx msg
@@ -55,7 +62,12 @@ async def main() -> None:
     # broadcast the transaction
     result = await message_broadcaster.broadcast([msg])
     print("---Transaction Response---")
-    print(result)
+    print(json.dumps(result, indent=2))
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+    message_broadcaster.update_gas_price(gas_price=gas_price)
 
 
 if __name__ == "__main__":

examples/chain_client/5_MessageBroadcasterWithoutSimulation.py

@@ -1,11 +1,12 @@
 import asyncio
+import json
 import os
 import uuid
 from decimal import Decimal
 
 import dotenv
 
-from pyinjective.composer import Composer as ProtoMsgComposer
+from pyinjective.async_client import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import PrivateKey
@@ -17,11 +18,21 @@ async def main() -> None:
 
     # select network: local, testnet, mainnet
     network = Network.testnet()
-    composer = ProtoMsgComposer(network=network.string())
+
+    client = AsyncClient(network)
+    composer = await client.composer()
+    await client.sync_timeout_height()
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
 
     message_broadcaster = MsgBroadcasterWithPk.new_without_simulation(
         network=network,
         private_key=private_key_in_hexa,
+        gas_price=gas_price,
+        client=client,
+        composer=composer,
     )
 
     priv_key = PrivateKey.from_hex(private_key_in_hexa)
@@ -64,7 +75,12 @@ async def main() -> None:
     # broadcast the transaction
     result = await message_broadcaster.broadcast([msg])
     print("---Transaction Response---")
-    print(result)
+    print(json.dumps(result, indent=2))
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+    message_broadcaster.update_gas_price(gas_price=gas_price)
 
 
 if __name__ == "__main__":

examples/chain_client/6_MessageBroadcasterWithGranteeAccountWithoutSimulation.py

@@ -1,12 +1,12 @@
 import asyncio
+import json
 import os
 import uuid
 from decimal import Decimal
 
 import dotenv
 
 from pyinjective.async_client import AsyncClient
-from pyinjective.composer import Composer as ProtoMsgComposer
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import Address, PrivateKey
@@ -19,20 +19,26 @@ async def main() -> None:
 
     # select network: local, testnet, mainnet
     network = Network.testnet()
-    composer = ProtoMsgComposer(network=network.string())
 
     # initialize grpc client
     client = AsyncClient(network)
-    await client.sync_timeout_height()
+    composer = await client.composer()
 
     # load account
     priv_key = PrivateKey.from_hex(private_key_in_hexa)
     pub_key = priv_key.to_public_key()
     address = pub_key.to_address()
 
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     message_broadcaster = MsgBroadcasterWithPk.new_for_grantee_account_without_simulation(
         network=network,
         grantee_private_key=private_key_in_hexa,
+        gas_price=gas_price,
+        client=client,
+        composer=composer,
     )
 
     # prepare tx msg
@@ -54,7 +60,12 @@ async def main() -> None:
     # broadcast the transaction
     result = await message_broadcaster.broadcast([msg])
     print("---Transaction Response---")
-    print(result)
+    print(json.dumps(result, indent=2))
+
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+    message_broadcaster.update_gas_price(gas_price=gas_price)
 
 
 if __name__ == "__main__":

examples/chain_client/auction/1_MsgBid.py

@@ -5,7 +5,7 @@
 from grpc import RpcError
 
 from pyinjective.async_client import AsyncClient
-from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT, GAS_PRICE
+from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT
 from pyinjective.core.network import Network
 from pyinjective.transaction import Transaction
 from pyinjective.wallet import PrivateKey
@@ -52,7 +52,10 @@ async def main() -> None:
         return
 
     # build tx
-    gas_price = GAS_PRICE
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     gas_limit = int(sim_res["gasInfo"]["gasUsed"]) + GAS_FEE_BUFFER_AMOUNT  # add buffer for gas fee computation
     gas_fee = "{:.18f}".format((gas_price * gas_limit) / pow(10, 18)).rstrip("0")
     fee = [

examples/chain_client/authz/1_MsgGrant.py

@@ -5,7 +5,7 @@
 from grpc import RpcError
 
 from pyinjective.async_client import AsyncClient
-from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT, GAS_PRICE
+from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT
 from pyinjective.core.network import Network
 from pyinjective.transaction import Transaction
 from pyinjective.wallet import PrivateKey
@@ -72,7 +72,10 @@ async def main() -> None:
         return
 
     # build tx
-    gas_price = GAS_PRICE
+    gas_price = await client.current_chain_gas_price()
+    # adjust gas price to make it valid even if it changes between the time it is requested and the TX is broadcasted
+    gas_price = int(gas_price * 1.1)
+
     gas_limit = int(sim_res["gasInfo"]["gasUsed"]) + GAS_FEE_BUFFER_AMOUNT  # add buffer for gas fee computation
     gas_fee = "{:.18f}".format((gas_price * gas_limit) / pow(10, 18)).rstrip("0")
     fee = [