Resolves #12:

- bot interfaces switched from dry-mode
- wallet to wallet payment test contract
- integrations tests

Author: mikekeke

example/Main.hs

@@ -6,14 +6,16 @@ import Control.Monad.Reader (ask)
 import DSL (
   ada,
   addSomeWallet,
+  ledgerPaymentPkh,
   mkMainnetAddress,
   report,
   runContract,
   runUsingCluster,
   waitSeconds,
  )
 import Data.Text (Text, unpack)
-import DebugContract.DebugGet qualified as DebugContract
+import DebugContract.GetUtxos qualified as DebugContract
+import DebugContract.PayToWallet qualified as DebugContract
 import LocalCluster.Types (supportDir)
 import System.Environment (setEnv)
 import Tools.DebugCli qualified as CLI
@@ -31,15 +33,20 @@ main = do
     w2 <- addSomeWallet (ada 202)
 
     debugWallets (sequence [w1, w2]) --temporary, for debugging
-    testWallet <- either (error . show) pure w1
-    runContract testWallet DebugContract.getUtxos
+    testW1 <- either (error . show) pure w1
+    runContract testW1 DebugContract.getUtxos
       >>= report
-    runContract testWallet DebugContract.getUtxosThrowsErr
+    runContract testW1 DebugContract.getUtxosThrowsErr
       >>= report
-    runContract testWallet DebugContract.getUtxosThrowsEx
+    runContract testW1 DebugContract.getUtxosThrowsEx
       >>= report
 
-    liftIO $ putStrLn "Done. Debug awaiting - interrupt to exit" >> forever (waitSeconds 60)
+    testW2 <- either (error . show) pure w2
+    runContract testW1 (DebugContract.payTo (ledgerPaymentPkh testW2) 10_000_000)
+      >>= report
+      >> debugWallets (sequence [w1, w2])
+
+    liftIO $ putStrLn "Done. Debug awaiting - Enter to exit" >> void getLine
   where
     debugWallets ws = do
       cEnv <- ask
@@ -50,22 +57,3 @@ main = do
         (error . ("Err: " <>) . show)
         (mapM_ (liftIO . CLI.utxoAtAddress cEnv . mkMainnetAddress))
         ws
-
-testMnemonic :: [Text]
-testMnemonic =
-  [ "radar"
-  , "scare"
-  , "sense"
-  , "winner"
-  , "little"
-  , "jeans"
-  , "blue"
-  , "spell"
-  , "mystery"
-  , "sketch"
-  , "omit"
-  , "time"
-  , "tiger"
-  , "leave"
-  , "load"
-  ]

plutip.cabal

@@ -46,6 +46,7 @@ common common-imports
     , plutus-contract
     , plutus-ledger
     , plutus-ledger-api
+    , plutus-ledger-constraints
     , plutus-pab
     , prettyprinter
     , row-types
@@ -119,7 +120,8 @@ library
     BotInterface.Types
     BotInterface.Wallet
     DSL
-    DebugContract.DebugGet
+    DebugContract.GetUtxos
+    DebugContract.PayToWallet
     LocalCluster.Cluster
     LocalCluster.Types
     LocalCluster.Wallet

src/BotInterface/Run.hs

@@ -76,7 +76,7 @@ runContract bpiWallet contract =
               , pcScriptFileDir = pack $ BIS.scriptsDir cEnv
               , pcSigningKeyFileDir = pack $ BIS.keysDir cEnv
               , pcTxFileDir = pack $ BIS.txsDir cEnv
-              , pcDryRun = True
+              , pcDryRun = False
               , pcProtocolParamsFile = pack $ BIS.pParamsFile cEnv
               , pcLogLevel = Info
               , pcOwnPubKeyHash = ledgerPkh bpiWallet

src/BotInterface/Setup.hs

@@ -7,6 +7,7 @@ module BotInterface.Setup (
   txsDir,
 ) where
 
+import Cardano.Launcher.Node (nodeSocketFile)
 import Data.Aeson (encodeFile)
 import LocalCluster.Types (ClusterEnv (supportDir), nodeSocket)
 import System.Directory (createDirectoryIfMissing, doesDirectoryExist)
@@ -34,6 +35,7 @@ runSetup cEnv = do
   setSocketPathEnv
   where
     setSocketPathEnv =
