Seungheonoh/ctlsubmodule

CHANGELOG.md

@@ -5,12 +5,15 @@ This format is based on [Keep A Changelog](https://keepachangelog.com/en/1.0.0).
 ## Unreleased
 
 - Update templates.
+- Deprecate ctl-server.
+- Add `submodules` option to offchain that addes path for npm submodules
 
 ## 2.9.2 - 2023-06-14
 
 - Add liqwid-nix module documentation generation. Both onchain and offchain have their modules included.
   Pending implementation for automating this workstream.
 
+
 ## 2.9.1 - 2023-05-26
 
 - Hercules CI option is moved from `flake` to top level, by using hercules-ci-effects module.

nix/offchain.nix

@@ -149,18 +149,6 @@ in
 
           runtime = types.submodule {
             options = {
-              enableCtlServer = lib.mkOption {
-                description = ''
-                  Whether to enable or disable the CTL server (used to apply
-                  arguments to scripts and evaluate UPLC). Enabling this will
-                  also add the ctl-server overlay.
-
-                  Added in: 2.1.0.
-                '';
-                type = types.bool;
-                default = false;
-              };
-
               extraConfig = lib.mkOption {
                 description = ''
                   Additional config options to pass to the CTL runtime. See
@@ -325,6 +313,16 @@ in
                 default = { };
               };
 
+              submodules = lib.mkOption {
+                description = ''
+                  NPM submodules directories to include when making Node Env
+
+                  Added in: 2.8.0
+                '';
+                type = types.listOf types.path;
+                default = [ ];
+              };
+
               enableFormatCheck = lib.mkOption {
                 description = ''
                   Whether to add a flake check verifying that the code
@@ -387,16 +385,6 @@ in
           spago
         ];
 
-        includeCtlServer =
-          lib.any
-            (project: project.runtime.enableCtlServer)
-            (lib.attrValues projectConfigs);
-
-        additionalOverlays =
-          if includeCtlServer
-          then [ ctl-overlays.ctl-server ]
-          else [ ];
-
         nixpkgs-ctl = assert (lib.assertMsg (self.inputs ? nixpkgs-ctl) ''
           [liqwid-nix] liqwid-nix offchain module is being used. Please provide a 'nixpkgs-ctl' input, as taken from 'cardano-transaction-lib'.
         ''); self.inputs.nixpkgs-ctl;
@@ -410,7 +398,7 @@ in
               if projectConfig.pkgs == null then
                 (import nixpkgs-ctl {
                   inherit system;
-                  overlays = defaultCtlOverlays ++ additionalOverlays;
+                  overlays = defaultCtlOverlays;
                 })
               else projectConfig.pkgs;
 
@@ -530,6 +518,8 @@ in
 
                   strictComp = projectConfig.compileStrict;
 
+                  submodules = projectConfig.submodules;
+
                   shell = {
                     withRuntime = true;
                     withChromium = pkgs.stdenv.isLinux;
@@ -644,16 +634,9 @@ in
               formattingCheck
               jsLintCheck
             ];
-
-            ctlRuntimeConfig = projectConfig.runtime.extraConfig // {
-              ctlServer.enable = projectConfig.runtime.enableCtlServer;
-            };
           in
           {
-            packages = bundles //
-              (if projectConfig.runtime.exposeConfig
-              then { ctl-runtime = pkgs.buildCtlRuntime ctlRuntimeConfig { }; }
-              else { });
+            packages = bundles;
 
             run.nixFormat =
               {
@@ -699,7 +682,6 @@ in
             check = utils.combineChecks "combined-checks" checks;
 
             apps = {
-              ctl-runtime = pkgs.launchCtlRuntime ctlRuntimeConfig;
               docs = project.launchSearchablePursDocs { };
             };