fix: Update docker-compose file and readme for it

Author: Sital999

.env.example

@@ -0,0 +1,70 @@
+# Frontend
+NEXT_PUBLIC_API_URL=http://localhost:8000/api
+NEXT_PUBLIC_NETWORK_NAME=sanchonet
+NEXT_PUBLIC_MANAGER_BASE_DOMAIN=agent_manager:3001
+
+# API and Manager Common
+KAFKA_PREFIX=testing
+DATABASE_URL=postgresql://root:root@postgres:5432/cardano_autonomous_agent_testing_db
+KAFKA_BROKERS=kafka:9093
+AGENT_MNEMONIC=
+
+# API
+DOCS_URL=/api/docs
+KAFKA_ENABLED=true
+METADATA_BASE_URL=https://metadata.drep.id/api
+DB_SYNC_BASE_URL=http://dbsync:9000/api
+
+# Agent Manager
+CLIENT_ID=my-app
+CARDANO_NODE_URL=172.31.0.4:3004
+KUBER_BASE_URL=https://sanchonet.kuber.cardanoapi.io
+KUBER_API_KEY=
+MANAGER_WALLET_ADDRESS=
+MANAGER_WALLET_SIGNING_KEY=
+FAUCET_API_KEY=
+CARDANO_NETWORK_MAGIC=4
+BLOCKFROST_API_KEY=
+ENABLE_BLOCKFROST_SUBMIT_API=True
+NETWORK_NAME=sanchonet
+
+# Postgres
+POSTGRES_DB=cardano_autonomous_agent_testing_db
+POSTGRES_USER=root
+POSTGRES_PASSWORD=root
+
+# DbSync
+DBSYNC_PORT=9000
+DBSYNC_CORS_ENABLE=true
+DBSYNC_DATABASE_URL=
+
+# KAFKA
+KAFKA_BROKER_ID= 1
+KAFKA_ZOOKEEPER_CONNECT= zookeeper:2181
+KAFKA_LISTENER_SECURITY_PROTOCOL_MAP= DOCKER_NET:PLAINTEXT,HOST_NET:PLAINTEXT
+KAFKA_ADVERTISED_LISTENERS=  DOCKER_NET://kafka:9093,HOST_NET://localhost:9092
+KAFKA_INTER_BROKER_LISTENER_NAME= DOCKER_NET
+KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR= 1
+KAFKA_TRANSACTION_STATE_LOG_MIN_ISR= 1
+KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR= 1
+KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS= 0
+KAFKA_JMX_PORT= 9999
+KAFKA_CREATE_TOPICS= "trigger_config_updates:1:1"
+
+#zookeeper
+ZOOKEEPER_CLIENT_PORT = 2181
+ZOOKEEPER_TICK_TIME = 2000
+ZOOKEEPER_SYNC_LIMIT = 2
+
+# Docker network name
+DOCKER_NETWORK_NAME=cardano_autonomous_agent
+
+# Docker network name
+DOCKER_NETWORK_NAME=cardano_autonomous_agent
+
+# Agent
+AGENT_NODE_DOCKER_IMAGE_NAME=autonomous_agent
+
+
+
+

.gitignore

@@ -3,5 +3,6 @@ app.log
 .idea/
 .vscode/
 */**/.vscode/
+.env
 
 

README.md

@@ -20,11 +20,15 @@ and align with the decentralized governance objectives of Cardano's Voltaire era
 
 ### Using Docker
 
-Before running whole service locally using docker you need to add few of the environment variables
-on file `docker-compose.dev.yml`
+Before running whole service locally using docker you need to create a `.env` and `.env.dbsync` file from `.env.example` and `.env.dbsync.example` respectively to add environment variables.
+Below are some of the descriptions of the environment variables.
 
-##### api
-- AGENT_MNEMONIC 
+**Changes to be made in `.env` file**
+
+##### api and manager
+- KAFKA_PREFIX
+  - prefix for kafka topic
+- AGENT_MNEMONIC
   - Add seed phrase to generate wallet
 
 ##### agent_manager
@@ -35,20 +39,27 @@ on file `docker-compose.dev.yml`
   - Add a wallet address having sufficient ADA so that it can be used to transfer ADA to agent when requested
 - FAUCET_API_KEY (OPTIONAL)
   - Add faucet api key to load ADA which will be used to transfer ADA to agents as per request. And it will only be used if the provided `MANAGER_WALLET_ADDRESS` doesnot have sufficient ADA.
