Add TODO for odds and ends

Author: cpacia

constants.py

@@ -1,8 +1,9 @@
 from os.path import expanduser
 
-# This should be turned into a more formal context module
+# TODO: this can be loaded from a config file
 
 DATA_FOLDER = expanduser("~") + "/OpenBazaar/"
 SEED_NODE = ("205.186.154.163", 18467)
 SEED_NODE_TESTNET = ("205.186.154.163", 28467)
-
+KSIZE = 20
+ALPHA = 3

dht/constants.py

@@ -353,6 +353,8 @@ def loadState(cls, fname, ip_address, port, multiplexer, db, callback=None, stor
                 s.bootstrap(data['neighbors']).addCallback(callback)
             else:
                 s.bootstrap(data['neighbors'])
+
+        # TODO: if bootstrapping fails because all our cached nodes are dead, then query the seed again
         return s
 
     def saveStateRegularly(self, fname, frequency=600):

dht/network.py

@@ -1,7 +1,6 @@
 __author__ = 'chris'
 from binascii import unhexlify
 
-import dht.constants
 import mock
 import nacl.signing
 import nacl.hash
@@ -16,6 +15,7 @@
 from protos.objects import Value
 from wireprotocol import OpenBazaarProtocol
 from db.datastore import Database
+from constants import ALPHA, KSIZE
 
 
 class ValueSpiderCrawlTest(unittest.TestCase):
@@ -80,8 +80,7 @@ def test_find(self):
 
         node = Node(digest("s"))
         nearest = self.protocol.router.findNeighbors(node)
-        spider = ValueSpiderCrawl(self.protocol, node, nearest,
-                                  dht.constants.KSIZE, dht.constants.ALPHA)
+        spider = ValueSpiderCrawl(self.protocol, node, nearest, KSIZE, ALPHA)
         spider.find()
 
         self.clock.advance(100 * constants.PACKET_TIMEOUT)
@@ -101,7 +100,7 @@ def test_nodesFound(self):
         # test resonse with uncontacted nodes
         node = Node(digest("s"))
         nearest = self.protocol.router.findNeighbors(node)
-        spider = ValueSpiderCrawl(self.protocol, node, nearest, dht.constants.KSIZE, dht.constants.ALPHA)
+        spider = ValueSpiderCrawl(self.protocol, node, nearest, KSIZE, ALPHA)
         response = (True, (self.node1.getProto().SerializeToString(), self.node2.getProto().SerializeToString(),
                            self.node3.getProto().SerializeToString()))
         responses = {self.node1.id: response}
@@ -111,7 +110,7 @@ def test_nodesFound(self):
         self.assertEqual(len(self.proto_mock.send_datagram.call_args_list), 4)
 
         # test all been contacted
-        spider = ValueSpiderCrawl(self.protocol, node, nearest, dht.constants.KSIZE, dht.constants.ALPHA)
+        spider = ValueSpiderCrawl(self.protocol, node, nearest, KSIZE, ALPHA)
         for peer in spider.nearest.getUncontacted():
             spider.nearest.markContacted(peer)
         response = (True, (self.node1.getProto().SerializeToString(), self.node2.getProto().SerializeToString(),
@@ -121,7 +120,7 @@ def test_nodesFound(self):
         self.assertTrue(resp is None)
 
         # test didn't happen
-        spider = ValueSpiderCrawl(self.protocol, node, nearest, dht.constants.KSIZE, dht.constants.ALPHA)
+        spider = ValueSpiderCrawl(self.protocol, node, nearest, KSIZE, ALPHA)
         response = (False, (self.node1.getProto().SerializeToString(), self.node2.getProto().SerializeToString(),
                             self.node3.getProto().SerializeToString()))
         responses = {self.node1.id: response}
@@ -148,7 +147,7 @@ def test_handleFoundValues(self):
 
         node = Node(digest("s"))
         nearest = self.protocol.router.findNeighbors(node)
-        spider = ValueSpiderCrawl(self.protocol, node, nearest, dht.constants.KSIZE, dht.constants.ALPHA)
+        spider = ValueSpiderCrawl(self.protocol, node, nearest, KSIZE, ALPHA)
         val = Value()
         val.valueKey = digest("contractID")
         val.serializedData = self.node1.getProto().SerializeToString()

dht/tests/test_crawling.py

@@ -12,14 +12,13 @@
 import requests
 from autobahn.twisted.websocket import listenWS
 
-import dht.constants
 import obelisk
 from db.datastore import Database
 from keyutils.keys import KeyChain
 from dht.network import Server
 from dht.node import Node
 from wireprotocol import OpenBazaarProtocol
-from constants import DATA_FOLDER
+from constants import DATA_FOLDER, KSIZE, ALPHA
 from market import network
 from market.listeners import MessageListenerImpl, NotificationListenerImpl
 from api.ws import WSFactory, WSProtocol
@@ -37,18 +36,27 @@ def run(*args):
     keys = KeyChain(db)
 
     # logging
+    # TODO: prune this log file and prevent it from getting too large?
     logFile = logfile.LogFile.fromFullPath(DATA_FOLDER + "debug.log")
     log.addObserver(log.FileLogObserver(logFile).emit)
     log.startLogging(sys.stdout)
 
     # stun
+    # TODO: accept port from command line
     port = 18467 if not TESTNET else 28467
     print "Finding NAT Type.."
+    # TODO: maintain a list of backup STUN servers and try them if ours fails
     response = stun.get_ip_info(stun_host="seed.openbazaar.org", source_port=port)
     print "%s on %s:%s" % (response[0], response[1], response[2])
     ip_address = response[1]
     port = response[2]
 
+    # TODO: try UPnP if restricted NAT
+
+    # TODO: maintain open connection to seed node if STUN/UPnP fail
+
+    # TODO: use TURN of symmetric NAT
+
     def on_bootstrap_complete(resp):
         mlistener = MessageListenerImpl(ws_factory, db)
         mserver.get_messages(mlistener)
@@ -65,13 +73,13 @@ def on_bootstrap_complete(resp):
         kserver = Server.loadState(DATA_FOLDER + 'cache.pickle', ip_address, port, protocol, db,
                                    on_bootstrap_complete, storage=PersistentStorage(db.DATABASE))
     except Exception:
-        kserver = Server(node, db, dht.constants.KSIZE, dht.constants.ALPHA, storage=PersistentStorage(db.DATABASE))
+        kserver = Server(node, db, KSIZE, ALPHA, storage=PersistentStorage(db.DATABASE))
         kserver.protocol.connect_multiplexer(protocol)
         kserver.bootstrap(
             kserver.querySeed("seed.openbazaar.org:8080",
                               "ddd862778e3ed71af06db0e3619a4c6269ec7468c745132dbb73982b319fc572"))\
             .addCallback(on_bootstrap_complete)
-
+        # TODO: load seeds from config file
     kserver.saveStateRegularly(DATA_FOLDER + 'cache.pickle', 10)
     protocol.register_processor(kserver.protocol)
 
@@ -96,7 +104,10 @@ def on_bootstrap_complete(resp):
     site = Site(api, timeout=None)
     reactor.listenTCP(18469, site, interface="127.0.0.1")
 
+    # TODO: add optional SSL on rest and websocket servers
+
     # blockchain
+    # TODO: listen on the libbitcoin heartbeat port instead fetching height
     def height_fetched(ec, height):
         print "Libbitcoin server online"
         try:
@@ -112,6 +123,9 @@ def timeout(client):
         libbitcoin_client = obelisk.ObeliskOfLightClient("tcp://libbitcoin2.openbazaar.org:9091")
     else:
         libbitcoin_client = obelisk.ObeliskOfLightClient("tcp://libbitcoin1.openbazaar.org:9091")
+
+    # TODO: load libbitcoin server url from config file
+
     libbitcoin_client.fetch_last_height(height_fetched)
     timeout = reactor.callLater(5, timeout, libbitcoin_client)
 
@@ -168,6 +182,7 @@ def start(self):
             print
             print "OpenBazaar Server v0.1 starting..."
             unix = ("linux", "linux2", "darwin")
+            # TODO: run as windows service (also for STOP and RESTART)
             if args.daemon and platform.system().lower() in unix:
                 self.daemon.start(args.testnet)
             else:

openbazaard.py

@@ -8,6 +8,7 @@
 from log import Logger
 from dht.node import Node
 
+
 class OpenBazaarProtocol(ConnectionMultiplexer):
     """
     A protocol extending the txrudp datagram protocol. This is the main protocol
@@ -59,7 +60,7 @@ def receive_message(self, datagram):
                 return False
 
         def handle_shutdown(self):
-            del self.active_connections[self.connection.dest_addr]
+            self.connection.unregister()
             if self.node is not None:
                 for processor in self.processors:
                     if FIND_VALUE in processor: