Merge remote-tracking branch 'origin/master' into aleksandr/config-2

Author: Aleksandr Penskoi

.github/format.sh

@@ -4,7 +4,7 @@
 
 .PHONY: hoogle pab_servers_all pab_servers_all pab_db clean_db \
 	nix_build_lib nix_build_examples build test accept_pirs watch ghci readme_contents \
-	format lint requires_nix_shell 
+	format lint requires_nix_shell
 
 usage:
 	@echo "usage: make <command> [OPTIONS]"
@@ -25,8 +25,10 @@ usage:
 	@echo "  ghci                -- Run cabal v2-repl bot-plutus-interface"
 	@echo "  format              -- Apply source code formatting with fourmolu"
 	@echo "  format_check        -- Check source code formatting without making changes"
-	@echo "  nixfmt              -- Apply nix formatting with nixfmt"
-	@echo "  nixfmt_check        -- Check nix files for format errors"
+	@echo "  cabalfmt            -- Apply cabal formatting with cabal-fmt"
+	@echo "  cabalfmt_check      -- Check cabal files for formatting errors without making changes"
+	@echo "  nixpkgsfmt          -- Apply nix formatting with nixfmt"
+	@echo "  nixpkgsfmt_check    -- Check nix files for format errors"
 	@echo "  lint                -- Check the sources with hlint"
 	@echo "  readme_contents     -- Add table of contents to README"
 	@echo "  update_plutus       -- Update plutus version with niv"
@@ -68,7 +70,7 @@ ghci: requires_nix_shell
 	cabal v2-repl $(GHC_FLAGS) bot-plutus-interface
 
 # Source dirs to run fourmolu on
