Update docs and test comments

Author: jy14898

doc/e2e-testing.md

@@ -29,7 +29,7 @@ An executable for concrete tests is also needed. For a working example see `test
 
 The process is as follows:
 
-1. Set `ps-entrypoint` in Makefile to `Examples.ByURL`.
+1. Set `ps-entrypoint` in Makefile to `CTL.Examples.ByURL`.
 2. run `make run-dev`.
 3. In another shell, run `make e2e-test`.
 4. Examples will be run headless by default. In case of errors, the browser console will be printed to the console.
@@ -52,7 +52,7 @@ Chrome extensions are unpacked to some directory by the browser. From there, the
 The default test suite accepts the arguments `--nami-dir` and `--gero-dir` to point to the directories from which the extensions are loaded. (see the Makefile) In order to use the "live" version of an extension, just pass the arguments accordingly, e.g.:
 
 ```
-@spago test --main Test.E2E -a "E2ETest --nami-dir ~/.config/google-chrome/Default/Extensions/lpfcbjknijpeeillifnkikgncikgfhdo/ --gero-dir ~/.config/google-chrome/Default/Extensions/iifeegfcfhlhhnilhfoeihllenamcfgc --chrome-exe google-chome
+@spago test --main Test.CTL.E2E -a "E2ETest --nami-dir ~/.config/google-chrome/Default/Extensions/lpfcbjknijpeeillifnkikgncikgfhdo/ --gero-dir ~/.config/google-chrome/Default/Extensions/iifeegfcfhlhhnilhfoeihllenamcfgc --chrome-exe google-chome
 ```
 
 ### Where to Find the Installed Extensions
@@ -101,7 +101,7 @@ A new settings tarball can be easily created, for example using the `Makefile`:
 
 If you are using CTL as a library, you can and should create your own test suite to test your own contracts.
 
-1. Take `test/E2E.purs` as inspiration and create your own binary. You will find the necessary machinery in `Contract.Test.E2E`. Notable components:
+1. Take `test/E2E.purs` as inspiration and create your own binary. You will find the necessary machinery in `CTL.Contract.Test.E2E`. Notable components:
    - `withBrowser`: bracket to launch the browser with a specific extension, run something and clos the browser.
    - `parseOptions`: Parses command line options, in case you want to use the same as our example suite.
    - `publishTestFeedback`, `resetTestFeedback`, `retrieveTestFeedback`: Can be used to communicate success or failure from a contract to the tests.

doc/getting-started.md

@@ -46,7 +46,7 @@ You will also need to become familiar with [CTL's runtime](./runtime.md) as its
 
 ### The `Contract` interface
 
-CTL's public interface is contained in the `Contract.*` namespace. We recommend to always prefer imports from the `Contract` namespace. That is, **avoid importing any CTL modules not contained in `Contract`**, which should be considered internal. Importing non-`Contract` modules will make your code more brittle and susceptible to breakages when upgrading CTL versions.
+CTL's public interface is contained in the `CTL.Contract.*` namespace. We recommend to always prefer imports from the `Contract` namespace. That is, **avoid importing any CTL modules in `CTL.Internal.*`**. Importing internal modules will make your code more brittle and susceptible to breakages when upgrading CTL versions.
 
 For example, avoid the following:
 
@@ -55,17 +55,17 @@ For example, avoid the following:
 -- Anything not in in the `Contract` namespace should be considered an
 -- **internal** CTL module
 
-import Types.TokenName (TokenName)
-import Types.Scripts (MintingPolicy)
+import CTL.Internal.Types.TokenName (TokenName)
+import CTL.Internal.Types.Scripts (MintingPolicy)
 
 ```
 
 Instead, prefer:
 
 ```purescript
 
-import Contract.Value (TokenName)
-import Contract.Scripts (MintingPolicy)
+import CTL.Contract.Value (TokenName)
+import CTL.Contract.Scripts (MintingPolicy)
 
 ```
 

doc/plutip-testing.md

@@ -28,7 +28,7 @@ The services are NOT run by `docker-compose` as is the case with `launchCtlRunti
 
 ## Testing contracts
 
-The main entry point to the testing interface is `Contract.Test.Plutip.runPlutipContract` function:
+The main entry point to the testing interface is `CTL.Contract.Test.Plutip.runPlutipContract` function:
 
 ```purescript
 runPlutipContract
