Merge pull request #16 from mlabs-haskell/aleksandr/bump-nftmarketplace

Update all submodules, related fixes and mint automatization

Author: rynoV

.gitmodules

@@ -13,3 +13,6 @@
 [submodule "plutus-use-cases"]
 	path = plutus-use-cases
 	url = https://github.com/mlabs-haskell/plutus-use-cases
+[submodule "seabug-contracts"]
+	path = seabug-contracts
+	url = [email protected]:mlabs-haskell/seabug-contracts.git

README.md

@@ -69,81 +69,42 @@ Ensure that Nami is set to Testnet, that you have some Test Ada, and that you've
 
 ### Optional: Mint your own NFTs
 
-This process will be simplified in the future.
+See the minting section in `seabug-contracts/README.md`. The following section describes how to upload an image and get its IPFS CID.
 
-```shell
-$ # Setup server admin token, password: seabug
-$ PGPASSWORD=seabug psql -U seabug -h localhost -c "INSERT INTO admin_token(token) VALUES ('ADMIN_TOKEN')"
-
-$ # Upload image
-$ curl --location --request POST "locahost:8008" \
-    -F "image=@./cat123.png" \
-    -F "title=Cat Cat number 123" \
-    -F "description=Cat eating piece of cheese" \
-    -H "Authorization: ADMIN_TOKEN"
-
-$ # Get IPFS CID, replace SHA_256_HASH with hash from previous response, note "ipfsHash"
-$ curl --location --request GET 'localhost:8008' \
-    | jq 'to_entries[] | select (.value.sha256hash=="SHA_256_HASH")'
-
-$ # Convert CID, replace "IPFS_HASH" with hash from previous response, note the result
-$ ipfs cid format -b=base36 IPFS_HASH
-
-$ # Configure keys for BPI
-$ cd plutus-use-cases/mlabs
-$ cardano-cli address build \
-    --payment-verification-key-file payment.vkey \ 
-    --out-file payment.addr \ 
-    --testnet-magic 1097911063
-$ cardano-cli address key-gen \
-    --verification-key-file payment.vkey \
-    --signing-key-file payment.skey
-$ mkdir -p pab/signing-keys
-$ cat payment.addr
-$ mv payment.skey pab/signing-keys/signing-key-PKH_HERE.skey
-
-$ # Start BPI, note "minting-policy", it will be used later
-$ nix develop -L -c cabal run efficient-nft-pab
-
-$ # In other console
-$ # Mint underlying CNFTs, replace "CONVERTED_CID" with the result of `ipfs` command
-$ curl --location --request POST 'localhost:3003/api/contract/activate' \
-    --header 'Content-Type: application/json' \
-    --data-raw '
-     {
-        "caID": {
-            "tag":"MintCnft",
-            "contents":[
-               {
-                  "mc'"'"'name":"Cat number 123",
-                  "mc'"'"'description":"Cat eating piece of cheese",
-                  "mc'"'"'image":"ipfs://CONVERTED_CID",
-                  "mc'"'"'tokenName":"cat-123" # This should be hex encoded (without 0x)
-               }
-            ]
-        }
-     }'
-
-$ # Go back to previous terminal and stop BPI
-$ # Replace "CURRENCY_SYMBOL" in /efficient-nft-pab/Main.hs with currency symbol from BPI log
-$ # Restart BPI, note "seabug-mint-request"
-$ nix develop -L -c cabal run efficient-nft-pab
-
-$ # Mint SeaBug NFT
-$ curl --location --request POST 'localhost:3003/api/contract/activate'
-    --header 'Content-Type: application/json' \
-    --data-raw 'INSERT_seabug-mint-request_HERE'
-
-$ cd ../cardano-transaction-lib
-$ # Replace value of "mintingPolicy1" in seabug_contracts/MintingPolicy.js with policy noted from BPI
+#### Upload NFT image
+
+If you have an image:
+
+``` shell
+$ cd seabug
+$ scripts/upload-image.sh
+Arguments: <IMAGE_FILE> <TITLE> <DESCRIPTION>
+$ scripts/upload-image.sh 'image.jpeg' 'Title' 'Description'
+```
+
+This will add the image to IPFS and the postgres database, and should print out something like:
+
+```
+IMAGE: image.jpeg
+TITLE: Title
+DESC: Description
+> IMAGE_HASH: 4cefddfb4f62a3c68d08863cc299a2d6411174c8ff3325d21239ad3b5dcbf21c
+> IPFS_HASH: bafkreicm57o7wt3cupdi2ceghtbjtiwwieixjsh7gms5eerzvu5v3s7sdq
+> IPFS Base36 CID: k2cwueakfq42m0c5y33czg6ces3tj9b1xlv59krz88y2r8m18e2zxee4
 ```
 
+The `IPFS Base36 CID` value can be used to continue the minting process.
+
 ## Components
 
 ### `nft-marketplace`
 
 Frontend for Seabug marketplace, interacts with Cardano blockchain using `cardano-transaction-lib`.
 
+### `seabug-contract`
+
+NFT marketplace contracts in purescript. Onchain part was hardcoded as binary.
+
 ### `ogmios-datum-cache`
 
 Caches datums of NFTs that are on available marketplace.

arion-compose.nix

@@ -1,15 +1,18 @@
 { pkgs, ... }:
 let
-  nft-marketplace-server =
-    (pkgs.callPackage (import nft-marketplace-server/release.nix)
-      { }).nft-marketplace-server;
-  ogmios-datum-cache = (import ogmios-datum-cache/default.nix).packages.x86_64-linux.ogmios-datum-cache;
+  # The address of the marketplace script (`MarketPlace.js` in `seabug-contracts`)
+  marketplace-escrow-address = "addr_test1wr05mmuhd3nvyjan9u4a7c76gj756am40qg7vuz90vnkjzczfulda";
+
+  nft-marketplace-server = (import nft-marketplace-server/default.nix).packages.x86_64-linux."nft-marketplace-server:exe:nft-marketplace-server";
+  ogmios-datum-cache = (import ogmios-datum-cache/default.nix).packages.x86_64-linux."ogmios-datum-cache";
+  # 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."cardano-browser-tx-server:exe:cardano-browser-tx-server";
+    cardano-transaction-lib/default.nix).packages.x86_64-linux."ctl-server:exe:ctl-server";
 in {
   # NOTE: still can't remember it...
   # ports = [ "host:container" ]
   config.services = {
+
     nft-marketplace.service = {
       depends_on = {
         nft-marketplace-server.condition = "service_healthy";
@@ -22,7 +25,8 @@ in {
       ports = [ "8080:80" ];
       volumes = [
         "${toString ./.}/nft-marketplace/build:/usr/share/nginx/html"
-        "${toString ./.}/config/nginx.conf:/etc/nginx/nginx.conf"
+        "${toString ./.}/config/nginx/nginx.conf:/etc/nginx/nginx.conf"
+        "${toString ./.}/config/nginx/conf.d:/etc/nginx/conf.d"
       ];
       healthcheck = {
         test = [
@@ -41,46 +45,61 @@ in {
       };
       useHostStore = true;
     };
+
     cardano-transaction-lib-server.service = {
       command =
-        [ "${cardano-transaction-lib-server}/bin/cardano-browser-tx-server" ];
+        [ "${cardano-transaction-lib-server}/bin/ctl-server"
+          "--port" "8081"
+          "--ogmios-host" "ogmios" "--ogmios-port" "1337"
+        ];
       ports = [ "8081:8081" ];
       useHostStore = true;
+      volumes = [
+        "${toString ./.}/data/cardano-node/ipc:/ipc"
+      ];
+      restart = "always";
     };
+
     ogmios.service = {
       command = [
         "--host"
         "0.0.0.0"
         "--node-socket"
         "/ipc/node.socket"
         "--node-config"
-        "/config/testnet-config.json"
+        "/config/testnet-node-config.json"
       ];
       depends_on = { cardano-node.condition = "service_healthy"; };
-      image = "cardanosolutions/ogmios:v5.2.0-testnet";
+      image = "cardanosolutions/ogmios:v5.5.1-testnet";
       ports = [ "1337:1337" ];
       volumes = [
         "${toString ./.}/data/cardano-node/ipc:/ipc"
         "${toString ./.}/config:/config"
       ];
+      restart = "always";
     };
+
     ogmios-datum-cache.service = {
-      command = [ "${ogmios-datum-cache}/bin/ogmios-datum-cache" ];
+      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";
       };
       ports = [ "9999:9999" ];
       useHostStore = true;
-      volumes = [
-        "${toString ./.}/config/datum-cache-config.toml:/config/config.toml"
-      ];
-      working_dir = "/config";
       restart = "always";
     };
+
     cardano-node.service = {
       environment = { NETWORK = "testnet"; };
-      image = "inputoutput/cardano-node:1.33.0";
+      image = "inputoutput/cardano-node:1.35.2";
       volumes = [
         "${toString ./.}/data/cardano-node/ipc:/ipc"
         "${toString ./.}/data/cardano-node/cardano-node-data:/data"
@@ -95,7 +114,9 @@ in {
         start_period = "15m";
         retries = 3;
       };
+      restart = "always";
     };
+
     postgresql-db.service = {
       command = [ "-c" "stats_temp_directory=/tmp" ];
       environment = {
@@ -113,7 +134,9 @@ in {
       };
       volumes =
         [ "${toString ./.}/data/postgres-data:/var/lib/postgresql/data" ];
+      restart = "always";
     };
+
     nft-marketplace-server.service = {
       image = "alpine";
       command = [
@@ -144,5 +167,6 @@ in {
       restart = "always";
       volumes = [ "${toString ./.}/config/tmp:/tmp" ];
     };
+
   };
 }

buildFrontend.sh

@@ -1 +1 @@
-nix develop cardano-transaction-lib/ -L --extra-experimental-features "nix-command flakes" -c ./buildFrontendStage2.sh 
+nix develop seabug-contracts/ -L --extra-experimental-features "nix-command flakes" -c ./buildFrontendStage2.sh 

buildFrontendStage2.sh

@@ -1,29 +1,37 @@
 set -e
 set -x
-cd cardano-transaction-lib
-npm run bundle-seabug
-cd npm-packages/cardano-transaction-lib-seabug
+
+SEABUG=$PWD
+
+cd $SEABUG/seabug-contracts
 npm install
-cd ../../..
+make run-build
+
+cd $SEABUG/nft-marketplace
+npm install
+
 # This is a replacement of npm link. npm link is problematic on immutable file systems
-rm -rf nft-marketplace/node_modules/cardano-transaction-lib-seabug
-mkdir -p $PWD/nft-marketplace/node_modules/
-ln -s $PWD/cardano-transaction-lib/npm-packages/cardano-transaction-lib-seabug\
-      $PWD/nft-marketplace/node_modules/cardano-transaction-lib-seabug
-cd nft-marketplace
-rm .env
+rm -rf $SEABUG/nft-marketplace/node_modules/seabug-contracts
+mkdir -p $SEABUG/nft-marketplace/node_modules/
+ln -s $SEABUG/seabug-contracts \
+      $SEABUG/nft-marketplace/node_modules/seabug-contracts
+
+cd $SEABUG/nft-marketplace
+rm -f .env
 cat <<EOT >> .env
 SKIP_PREFLIGHT_CHECK=true
-NODE_PATH=./src\
+NODE_PATH=./src
 
-REACT_APP_API_BASE_URL=http://api.localho.st:8080
+REACT_APP_API_BASE_URL=http://nft-mp-svr.localho.st:8080
 
-REACT_APP_CTL_SERVER_HOST=localho.st
-REACT_APP_CTL_SERVER_PORT=8081
+REACT_APP_CTL_SERVER_HOST=ctl.localho.st
+REACT_APP_CTL_SERVER_PORT=8080
 REACT_APP_CTL_SERVER_SECURE_CONN=false
+
 REACT_APP_CTL_OGMIOS_HOST=localho.st
 REACT_APP_CTL_OGMIOS_PORT=1337
 REACT_APP_CTL_OGMIOS_SECURE_CONN=false
+
 REACT_APP_CTL_DATUM_CACHE_HOST=localho.st
 REACT_APP_CTL_DATUM_CACHE_PORT=9999
 REACT_APP_CTL_DATUM_CACHE_SECURE_CONN=false
@@ -32,5 +40,4 @@ REACT_APP_CTL_PROJECT_ID=testnetu7qDM8q2XT1S6gEBSicUIqXB6QN60l7B
 
 REACT_APP_IPFS_BASE_URL=https://cloudflare-ipfs.com/ipfs/
 EOT
-npm install
 npm run build