-- AGENT_MNEMONIC
-    - Add seed phrase to generate wallet that should be same as added in `api`
 - BLOCKFROST_API_KEY (Required if ENABLE_BLOCKFROST_SUBMIT_API is 'True' or enabled)
   - Visit [Blockfrost](https://blockfrost.io/) and sign up and generate api key
 
-Note: environment variable `ENABLE_BLOCKFROST_SUBMIT_API` is preferred as if it is not enabled then `Kuber` will be used to submit the transaction which might take couple of minutes.
+***Note***: environment variable `ENABLE_BLOCKFROST_SUBMIT_API` is preferred as if it is not enabled then `Kuber` will be used to submit the transaction which might take couple of minutes.
 
 ##### dbsync
-- DATABASE_URL
+- DBSYNC_DATABASE_URL
   - Add database url of dbsync
 
-Furthermore all env are setup to run in `Sanchonet` so if you want to run in `Preprod` or `Preview`
+##### docker network name
+- DOCKER_NETWORK_NAME
+  - Change name for docker network as default value is provided in `.env.example`
+
+##### agent
+- AGENT_NODE_DOCKER_IMAGE_NAME
+  - Change name for docker network as default value is provided in `.env.example`
+
+***Note***: Furthermore all env are setup to run in `Sanchonet` so if you want to run in `Preprod` or `Preview`
 Network then following environment variables are to be updated:
 
+**Changes to be made in `.env` file**
 ##### frontend
 - NEXT_PUBLIC_NETWORK_NAME
   -  preview or preprod
@@ -73,19 +84,33 @@ Network then following environment variables are to be updated:
 - NETWORK_NAME
   - preprod or preview
 
-##### dbsync
-- DATABASE_URL
+##### dbsync 
+- DBSYNC_DATABASE_URL
   - Update the dbsync database url and database name accordingly
 
+
+Finally run the given command below:
 ```shell
 docker compose -f docker-compose.dev.yml up -d
 ```
 
-**Note**: You can also use already existing services in place of this
+**Note** Make sure no application is running on port `3000`, `8000`
+
+**Note**: After running the above command line, you can run the agent by following steps:
+###### For running agent:
+- Visit frontend at `http://localhost:3000` and connect your wallet. 
+- Then click the `My Agent` tab at bottom left. you will be navigated to `Agents Page`
+- In `Overview Tab` click `Run Agent` button at the top right of `Agents Overview Section`
+- Now copy the docker command and run it in terminal. And Finally your agent is ready to run.
 
 
+### Setup Locally
+
 The setup guide for each services are in the respective directories:
 
+For running all services locally some of the dependent services like `Kafka`, `Postgresql` can be run via Docker using following command.
+
+
 1. [Backend](api/README.md)
 2. [Agent Manager](agent-manager/README.md)
 3. [Agent](agent-node/README.md)

agent-node/src/index.ts

@@ -32,11 +32,15 @@ if (token) {
 }
 if (!wsUrl) {
     const network = token.split('_')[0]
-
-    if (network && process.env.MANAGER_BASE_DOMAIN) {
+    const managerBaseDomain = process.env.MANAGER_BASE_DOMAIN
+    if (network && managerBaseDomain) {
         // This is set in docker file
-        wsUrl = `wss://${network.toLowerCase()}.${process.env.MANAGER_BASE_DOMAIN}`
-    } else {
+        wsUrl = `wss://${network.toLowerCase()}.${managerBaseDomain}`
+    }
+    else if (managerBaseDomain){
+        wsUrl = `ws://${managerBaseDomain}`
+    }
+    else {
         wsUrl = 'ws://localhost:3001'
     }
 }

agent-node/src/utils/validator.ts

@@ -4,13 +4,12 @@ import { logicalFunctions } from './operatorSupport'
 const NetworkName = ['preview', 'preprod', 'sanchonet']
 
 export function validateToken(token: string) {
-    if (token.split('_').length !== 2) {
+    if (token.split('_').length < 1) {
         return 'Not a valid token. Missing secret key'
     }
     if (token.split('_')[1].includes('undefined')) {
         return 'Not a valid token. Missing secret key'
     }
-    if (!NetworkName.includes(token.split('_')[0])) return 'Not a valid network name'
     return ''
 }