-FORMAT_SOURCES := $(shell git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.hs' )
+FORMAT_SOURCES := $(shell fd -e hs)
 
 # Extensions we need to tell fourmolu about
 FORMAT_EXTENSIONS := -o -XTemplateHaskell -o -XTypeApplications -o -XImportQualifiedPost -o -XPatternSynonyms -o -fplugin=RecordDotPreprocessor
@@ -81,14 +83,23 @@ format: requires_nix_shell
 format_check: requires_nix_shell
 	fourmolu --mode check --check-idempotence $(FORMAT_EXTENSIONS) $(FORMAT_SOURCES)
 
+# Cabal package definitions
+CABAL_SOURCES := $(shell fd -e cabal)
+
+cabalfmt: requires_nix_shell
+	cabal-fmt --inplace $(CABAL_SOURCES)
+
+cabalfmt_check: requires_nix_shell
+	cabal-fmt --check $(CABAL_SOURCES)
+
 # Nix files to format
-NIX_SOURCES := $(shell git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.nix' )
+NIX_SOURCES := $(shell fd -e nix)
 
-nixfmt: requires_nix_shell
-	nixfmt $(NIX_SOURCES)
+nixpkgsfmt: requires_nix_shell
+	nixpkgs-fmt $(NIX_SOURCES)
 
-nixfmt_check: requires_nix_shell
-	nixfmt --check $(NIX_SOURCES)
+nixpkgsfmt_check: requires_nix_shell
+	nixpkgs-fmt --check $(NIX_SOURCES)
 
 # Check with hlint, currently I couldn't get --refactor to work
 lint: requires_nix_shell
@@ -124,4 +135,3 @@ update_plutus:
 build_path = dist-newstyle/build/x86_64-linux/ghc-8.10.4.20210212/bot-plutus-interface-0.1
 clear_build:
 	@[ ! -e $(build_path) ] || rm -rf $(build_path)
-

.github/workflows/integrate.yaml

@@ -73,11 +73,11 @@ main :: IO ()
 main = do
   pabConf <-
     either error id
-      <$> BotPlutusInterface.loadPABConfig "config/pabConfig.value"
+      <$> BotPlutusInterface.loadPABConfig "pabConfig.value"
   BotPlutusInterface.runPAB @MyContracts pabConf
 ```
 
-Configuration format (example: <examples/plutus-game/config/pabConfig.value>): 
+Configuration format (example: <examples/plutus-game/pabConfig.value>): 
 
 ``` console
 $ cabal repl --disable-optimisation --repl-options -Wwarn

Makefile

@@ -131,25 +131,26 @@
         allow-newer: size-based:template-haskell
       '';
 
-      haskellModules = [(
-        { pkgs, ... }:
-        {
-          packages = {
-            marlowe.flags.defer-plugin-errors = true;
-            plutus-use-cases.flags.defer-plugin-errors = true;
-            plutus-ledger.flags.defer-plugin-errors = true;
-            plutus-contract.flags.defer-plugin-errors = true;
-            cardano-crypto-praos.components.library.pkgconfig = pkgs.lib.mkForce [ [ pkgs.libsodium-vrf ] ];
-            cardano-crypto-class.components.library.pkgconfig = pkgs.lib.mkForce [ [ pkgs.libsodium-vrf ] ];
-            cardano-wallet-core.components.library.build-tools = [
-              pkgs.buildPackages.buildPackages.gitMinimal
-            ];
-            cardano-config.components.library.build-tools = [
-              pkgs.buildPackages.buildPackages.gitMinimal
-            ];
-          };
-        }
-      )];
+      haskellModules = [
+        ({ pkgs, ... }:
+          {
+            packages = {
+              marlowe.flags.defer-plugin-errors = true;
+              plutus-use-cases.flags.defer-plugin-errors = true;
+              plutus-ledger.flags.defer-plugin-errors = true;
+              plutus-contract.flags.defer-plugin-errors = true;
+              cardano-crypto-praos.components.library.pkgconfig = pkgs.lib.mkForce [ [ pkgs.libsodium-vrf ] ];
+              cardano-crypto-class.components.library.pkgconfig = pkgs.lib.mkForce [ [ pkgs.libsodium-vrf ] ];
+              cardano-wallet-core.components.library.build-tools = [
+                pkgs.buildPackages.buildPackages.gitMinimal
+              ];
+              cardano-config.components.library.build-tools = [
+                pkgs.buildPackages.buildPackages.gitMinimal
+              ];
+            };
+          }
+        )
+      ];
 
       extraSources = [
         {
@@ -325,7 +326,8 @@
         let
           pkgs = nixpkgsFor system;
           pkgs' = nixpkgsFor' system;
-        in pkgs.haskell-nix.cabalProject' {
+        in
+        pkgs.haskell-nix.cabalProject' {
           src = ./.;
           inherit cabalProjectLocal extraSources;
           name = "bot-plutus-interface";
@@ -336,22 +338,40 @@
               ps.plutus-config
             ];
             withHoogle = true;
-            tools.haskell-language-server = {};
+            tools.haskell-language-server = { };
             exactDeps = true;
-            nativeBuildInputs = [
-              pkgs'.cabal-install
-              pkgs'.haskellPackages.cabal-fmt
-              pkgs'.haskellPackages.implicit-hie
-              pkgs'.hlint
-              pkgs'.haskellPackages.fourmolu
-              pkgs'.jq
-              pkgs'.websocat
+            nativeBuildInputs = with pkgs'; [
+              cabal-install
+              haskellPackages.cabal-fmt
+              haskellPackages.implicit-hie
+              haskellPackages.fourmolu
+              hlint
+              jq
+              websocat
+              fd
+              nixpkgs-fmt
             ];
           };
           modules = haskellModules;
         };
 
-    in {
+      formatCheckFor = system:
+        let
+          pkgs = nixpkgsFor system;
+        in
+        pkgs.runCommand "format-check"
+          { nativeBuildInputs = [ self.devShell.${system}.nativeBuildInputs ]; } ''
+          cd ${self}
+          export LC_CTYPE=C.UTF-8
+          export LC_ALL=C.UTF-8
+          export LANG=C.UTF-8
+          export IN_NIX_SHELL='pure'
+          make format_check cabalfmt_check nixpkgsfmt_check lint
+          mkdir $out
+        '';
+
+    in
+    {
       inherit cabalProjectLocal extraSources haskellModules;
 
       project = perSystem projectFor;
@@ -369,14 +389,18 @@
 
       # This will build all of the project's executables and the tests
       check = perSystem (system:
-        (nixpkgsFor system).runCommand "combined-check" {
-          nativeBuildInputs = builtins.attrValues self.checks.${system}
-            ++ builtins.attrValues self.flake.${system}.packages
-            ++ [ self.devShell.${system}.inputDerivation ];
-        } "touch $out");
-
+        (nixpkgsFor system).runCommand "combined-check"
+          {
+            nativeBuildInputs = builtins.attrValues self.checks.${system}
+              ++ builtins.attrValues self.flake.${system}.packages
+              ++ [ self.devShell.${system}.inputDerivation ];
+          } "touch $out");
       # NOTE `nix flake check` will not work at the moment due to use of
       # IFD in haskell.nix
-      checks = perSystem (system: self.flake.${system}.checks);
+      checks = perSystem (system: self.flake.${system}.checks // {
+        formatCheck = formatCheckFor system;
+      });
+
+      herculesCI.ciSystems = [ "x86_64-linux" ];
     };
 }

