Merge pull request #16 from iotaledger/develop

1.0.0b7

Author: todofixthis

examples/shell.py

@@ -7,17 +7,25 @@
 
 from argparse import ArgumentParser
 from getpass import getpass as secure_input
-from sys import argv
+from logging import INFO, basicConfig, getLogger
+from sys import argv, stderr
 
-from iota import __version__
 from six import text_type
 
 # Import all IOTA symbols into module scope, so that it's more
 # convenient for the user.
 from iota import *
 
+from iota import __version__
+from iota.adapter import resolve_adapter
+from iota.adapter.wrappers import LogWrapper, RoutingWrapper
+
 
-def main(uri, testnet):
+basicConfig(level=INFO, stream=stderr)
+
+
+def main(uri, testnet, pow_uri, debug_requests):
+  # type: (Text, bool, Text, bool) -> None
   seed = secure_input(
     'Enter seed and press return (typing will not be shown).\n'
     'If no seed is specified, a random one will be used instead.\n'
@@ -26,7 +34,17 @@ def main(uri, testnet):
   if isinstance(seed, text_type):
     seed = seed.encode('ascii')
 
-  iota = Iota(uri, seed=seed, testnet=testnet)
+  # If ``pow_uri`` is specified, route POW requests to a separate node.
+  adapter_ = create_adapter(uri, debug_requests)
+  if pow_uri:
+    pow_adapter = create_adapter(pow_uri, debug_requests)
+
+    adapter_ =\
+      RoutingWrapper(adapter_)\
+        .add_route('attachToTangle', pow_adapter)\
+        .add_route('interruptAttachingToTangle', pow_adapter)
+
+  iota = Iota(adapter_, seed=seed, testnet=testnet)
 
   _banner = (
     'IOTA API client for {uri} ({testnet}) initialized as variable `iota`.\n'
@@ -39,6 +57,26 @@ def main(uri, testnet):
   start_shell(iota, _banner)
 
 
+def create_adapter(uri, debug):
+  # type: (Text, bool) -> BaseAdapter
+  """
+  Creates an adapter with the specified settings.
+
+  :param uri:
+    Node URI.
+
+  :param debug:
+    Whether to attach a LogWrapper to the adapter.
+  """
+  adapter_ = resolve_adapter(uri)
+
+  return (
+    LogWrapper(adapter_, getLogger(__name__), INFO)
+      if debug
+      else adapter_
+  )
+
+
 def start_shell(iota, _banner):
   """
   Starts the shell with limited scope.
@@ -71,11 +109,27 @@ def start_shell(iota, _banner):
         '(defaults to udp://localhost:14265/).',
   )
 
+  parser.add_argument(
+    '--pow-uri',
+      type    = text_type,
+      default = None,
+      dest    = 'pow_uri',
+      help    = 'URI of node to send POW requests to.'
+  )
+
   parser.add_argument(
     '--testnet',
       action  = 'store_true',
       default = False,
-      help    = 'If specified, use testnet settings (e.g., for PoW).',
+      help    = 'If set, use testnet settings (e.g., for PoW).',
+  )
+
+  parser.add_argument(
+    '--debug',
+      action  = 'store_true',
+      default = False,
+      dest    = 'debug_requests',
+      help    = 'If set, log HTTP requests to stderr.'
   )
 
   main(**vars(parser.parse_args(argv[1:])))

setup.py

@@ -28,7 +28,7 @@
   name        = 'PyOTA',
   description = 'IOTA API library for Python',
   url         = 'https://github.com/iotaledger/iota.lib.py',
-  version     = '1.0.0b6',
+  version     = '1.0.0b7',
 
   packages              = find_packages('src'),
   include_package_data  = True,

src/iota/adapter/wrappers.py

@@ -4,16 +4,19 @@
 
 from abc import ABCMeta, abstractmethod as abstract_method
 from logging import INFO, Logger
+from typing import Dict, Text
 
-from iota.adapter import AdapterSpec, BaseAdapter, resolve_adapter
 from six import with_metaclass
 
+from iota.adapter import AdapterSpec, BaseAdapter, resolve_adapter
+
 __all__ = [
   'LogWrapper',
+  'RoutingWrapper',
 ]
 
 
-class BaseWrapper(with_metaclass(ABCMeta)):
+class BaseWrapper(with_metaclass(ABCMeta, BaseAdapter)):
   """
   Base functionality for "adapter wrappers", used to extend the
   functionality of IOTA adapters.
@@ -68,3 +71,69 @@ def send_request(self, payload, **kwargs):
     ))
 
     return response
