Merge pull request #382 from InjectiveLabs/cp-446/created_v2_client_for_exchange_v2_endpoints

[CP-446] created v2 client for exchange v2 endpoints

Author: aarmoa

.gitignore

@@ -145,3 +145,4 @@ cython_debug/
 .exchange_cookie
 
 .flakeheaven_cache
+.vscode/settings.json

CHANGELOG.md

@@ -10,6 +10,9 @@ All notable changes to this project will be documented in this file.
 - Updated all chain exchange module examples to use the new Exchange V2 proto queries and types
 - Added examples for ERC20 queries and messages
 - Added examples for EVM queries
+- Created a new AsyncClient in the pyinjective.async_client_v2 module. This new AsyncClient provides support for the new v2 exchange endpoints. AsyncClient in pyinjective.async_client module still provides access to the v1 exchange endpoints.
+- Created a new Composer in the pyinjective.composer_v2 module. This new Composer provides support to create exchange v2 objects. Composer in pyinjective.composer module still provides access to the v1 exchange objects.
+- Created the IndexerClient class to have all indexer queries. AsyncClient v2 now does not include any logic related to the indexer endpoints. The original AsyncClient still does support indexer endpoints (for backwards compatibility) but it does that by using an instance of the IndexerClient
 
 ### Removed
 - Removed all methods marked as deprecated in AsyncClient and Composer

Makefile

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

README.md

@@ -70,6 +70,62 @@ Upgrade `pip` to the latest version, if you see these warnings:
 poetry run pytest -v
 ```
 
+---
+
+## Choose Exchange V1 or Exchange V2 queries
+
+The Injective Python SDK provides two different clients for interacting with the exchange:
+
+1. **Exchange V1 Client** (`async_client` module):
+   - Use this client if you need to interact with the original Injective Exchange API
+   - Import using: `from injective.async_client import AsyncClient`
+   - Suitable for applications that need to maintain compatibility with the original exchange interface
+   - Example:
+   ```python
+   from injective.async_client import AsyncClient
+   from injective.network import Network
+
+   async def main():
+       # Initialize client with mainnet
+       client = AsyncClient(network=Network.mainnet())
+       # Or use testnet
+       # client = AsyncClient(network=Network.testnet())
+       # Use V1 exchange queries here
+   ```
+
+2. **Exchange V2 Client** (`async_client_v2` module):
+   - Use this client for the latest exchange features and improvements
+   - Import using: `from injective.async_client_v2 import AsyncClient`
+   - Recommended for new applications and when you need access to the latest exchange features
+   - Example:
+   ```python
+   from injective.async_client_v2 import AsyncClient
+   from injective.network import Network
+
+   async def main():
+       # Initialize client with mainnet
+       client = AsyncClient(network=Network.mainnet())
+       # Or use testnet
+       # client = AsyncClient(network=Network.testnet())
+       # Use V2 exchange queries here
+   ```
+
+Both clients provide similar interfaces but with different underlying implementations. Choose V2 for new projects unless you have specific requirements for V1 compatibility.
+
+> **Market Format Differences**:
+> - V1 AsyncClient: Markets are initialized with values in chain format (raw blockchain values)
+> - V2 AsyncClient: Markets are initialized with values in human-readable format (converted to standard decimal numbers)
+>
+> **Exchange Endpoint Format Differences**:
+> - V1 Exchange endpoints: All values (amounts, prices, margins, notionals) are returned in chain format
+> - V2 Exchange endpoints:
+>   - Human-readable format for: amounts, prices, margins, and notionals
+>   - Chain format for: deposit-related information (to maintain consistency with the Bank module)
+>
+> **Important Note**: The ChainClient (V1) will not receive any new endpoints added to the Exchange module. If you need access to new exchange-related endpoints or features, you should migrate to the V2 client. The V2 client ensures you have access to all the latest exchange functionality and improvements.
+
+___
+
 ## License
 
 Copyright © 2021 - 2025 Injective Labs Inc. (https://injectivelabs.org/)

buf.gen.yaml

@@ -14,7 +14,7 @@ inputs:
   - git_repo: https://github.com/InjectiveLabs/ibc-go
     tag: v8.7.0-evm-comet1-inj
   - git_repo: https://github.com/InjectiveLabs/wasmd
-    tag: v0.53.2-evm-comet1-inj
+    tag: v0.53.3-evm-comet1-inj
   - git_repo: https://github.com/InjectiveLabs/cometbft
     tag: v1.0.1-inj.2
   - git_repo: https://github.com/InjectiveLabs/cosmos-sdk
@@ -23,7 +23,7 @@ inputs:
 #    branch: v0.51.x-inj
 #    subdir: proto
   - git_repo: https://github.com/InjectiveLabs/injective-core
-    tag: v1.16.0-beta.2
+    tag: v1.16.0-beta.3
     subdir: proto
 #  - git_repo: https://github.com/InjectiveLabs/injective-core
 #    branch: master

examples/chain_client/1_LocalOrderHash.py

@@ -5,7 +5,7 @@
 
 import dotenv
 
-from pyinjective.async_client import AsyncClient
+from pyinjective.async_client_v2 import AsyncClient
 from pyinjective.constant import GAS_FEE_BUFFER_AMOUNT
 from pyinjective.core.network import Network
 from pyinjective.orderhash import OrderHashManager
@@ -41,7 +41,7 @@ async def main() -> None:
     fee_recipient = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
 
     spot_orders = [
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -50,7 +50,7 @@ async def main() -> None:
             order_type="BUY",
             cid=str(uuid.uuid4()),
         ),
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -62,7 +62,7 @@ async def main() -> None:
     ]
 
     derivative_orders = [
-        composer.create_derivative_order_v2(
+        composer.derivative_order(
             market_id=deriv_market_id,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -74,7 +74,7 @@ async def main() -> None:
             order_type="BUY",
             cid=str(uuid.uuid4()),
         ),
-        composer.create_derivative_order_v2(
+        composer.derivative_order(
             market_id=deriv_market_id,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -89,9 +89,9 @@ async def main() -> None:
     ]
 
     # prepare tx msg
-    spot_msg = composer.msg_batch_create_spot_limit_orders_v2(sender=address.to_acc_bech32(), orders=spot_orders)
+    spot_msg = composer.msg_batch_create_spot_limit_orders(sender=address.to_acc_bech32(), orders=spot_orders)
 
-    deriv_msg = composer.msg_batch_create_derivative_limit_orders_v2(
+    deriv_msg = composer.msg_batch_create_derivative_limit_orders(
         sender=address.to_acc_bech32(), orders=derivative_orders
     )
 
@@ -178,7 +178,7 @@ async def main() -> None:
     print("gas fee: {} INJ".format(gas_fee))
 
     spot_orders = [
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id,
             subaccount_id=subaccount_id_2,
             fee_recipient=fee_recipient,
@@ -187,7 +187,7 @@ async def main() -> None:
             order_type="BUY_PO",
             cid=str(uuid.uuid4()),
         ),
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id,
             subaccount_id=subaccount_id_2,
             fee_recipient=fee_recipient,
@@ -199,7 +199,7 @@ async def main() -> None:
     ]
 
     derivative_orders = [
-        composer.create_derivative_order_v2(
+        composer.derivative_order(
             market_id=deriv_market_id,
             subaccount_id=subaccount_id_2,
             fee_recipient=fee_recipient,
@@ -211,7 +211,7 @@ async def main() -> None:
             order_type="BUY",
             cid=str(uuid.uuid4()),
         ),
-        composer.create_derivative_order_v2(
+        composer.derivative_order(
             market_id=deriv_market_id,
             subaccount_id=subaccount_id_2,
             fee_recipient=fee_recipient,
@@ -226,9 +226,9 @@ async def main() -> None:
     ]
 
     # prepare tx msg
-    spot_msg = composer.msg_batch_create_spot_limit_orders_v2(sender=address.to_acc_bech32(), orders=spot_orders)
+    spot_msg = composer.msg_batch_create_spot_limit_orders(sender=address.to_acc_bech32(), orders=spot_orders)
 
-    deriv_msg = composer.msg_batch_create_derivative_limit_orders_v2(
+    deriv_msg = composer.msg_batch_create_derivative_limit_orders(
         sender=address.to_acc_bech32(), orders=derivative_orders
     )
 

examples/chain_client/3_MessageBroadcaster.py

@@ -6,7 +6,7 @@
 
 import dotenv
 
-from pyinjective.async_client import AsyncClient
+from pyinjective.async_client_v2 import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import PrivateKey
@@ -45,7 +45,7 @@ async def main() -> None:
     spot_market_id_create = "0x0611780ba69656949525013d947713300f56c37b6175e02f26bffa495c3208fe"
 
     spot_orders_to_create = [
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id_create,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -54,7 +54,7 @@ async def main() -> None:
             order_type="BUY",
             cid=(str(uuid.uuid4())),
         ),
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id_create,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -66,7 +66,7 @@ async def main() -> None:
     ]
 
     # prepare tx msg
-    msg = composer.msg_batch_update_orders_v2(
+    msg = composer.msg_batch_update_orders(
         sender=address.to_acc_bech32(),
         spot_orders_to_create=spot_orders_to_create,
     )

examples/chain_client/4_MessageBroadcasterWithGranteeAccount.py

@@ -6,7 +6,7 @@
 
 import dotenv
 
-from pyinjective.async_client import AsyncClient
+from pyinjective.async_client_v2 import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import Address, PrivateKey
@@ -48,7 +48,7 @@ async def main() -> None:
     granter_address = Address.from_acc_bech32(granter_inj_address)
     granter_subaccount_id = granter_address.get_subaccount_id(index=0)
 
-    msg = composer.msg_create_spot_limit_order_v2(
+    msg = composer.msg_create_spot_limit_order(
         market_id=market_id,
         sender=granter_inj_address,
         subaccount_id=granter_subaccount_id,

examples/chain_client/5_MessageBroadcasterWithoutSimulation.py

@@ -6,7 +6,7 @@
 
 import dotenv
 
-from pyinjective.async_client import AsyncClient
+from pyinjective.async_client_v2 import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import PrivateKey
@@ -46,7 +46,7 @@ async def main() -> None:
     spot_market_id_create = "0x0611780ba69656949525013d947713300f56c37b6175e02f26bffa495c3208fe"
 
     spot_orders_to_create = [
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id_create,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -55,7 +55,7 @@ async def main() -> None:
             order_type="BUY",
             cid=str(uuid.uuid4()),
         ),
-        composer.create_spot_order_v2(
+        composer.spot_order(
             market_id=spot_market_id_create,
             subaccount_id=subaccount_id,
             fee_recipient=fee_recipient,
@@ -67,7 +67,7 @@ async def main() -> None:
     ]
 
     # prepare tx msg
-    msg = composer.msg_batch_update_orders_v2(
+    msg = composer.msg_batch_update_orders(
         sender=address.to_acc_bech32(),
         spot_orders_to_create=spot_orders_to_create,
     )

examples/chain_client/6_MessageBroadcasterWithGranteeAccountWithoutSimulation.py

@@ -6,7 +6,7 @@
 
 import dotenv
 
-from pyinjective.async_client import AsyncClient
+from pyinjective.async_client_v2 import AsyncClient
 from pyinjective.core.broadcaster import MsgBroadcasterWithPk
 from pyinjective.core.network import Network
 from pyinjective.wallet import Address, PrivateKey
@@ -46,7 +46,7 @@ async def main() -> None:
     granter_address = Address.from_acc_bech32(granter_inj_address)
     granter_subaccount_id = granter_address.get_subaccount_id(index=0)
 
-    msg = composer.msg_create_spot_limit_order_v2(
+    msg = composer.msg_create_spot_limit_order(
         market_id=market_id,
         sender=granter_inj_address,
         subaccount_id=granter_subaccount_id,