+      -- required by `cardano-cli` used by bot interface
       setEnv "CARDANO_NODE_SOCKET_PATH" (nodeSocketFile $ nodeSocket cEnv)
     createRequiredDirs =
       mapM_

src/BotInterface/Wallet.hs

@@ -5,6 +5,7 @@ module BotInterface.Wallet (
   mkMainnetAddress,
   cardanoMainnetAddress,
   ledgerPkh,
+  ledgerPaymentPkh,
 ) where
 
 import BotInterface.Setup qualified as Setup
@@ -22,7 +23,7 @@ import Control.Monad.Reader (MonadReader (ask), ReaderT (runReaderT))
 import Data.Bool (bool)
 import Data.Text (Text, pack, unpack)
 import GHC.Natural (Natural)
-import Ledger (PubKey (PubKey), PubKeyHash, pubKeyHash)
+import Ledger (PaymentPubKeyHash (PaymentPubKeyHash), PubKey (PubKey), PubKeyHash, pubKeyHash)
 import LocalCluster.Types (ClusterEnv, nodeSocket, supportDir)
 import Plutus.V1.Ledger.Api qualified as LAPI
 import System.FilePath ((<.>), (</>))
@@ -109,6 +110,9 @@ ledgerPkh =
     . CAPI.serialiseToRawBytes
     . vrfKey
 
+ledgerPaymentPkh :: BpiWallet -> PaymentPubKeyHash
+ledgerPaymentPkh = PaymentPubKeyHash . ledgerPkh
+
 -- whateverJsonYouNeed :: BpiWallet -> String
 -- whateverJsonYouNeed wallet =
 --   (C8.unpack $ encode $ addressCredential $ pubKeyHashAddress (PaymentPubKeyHash $ ledgerPkh wallet) Nothing)

src/DSL.hs

