requirements documented for forwardMessage

1 files changed, 5 insertions, 1 deletions

diff --git a/SybilLimit.hs b/SybilLimit.hs
index f2b983c..ad85cfd 100644
--- a/SybilLimit.hs
+++ b/SybilLimit.hs
@@ -139,7 +139,11 @@ updateRoute i (k,j) fs = jfromk $ ktoj fs
     setFrom i x f = f { routesFrom = IntMap.insert i x (routesFrom f)}
 
 
--- | Note: an exception will be thrown if srcId is not a valid friend node.
+-- | Required:
+--
+-- (1) srcId must be a valid friend node.
+--
+-- (2) msg must be either ForwardRRMessage or BackwardRRMessage
 forwardMessage :: ThisNode -> (FriendNode -> IntMap Int) -> (NodeId,PeerMessage) -> (NodeId, PeerMessage)
 forwardMessage me next (srcId,msg) = msg'
       where msg' = ( dest, msg { rrCount = rrCount msg + 1 } )