Plutonomicon · klntsky · Dec 15, 2023 · Jun 29, 2023 · Jun 29, 2023 · Jun 29, 2023
diff --git a/.gitignore b/.gitignore
@@ -27,5 +27,5 @@ test-data/keys
 tmp
 node_modules
 plutip-server/dist-newstyle/
+plutip-server/dist/
 plutip-server/.stack-work/
-
diff --git a/Makefile b/Makefile
@@ -1,21 +1,61 @@
 SHELL := bash
 .ONESHELL:
-.PHONY: run-dev run-build check-format format query-testnet-tip clean check-explicit-exports
+.PHONY: esbuild-bundle esbuild-serve webpack-bundle webpack-serve check-format format query-testnet-tip clean check-explicit-exports spago-build create-bundle-entrypoint create-html-entrypoint delete-bundle-entrypoint
 .SHELLFLAGS := -eu -o pipefail -c
 
 ps-sources := $(shell fd --no-ignore-parent -epurs)
 nix-sources := $(shell fd --no-ignore-parent -enix --exclude='spago*')
-js-sources := $(shell fd --no-ignore-parent -ejs)
-ps-entrypoint := Ctl.Examples.ByUrl # points to one of the example PureScript modules in examples/
-ps-bundle = spago bundle-module -m ${ps-entrypoint} --to output.js
+js-sources := $(shell fd --no-ignore-parent -ejs -ecjs)
+
+### Bundler setup
+
+# The main Purescript module
+ps-entrypoint := Ctl.Examples.ByUrl
+# The entry point function in the main PureScript module
+ps-entrypoint-function := main
+# Whether to bundle for the browser
+browser-runtime := 1 # Use "1" for true and "" for false
+
 preview-node-ipc = $(shell docker volume inspect store_node-preview-ipc | jq -r '.[0].Mountpoint')
 preprod-node-ipc = $(shell docker volume inspect store_node-preprod-ipc | jq -r '.[0].Mountpoint')
+serve-port := 4008
+
+spago-build:
+	@spago build
+
+create-bundle-entrypoint:
+	@mkdir -p dist/
+	@echo 'import("../output/${ps-entrypoint}/index.js").then(m => m.${ps-entrypoint-function}());' > ./dist/entrypoint.js
 
-run-dev:
-	@${ps-bundle} && BROWSER_RUNTIME=1 webpack-dev-server --progress
+delete-bundle-entrypoint:
+	@rm -f ./dist/entrypoint.js
 
-run-build:
-	@${ps-bundle} && BROWSER_RUNTIME=1 webpack --mode=production
+create-html-entrypoint:
+	@mkdir -p dist/
+	@cat << EOF > dist/index.html
+	<!DOCTYPE html>
+	<html>
+	  <body><script type="module" src="./index.js"></script></body>
+	</html>
+	EOF
+
+esbuild-bundle: spago-build create-bundle-entrypoint
+	@mkdir -p dist/
+	BROWSER_RUNTIME=${browser-runtime} node esbuild/bundle.js ./dist/entrypoint.js dist/index.js
+	@make delete-bundle-entrypoint
+
+esbuild-serve: spago-build create-bundle-entrypoint create-html-entrypoint
+	BROWSER_RUNTIME=1 node esbuild/serve.js ./dist/entrypoint.js dist/index.js dist/ ${serve-port}
+
+webpack-bundle: spago-build create-bundle-entrypoint
+	BROWSER_RUNTIME=${browser-runtime} webpack --mode=production \
+		-o dist/ --env entry=./dist/entrypoint.js
+	@make delete-bundle-entrypoint
+
+webpack-serve: spago-build create-bundle-entrypoint create-html-entrypoint
+	BROWSER_RUNTIME=1 webpack-dev-server --progress \
+		--port ${serve-port} \
+		-o dist/ --env entry=./dist/entrypoint.js
 
 .ONESHELL:
 check-explicit-exports:
@@ -35,8 +75,8 @@ check-whitespace:
 check-format: check-explicit-exports check-examples-imports check-whitespace
 	@purs-tidy check ${ps-sources}
 	@nixpkgs-fmt --check ${nix-sources}