+
+
+class RoutingWrapper(BaseWrapper):
+  """
+  Routes commands to different nodes.
+
+  This allows you to, for example, send POW requests to a local node,
+  while routing all other requests to a remote one.
+
+  Example::
+
+     # Route POW to localhost, everything else to 12.34.56.78.
+     iota = Iota(
+       RoutingWrapper('http://12.34.56.78:14265')
+         .add_route('attachToTangle', 'http://localhost:14265')
+         .add_route('interruptAttachingToTangle', 'http://localhost:14265')
+       ),
+     )
+  """
+  def __init__(self, default_adapter):
+    # type: (AdapterSpec) -> None
+    """
+    :param default_adapter:
+      Adapter to use for any routes not listed in ``routes``.
+    """
+    super(RoutingWrapper, self).__init__(default_adapter)
+
+    # Try to limit the number of distinct adapter instances we create
+    # when resolving URIs.
+    self.adapter_aliases = {} # type: Dict[AdapterSpec, BaseAdapter]
+
+    self.routes = {} # type: Dict[Text, BaseAdapter]
+
+  def add_route(self, command, adapter):
+    # type: (Text, AdapterSpec) -> RoutingWrapper
+    """
+    Adds a route to the wrapper.
+
+    :param command:
+      The name of the command to route (e.g., "attachToTangle").
+
+    :param adapter:
+      The adapter object or URI to route requests to.
+    """
+    if not isinstance(adapter, BaseAdapter):
+      try:
+        adapter = self.adapter_aliases[adapter]
+      except KeyError:
+        self.adapter_aliases[adapter] = adapter = resolve_adapter(adapter)
+
+    self.routes[command] = adapter
+
+    return self
+
+  def get_adapter(self, command):
+    # type: (Text) -> BaseAdapter
+    """
+    Return the adapter for the specified command.
+    """
+    return self.routes.get(command, self.adapter)
+
+  def send_request(self, payload, **kwargs):
+    # type: (dict, dict) -> dict
+    command = payload.get('command')
+
+    return self.get_adapter(command).send_request(payload, **kwargs)

src/iota/api.py