@@ -1,5 +1,6 @@
 module DSL (
   BpiWallet,
+  RunResult (RunSuccess, RunFailed),
   addSomeWallet,
   runContract,
   runContract_,
@@ -10,17 +11,20 @@ module DSL (
   report,
   mkMainnetAddress,
   cardanoMainnetAddress,
+  ledgerPaymentPkh,
 ) where
 
 import BotInterface.Run (runContract, runContract_)
 import BotInterface.Wallet (
   BpiWallet,
   addSomeWallet,
   cardanoMainnetAddress,
+  ledgerPaymentPkh,
   mkMainnetAddress,
  )
 import Control.Monad.IO.Class (MonadIO, liftIO)
 import LocalCluster.Cluster (runUsingCluster, runUsingCluster')
+import LocalCluster.Types (RunResult (RunFailed, RunSuccess))
 import Utils (ada, waitSeconds)
 
 {- | Stand-in for upcoming report functionality

src/DebugContract/DebugGet.hs src/DebugContract/GetUtxos.hssrc/DebugContract/DebugGet.hs renamed to src/DebugContract/GetUtxos.hs

@@ -1,4 +1,4 @@
-module DebugContract.DebugGet (getUtxos, getUtxosThrowsErr, getUtxosThrowsEx) where
+module DebugContract.GetUtxos (getUtxos, getUtxosThrowsErr, getUtxosThrowsEx) where
 
 import Data.Map (Map)
 import Data.Text (Text, pack)

src/DebugContract/PayToWallet.hs

@@ -0,0 +1,17 @@
+module DebugContract.PayToWallet (payTo) where
+
+import Data.Text (Text)
+import Ledger (CardanoTx, PaymentPubKeyHash, getCardanoTxId)
+import Ledger.Ada qualified as Ada
+import Plutus.Contract (Contract, awaitTxConfirmed, ownPaymentPubKeyHash, submitTx)
+import Plutus.PAB.Effects.Contract.Builtin (EmptySchema)
+
+import Ledger.Constraints qualified as Constraints
+import Ledger.Constraints qualified as Contract
+
+payTo :: PaymentPubKeyHash -> Integer -> Contract () EmptySchema Text CardanoTx
+payTo toPkh amt = do
+  uwnPkh <- ownPaymentPubKeyHash
+  tx <- submitTx (Constraints.mustPayToPubKey toPkh (Ada.lovelaceValueOf amt) <> Contract.mustBeSignedBy uwnPkh)
+  awaitTxConfirmed $ getCardanoTxId tx
+  pure tx

test/Test/Integration.hs

@@ -1,38 +1,87 @@
 module Test.Integration (test) where
 
-import Cardano.Api (AssetId (AdaAssetId), Quantity (Quantity), TxOut (TxOut), UTxO (unUTxO), txOutValueToValue, valueToList)
+import Cardano.Api (AssetId (AdaAssetId), Quantity (Quantity), TxOut (TxOut), UTxO (UTxO, unUTxO), txOutValueToValue, valueToList)
 import Data.Map qualified as Map
 import System.Environment (setEnv)
 import Test.Tasty (TestTree)
-import Test.Tasty.HUnit (assertFailure, testCase, (@?=))
+import Test.Tasty.HUnit (assertBool, assertFailure, testCase, (@?=))
 import Tools.CardanoApi (utxosAtAddress)
 
 import Control.Monad.IO.Class (liftIO)
 import Control.Monad.Reader (ask)
 import DSL (
+  RunResult (RunFailed, RunSuccess),
   ada,
   addSomeWallet,
   cardanoMainnetAddress,
+  runContract,
   runUsingCluster,
   waitSeconds,
  )
 
+import DebugContract.GetUtxos qualified as DebugContract
+import DebugContract.PayToWallet qualified as DebugContract
+
+import BotInterface.Wallet (ledgerPaymentPkh)
+
 -- FIXME: something prints node configs polluting test outputs
 test :: TestTree
 test = do
-  testCase "Basic integration: launch and add wallet" $ do
+  testCase "Basic integration: launch, add wallet, tx from wallet to wallet" $ do
     withTestConf . runUsingCluster $ do
-      ws <- addSomeWallet (ada 101)
-      case ws of
-        Left e -> liftIO $ assertFailure $ "Error: " <> show e
-        Right wallet -> checkFunds wallet
+      w1 <- addSomeWallet (ada 101) >>= either (error . show) pure
+      checkFunds w1 (ada 101)
+      w2 <- addSomeWallet (ada 102) >>= either (error . show) pure
+      checkFunds w2 (ada 102)
+
+      assertSucceeds
+        "Get utxos"
+        (runContract w1 DebugContract.getUtxos)
+      assertFails
+        "Get utxos throwing error"
+        (runContract w1 DebugContract.getUtxosThrowsErr)
+      assertFails
+        "Get utxos throwing exception"
+        (runContract w1 DebugContract.getUtxosThrowsEx)
+      assertFails
+        "Pay negative amount"
+        (runContract w1 (DebugContract.payTo (ledgerPaymentPkh w2) (-10_000_000)))
+
+      checkAdaTxFromTo w1 w2
   where
-    checkFunds wallet' =
+    checkFunds wallet' expectedAmt = do
+      let expectedAmt' = toInteger expectedAmt
       ask >>= \cEnv -> liftIO $ do
         waitSeconds 2
         res <- utxosAtAddress cEnv (cardanoMainnetAddress wallet')
         let resultValue = toCombinedFlatValue <$> res
-        resultValue @?= Right [(AdaAssetId, Quantity 101000000)]
+        resultValue @?= Right [(AdaAssetId, Quantity expectedAmt')]
+
+    assertSucceeds tag act = do
+      act >>= liftIO . assertBool (tag <> " did not succeed") . isSuccess
+
+    assertFails tag act = do
+      act >>= liftIO . assertBool (tag <> " did not fail") . not . isSuccess
+
+    checkAdaTxFromTo w1 w2 = do
+      res <- runContract w1 (DebugContract.payTo (ledgerPaymentPkh w2) 10_000_000)
+      cEnv <- ask
+      liftIO $ do
+        assertBool ("Wallet to wallet tx failed: " <> show res) (isSuccess res)
+        waitSeconds 1 -- todo: some "wait tx processed" could be handy
+        utxosAtAddress cEnv (cardanoMainnetAddress w2)
+          >>= \case
+            Left e ->
+              assertFailure $ "Failed ot get wallet UTxO: " <> show e
+            Right (UTxO utxo) ->
+              let utxoCnt = Map.size utxo
+               in assertBool
+                    ("Should be 2 UTxO at destination wallet, but request returned " <> show utxoCnt)
+                    (utxoCnt == 2)
+
+    isSuccess = \case
+      RunSuccess _ _ -> True
+      RunFailed _ -> False
 
 withTestConf :: IO b -> IO b
 withTestConf runTest = do