Merge pull request #297 from lzpap/remove_tips_from_gis

Fixes #288 Remove tips from `get_inclusion_states`

Author: lzpap

docs/extended_api.rst

@@ -52,11 +52,6 @@ tasks such as sending and receiving transfers.
 .. automethod:: Iota.get_inputs
 .. automethod:: AsyncIota.get_inputs
 
-``get_latest_inclusion``
-------------------------
-.. automethod:: Iota.get_latest_inclusion
-.. automethod:: AsyncIota.get_latest_inclusion
-
 ``get_new_addresses``
 ---------------------
 .. automethod:: Iota.get_new_addresses

iota/api.py

@@ -372,22 +372,16 @@ def get_balances(
     def get_inclusion_states(
             self,
             transactions: Iterable[TransactionHash],
-            tips: Iterable[TransactionHash]
     ) -> dict:
         """
         Get the inclusion states of a set of transactions. This is for
         determining if a transaction was accepted and confirmed by the
-        network or not. You can search for multiple tips (and thus,
-        milestones) to get past inclusion states of transactions.
+        network or not.
 
         :param Iterable[TransactionHash] transactions:
             List of transactions you want to get the inclusion state
             for.
 
-        :param Iterable[TransactionHash] tips:
-            List of tips (including milestones) you want to search for
-            the inclusion state.
-
         :return:
             ``dict`` with the following structure::
 
@@ -410,7 +404,6 @@ def get_inclusion_states(
         return asyncio.get_event_loop().run_until_complete(
                 super().get_inclusion_states(
                         transactions,
-                        tips,
                 )
         )
 
@@ -1201,36 +1194,6 @@ def get_inputs(
                 )
         )
 
-    def get_latest_inclusion(
-            self,
-            hashes: Iterable[TransactionHash]
-    ) -> Dict[str, Dict[TransactionHash, bool]]:
-        """
-        Fetches the inclusion state for the specified transaction
-        hashes, as of the latest milestone that the node has processed.
-
-        Effectively, this is :py:meth:`get_node_info` +
-        :py:meth:`get_inclusion_states`.
-
-        :param Iterable[TransactionHash] hashes:
-            List of transaction hashes.
-
-        :return:
-            ``dict`` with the following structure::
-
-                {
-                    "states": Dict[TransactionHash, bool]
-                        ``dict`` with one boolean per transaction hash in
-                        ``hashes``.
-                }
-
-        """
-        # Execute original coroutine inside an event loop to make this method
-        # synchronous
-        return asyncio.get_event_loop().run_until_complete(
-                super().get_latest_inclusion(hashes)
-        )
-
     def get_new_addresses(
             self,
             index: int = 0,

iota/api_async.py

@@ -369,22 +369,16 @@ async def get_balances(
     async def get_inclusion_states(
             self,
             transactions: Iterable[TransactionHash],
-            tips: Iterable[TransactionHash]
     ) -> dict:
         """
         Get the inclusion states of a set of transactions. This is for
         determining if a transaction was accepted and confirmed by the
-        network or not. You can search for multiple tips (and thus,
-        milestones) to get past inclusion states of transactions.
+        network or not.
 
         :param Iterable[TransactionHash] transactions:
             List of transactions you want to get the inclusion state
             for.
 
-        :param Iterable[TransactionHash] tips:
-            List of tips (including milestones) you want to search for
-            the inclusion state.
-
         :return:
             ``dict`` with the following structure::
 
@@ -403,7 +397,6 @@ async def get_inclusion_states(
         """
         return await core.GetInclusionStatesCommand(self.adapter)(
                 transactions=transactions,
-                tips=tips,
         )
 
     async def get_missing_transactions(self) -> dict:
@@ -1123,32 +1116,6 @@ async def get_inputs(
                 securityLevel=security_level
         )
 
-    async def get_latest_inclusion(
-            self,
-            hashes: Iterable[TransactionHash]
-    ) -> Dict[str, Dict[TransactionHash, bool]]:
-        """
-        Fetches the inclusion state for the specified transaction
-        hashes, as of the latest milestone that the node has processed.
-
-        Effectively, this is :py:meth:`get_node_info` +
-        :py:meth:`get_inclusion_states`.
-
-        :param Iterable[TransactionHash] hashes:
-            List of transaction hashes.
-
-        :return:
-            ``dict`` with the following structure::
-
-                {
-                    "states": Dict[TransactionHash, bool]
-                        ``dict`` with one boolean per transaction hash in
-                        ``hashes``.
-                }
-
-        """
-        return await extended.GetLatestInclusionCommand(self.adapter)(hashes=hashes)
-
     async def get_new_addresses(
             self,
             index: int = 0,

iota/commands/core/get_inclusion_states.py

@@ -31,14 +31,5 @@ def __init__(self) -> None:
                 # Required parameters.
                 'transactions':
                     StringifiedTrytesArray(TransactionHash) | f.Required,
-
-                # Optional parameters.
-                'tips':
-                    StringifiedTrytesArray(TransactionHash) |
-                    f.Optional(default=[]),
-            },
-
-            allow_missing_keys={
-                'tips',
             },
         )

iota/commands/extended/__init__.py

@@ -14,7 +14,6 @@
 from .get_account_data import *
 from .get_bundles import *
 from .get_inputs import *
-from .get_latest_inclusion import *
 from .get_new_addresses import *
 from .get_transaction_objects import *
 from .get_transfers import *

iota/commands/extended/get_latest_inclusion.py

@@ -4,9 +4,9 @@
 
 from iota import Address
 from iota.commands import FilterCommand, RequestFilter, ResponseFilter
-from iota.commands.extended import FindTransactionObjectsCommand, \
-    GetLatestInclusionCommand
-from iota.filters import StringifiedTrytesArray
+from iota.commands.extended import FindTransactionObjectsCommand
+from iota.commands.core import GetInclusionStatesCommand
+from iota.filters import Trytes, StringifiedTrytesArray
 
 __all__ = [
     'IsReattachableCommand',
@@ -48,14 +48,15 @@ async def _execute(self, request: dict) -> dict:
         }
 
         # Fetch inclusion states.
-        inclusion_states = await GetLatestInclusionCommand(adapter=self.adapter)(
-            hashes=list(transaction_map.values()),
+        inclusion_states = GetInclusionStatesCommand(adapter=self.adapter)(
+            transactions=list(transaction_map.values()),
         )
-        inclusion_states = inclusion_states['states']
+        inclusion_states_map = dict(zip(
+            list(transaction_map.keys()), inclusion_states['states']))
 
         return {
             'reattachable': [
-                not inclusion_states[transaction_map[address]]
+                not inclusion_states_map[address]
                 for address in addresses
             ],
         }

iota/commands/extended/is_reattachable.py

@@ -10,8 +10,8 @@
     WereAddressesSpentFromCommand
 from iota.commands.extended import FindTransactionObjectsCommand
 from iota.commands.extended.get_bundles import GetBundlesCommand
-from iota.commands.extended.get_latest_inclusion import \
-    GetLatestInclusionCommand
+from iota.commands.core.get_inclusion_states import \
+    GetInclusionStatesCommand
 from iota.crypto.addresses import AddressGenerator
 from iota.crypto.types import Seed
 
@@ -123,12 +123,12 @@ async def get_bundles_from_transaction_hashes(
 
     # Attach inclusion states, if requested.
     if inclusion_states:
-        gli_response = await GetLatestInclusionCommand(adapter)(
-            hashes=list(tail_transaction_hashes),
+        gli_response = await GetInclusionStatesCommand(adapter)(
+            transactions=list(tail_transaction_hashes),
         )
 
-        for txn in tail_transactions:
-            txn.is_confirmed = gli_response['states'].get(txn.hash)
+        for txn, state in zip(tail_transactions, gli_response['states']):
+            txn.is_confirmed = state
 
     # Find the bundles for each transaction.
     txn_bundles: List[Bundle] = (await GetBundlesCommand(adapter)(