Rewrite E2E test suite

CHANGELOG.md

@@ -54,12 +54,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Switched to `preview` testnet by default ([#1030](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1030))
 - `addressFromBech32` checks that address network Id corresponds to the contract environment Id and is therefore lifted to the `Contract` monad ([#1062](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1062))
 - `keyWalletPrivatePaymentKey` and `keyWalletPrivateStakeKey` are now in to the public `Contract.Wallet.Key` API. ([#1094](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1094))
+- Completely new E2E (headless browser) test suite. It is now both easier to set up and use, and less flaky. The shell script has been removed (and re-implemented in PureScript). The suite can now be configured using environment variables (`test/e2e.env`) or CLI arguments. It is no more required to provide an accompanying tester script for each of the `Contract`s to be tested. ([#1058](https://github.com/Plutonomicon/cardano-transaction-lib/issues/1058), [#986](https://github.com/Plutonomicon/cardano-transaction-lib/issues/986))
 - The `logLevel` from the config parameters is passed to the `customLogger` to allow consistent filtering of the logs. ([#1110](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1110)).
 - Functions for working with `BigNum` are now in the public `Contract.Numeric.BigNum` API ([#1109](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1109)).
 - `PublicKey` and `Ed25519Signature` types now wrap `RawBytes` instead of `Bech32String`.
 - `TypeLevel.Nat`, needed to implement `HasPlutusSchema`, gets exported in `Contract.PlutusData` ([#1143](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1143)).
 - `MintingPolicy` to an enum consisting of `PlutusScript` or `NativeScript` ([#1069](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1069))
 - `Contract.Scripts` `applyArgs` is now monomorphic on the script parameter ([#1069](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1069))
+- Adapted Gero wallet extension to `preview` network in E2E test suite ([#1086](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1086))
 
 ### Removed
 - `balanceAndSignTxE`, `balanceAndSignTx`, `balanceAndSignTxs`, `balanceTxWithAddress`, `balanceTxsWithAddress`, `withBalancedAndSignedTx` and `withBalancedAndSignedTxs` from `Contract.Transaction` ([#1053](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1053))

doc/faq.md

@@ -17,6 +17,12 @@ This is probably because npm is used directly. This is something users have repo
 
 You can prevent `npm` from ever installing to local `node_modules` by enabling the `packageLockOnly` flag in the `shell` argument to `purescriptProject`. When enabled, `npm i` will always act as if the `--package-lock-only` flag has been passed. This is not enabled by default, but we recommend enabling it.
 
+## Common Contract execution problems
+
+### Q: What are the common reasons behind InsufficientTxInputs error?
+
+Most contracts require at least two UTxOs to run (one will be used as a collateral). If you use a wallet with only one UTxO, e.g. a new wallet you just funded from the faucet, you need to send yourself at least 5 tAda to create another UTxO for the collateral.
+
 ## Time-related
 
 ### Q: Time-related functions behave strangely, what's the reason?

doc/getting-started.md

@@ -5,19 +5,18 @@ This guide will help you get started writing contracts with CTL. Please also see
 **Table of Contents**
 
 - [Prerequisites](#prerequisites)
-  - [Setting up a new project](#setting-up-a-new-project)
-  - [Other prerequisites](#other-prerequisites)
+  * [Setting up a new project](#setting-up-a-new-project)
+  * [Other prerequisites](#other-prerequisites)
 - [Importing CTL modules](#importing-ctl-modules)
-  - [The `Contract` interface](#the-contract-interface)
-  - [Our `Prelude`](#our-prelude)
-- [Executing contracts and the `ContractEnv`](#executing-contracts-and-the-contractenv)
-  - [Making the `ContractEnv`](#making-the-contractenv)
+  * [The `Contract` interface](#the--contract--interface)
+  * [Our `Prelude`](#our--prelude-)
+- [Executing contracts and the `ContractEnv`](#executing-contracts-and-the--contractenv-)
+  * [Making the `ContractEnv`](#making-the--contractenv-)
 - [Building and submitting transactions](#building-and-submitting-transactions)
-  - [Awaiting tx confirmation](#awaiting-tx-confirmation)
-  - [Using compiled scripts](#using-compiled-scripts)
+  * [Using compiled scripts](#using-compiled-scripts)
 - [Testing](#testing)
-  - [With a light wallet](#with-a-light-wallet)
-  - [Without a light wallet](#without-a-light-wallet)
+  * [Without a light wallet](#without-a-light-wallet)
+  * [With a light wallet](#with-a-light-wallet)
 
 ## Prerequisites
 

examples/AlwaysMints.purs

@@ -10,7 +10,6 @@ import Contract.Log (logInfo')
 import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.ScriptLookups as Lookups
 import Contract.Scripts (MintingPolicy(PlutusMintingPolicy))
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.TextEnvelope
   ( TextEnvelopeType(PlutusScriptV1)
   , textEnvelopeBytes
@@ -50,7 +49,6 @@ contract = do
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ $ do
   runContract cfg contract
-  publishTestFeedback true
 
 foreign import alwaysMints :: String
 

examples/AlwaysSucceeds.purs

@@ -19,7 +19,6 @@ import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.PlutusData (PlutusData, unitDatum, unitRedeemer)
 import Contract.ScriptLookups as Lookups
 import Contract.Scripts (Validator, ValidatorHash, validatorHash)
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.TextEnvelope
   ( TextEnvelopeType(PlutusScriptV1)
   , textEnvelopeBytes
@@ -61,7 +60,6 @@ contract = do
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ do
   runContract cfg contract
-  publishTestFeedback true
 
 payToAlwaysSucceeds :: ValidatorHash -> Contract () TransactionHash
 payToAlwaysSucceeds vhash = do

examples/AwaitTxConfirmedWithTimeout.purs

@@ -13,7 +13,6 @@ import Contract.Prelude
 import Contract.Config (ConfigParams, testnetNamiConfig)
 import Contract.Log (logInfo')
 import Contract.Monad (Contract, launchAff_, runContract, throwContractError)
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.Transaction (awaitTxConfirmedWithTimeout)
 import Control.Monad.Error.Class (try)
 -- TODO Re-export into Contract or drop the usage
@@ -27,7 +26,6 @@ main = example testnetNamiConfig
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ do
   runContract cfg contract
-  publishTestFeedback true
 
 contract :: Contract () Unit
 contract = do

examples/ByUrl.purs

@@ -10,19 +10,8 @@ import Contract.Config
   , testnetLodeConfig
   , testnetNamiConfig
   )
-import Contract.Monad (Contract, runContract)
-import Contract.Prelude (fst, traverse_, uncurry)
-import Contract.Test.E2E (publishTestFeedback)
-import Contract.Wallet.Cip30Mock
-  ( WalletMock(MockFlint, MockGero, MockNami)
-  , withCip30Mock
-  )
-import Contract.Wallet.Key (privateKeysToKeyWallet)
-import Contract.Wallet.KeyFile
-  ( privatePaymentKeyFromString
-  , privateStakeKeyFromString
-  )
-import Control.Monad.Error.Class (liftMaybe)
+import Contract.Monad (Contract)
+import Contract.Test.E2E (E2EConfigName, E2ETestName, addLinks, route)
 import Ctl.Examples.AlwaysMints as AlwaysMints
 import Ctl.Examples.AlwaysSucceeds as AlwaysSucceeds
 import Ctl.Examples.Datums as Datums
@@ -37,74 +26,35 @@ import Ctl.Examples.SendsToken as SendsToken
 import Ctl.Examples.SignMultiple as SignMultiple
 import Ctl.Examples.TxChaining as TxChaining
 import Ctl.Examples.Wallet as Wallet
-import Data.Array (last)
-import Data.Foldable (lookup)
+import Ctl.Internal.Wallet.Cip30Mock
+  ( WalletMock(MockNami, MockGero, MockFlint, MockLode)
+  )
+import Data.Map (Map)
+import Data.Map as Map
 import Data.Maybe (Maybe(Just, Nothing))
-import Data.Newtype (wrap)
-import Data.String.Common (split)
-import Data.String.Pattern (Pattern(Pattern))
 import Data.Tuple.Nested (type (/\), (/\))
 import Effect (Effect)
-import Effect.Aff (delay, launchAff_)
-import Effect.Class (liftEffect)
-import Effect.Console as Console
-import Effect.Exception (error)
-
-foreign import _queryString :: Effect String
-
-foreign import _writeExampleHTML :: String -> Array String -> Effect Unit
 
 main :: Effect Unit
 main = do
-  traverse_ (uncurry _writeExampleHTML) $ map ((_ /\ map fst wallets) <<< fst)
-    examples
-  queryString <- last <<< split (Pattern "?") <$> _queryString
-  case split (Pattern ":") <$> queryString of
-    Just [ exampleName, walletName ] -> do
-      exampleContract <-
-        liftMaybe (error $ "unknown example name: " <> exampleName) $
-          lookup exampleName examples
-      config <- liftMaybe (error $ "unknown wallet name: " <> walletName) $
-        lookup walletName wallets
-      launchAff_ do
-        -- For Eternl, that does not initialize instantly
-        delay $ wrap 3000.0
-        paymentKey <- liftMaybe (error "Unable to load private key") $
-          privatePaymentKeyFromString paymentKeyStr
-        let
-          mbStakeKey = privateStakeKeyFromString stakeKeyStr
-          mbWalletMock = case walletName of
-            "nami-mock" -> Just MockNami
-            "gero-mock" -> Just MockGero
-            "flint-mock" -> Just MockFlint
-            _ -> Nothing
-        case mbWalletMock of
-          Just walletMock -> do
-            runContract config { walletSpec = Nothing }
-              $ withCip30Mock (privateKeysToKeyWallet paymentKey mbStakeKey)
-                  walletMock
-                  exampleContract
-            publishTestFeedback true
-          Nothing -> do
-            runContract config exampleContract
-            publishTestFeedback true
-    _ -> liftEffect $ Console.error "Error parsing query string"
+  addLinks wallets examples
+  route wallets examples
 
-wallets :: Array (String /\ ConfigParams ())
-wallets =
-  [ "nami" /\ testnetNamiConfig
-  , "gero" /\ testnetGeroConfig
-  , "flint" /\ testnetFlintConfig
-  , "eternl" /\ testnetEternlConfig
-  , "lode" /\ testnetLodeConfig
-  , "nami-mock" /\ testnetNamiConfig
-  , "gero-mock" /\ testnetGeroConfig
-  , "flint-mock" /\ testnetFlintConfig
-  , "lode-mock" /\ testnetLodeConfig
+wallets :: Map E2EConfigName (ConfigParams () /\ Maybe WalletMock)
+wallets = Map.fromFoldable
+  [ "nami" /\ testnetNamiConfig /\ Nothing
+  , "gero" /\ testnetGeroConfig /\ Nothing
+  , "flint" /\ testnetFlintConfig /\ Nothing
+  , "eternl" /\ testnetEternlConfig /\ Nothing
+  , "lode" /\ testnetLodeConfig /\ Nothing
+  , "nami-mock" /\ testnetNamiConfig /\ Just MockNami
+  , "gero-mock" /\ testnetGeroConfig /\ Just MockGero
+  , "flint-mock" /\ testnetFlintConfig /\ Just MockFlint
+  , "lode-mock" /\ testnetLodeConfig /\ Just MockLode
   ]
 
-examples :: Array (String /\ Contract () Unit)
-examples =
+examples :: Map E2ETestName (Contract () Unit)
+examples = Map.fromFoldable
   [ "AlwaysMints" /\ AlwaysMints.contract
   , "NativeScriptMints" /\ NativeScriptMints.contract
   , "AlwaysSucceeds" /\ AlwaysSucceeds.contract
@@ -120,27 +70,3 @@ examples =
   , "OneShotMintingV2" /\ OneShotMintingV2.contract
   , "ReferenceInputs" /\ ReferenceInputsV2.contract
   ]
-
--- Address is:
--- addr_test1qz4fcrdru8scms07fw5ztljq84jhmfv9eqf04rhx79kd66k264fzzl5qr7nr7rsz0mupy7wqgs8tg44tgx605mlmf4dss0agmx
--- Fund it when needed
-
-paymentKeyStr :: String
-paymentKeyStr =
-  """
-    {
-      "type": "PaymentSigningKeyShelley_ed25519",
-      "description": "Payment Signing Key",
-      "cborHex": "58200b07c066ba037344acee5431e6df41f6034bf1c5ffd6f803751e356807c6a209"
-    }
-  """
-
-stakeKeyStr :: String
-stakeKeyStr =
-  """
-    {
-      "type": "StakeSigningKeyShelley_ed25519",
-      "description": "Stake Signing Key",
-      "cborHex": "5820f0db841df6c7fbc4506c58fad6676db0354a02dfd26efca445715a8adeabc338"
-    }
-  """

examples/Datums.purs

@@ -24,7 +24,6 @@ import Contract.Log (logInfo')
 import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.PlutusData (DataHash, getDatumByHash, getDatumsByHashes)
 import Contract.Prim.ByteArray (hexToByteArrayUnsafe)
-import Contract.Test.E2E (publishTestFeedback)
 
 main :: Effect Unit
 main = example testnetConfig
@@ -49,4 +48,3 @@ contract = do
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ $ do
   runContract cfg contract
-  publishTestFeedback true

examples/IncludeDatum.purs

@@ -19,7 +19,6 @@ import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.PlutusData (Datum(Datum), PlutusData(Integer), unitRedeemer)
 import Contract.ScriptLookups as Lookups
 import Contract.Scripts (Validator, ValidatorHash, validatorHash)
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.TextEnvelope
   ( TextEnvelopeType(PlutusScriptV1)
   , textEnvelopeBytes
@@ -55,7 +54,6 @@ example cfg = launchAff_ do
     awaitTxConfirmed txId
     logInfo' "Tx submitted successfully, Try to spend locked values"
     spendFromIncludeDatum vhash validator txId
-  publishTestFeedback true
 
 datum :: Datum
 datum = Datum $ Integer $ BigInt.fromInt 42

examples/Lose7Ada.purs

@@ -20,7 +20,6 @@ import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.PlutusData (PlutusData, unitDatum, unitRedeemer)
 import Contract.ScriptLookups as Lookups
 import Contract.Scripts (Validator, ValidatorHash, validatorHash)
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.TextEnvelope
   ( TextEnvelopeType(PlutusScriptV1)
   , textEnvelopeBytes
@@ -58,7 +57,6 @@ example cfg = launchAff_ do
     awaitTxConfirmed txId
     logInfo' "Tx submitted successfully, Try to spend locked values"
     spendFromAlwaysFails vhash validator txId
-  publishTestFeedback true
 
 payToAlwaysFails :: ValidatorHash -> Contract () TransactionHash
 payToAlwaysFails vhash = do

examples/MintsMultipleTokens.purs

@@ -18,7 +18,6 @@ import Contract.Monad (Contract, launchAff_, runContract)
 import Contract.PlutusData (PlutusData(Integer), Redeemer(Redeemer))
 import Contract.ScriptLookups as Lookups
 import Contract.Scripts (MintingPolicy(PlutusMintingPolicy))
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.TextEnvelope
   ( TextEnvelopeType(PlutusScriptV1)
   , textEnvelopeBytes
@@ -73,7 +72,6 @@ contract = do
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ do
   runContract cfg contract
-  publishTestFeedback true
 
 foreign import redeemerInt1 :: String
 foreign import redeemerInt2 :: String

examples/NativeScriptMints.purs

@@ -17,7 +17,6 @@ import Contract.Scripts
   ( MintingPolicy(NativeMintingPolicy)
   , NativeScript(ScriptPubkey)
   )
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.Transaction (awaitTxConfirmed)
 import Contract.TxConstraints as Constraints
 import Contract.Value (CurrencySymbol, TokenName)
@@ -82,7 +81,6 @@ toSelfContract cs tn amount = do
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ $ do
   runContract cfg contract
-  publishTestFeedback true
 
 nsPolicy :: PaymentPubKeyHash -> NativeScript
 nsPolicy = ScriptPubkey <<< unwrap <<< unwrap

examples/OneShotMinting.purs

@@ -1,5 +1,5 @@
--- | This module demonstrates how `applyArgs` from `Contract.Scripts` can be 
--- | used to build scripts with the provided arguments applied. It creates a 
+-- | This module demonstrates how `applyArgs` from `Contract.Scripts` can be
+-- | used to build scripts with the provided arguments applied. It creates a
 -- | transaction that mints an NFT using the one-shot minting policy.
 module Ctl.Examples.OneShotMinting
   ( contract
@@ -30,7 +30,6 @@ import Contract.Scripts
   , PlutusScript
   , applyArgs
   )
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.Test.Utils (ContractWrapAssertion, Labeled, label)
 import Contract.Test.Utils as TestUtils
 import Contract.TextEnvelope
@@ -61,7 +60,6 @@ main = example testnetNamiConfig
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ do
   runContract cfg contract
-  publishTestFeedback true
 
 mkAssertions
   :: Address
@@ -139,4 +137,3 @@ mkOneShotMintingPolicy json ty mkPlutusScript oref = do
 
   liftedE $ map PlutusMintingPolicy <$> applyArgs unappliedMintingPolicy
     mintingPolicyArgs
-

examples/Pkh2Pkh.purs

@@ -10,7 +10,6 @@ import Contract.Config (ConfigParams, testnetNamiConfig)
 import Contract.Log (logInfo')
 import Contract.Monad (Contract, launchAff_, liftedM, runContract)
 import Contract.ScriptLookups as Lookups
-import Contract.Test.E2E (publishTestFeedback)
 import Contract.Transaction (awaitTxConfirmedWithTimeout)
 import Contract.TxConstraints as Constraints
 import Contract.Value as Value
@@ -39,7 +38,6 @@ contract = do
 
   awaitTxConfirmedWithTimeout (wrap 100.0) txId
   logInfo' $ "Tx submitted successfully!"
-  liftAff $ publishTestFeedback true
 
 example :: ConfigParams () -> Effect Unit
 example cfg = launchAff_ do