README.md

@@ -185,6 +185,7 @@ awaitTxStatusChange contractEnv txId = do
   case mTx of
     Nothing -> pure Unknown
     Just txState -> do
+      printLog @w Debug $ "Found transaction in node, waiting " ++ show chainConstant ++ " blocks for it to settle."
       awaitNBlocks @w contractEnv (chainConstant + 1)
       -- Check if the tx is still present in chain-index, in case of a rollback
       -- we might not find it anymore.

flake.nix

@@ -86,7 +86,7 @@ initState :: IO AppState
 initState = AppState <$> newTVarIO Map.empty
 
 -- | Mock API Schema, stripped endpoints that we don't use in this project
-type API a = WebSocketEndpoint :<|> ActivateContractEndpoint a :<|> RawTxEndpoint
+type API a = WebSocketEndpoint :<|> ActivateContractEndpoint a :<|> ContractLookupEndpoint :<|> RawTxEndpoint
 
 -- Endpoints are split up so it is easier to test them. In particular servant-client
 -- can not generate a client for the WebSocketEndpoint; this allows us to still
@@ -101,6 +101,13 @@ type ActivateContractEndpoint a =
     :> ReqBody '[JSON] (ContractActivationArgs a)
     :> Post '[JSON] ContractInstanceId -- Start a new instance.
 
+type ContractLookupEndpoint =
+  "api"
+    :> "contract"
+    :> "exists"
+    :> ReqBody '[JSON] ContractInstanceId
+    :> Post '[JSON] Bool
+
 type RawTxEndpoint =
   "raw-tx"
     :> Capture "tx-id" TxIdCapture
@@ -131,6 +138,7 @@ server :: HasDefinitions t => PABConfig -> AppState -> Server (API t)
 server pabConfig state =
   websocketHandler state
     :<|> activateContractHandler pabConfig state
+    :<|> contractLookupHandler state
     :<|> rawTxHandler pabConfig
 
 apiProxy :: forall (t :: Type). Proxy (API t)
@@ -191,7 +199,7 @@ handleContractActivityChange ::
   ContractState w ->
   [CombinedWSStreamToClient]
 handleContractActivityChange contractInstanceID prevState currentState =
-  catMaybes [activityChange, observableStateChange]
+  catMaybes [observableStateChange, activityChange]
   where
     activityChange =
       if (csActivity <$> prevState) /= Just currentState.csActivity
@@ -239,6 +247,14 @@ activateContractHandler pabConf state (ContractActivationArgs cardMessage _) =
   case getContract cardMessage of
     SomeBuiltin contract -> handleContract pabConf state contract
 
+contractLookupHandler ::
+  AppState ->
+  ContractInstanceId ->
+  Handler Bool
+contractLookupHandler (AppState s) contractInstanceId = liftIO . atomically $ do
+  instances <- readTVar s
+  return $ Map.member contractInstanceId instances
+
 handleContract ::
   forall
     (w :: Type)