Added some TODOs for next time

Co-authored-by: Nick Waywood <n.waywood@gmail.com>
Signed-off-by: Allison Irvin <allison.irvin2@gmail.com>

Author: airvin

examples/Marbles.hs

@@ -188,6 +188,8 @@ generateResultBytes sqi text = do
   hasNextBool <- hasNext sqi
   if hasNextBool then do 
       eeKV <- next sqi
+      -- TODO: We need to check that the Either Error KV returned from next 
+      -- is correct and append the showable version of KVs instead of "abc".
       generateResultBytes sqi (append text "abc")
   else pure $ Right $ TSE.encodeUtf8 text
 

src/Interfaces.hs

@@ -37,7 +37,10 @@ class ChaincodeStubInterface ccs where
     -- setStateValidationParameter :: ccs -> String -> [ByteString] -> Maybe Error
     -- getStateValiationParameter :: ccs -> String -> Either Error [ByteString]
     getStateByRange :: ccs -> Text -> Text -> IO (Either Error StateQueryIterator)
+    
+    -- TODO: We need to implement this so we can test the fetchNextQueryResult functionality
     -- getStateByRangeWithPagination :: ccs -> String -> String -> Int32 -> String -> Either Error (StateQueryIterator, Pb.QueryResponseMetadata)
+    
     -- getStateByPartialCompositeKey :: ccs -> String -> [String] -> Either Error StateQueryIterator
     -- getStateByPartialCompositeKeyWithPagination :: ccs -> String -> [String] -> Int32 -> String -> Either Error (StateQueryIterator, Pb.QueryResponseMetadata)
     -- createCompositeKey :: ccs -> String -> [String] -> Either Error String
@@ -72,6 +75,8 @@ class StateQueryIteratorInterface sqi where
 --     -- close terminantes the iteration.
     close :: sqi -> IO (Maybe Error)
 --     -- Provides the next key-value pair pointed by the iterator
+--     TODO: Change this to an ExceptT type to make handling the next function
+--     easier on the user chaincode side
     next :: sqi -> IO (Either Error Pb.KV)
 
 -- The type class HistoryQueryIterator defines the behaviour of the types that expose functionalities