Updated todo.txt and comments.

2 files changed, 83 insertions, 62 deletions

diff --git a/examples/dhtd.hs b/examples/dhtd.hs
index badea2b1..67dece2e 100644
--- a/examples/dhtd.hs
+++ b/examples/dhtd.hs
@@ -16,6 +16,8 @@
 {-# LANGUAGE TypeFamilies              #-}
 {-# LANGUAGE TypeOperators             #-}
 
+module Main where
+
 import Control.Arrow
 import Control.Applicative
 import Control.Concurrent.STM
@@ -525,6 +527,16 @@ clientSession s@Session{..} sock cnum h = do
                                          , ("node-id", show $ thisNode bkts)
                                          , ("network", netname) ]
 
+        --  TODO: online documentation.
+        --
+        --  k - manage key-pairs
+        --
+        --      k                  (list keys)
+        --      k gen              (generate new key and list keys)
+        --      k add <secret-key> (input a specific secret key)
+        --      k del <secret-key>
+        --      k secrets          (list key pairs, including secret keys)
+
         ("k", s) | ""           <- strp s -> cmd0 $ do
                         ks <- atomically $ readTVar userkeys
                         hPutClient h $ unlines $ map (mappend "  " . show . Tox.key2id . snd) ks
@@ -607,6 +619,30 @@ clientSession s@Session{..} sock cnum h = do
                               goQuery
                               $ Map.lookup method dhtQuery
 
+        -- TODO: Online help.
+        --
+        -- p - put/publish a single given datum on a single given node.
+        --
+        --         When destination address (node-addr) is optional, it's absense means to
+        --         publish information in the local node's own database.
+        --
+        --         Bittorrent: (peer) publish yourself as peer in swarm.
+        --                     (port) set your current bittorrent listen port.
+        --
+        --             p peer <infohash> <token> [node-addr]
+        --
+        --             p port <num>
+        --
+        --         Tox: (toxid) publish a rendezvous onion route to dht node.
+        --              (friend) send a friend-request over a rendezvous point.
+        --              (dhtkey) send your dht node-id over a rendezvous point.
+        --
+        --             p toxid <key> <token> <node-addr>
+        --
+        --             p friend <key> <nospam> <rendezvous-addr> <text>
+        --
+        --             p dhtkey <key> - <rendezvous-addr>
+
         ("p", s) | Just DHT{..} <- Map.lookup netname dhts
                     -> cmd0 $ do
                         -- arguments: method
@@ -635,6 +671,28 @@ clientSession s@Session{..} sock cnum h = do
                               goTarget
                               $ Map.lookup method dhtAnnouncables
 
+        -- TODO: Online documentation.
+        --
+        -- a - announce, like put/publish but automatically selects nodes to publish on
+        --     and periodically refreshes them.
+        --
+        --     The method name is preceded with a + to start or a - to stop a given
+        --     recurring publication.
+        --
+        --     BitTorrent: (peer) Every minute, announce you are participating
+        --                        in a torrent swarm.
+        --
+        --         a +peer <infohash> a -peer <infohash>
+        --
+        --     Tox: (toxid) Every 15 seconds, announce your tox identity to the
+        --                  DHT so friends can find you.
+        --
+        --         a +toxid <key>
+        --         a -toxid <key>
+        --
+        --       These probably don't work:
+        --         (experimental) a +friend <nospam> <text>
+        --         (experimental) a +dhtkey
         ("a", s) | Just DHT{..} <- Map.lookup netname dhts
                  , not (null s)
                     -> cmd0 $ do
diff --git a/todo.txt b/todo.txt
index f92dd435..92da7962 100644
--- a/todo.txt
+++ b/todo.txt
@@ -1,17 +1,23 @@
-Online help.
+ui: Online help.
 
-Change refresh algorithm to refresh farther away buckets before closer ones.
+ui: Explicit routing table node deletion. "forget" command.
 
-Remove (without replacement) stale routing nodes at some point.
+ui: a -  with no arguments would list the currently active recuring publications.
 
-Explicit routing table node deletion. "forget" command.
+kademlia: Change refresh algorithm to refresh farther away buckets before closer ones.
 
-Debug why disabled-6 does not get peer/key storage.
+kademlia: Remove (without replacement) stale routing nodes at some point.
 
-Give different networks a different minimum count to terminate bootstrap.  Imperically,
-tox4: 6 buckets, tox6: 3 buckets
+bug: Why does running without -4 (ipv4-only) on an ipv6-disabled computer prevent
+     storage of bt peers and tox keys in the local store?
 
-handle exception: dhtd: Network.Socket.sendTo: does not exist (Network is unreachable
+kademlia: Give different networks a different minimum count to terminate
+          bootstrap.  Imperically, tox4: 6 buckets, tox6: 3 buckets
+
+bug: Unhandled exception: dhtd: Network.Socket.sendTo: does not exist (Network
+     is unreachable
+
+tox: Don't store ourself in the kademlia buckets.
 
 tox: fallback to https://nodes.tox.chat/json
 
@@ -21,11 +27,9 @@ tox: hardening get-nodes test request.
 
 tox: nat ping
 
-tox: base64 read/show
-
 tox: cache diffie-helman secrets
 
-tox: Expire old Tox keys.
+tox: Expire ofline Tox announces.
 
 tox: Chat support.
 
@@ -37,56 +41,15 @@ bt: Limit peers in get_peers response for UDP packet size limiting (around 1k).
 
 bt: Use LMDB backend for peer store (and nodes too?).
 
-Notes:
-
-
-
-new commands:
-
-p - put/publish a single given datum on a single given node.
-
-        When destination address (node-addr) is optional, it's absense means to
-        publish information in the local node's own database.
-
-        Bittorrent: (peer) publish yourself as peer in swarm.
-            arguments:  {"id" : "<querying nodes id>",
-              "implied_port": <0 or 1>,
-              "info_hash" : "<20-byte infohash of target torrent>",
-              "port" : <port number>,
-              "token" : "<opaque token>"}
-            response: {"id" : "<queried nodes id>"}
-
-            p peer <infohash> <token> [node-addr]
-
-        Tox: (toxid) publish a rendezvous onion route to dht node.
-             (friend) publish friend-request to rendezvous point.
-             (dhtkey) publish dht-nodeid to rendezvous point.
-
-            p toxid <key-pair> <token> [node-addr]
-
-            p friend <key-pair> <nospam> <rendezvous-addr> <text>
-
-            p dhtkey <key-pair> - <rendezvous-addr>
-
-a - announce, like put/publish but automatically selects nodes to publish on
-    and continually refreshes the records.
-
-    The method name is preceded with a + to start or a - to stop a given
-    recuring publication.
-
-    a -  with no arguments would list the currently active recuring publications.
-
-    a +peer <infohash>
-    a -peer <infohash>
-
-    a +toxid <key-pair>
-    a +friend <nospam> <text>
-    a +dhtkey
+maint: Rename files.
 
-k - manage key-pairs
+       OnionRouter                  -> Network.Tox.Onion.Routes
+       Announcer                    -> Network.Kademlia.Announce
+       InterruptibleDelay           -> Control.Concurrent.Delay
+       Roster                       -> Network.Tox.ContactInfo
+       Crypto.Tox                   -> Network.Tox.Crypto
+       Network.Tox.Crypto.Handlers  -> Network.Tox.Friend.Handlers
+       Network.Tox.Crypto.Transport -> Network.Tox.Friend.Transport
 
-    k                  (list keys)
-    k gen              (generate new key and list keys)
-    k add <secret-key> (input a specific secret key)
-    k del <secret-key>
-    k secrets          (list key pairs, including secret keys)
+maint: Probably, Network.* should be reserved for very general tools and the Tox and
+       BitTorrent paths should be moved to the top level.