Merge pull request #226 from InjectiveLabs/feat/message_broadcaster_without_simulation

Feat/message broadcaster without simulation

Author: aarmoa

README.md

@@ -87,14 +87,17 @@ make tests
 ```
 
 ### Changelogs
+**0.7.2**
+* Added a new gas limit calculation for the TransactionBroadcaster that estimates the value based on the messages in the transaction (without running the transaction simulation).
+
 **0.7.1.2**
 * Add NBLA
 
 **0.7.1.1**
 * Fixed Testnet network URLs
 
 **0.7.1**
-* Include implementation of the MessageBroadcaster, to simplify the transaction creation and broadcasting process.
+* Include implementation of the TransactionBroadcaster, to simplify the transaction creation and broadcasting process.
 
 **0.7.0.6**
 * ADD SEI/USDT in metadata

examples/chain_client/46_MessageBroadcasterWithoutSimulation.py

@@ -0,0 +1,64 @@
+import asyncio
+
+from pyinjective.composer import Composer as ProtoMsgComposer
+from pyinjective.core.broadcaster import MsgBroadcasterWithPk
+from pyinjective.constant import Network
+from pyinjective.wallet import PrivateKey
+
+
+async def main() -> None:
+    # select network: local, testnet, mainnet
+    network = Network.testnet()
+    composer = ProtoMsgComposer(network=network.string())
+    private_key_in_hexa = "f9db9bf330e23cb7839039e944adef6e9df447b90b503d5b4464c90bea9022f3"
+
+    message_broadcaster = MsgBroadcasterWithPk.new_without_simulation(
+        network=network,
+        private_key=private_key_in_hexa,
+        use_secure_connection=True
+    )
+
+    priv_key = PrivateKey.from_hex(private_key_in_hexa)
+    pub_key = priv_key.to_public_key()
+    address = pub_key.to_address()
+    subaccount_id = address.get_subaccount_id(index=0)
+
+    # prepare trade info
+    fee_recipient = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+
+    spot_market_id_create = "0x0611780ba69656949525013d947713300f56c37b6175e02f26bffa495c3208fe"
+
+    spot_orders_to_create = [
+        composer.SpotOrder(
+            market_id=spot_market_id_create,
+            subaccount_id=subaccount_id,
+            fee_recipient=fee_recipient,
+            price=3,
+            quantity=55,
+            is_buy=True,
+            is_po=False
+        ),
+        composer.SpotOrder(
+            market_id=spot_market_id_create,
+            subaccount_id=subaccount_id,
+            fee_recipient=fee_recipient,
+            price=300,
+            quantity=55,
+            is_buy=False,
+            is_po=False
+        ),
+    ]
+
+    # prepare tx msg
+    msg = composer.MsgBatchUpdateOrders(
+        sender=address.to_acc_bech32(),
+        spot_orders_to_create=spot_orders_to_create,
+    )
+
+    # broadcast the transaction
+    result = await message_broadcaster.broadcast([msg])
+    print("---Transaction Response---")
+    print(result)
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())

examples/chain_client/47_MessageBroadcasterWithGranteeAccountWithoutSimulation.py

@@ -0,0 +1,54 @@
+import asyncio
+
+from pyinjective.composer import Composer as ProtoMsgComposer
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.broadcaster import MsgBroadcasterWithPk
+from pyinjective.constant import Network
+from pyinjective.wallet import PrivateKey, Address
+
+
+async def main() -> None:
+    # select network: local, testnet, mainnet
+    network = Network.testnet()
+    composer = ProtoMsgComposer(network=network.string())
+
+    # initialize grpc client
+    client = AsyncClient(network, insecure=False)
+    await client.sync_timeout_height()
+
+    # load account
+    private_key_in_hexa = "5d386fbdbf11f1141010f81a46b40f94887367562bd33b452bbaa6ce1cd1381e"
+    priv_key = PrivateKey.from_hex(private_key_in_hexa)
+    pub_key = priv_key.to_public_key()
+    address = pub_key.to_address()
+
+    message_broadcaster = MsgBroadcasterWithPk.new_for_grantee_account_without_simulation(
+        network=network,
+        grantee_private_key=private_key_in_hexa,
+        use_secure_connection=True
+    )
+
+    # prepare tx msg
+    market_id = "0x0611780ba69656949525013d947713300f56c37b6175e02f26bffa495c3208fe"
+    granter_inj_address = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+    granter_address = Address.from_acc_bech32(granter_inj_address)
+    granter_subaccount_id = granter_address.get_subaccount_id(index=0)
+
+    msg = composer.MsgCreateSpotLimitOrder(
+        sender=granter_inj_address,
+        market_id=market_id,
+        subaccount_id=granter_subaccount_id,
+        fee_recipient=address.to_acc_bech32(),
+        price=7.523,
+        quantity=0.01,
+        is_buy=True,
+        is_po=False
+    )
+
+    # broadcast the transaction
+    result = await message_broadcaster.broadcast([msg])
+    print("---Transaction Response---")
+    print(result)
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())

pyinjective/async_client.py

@@ -302,7 +302,7 @@ async def get_account(self, address: str) -> Optional[account_pb2.EthAccount]:
         try:
             metadata = await self.load_cookie(type="chain")
             account_any = (await self.stubAuth.Account(
-                auth_query.QueryAccountRequest.__call__(address=address), metadata=metadata
+                auth_query.QueryAccountRequest(address=address), metadata=metadata
             )).account
             account = account_pb2.EthAccount()
             if account_any.Is(account.DESCRIPTOR):
@@ -339,7 +339,7 @@ async def simulate_tx(
         try:
             req = tx_service.SimulateRequest(tx_bytes=tx_byte)
             metadata = await self.load_cookie(type="chain")
-            return await self.stubTx.Simulate.__call__(req, metadata=metadata), True
+            return await self.stubTx.Simulate(request=req, metadata=metadata), True
         except grpc.RpcError as err:
             return err, False
 
@@ -348,23 +348,23 @@ async def send_tx_sync_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_SYNC
         )
         metadata = await self.load_cookie(type="chain")
-        result = await self.stubTx.BroadcastTx.__call__(req, metadata=metadata)
+        result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
     async def send_tx_async_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
         req = tx_service.BroadcastTxRequest(
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_ASYNC
         )
         metadata = await self.load_cookie(type="chain")
-        result = await self.stubTx.BroadcastTx.__call__(req, metadata=metadata)
+        result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
     async def send_tx_block_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
         req = tx_service.BroadcastTxRequest(
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_BLOCK
         )
         metadata = await self.load_cookie(type="chain")
-        result = await self.stubTx.BroadcastTx.__call__(req, metadata=metadata)
+        result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
     async def get_chain_id(self) -> str:
@@ -632,7 +632,7 @@ async def stream_spot_markets(self, **kwargs):
             market_ids=kwargs.get("market_ids")
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamMarkets.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamMarkets(request=req, metadata=metadata)
 
     async def get_spot_orderbookV2(self, market_id: str):
         req = spot_exchange_rpc_pb.OrderbookV2Request(market_id=market_id)
@@ -689,12 +689,12 @@ async def get_spot_trades(self, **kwargs):
     async def stream_spot_orderbook_snapshot(self, market_ids: List[str]):
         req = spot_exchange_rpc_pb.StreamOrderbookV2Request(market_ids=market_ids)
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamOrderbookV2.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamOrderbookV2(request=req, metadata=metadata)
 
     async def stream_spot_orderbook_update(self, market_ids: List[str]):
         req = spot_exchange_rpc_pb.StreamOrderbookUpdateRequest(market_ids=market_ids)
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamOrderbookUpdate.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamOrderbookUpdate(request=req, metadata=metadata)
 
     async def stream_spot_orders(self, market_id: str, **kwargs):
         req = spot_exchange_rpc_pb.StreamOrdersRequest(
@@ -703,7 +703,7 @@ async def stream_spot_orders(self, market_id: str, **kwargs):
             subaccount_id=kwargs.get("subaccount_id"),
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamOrders.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamOrders(request=req, metadata=metadata)
 
     async def stream_historical_spot_orders(self, market_id: str, **kwargs):
         req = spot_exchange_rpc_pb.StreamOrdersHistoryRequest(
@@ -715,7 +715,7 @@ async def stream_historical_spot_orders(self, market_id: str, **kwargs):
             execution_types=kwargs.get("execution_types")
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamOrdersHistory.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamOrdersHistory(request=req, metadata=metadata)
 
     async def stream_historical_derivative_orders(self, market_id: str, **kwargs):
         req = derivative_exchange_rpc_pb.StreamOrdersHistoryRequest(
@@ -727,7 +727,7 @@ async def stream_historical_derivative_orders(self, market_id: str, **kwargs):
             execution_types=kwargs.get("execution_types")
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamOrdersHistory.__call__(req, metadata=metadata)
+        return self.stubDerivativeExchange.StreamOrdersHistory(request=req, metadata=metadata)
 
     async def stream_spot_trades(self, **kwargs):
         req = spot_exchange_rpc_pb.StreamTradesRequest(
@@ -740,7 +740,7 @@ async def stream_spot_trades(self, **kwargs):
             execution_types=kwargs.get("execution_types"),
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubSpotExchange.StreamTrades.__call__(req, metadata=metadata)
+        return self.stubSpotExchange.StreamTrades(request=req, metadata=metadata)
 
     async def get_spot_subaccount_orders(self, subaccount_id: str, **kwargs):
         req = spot_exchange_rpc_pb.SubaccountOrdersListRequest(
@@ -780,7 +780,7 @@ async def stream_derivative_markets(self, **kwargs):
             market_ids=kwargs.get("market_ids")
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamMarket.__call__(req, metadata=metadata)
+        return self.stubDerivativeExchange.StreamMarket(request=req, metadata=metadata)
 
     async def get_derivative_orderbook(self, market_id: str):
         req = derivative_exchange_rpc_pb.OrderbookV2Request(market_id=market_id)
@@ -846,16 +846,12 @@ async def get_derivative_trades(self, **kwargs):
     async def stream_derivative_orderbook_snapshot(self, market_ids: List[str]):
         req = derivative_exchange_rpc_pb.StreamOrderbookV2Request(market_ids=market_ids)
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamOrderbookV2.__call__(
-            req, metadata=metadata
-        )
+        return self.stubDerivativeExchange.StreamOrderbookV2(request=req, metadata=metadata)
 
     async def stream_derivative_orderbook_update(self, market_ids: List[str]):
         req = derivative_exchange_rpc_pb.StreamOrderbookUpdateRequest(market_ids=market_ids)
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamOrderbookUpdate.__call__(
-            req, metadata=metadata
-        )
+        return self.stubDerivativeExchange.StreamOrderbookUpdate(request=req, metadata=metadata)
 
     async def stream_derivative_orders(self, market_id: str, **kwargs):
         req = derivative_exchange_rpc_pb.StreamOrdersRequest(
@@ -864,7 +860,7 @@ async def stream_derivative_orders(self, market_id: str, **kwargs):
             subaccount_id=kwargs.get("subaccount_id"),
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamOrders.__call__(req, metadata=metadata)
+        return self.stubDerivativeExchange.StreamOrders(request=req, metadata=metadata)
 
     async def stream_derivative_trades(self, **kwargs):
         req = derivative_exchange_rpc_pb.StreamTradesRequest(
@@ -879,7 +875,7 @@ async def stream_derivative_trades(self, **kwargs):
             execution_types=kwargs.get("execution_types"),
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamTrades.__call__(req, metadata=metadata)
+        return self.stubDerivativeExchange.StreamTrades(request=req, metadata=metadata)
 
     async def get_derivative_positions(self, **kwargs):
         req = derivative_exchange_rpc_pb.PositionsRequest(
@@ -901,9 +897,7 @@ async def stream_derivative_positions(self, **kwargs):
             subaccount_ids=kwargs.get("subaccount_ids"),
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubDerivativeExchange.StreamPositions.__call__(
-            req, metadata=metadata
-        )
+        return self.stubDerivativeExchange.StreamPositions(request=req, metadata=metadata)
 
     async def get_derivative_liquidable_positions(self, **kwargs):
         req = derivative_exchange_rpc_pb.LiquidablePositionsRequest(
@@ -979,4 +973,4 @@ async def stream_account_portfolio(self, account_address: str, **kwargs):
             type=kwargs.get("type")
         )
         metadata = await self.load_cookie(type="exchange")
-        return self.stubPortfolio.StreamAccountPortfolio.__call__(req, metadata=metadata)
+        return self.stubPortfolio.StreamAccountPortfolio(request=req, metadata=metadata)