@@ -112,10 +112,10 @@ def attach_to_tangle(
       min_weight_magnitude = self.default_min_weight_magnitude
 
     return self.attachToTangle(
-      trunk_transaction     = trunk_transaction,
-      branch_transaction    = branch_transaction,
-      min_weight_magnitude  = min_weight_magnitude,
-      trytes                = trytes,
+      trunkTransaction    = trunk_transaction,
+      branchTransaction   = branch_transaction,
+      minWeightMagnitude  = min_weight_magnitude,
+      trytes              = trytes,
     )
 
   def broadcast_transactions(self, trytes):
@@ -524,10 +524,10 @@ def get_transfers(self, start=0, stop=None, inclusion_states=False):
       - https://github.com/iotaledger/wiki/blob/master/api-proposal.md#gettransfers
     """
     return self.getTransfers(
-      seed              = self.seed,
-      start             = start,
-      stop              = stop,
-      inclusion_states  = inclusion_states,
+      seed            = self.seed,
+      start           = start,
+      stop            = stop,
+      inclusionStates = inclusion_states,
     )
 
   def prepare_transfer(self, transfers, inputs=None, change_address=None):
@@ -567,10 +567,10 @@ def prepare_transfer(self, transfers, inputs=None, change_address=None):
       - https://github.com/iotaledger/wiki/blob/master/api-proposal.md#preparetransfers
     """
     return self.prepareTransfer(
-      seed            = self.seed,
-      transfers       = transfers,
-      inputs          = inputs,
-      change_address  = change_address,
+      seed          = self.seed,
+      transfers     = transfers,
+      inputs        = inputs,
+      changeAddress = change_address,
     )
 
   def replay_bundle(
@@ -607,9 +607,9 @@ def replay_bundle(
       min_weight_magnitude = self.default_min_weight_magnitude
 
     return self.replayBundle(
-      transaction           = transaction,
-      depth                 = depth,
-      min_weight_magnitude  = min_weight_magnitude,
+      transaction         = transaction,
+      depth               = depth,
+      minWeightMagnitude  = min_weight_magnitude,
     )
 
   def send_transfer(
@@ -659,12 +659,12 @@ def send_transfer(
       min_weight_magnitude = self.default_min_weight_magnitude
 
     return self.sendTransfer(
-      seed                  = self.seed,
-      depth                 = depth,
-      transfers             = transfers,
-      inputs                = inputs,
-      change_address        = change_address,
-      min_weight_magnitude  = min_weight_magnitude,
+      seed                = self.seed,
+      depth               = depth,
+      transfers           = transfers,
+      inputs              = inputs,
+      changeAddress       = change_address,
+      minWeightMagnitude  = min_weight_magnitude,
     )
 
   def send_trytes(self, trytes, depth, min_weight_magnitude=18):
@@ -690,7 +690,7 @@ def send_trytes(self, trytes, depth, min_weight_magnitude=18):
       - https://github.com/iotaledger/wiki/blob/master/api-proposal.md#sendtrytes
     """
     return self.sendTrytes(
-      trytes                = trytes,
-      depth                 = depth,
-      min_weight_magnitude  = min_weight_magnitude,
+      trytes              = trytes,
+      depth               = depth,
+      minWeightMagnitude  = min_weight_magnitude,
     )

src/iota/commands/core/attach_to_tangle.py

@@ -30,8 +30,8 @@ def get_response_filter(self):
 class AttachToTangleRequestFilter(RequestFilter):
   def __init__(self):
     super(AttachToTangleRequestFilter, self).__init__({
-      'branch_transaction': f.Required | Trytes(result_type=TransactionHash),
-      'trunk_transaction':  f.Required | Trytes(result_type=TransactionHash),
+      'branchTransaction': f.Required | Trytes(result_type=TransactionHash),
+      'trunkTransaction':  f.Required | Trytes(result_type=TransactionHash),
 
       'trytes':
           f.Required
@@ -40,12 +40,16 @@ def __init__(self):
 
       # Loosely-validated; testnet nodes require a different value than
       # mainnet.
-      'min_weight_magnitude': f.Required| f.Type(int) | f.Min(1),
+      'minWeightMagnitude': f.Required| f.Type(int) | f.Min(1),
     })
 
 
 class AttachToTangleResponseFilter(ResponseFilter):
   def __init__(self):
     super(AttachToTangleResponseFilter, self).__init__({
-      'trytes': f.FilterRepeater(f.ByteString(encoding='ascii') | Trytes),
+      'trytes':
+        f.FilterRepeater(
+            f.ByteString(encoding='ascii')
+          | Trytes(result_type=TransactionTrytes)
+        ),
     })

src/iota/commands/core/broadcast_transactions.py

@@ -3,8 +3,9 @@
   unicode_literals
 
 import filters as f
+
 from iota import TransactionTrytes
-from iota.commands import FilterCommand, RequestFilter, ResponseFilter
+from iota.commands import FilterCommand, RequestFilter
 from iota.filters import Trytes
 
 __all__ = [
@@ -24,7 +25,7 @@ def get_request_filter(self):
     return BroadcastTransactionsRequestFilter()
 
   def get_response_filter(self):
-    return BroadcastTransactionsResponseFilter()
+    pass
 
 
 class BroadcastTransactionsRequestFilter(RequestFilter):
@@ -35,10 +36,3 @@ def __init__(self):
         | f.Array
         | f.FilterRepeater(f.Required | Trytes(result_type=TransactionTrytes)),
     })
-
-
-class BroadcastTransactionsResponseFilter(ResponseFilter):
-  def __init__(self):
-    super(BroadcastTransactionsResponseFilter, self).__init__({
-      'trytes': f.FilterRepeater(f.ByteString(encoding='ascii') | Trytes),
-    })

src/iota/commands/extended/broadcast_and_store.py

@@ -28,4 +28,7 @@ def get_response_filter(self):
 
   def _execute(self, request):
     BroadcastTransactionsCommand(self.adapter)(**request)
-    return StoreTransactionsCommand(self.adapter)(**request)
+    StoreTransactionsCommand(self.adapter)(**request)
+    return {
+      'trytes': request['trytes'],
+    }

src/iota/commands/extended/get_transfers.py

@@ -37,7 +37,7 @@ def get_response_filter(self):
 
   def _execute(self, request):
     stop              = request['stop'] # type: Optional[int]
-    inclusion_states  = request['inclusion_states'] # type: bool
+    inclusion_states  = request['inclusionStates'] # type: bool
     seed              = request['seed'] # type: Seed
     start             = request['start'] # type: int
 
@@ -165,12 +165,12 @@ def __init__(self):
         'stop':   f.Type(int) | f.Min(0),
         'start':  f.Type(int) | f.Min(0) | f.Optional(0),
 
-        'inclusion_states': f.Type(bool) | f.Optional(False),
+        'inclusionStates': f.Type(bool) | f.Optional(False),
       },
 
       allow_missing_keys = {
         'stop',
-        'inclusion_states',
+        'inclusionStates',
         'start',
       },
     )