Merge pull request #65 from geniusyield/61-example-config-for-kupo-backend-for-bot-api-server

Example config for kupo backend for bot api server #61

Author: 4TT1L4

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "cardano-configurations"]
+	path = cardano-configurations
+	url = https://github.com/input-output-hk/cardano-configurations.git
+	branch = 692010ed0f454bfbb566c06443227c79e2f4dbab

Makefile

@@ -11,6 +11,12 @@ pull:
 start:
 	docker compose up -d --remove-orphans
 
+start-kupo:
+	docker-compose -f docker-compose-kupo.yml up -d
+
+node-logs:
+	docker compose logs -f node
+
 logs:
 	docker compose logs -f
 

README.md

@@ -7,6 +7,8 @@ This repository houses on-chain smart contracts, Haskell off-chain interaction l
 - [Structure of repository](#structure-of-repository)
 - [Bot API Server](#bot-api-server)
   - [Spinning up the api server using docker](#spinning-up-the-api-server-using-docker)
+    - [Setting up the API Server with Docker (Maestro)](#setting-up-the-API-Server-with-docker-maestro)
+    - [Setting up the API Server with Docker (Kupo)](#setting-up-the-API-Server-with-docker-kupo)
   - [Building locally from source using Docker](#building-locally-from-source-using-docker)
   - [Building locally from source using the Haskell Toolchain](#building-locally-from-source-using-the-haskell-toolchain)
   - [Swagger API documentation](#swagger-api-documentation)
@@ -26,6 +28,8 @@ This repository houses on-chain smart contracts, Haskell off-chain interaction l
 
 ### Spinning up the api server using docker
 
+#### Setting up the API Server with Docker (Maestro)
+
 The api server can be started using [docker-compose](https://github.com/geniusyield/dex-contracts-api/blob/main/docker-compose.yml). Simply clone the repository,
 prepare a `.env` file with the necessary secrets and use the make targets from
 the Makefile available in the repository.
@@ -80,6 +84,33 @@ Integration with the Genius Yield DEX has never been easier.
 > [!TIP]
 > Have a look at sample configuration in [Building locally from source using the Haskell Toolchain](#building-locally-from-source-using-the-haskell-toolchain) section for thorough explanation of options made available to configure the server.
 
+#### Setting up the API Server with Docker (Kupo)
+
+If you're looking to utilize the API server alongside the Kupo provider backend, you're in luck! We've streamlined the process for you.
+
+Inside the repository, you'll find a `docker-compose-kupo.yml` file, which serves as a blueprint for running a local Cardano node, Kupo, and the API server seamlessly.
+
+```bash
+# Step 1: Clone the repository
+git clone git@github.com:geniusyield/dex-contracts-api.git
+
+# Step 2: Initialize and update submodules
+cd dex-contracts-api
+git submodule update --init --recursive
+
+# Step 3: Configure your environment variables
+# Create a .env file and populate it with the necessary secrets
+echo """
+SERVER_API_KEY=___REPLACE_ME___
+SEED_PHRASE=[word_1, word_2, ... word_23, word_24]""" > .env
+nano .env  # Use your preferred text editor to replace placeholders with actual values
+
+# Step 4: Launch the API server with Kupo
+docker-compose -f docker-compose-kupo.yml up -d
+```
+
+By following these steps, you'll have the API server up and running smoothly, integrated with the powerful capabilities of the Kupo provider backend.
+
 ### Building locally from source using Docker
 
 The easiest way to build the software is using docker.

cardano-configurations

@@ -0,0 +1,63 @@
+version: '3.8'
+services:
+  server:
+    image: ghcr.io/geniusyield/dex-contracts-api:latest
+    container_name: server
+    restart: always
+    volumes: ["node-ipc:/ipc"]
+    ports: ["8082:8082"]
+    depends_on: { node: { condition: service_healthy } }
+    environment:
+      MAESTRO_API_KEY: ${MAESTRO_API_KEY}
+      SERVER_API_KEY: ${SERVER_API_KEY}
+      SEED_PHRASE: ${SEED_PHRASE}
+      SERVER_CONFIG: |
+        coreProvider:
+          socketPath: /ipc/node.socket
+          kupoUrl: "kupo:1442"
+        networkId: mainnet
+        logging: [{type: {tag: stderr}, severity: "Debug", verbosity: "V2"}]
+        maestroToken: <<MAESTRO_API_KEY>>
+        serverApiKey: <<SERVER_API_KEY>>
+        wallet:
+          tag: mnemonicWallet
+          contents:
+            mnemonic: <<SEED_PHRASE>>
+        port: 8082
+  kupo:
+    image: cardanosolutions/kupo:v2.8.0
+    container_name: kupo
+    restart: always
+    volumes: ["node-ipc:/ipc", "./cardano-configurations/network:/network"]
+    ports: ['1442:1442']
+    depends_on: { node: { condition: service_healthy } }
+    command: [
+     --node-socket, /ipc/node.socket,
+     --since, origin,
+     --match, "*",
+     --host, "0.0.0.0",
+     --node-config, "/network/${NETWORK-mainnet}/cardano-node/config.json",
+     --workdir,
+     --prune-utxo,
+    ]
+    healthcheck:
+        test: ["CMD", "/bin/kupo", "health-check"]
+        interval: 30s
+        timeout: 10s
+        retries: 100
+  node:
+    image: ghcr.io/intersectmbo/cardano-node:8.9.1
+    container_name: node
+    restart: always
+    environment:
+     - NETWORK=${NETWORK-mainnet}
+    volumes: ["${NETWORK-mainnet}-node-db:/data/db", "node-ipc:/ipc"]
+    healthcheck:
+        test: ["CMD", "test", "-S", "/ipc/node.socket"]
+        interval: 30s
+        timeout: 10s
+        retries: 100
+volumes:
+  preprod-node-db: null
+  mainnet-node-db: null
+  node-ipc: null

docker-compose-kupo.yml

@@ -7,19 +7,25 @@ if [ -z "$SERVER_CONFIG" ]; then
     exit 1 # Exit code 1 for unset variable
 fi
 
-
-if [ -z "$CORE_MAESTRO_API_KEY" ]; then
-    echo "Error: CORE_MAESTRO_API_KEY environment variable is not set." >&2
-    exit 1 # Exit code 1 for unset variable
+if [[ "$SERVER_CONFIG" == *"<<CORE_MAESTRO_API_KEY>>"* ]]; then
+    if [ -z "$CORE_MAESTRO_API_KEY" ]; then
+        echo "Error: CORE_MAESTRO_API_KEY environment variable is not set." >&2
+        exit 1 # Exit code 1 for unset variable
+    fi
 fi
-if [ -z "$MAESTRO_API_KEY" ]; then
-    echo "Error: MAESTRO_API_KEY environment variable is not set." >&2
-    exit 1 # Exit code 1 for unset variable
+
+if [[ "$SERVER_CONFIG" == *"<<MAESTRO_API_KEY>>"* ]]; then
+    if [ -z "$MAESTRO_API_KEY" ]; then
+        echo "Error: MAESTRO_API_KEY environment variable is not set." >&2
+        exit 1 # Exit code 1 for unset variable
+    fi
 fi
+
 if [ -z "$SERVER_API_KEY" ]; then
     echo "Error: SERVER_API_KEY environment variable is not set." >&2
     exit 1 # Exit code 1 for unset variable
 fi
+
 if [ -z "$SEED_PHRASE" ]; then
     echo "Error: SEED_PHRASE environment variable is not set." >&2
     exit 1 # Exit code 1 for unset variable