@@ -75,7 +75,7 @@ You can run Plutip tests via CTL's `purescriptProject` as well. After creating y
 {
   some-plutip-test = project.runPlutipTest {
     name = "some-plutip-test";
-    testMain = "MyProject.Test.Plutip";
+    testMain = "Test.MyProject.Plutip";
     # If you don't need `ctl-server`, you can set the following
     # to `false`. Make sure to leave it as `true` (the default)
     # if you are calling `applyArgs` in your contracts. This

doc/side-by-side-ctl-plutus-comparison.md

@@ -104,17 +104,17 @@ of CTL:
 ```PureScript
 module ExampleModule where
 
-import Contract.Prelude
-import Contract.Monad (Contract, liftedE, liftedM, logInfo')
-import Contract.ScriptLookups (ScriptLookups, mkUnbalancedTx)
-import Contract.PlutusData (PlutusData)
-import Contract.Transaction
+import CTL.Contract.Prelude
+import CTL.Contract.Monad (Contract, liftedE, liftedM, logInfo')
+import CTL.Contract.ScriptLookups (ScriptLookups, mkUnbalancedTx)
+import CTL.Contract.PlutusData (PlutusData)
+import CTL.Contract.Transaction
   ( BalancedSignedTransaction(BalancedSignedTransaction)
+  , TransactionHash
   , balanceAndSignTx
   , submit
   )
-import Types.TxConstraints (TxConstraints)
-import Types.Transaction (TransactionHash)
+import CTL.Contract.TxConstraints (TxConstraints)
 
 buildBalanceSignAndSubmitTx
   :: ScriptLookups PlutusData
@@ -230,10 +230,10 @@ contract.
 
 ```PureScript
 -- PureScript
-import Contract.PlutusData (PlutusData, unitDatum)
-import Contract.ScriptLookups as Lookups
-import Contract.TxConstraints as Constraints
-import Contract.Prelude
+import CTL.Contract.PlutusData (PlutusData, unitDatum)
+import CTL.Contract.ScriptLookups as Lookups
+import CTL.Contract.TxConstraints as Constraints
+import CTL.Contract.Prelude
 import Data.BigInt as BigInt
 
 give :: ValidatorHash -> Contract () TransactionHash
@@ -279,24 +279,23 @@ To talk about the grab contract in CTL we need to talk about some
 functions and types of CTL first. 
 
 ```PureScript
-module Plutus.Types.Transaction ... 
+module CTL.Internal.Plutus.Types.Transaction ... 
 .
 .
 .
-type Utxo = Map TransactionInput TransactionOutput
-newtype UtxoM = UtxoM Utxo
+type UtxoMap = Map TransactionInput TransactionOutputWithRefScript
 ```
 
 ```PureScript
-module Contract.Utxos ...
+module CTL.Contract.Utxos ...
 .
 .
 .
 -- | This module defines query functionality via Ogmios to get utxos.
 -- | Gets utxos at an (internal) `Address` in terms of a Plutus Address`.
 -- | Results may vary depending on `Wallet` type. See `QueryM` for more details
 -- | on wallet variance.
-utxosAt :: forall (r :: Row Type). Address -> Contract r (Maybe UtxoM)
+utxosAt :: forall (r :: Row Type). Address -> Contract r (Maybe UtxoMap)
 ```
 
 
@@ -317,7 +316,7 @@ grab
   -> Contract () Unit
 grab vhash validator txId = do
   let scriptAddress = scriptHashAddress vhash
-  UtxoM utxos <- fromMaybe (UtxoM Map.empty) <$> utxosAt scriptAddress
+  utxos <- fromMaybe Map.empty <$> utxosAt scriptAddress
   case fst <$> find hasTransactionId (Map.toUnfoldable utxos :: Array _) of
     Just txInput ->
       let

test/E2E.purs

@@ -20,7 +20,7 @@ import Test.Spec.Runner as SpecRunner
 import Test.CTL.Utils as Utils
 import Test.CTL.TestM (TestPlanM)
 
--- Run with `spago test --main Test.E2E`
+-- Run with `spago test --main Test.CTL.E2E`
 main :: Effect Unit
 main = launchAff_ $ do
   options <- liftEffect parseOptions

test/Integration.purs

@@ -21,7 +21,7 @@ import Test.CTL.Types.Interval as Types.Interval
 import Test.CTL.Utils as Utils
 import Test.CTL.TestM (TestPlanM)
 
--- Run with `spago test --main Test.Integration`
+-- Run with `spago test --main Test.CTL.Integration`
 main :: Effect Unit
 main = launchAff_ do
   Utils.interpret testPlan

test/Plutip.purs

@@ -148,7 +148,7 @@ import CTL.Internal.Wallet.Cip30Mock
   , withCip30Mock
   )
 
--- Run with `spago test --main Test.Plutip`
+-- Run with `spago test --main Test.CTL.Plutip`
 main :: Effect Unit
 main = launchAff_ do
   Utils.interpretWithConfig

test/TxOutput.purs

@@ -27,7 +27,7 @@ import CTL.Internal.Types.OutputDatum
 import Data.FoldableWithIndex (traverseWithIndex_)
 import Test.CTL.Utils as Utils
 
--- Run with `spago test --main Test.TxOutput`
+-- Run with `spago test --main Test.CTL.TxOutput`
 main :: Effect Unit
 main = launchAff_ do
   Utils.interpret suite