Merge pull request #25 from mlabs-haskell/calum/update-seabug-contracts

Preparing for demo

Author: rynoV

README.md

@@ -8,6 +8,11 @@
   * [Optional: Copy testnet node database](#optional--copy-testnet-node-database)
   * [Start services](#start-services)
   * [Optional: Mint your own NFTs](#optional--mint-your-own-nfts)
+- [Maintenance](#maintenance)
+  * [Updating dependencies](#updating-dependencies)
+  * [Targeting different networks](#targeting-different-networks)
+  * [Adding new off-chain contracts](#adding-new-off-chain-contracts)
+  * [Known errors](#known-errors)
 - [Components](#components)
   * [`nft-marketplace`](#-nft-marketplace-)
   * [`ogmios-datum-cache`](#-ogmios-datum-cache-)
@@ -25,7 +30,7 @@
 - arion - Provided by devshell
 - [docker](https://docs.docker.com/get-docker/)
 - [nami wallet](https://namiwallet.io/) installed as browser extension
-- Funds in wallet obtained from [faucet](https://testnets.cardano.org/en/testnets/cardano/tools/faucet/)
+- Funds in wallet obtained from [faucet](https://faucet.preview.world.dev.cardano.org/basic-faucet)
 
 ## Usage
 
@@ -68,7 +73,7 @@ Please note that `arion up` will require a full cardano node to sync, which can
 
 Once the chain is synced, you should be able to view the dApp UI from `localhost:8080`
 
-Ensure that Nami is set to Testnet, that you have some Test Ada, and that you've set collateral in Nami.
+Ensure that Nami is set to Preview, that you have some Test Ada (see [the faucet](https://faucet.preview.world.dev.cardano.org/basic-faucet)), and that you've set collateral in Nami.
 
 ### Optional: Mint your own NFTs
 
@@ -98,6 +103,37 @@ DESC: Description
 
 The `IPFS Base36 CID` value can be used to continue the minting process.
 
+## Maintenance
+
+### Updating dependencies
+
+- CTL: see [the docs](https://github.com/Plutonomicon/cardano-transaction-lib/blob/develop/doc/ctl-as-dependency.md)
+- Submodules: assuming submodules have been setup locally ([see docs](https://git-scm.com/book/en/v2/Git-Tools-Submodules)), just change to the new commit in the submodule, then stage and commit in the main `seabug` repo.
+- Purescript/JavaScript dependencies: these are managed in the submodules through the standard package management systems for the languages. For submodules using CTL (`seabug-contracts`), just be sure to follow the CTL docs to avoid conflicts in dependencies
+- Haskell dependencies: managed in [nix flakes](https://nixos.wiki/wiki/Flakes)
+- Runtime dependencies: also managed by flakes and [Arion](https://docs.hercules-ci.com/arion/)
+
+### Targeting different networks
+
+See [this PR](https://github.com/mlabs-haskell/seabug/pull/25) as an example of switching to the preview network. The general steps are:
+
+- Update the [network in arion-compose.nix](https://github.com/mlabs-haskell/seabug/blob/68cdadfcd364076be467fe2dd2de4c06d35d4f3b/arion-compose.nix#L13-16)
+- Make a blockfrost project pointing to the correct network, and update the blockfrost project ids throughout the project
+- Update the network ids throughout the project
+- Update the blockfrost api url in `seabug-contracts`
+
+### Adding new off-chain contracts
+
+See the [CTL docs](https://github.com/Plutonomicon/cardano-transaction-lib/tree/develop/doc). Off-chain contracts are stored in the `seabug-contracts` submodule.
+
+### Known errors
+
+> WebSocket connection to ws://localho.st:9999/ws failed: WebSocket is closed before the connection is established
+> Error: [object Object]
+> at push.../seabug-contracts/output.js.exports.error
+
+Try waiting a bit and reloading the page. Likely just ODC needing some time to start up.
+
 ## Components
 
 ### `nft-marketplace`

arion-compose.nix

@@ -8,7 +8,14 @@ let
   # FIXME: CTL version also pinned in seabug-contract. We need only one source of truth
   cardano-transaction-lib-server = (import
     cardano-transaction-lib/default.nix).packages.x86_64-linux."ctl-server:exe:ctl-server";
-in {
+  cardano-configurations = fetchGit { url = "https://github.com/input-output-hk/cardano-configurations"; rev = "182b16cb743867b0b24b7af92efbf427b2b09b52"; };
+  # { name = "preprod"; magic = 1; }
+  network = {
+    name = "preview";
+    magic = 2; # use `null` for mainnet
+  };
+in
+{
   # NOTE: still can't remember it...
   # ports = [ "host:container" ]
   config.services = {
@@ -48,10 +55,7 @@ in {
 
     cardano-transaction-lib-server.service = {
       command =
-        [ "${cardano-transaction-lib-server}/bin/ctl-server"
-          "--port" "8081"
-          "--ogmios-host" "ogmios" "--ogmios-port" "1337"
-        ];
+        [ "${cardano-transaction-lib-server}/bin/ctl-server" "--port" "8081" ];
       ports = [ "8081:8081" ];
       useHostStore = true;
       volumes = [
@@ -67,27 +71,36 @@ in {
         "--node-socket"
         "/ipc/node.socket"
         "--node-config"
-        "/config/testnet-node-config.json"
+        "/config/cardano-node/config.json"
       ];
       depends_on = { cardano-node.condition = "service_healthy"; };
-      image = "cardanosolutions/ogmios:v5.5.1-testnet";
+      image = "cardanosolutions/ogmios:v5.5.5-${network.name}";
       ports = [ "1337:1337" ];
       volumes = [
         "${toString ./.}/data/cardano-node/ipc:/ipc"
-        "${toString ./.}/config:/config"
+        "${cardano-configurations}/network/${network.name}:/config"
       ];
       restart = "always";
     };
 
     ogmios-datum-cache.service = {
-      command = [ "${ogmios-datum-cache}/bin/ogmios-datum-cache"
-                  "--db-connection" "host=postgresql-db port=5432 user=seabug dbname=seabug password=seabug"
-                  "--server-port" "9999"
-                  "--server-api" "usr:pwd"
-                  "--ogmios-address" "ogmios" "--ogmios-port" "1337"
-                  "--from-tip" "--use-latest"
-                  "--block-filter" "{\"address\": \"${marketplace-escrow-address}\"}"
-                ];
+      command = [
+        "${ogmios-datum-cache}/bin/ogmios-datum-cache"
+        "--db-connection"
+        "host=postgresql-db port=5432 user=seabug dbname=seabug password=seabug"
+        "--server-port"
+        "9999"
+        "--server-api"
+        "usr:pwd"
+        "--ogmios-address"
+        "ogmios"
+        "--ogmios-port"
+        "1337"
+        "--from-tip"
+        "--use-latest"
+        "--block-filter"
+        "{\"address\": \"${marketplace-escrow-address}\"}"
+      ];
       depends_on = {
         ogmios.condition = "service_healthy";
         postgresql-db.condition = "service_healthy";
@@ -98,16 +111,28 @@ in {
     };
 
     cardano-node.service = {
-      environment = { NETWORK = "testnet"; };
-      image = "inputoutput/cardano-node:1.35.2";
+      image = "inputoutput/cardano-node:1.35.3";
       volumes = [
         "${toString ./.}/data/cardano-node/ipc:/ipc"
         "${toString ./.}/data/cardano-node/cardano-node-data:/data"
+        "${cardano-configurations}/network/${network.name}/cardano-node:/config"
+        "${cardano-configurations}/network/${network.name}/genesis:/genesis"
+      ];
+      command = [
+        "run"
+        "--config"
+        "/config/config.json"
+        "--database-path"
+        "/data/db"
+        "--socket-path"
+        "/ipc/node.socket"
+        "--topology"
+        "/config/topology.json"
       ];
       healthcheck = {
         test = [
           "CMD-SHELL"
-          "CARDANO_NODE_SOCKET_PATH=/ipc/node.socket /bin/cardano-cli query tip --testnet-magic 1097911063"
+          "CARDANO_NODE_SOCKET_PATH=/ipc/node.socket /bin/cardano-cli query tip --testnet-magic ${toString network.magic}"
         ];
         interval = "10s";
         timeout = "5s";

buildFrontendStage2.sh

@@ -24,6 +24,7 @@ NODE_PATH=./src
 
 REACT_APP_API_BASE_URL=http://nft-mp-svr.localho.st:8080
 
+REACT_APP_CTL_LOG_LEVEL=Trace
 REACT_APP_CTL_SERVER_HOST=ctl.localho.st
 REACT_APP_CTL_SERVER_PORT=8080
 REACT_APP_CTL_SERVER_SECURE_CONN=false
@@ -36,7 +37,7 @@ REACT_APP_CTL_DATUM_CACHE_HOST=localho.st
 REACT_APP_CTL_DATUM_CACHE_PORT=9999
 REACT_APP_CTL_DATUM_CACHE_SECURE_CONN=false
 REACT_APP_CTL_NETWORK_ID=0
-REACT_APP_CTL_PROJECT_ID=testnetu7qDM8q2XT1S6gEBSicUIqXB6QN60l7B
+REACT_APP_CTL_PROJECT_ID=previewoXa2yw1U0z39X4VmTs6hstw4c6cPx1LN
 
 REACT_APP_IPFS_BASE_URL=https://cloudflare-ipfs.com/ipfs/
 EOT