-	@prettier --log-level warn -c ${js-sources}
-	@eslint --quiet ${js-sources}
+	@prettier --loglevel warn -c ${js-sources}
+	@eslint --quiet ${js-sources} --parser-options 'sourceType: module'
 
 format:
 	@purs-tidy format-in-place ${ps-sources}
@@ -66,7 +106,6 @@ run-ci-actions:
 	nix build -L .#checks.x86_64-linux.ctl-staking-test
 	nix build -L .#checks.x86_64-linux.examples-imports-check
 
-
 clean:
 	@ rm -r .psc-ide-port || true
 	@ rm -rf .psci_modules || true
@@ -75,3 +114,4 @@ clean:
 	@ rm -rf .spago2nix || true
 	@ rm -rf node_modules || true
 	@ rm -rf output || true
+	@ rm -rf dist || true
diff --git a/doc/babbage-features.md b/doc/babbage-features.md
@@ -14,7 +14,7 @@ This document is a reference/explainer for the new CTL APIs introduced for Babba
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 ## Reference Inputs
 
-[Reference inputs](https://cips.cardano.org/cip/CIP-0031/#reference-inputs) allow looking at an output without spending it in Plutus scripts.
+[Reference inputs](https://cips.cardano.org/cip/CIP-0031#reference-inputs) allow looking at an output without spending it in Plutus scripts.
 
 There are two ways to use an input as a reference in the constraints API:
 
@@ -28,7 +28,7 @@ There are two ways to use an input as a reference in the constraints API:
 
 ## Reference Scripts
 
-[Reference Scripts](https://developers.cardano.org/docs/governance/cardano-improvement-proposals/cip-0033/) allows the use of scripts without attaching them to the transaction (and using a reference instead).
+[Reference Scripts](https://cips.cardano.org/cip/CIP-0033) allows the use of scripts without attaching them to the transaction (and using a reference instead).
 
 Reference scripts can be utilized in CTL by first creating a reference point for the script to be used later via `mustPayToScriptWithScriptRef` (or its variants).
 
@@ -40,7 +40,7 @@ Then, `mustSpendScriptOutputUsingScriptRef` (or its variants) can be used to use
 
 ## Inline Data
 
-[CIP-32](https://developers.cardano.org/docs/governance/cardano-improvement-proposals/cip-0032/) introduces the inline data feature that allows storing datum values directly in transaction outputs, instead of just the hashes.
+[CIP-32](https://cips.cardano.org/cip/CIP-0032) introduces the inline data feature that allows storing datum values directly in transaction outputs, instead of just the hashes.
 
 In CTL, alternating between datum storage options can be achieved by specifying a `DatumPresence` value with constraints that accept it, like `mustPayToPubKeyWithDatum`.
 

diff --git a/doc/e2e-testing.md b/doc/e2e-testing.md
@@ -214,7 +214,7 @@ Note that the test closes successfully after the first successful `Contract` exe
 
 CTL offers a function to serve the `Contract`s to be tested with a router, that dispatches contracts and configuration parameters based on query part of the URL.
 
-It also builds a page with a table consisting of links to all possible examples with all possible environments, that looks like this:
+It also builds a page with drop-downs, allowing to select an example and an environments, that looks like this:
 
 ![Headless browser test suite - served examples](./images/e2e.png)
 

diff --git a/doc/images/e2e.png b/doc/images/e2e.png
diff --git a/doc/importing-scripts.md b/doc/importing-scripts.md
@@ -4,7 +4,8 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Exporting scripts from Plutus](#exporting-scripts-from-plutus)
+- [Exporting scripts from Plutus or Plutarch](#exporting-scripts-from-plutus-or-plutarch)
+  - [Using Plutonomy](#using-plutonomy)
 - [Importing serialized scripts](#importing-serialized-scripts)
 - [Serializing Plutus scripts](#serializing-plutus-scripts)
   - [PlutusTx](#plutustx)
@@ -13,9 +14,35 @@
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Exporting scripts from Plutus
+## Exporting scripts from Plutus or Plutarch
 
-See [the-plutus-scaffold](https://github.com/mlabs-haskell/the-plutus-scaffold)'s [exporter](https://github.com/mlabs-haskell/the-plutus-scaffold/tree/main/onchain/exporter) for a pipeline example.
+Usually projects use a Haskell binary called *exporter* that outputs a pre-compiler UPLC bundle into a file.
+
+The output file should be a Cardano envelope:
+
+```json
+{
+    "cborHex": "4e4d01000033222220051200120011",
+    "description": "always-succeeds",
+    "type": "PlutusScriptV2"
+}
+```
+
+- An example of a Plutus exporter can be found [here](https://github.com/Mr-Andersen/ctl-multisign-mre/blob/main/onchain/exporter/Main.hs).
+- For Plutarch, see [the-plutus-scaffold](https://github.com/mlabs-haskell/the-plutus-scaffold)'s [exporter](https://github.com/mlabs-haskell/the-plutus-scaffold/tree/main/onchain/exporter).
+
+
+### Using Plutonomy
+
+It makes sense to use [Plutonomy](https://github.com/well-typed/plutonomy) (an optimizer for UPLC) in the exporter:
+
+```haskell
+import Plutonomy (aggressiveOptimizerOptions, optimizeUPLCWith)
+
+script :: Script
+script = fromCompiledCode $
+  optimizeUPLCWith aggressiveOptimizerOptions $$(PlutusTx.compile [||policy||])
+```
 
 ## Importing serialized scripts
 

diff --git a/doc/key-management.md b/doc/key-management.md
@@ -11,7 +11,7 @@
 
 # Key Management
 
-The process of going from private key menmonic to a set of addresses that the wallet can use is well specified in [CIP-1852](https://cips.cardano.org/cip/CIP-1852/).
+The process of going from private key menmonic to a set of addresses that the wallet can use is well specified in [CIP-1852](https://cips.cardano.org/cip/CIP-1852).
 
 For an address to be built, the user must provide some entropy for private key derivation and a *derivation path*, that specifies a list of cryptographic operations to perform on the "parent" or "root" key to get the "child" private key that can be used for signing.
 

diff --git a/doc/using-from-js.md b/doc/using-from-js.md
@@ -130,7 +130,7 @@ if (typeof BROWSER_RUNTIME != "undefined" && BROWSER_RUNTIME) {
 
 to only one of the import variants.
 
-Our default [WebPack config](../webpack.config.js) uses `BROWSER_RUNTIME` environment variable to differentiate between two bundling options:
+Our default [WebPack config](../webpack.config.cjs) uses `BROWSER_RUNTIME` environment variable to differentiate between two bundling options:
 
 ```js
   plugins: [

diff --git a/esbuild/bundle.js b/esbuild/bundle.js
@@ -0,0 +1,13 @@
+import * as esbuild from "esbuild";
+import { buildOptions } from "./config.js";
+
+if (process.argv.length < 4) {
+  throw `usage: node bundle.js ENTRY_POINT OUTPUT_FILENAME`;
+}
+
+esbuild.build(
+  buildOptions({
+    entryPoint: process.argv[2],
+    outfile: process.argv[3]
+  })
+);
diff --git a/esbuild/config.js b/esbuild/config.js
@@ -0,0 +1,41 @@
+import { wasmLoader } from "esbuild-plugin-wasm";
+import { polyfillNode } from "esbuild-plugin-polyfill-node";
+
+const isBrowser = !!process.env.BROWSER_RUNTIME;
+
+export const buildOptions = ({ entryPoint, outfile }) => {
+  const config = {
+    entryPoints: [entryPoint],
+    outfile: outfile,
+    define: {
+      BROWSER_RUNTIME: isBrowser ? "true" : '""'
+    },
+    plugins: [
+      wasmLoader({
+        mode: "deferred"
+      })
+    ],
+    bundle: true,
+    platform: isBrowser ? "browser" : "node",
+    format: "esm",
+    treeShaking: true,
+    logLevel: "error"
+  };
+
+  // https://esbuild.github.io/api/#packages
+  if (!isBrowser) {
+    config.packages = "external";
+  } else {
+    config.plugins.push(
+      polyfillNode({
+        polyfills: {
+          crypto: true,
+          fs: true,
+          os: true
+        }
+      })
+    );
+  }
+
+  return config;
+};
diff --git a/esbuild/serve.js b/esbuild/serve.js
@@ -0,0 +1,72 @@
+import * as esbuild from "esbuild";
+import { buildOptions } from "./config.js";
+import http from "node:http";
+import * as url from "url";
+
+if (process.argv.length < 6) {
+  throw `usage: node serve.js ENTRY_POINT OUTPUT_FILE SERVE_DIR PORT`;
+}
+
+const ctx = await esbuild.context(
+  buildOptions({
+    entryPoint: process.argv[2],
+    outfile: process.argv[3]
+  })
+);
+
+const config = {
+  // Use the next port for esbuild server,
+  // we need a port for our proxy (see below).
+  port: parseInt(process.argv[5]) + 1,
+  servedir: process.argv[4]
+};
+
+let { host, port } = await ctx.serve(config);
+
+// Proxy Kupo to esbuild server. This is needed due to CORS
+
+const kupoEndpoint = process.env.KUPO_HOST || "http://localhost:1442";
+const kupoHost = url.parse(kupoEndpoint).hostname;
+const kupoPort = url.parse(kupoEndpoint).port || 80;
+
+http
+  .createServer((req, res) => {
+    const options = {
+      hostname: host,
+      port: port,
+      path: req.url,
+      method: req.method,
+      headers: req.headers
+    };
+
+    // Forward each incoming request to esbuild
+    const proxyReq = http.request(options, proxyRes => {
+      // If esbuild returns "not found" and the path starts from /kupo/
+      if (proxyRes.statusCode === 404 && req.url.startsWith("/kupo/")) {
+        // Connect to Kupo running on port 1442
+        const kupoOptions = {
+          hostname: kupoHost,
+          port: kupoPort,
+          path: req.url.slice("/kupo".length),
+          method: req.method,
+          headers: req.headers
+        };
+        // Request the corresponding path
+        http
+          .request(kupoOptions, kupoRes => {
+            // Pipe the response from Kupo back to the client
+            res.writeHead(kupoRes.statusCode, kupoRes.headers);
+            kupoRes.pipe(res, { end: true });
+          })
+          .end();
+      } else {
+        // Otherwise, forward the response from esbuild to the client
+        res.writeHead(proxyRes.statusCode, proxyRes.headers);
+        proxyRes.pipe(res, { end: true });
+      }
+    });
+
+    // Forward the body of the request to esbuild
+    req.pipe(proxyReq, { end: true });
+  })
+  .listen(parseInt(process.argv[5]));
diff --git a/examples/AdditionalUtxos.purs b/examples/AdditionalUtxos.purs
@@ -42,8 +42,8 @@ import Contract.Value (Value)
 import Contract.Value (lovelaceValueOf) as Value
 import Ctl.Examples.PlutusV2.Scripts.AlwaysSucceeds (alwaysSucceedsScriptV2)
 import Data.Array (fromFoldable) as Array
-import Data.BigInt (fromInt) as BigInt
 import Data.Map (difference, filter, keys) as Map
+import JS.BigInt (fromInt) as BigInt
 import Test.QuickCheck (arbitrary)
 import Test.QuickCheck.Gen (randomSampleOne)
 

diff --git a/examples/AlwaysMints.js b/examples/AlwaysMints.js
@@ -1,14 +1,5 @@
-/* global BROWSER_RUNTIME */
-
-let script;
-if (typeof BROWSER_RUNTIME != "undefined" && BROWSER_RUNTIME) {
-  script = require("Scripts/always-mints.plutus");
-} else {
-  const fs = require("fs");
-  const path = require("path");
-  script = fs.readFileSync(
-    path.resolve(__dirname, "../../fixtures/scripts/always-mints.plutus"),
-    "utf8"
-  );
-}
-exports.alwaysMints = script;
+export const alwaysMints = `{
+    "cborHex": "484701000022120011",
+    "description": "always-mints",
+    "type": "PlutusScriptV1"
+}`;