remove QueryNode to avoid code duplication

Author: IAmPara0x

bot-plutus-interface.cabal

@@ -91,7 +91,6 @@ library
     BotPlutusInterface.ExBudget
     BotPlutusInterface.Files
     BotPlutusInterface.Helpers
-    BotPlutusInterface.QueryNode
     BotPlutusInterface.Server
     BotPlutusInterface.TimeSlot
     BotPlutusInterface.Types

src/BotPlutusInterface/Balance.hs

@@ -133,8 +133,8 @@ balanceTxIO' balanceCfg pabConf ownPkh unbalancedTx =
 
           requiredSigs :: [PubKeyHash]
           requiredSigs =
-            map Ledger.unPaymentPubKeyHash $
-              Set.toList (unBalancedTxRequiredSignatories unbalancedTx)
+            unBalancedTxRequiredSignatories unbalancedTx
+              ^.. folded . to Ledger.unPaymentPubKeyHash
 
       lift $ printBpiLog @w (Debug [TxBalancingLog]) $ viaShow utxoIndex
 

src/BotPlutusInterface/CardanoNode/Effects.hs

@@ -1,12 +1,12 @@
 {-# LANGUAGE RankNTypes #-}
 
 {- This is ongoing effort on replacing `cardano-cli` calls with `Cardano.Api` queries, see issues
-  https://github.com/mlabs-haskell/bot-plutus-interface/issues/109
-  https://github.com/mlabs-haskell/bot-plutus-interface/issues/101
-  We decided to provide single replacement for `BotPlutusInterface.CardanoCLI.utxosAt`
-  early on to enable inline Datum support from one side and avoid extending
-  `cardano-cli` output parser from the other side.
-  See https://github.com/mlabs-haskell/bot-plutus-interface/issues/145
+   https://github.com/mlabs-haskell/bot-plutus-interface/issues/109
+   https://github.com/mlabs-haskell/bot-plutus-interface/issues/101
+   We decided to provide single replacement for `BotPlutusInterface.CardanoCLI.utxosAt`
+   early on to enable inline Datum support from one side and avoid extending
+   `cardano-cli` output parser from the other side.
+   See https://github.com/mlabs-haskell/bot-plutus-interface/issues/145
 -}
 module BotPlutusInterface.CardanoNode.Effects (
   utxosAt,
@@ -23,7 +23,6 @@ import BotPlutusInterface.CardanoNode.Query (
   QueryConstraint,
   connectionInfo,
   queryBabbageEra,
-  queryInCardanoMode,
   toQueryError,
  )
 
@@ -44,7 +43,6 @@ import Control.Monad.Freer (Eff, Members, interpret, runM, send, type (~>))
 import Control.Monad.Freer.Reader (Reader, ask, runReader)
 import Control.Monad.Trans.Class (lift)
 import Control.Monad.Trans.Either (firstEitherT, hoistEither, newEitherT, runEitherT)
-import Control.Monad.Trans.Except (throwE)
 import Data.Map (Map)
 import Data.Map qualified as Map
 import Data.Set qualified as Set
@@ -89,7 +87,7 @@ handleNodeQuery ::
 handleNodeQuery =
   interpret $ \case
     UtxosAt addr -> handleUtxosAt addr
-    PParams -> queryPParams
+    PParams -> queryBabbageEra CApi.QueryProtocolParameters
     MinUtxo txout -> handleMinUtxo txout
 
 handleUtxosAt ::
@@ -129,7 +127,7 @@ handleMinUtxo ::
 handleMinUtxo txout = runEitherT $ do
   conn <- lift $ ask @NodeConn
 
-  params <- newEitherT queryPParams
+  params <- newEitherT $ queryBabbageEra CApi.QueryProtocolParameters
 
   let pparamsInEra = CApi.toLedgerPParams CApi.ShelleyBasedEraBabbage params
       netId = localNodeNetworkId conn
@@ -157,20 +155,3 @@ runNodeQuery conf effs = do
   runM $
     runReader conn $
       handleNodeQuery effs
-
--- Helpers
-
-queryPParams ::
-  forall effs.
-  QueryConstraint effs =>
-  Eff effs (Either NodeQueryError CApi.S.ProtocolParameters)
-queryPParams = runEitherT $ do
-  let query =
-        CApi.QueryInEra CApi.BabbageEraInCardanoMode $
-          CApi.QueryInShelleyBasedEra CApi.ShelleyBasedEraBabbage CApi.QueryProtocolParameters
-
-  result <- newEitherT $ queryInCardanoMode query
-
-  case result of
-    Right params -> return params
-    Left err -> throwE $ toQueryError err

src/BotPlutusInterface/CardanoNode/Query.hs

@@ -22,16 +22,22 @@ import System.Environment (getEnv)
 import Prelude
 
 {- | Error returned in case any error happened querying local node
- (wraps whatever received in `Text`)
+     (wraps whatever received in `Text`)
 -}
 data NodeQueryError
   = NodeQueryError Text
   deriving stock (Eq, Show)
 
+-- | Represents the connection to the local node.
 type NodeConn = CApi.LocalNodeConnectInfo CApi.CardanoMode
 
+-- | Constraints that are required to query local node.
 type QueryConstraint effs = (Member (Reader NodeConn) effs, LastMember IO effs)
 
+{- | 'queryInCardanoMode' establishes connection with local node and execute a single query.
+   The Query has a type of 'QueryInMode CardanoMode a', hence we don't need any information
+   about current era of the local node to execute certain queries, unlike `queryBabbageEra`.
+-}
 queryInCardanoMode ::
   forall effs a.
   (QueryConstraint effs) =>
@@ -45,6 +51,9 @@ queryInCardanoMode query =
         send $
           CApi.queryNodeLocalState conn Nothing query
 
+{- | 'queryBabbageEra' expects that every query must be in 'BabbageEra' and
+   it expects that the local node's current era should be 'BabbageEra'.
+-}
 queryBabbageEra ::
   forall effs a.
   (QueryConstraint effs) =>
@@ -61,7 +70,11 @@ queryBabbageEra query =
       Right a -> return a
       Left e -> throwE $ toQueryError e
 
-connectionInfo :: PABConfig -> IO (CApi.LocalNodeConnectInfo CApi.CardanoMode)
+{- | create connection info from 'PABConfig', this function excepts that there's
+   "CARDANO_NODE_SOCKET_PATH" environment variable present in the shell and has a
+   value that contains path for local node's socket.
+-}
+connectionInfo :: PABConfig -> IO NodeConn
 connectionInfo pabConf =
   CApi.LocalNodeConnectInfo
     (CApi.CardanoModeParams epochSlots)

src/BotPlutusInterface/Contract.hs

@@ -551,6 +551,9 @@ handleCollateral ::
 handleCollateral cEnv = do
   result <- (fmap swapEither . runEitherT) $
     do
+      let helperLog :: PP.Doc () -> ExceptT CollateralUtxo (Eff effs) ()
+          helperLog msg = newEitherT $ Right <$> printBpiLog @w (Debug [CollateralLog]) msg
+
       collateralNotInMem <-
         newEitherT $
           maybeToLeft "Collateral UTxO not found in contract env."
@@ -577,10 +580,6 @@ handleCollateral cEnv = do
       setInMemCollateral @w collteralUtxo
         >> Right <$> printBpiLog @w (Debug [CollateralLog]) "successfully set the collateral utxo in env."
     Left err -> pure $ Left $ "Failed to make collateral: " <> err
-  where
-    --
-    helperLog :: PP.Doc () -> ExceptT CollateralUtxo (Eff effs) ()
-    helperLog msg = newEitherT $ Right <$> printBpiLog @w (Debug [CollateralLog]) msg
 
 {- | Create collateral UTxO by submitting Tx.
   Then try to find created UTxO at own PKH address.