Merge pull request #154 from mlabs-haskell/karol/staking-keys

 Support for addresses with staking keys [Plutip's #103].

Author: mikekeke

README.md

@@ -140,7 +140,7 @@ cardano-cli query protocol-parameters --testnet-magic 42 --out-file protocol.jso
 ```
 
 5. Create a `signing-keys` folder under your projects root with the necessary signig key file(s).
-   The files should be named in the following format: `signing-key-PUBKEYHASH.skey`
+   The files should be named in the following format: `signing-key-PUBKEYHASHHEX.skey` and `verification-key-PUBKEYHASHHEX.vkey`
 
 Use the cardano-cli to find out the pub key hash for your key:
 

src/BotPlutusInterface/Collateral.hs

@@ -10,6 +10,7 @@ import BotPlutusInterface.Types (
   ContractEnvironment (ceCollateral),
   PABConfig (pcOwnPubKeyHash),
   collateralValue,
+  pcOwnStakePubKeyHash,
   unCollateralVar,
  )
 import Cardano.Prelude (Void)
@@ -54,7 +55,13 @@ mkCollateralTx :: PABConfig -> Either Constraints.MkTxError Constraints.Unbalanc
 mkCollateralTx pabConf = Constraints.mkTx @Void mempty txc
   where
     txc :: Constraints.TxConstraints Void Void
-    txc = Constraints.mustPayToPubKey (PaymentPubKeyHash $ pcOwnPubKeyHash pabConf) (collateralValue pabConf)
+    txc =
+      maybe -- pay to either a base or enterprise address
+        Constraints.mustPayToPubKey
+        (flip Constraints.mustPayToPubKeyAddress)
+        (pcOwnStakePubKeyHash pabConf)
+        (PaymentPubKeyHash $ pcOwnPubKeyHash pabConf)
+        (collateralValue pabConf)
 
 -- | Middleware to run `chain-index` queries and filter out collateral output from response.
 withCollateralHandling ::

src/BotPlutusInterface/Files.hs

@@ -59,7 +59,7 @@ import Data.ByteString.Lazy qualified as LazyByteString
 import Data.ByteString.Short qualified as ShortByteString
 import Data.Either.Combinators (mapLeft)
 import Data.Kind (Type)
-import Data.List (sortOn, unzip4)
+import Data.List (isPrefixOf, sortOn, unzip4)
 import Data.Map (Map)
 import Data.Map qualified as Map
 import Data.Maybe (catMaybes, mapMaybe)
@@ -211,21 +211,30 @@ readPrivateKeys ::
   Eff effs (Either Text (Map PubKeyHash DummyPrivKey))
 readPrivateKeys pabConf = do
   files <- listDirectory @w $ Text.unpack pabConf.pcSigningKeyFileDir
-
-  privKeys <-
-    catMaybes
-      <$> mapM
-        ( \filename ->
-            let fullPath = Text.unpack pabConf.pcSigningKeyFileDir </> filename
-             in case takeExtension filename of
-                  ".vkey" -> Just <$> readVerificationKey @w fullPath
-                  ".skey" -> Just <$> readSigningKey @w fullPath
-                  _ -> pure Nothing
-        )
-        files
-
+  privKeys <- catMaybes <$> mapM readKey files
   pure $ toPrivKeyMap <$> sequence privKeys
   where
+    readKey filename =
+      let fullPath = Text.unpack pabConf.pcSigningKeyFileDir </> filename
+       in case takeExtension filename of
+            ".vkey" ->
+              guardPaymentKey paymentVKeyPrefix filename
+                <$> readVerificationKey @w fullPath
+            ".skey" ->
+              guardPaymentKey paymentSKeyPrefix filename
+                <$> readSigningKey @w fullPath
+            _ -> pure Nothing
+
+    paymentVKeyPrefix = "verification-key"
+    paymentSKeyPrefix = "signing-key"
+
+    {- this filtering ensures that only payment keys are read,
+     it allows to store other types of keys in the same drirectory if required
+     by altering filename prefix
+    -}
+    guardPaymentKey prefix filename =
+      if prefix `isPrefixOf` filename then Just else const Nothing
+
     toPrivKeyMap :: [DummyPrivKey] -> Map PubKeyHash DummyPrivKey
     toPrivKeyMap =
       foldl

test/Spec/MockContract.hs

@@ -250,7 +250,7 @@ toSigningKeyFile signingKeyFileDir sKey =
 
 toVerificationKeyFile :: FilePath -> VerificationKey PaymentKey -> (FilePath, MockFile)
 toVerificationKeyFile signingKeyFileDir vKey =
-  ( signingKeyFileDir ++ "/signing-key-" ++ show (Ledger.pubKeyHash (vkeyToPubKey vKey)) ++ ".vkey"
+  ( signingKeyFileDir ++ "/verification-key-" ++ show (Ledger.pubKeyHash (vkeyToPubKey vKey)) ++ ".vkey"
   , TextEnvelopeFile $ serialiseToTextEnvelope Nothing vKey
   )