Merge pull request #2 from valory-xyz/development

Add build and local run functionality

Author: keshav1998

.github/workflows/common_checks.yaml

@@ -3,7 +3,6 @@ name: main_workflow
 on:
   push:
     branches:
-      - development
       - main
   pull_request:
 

README.md

@@ -29,7 +29,7 @@ For now, the agent uses ETH exclusively; support for other networks (such as CEL
 ## How It Works
 
 1. **Download the Quickstart**
-   Get started quickly by downloading the project and installing its dependencies.
+  Please refer to the [Agent Quickstart Guide](docs/agents.md).
 
 2. **Set Up Your Environment**
    - Fund your agent with ETH.

agents-fun/data/.gitkeep

@@ -139,10 +139,10 @@ export function fetchSafeAddress(): string {
   const safeAddressDict =
     process.env.CONNECTION_CONFIGS_CONFIG_SAFE_CONTRACT_ADDRESSES;
   if (!safeAddressDict) {
-    console.error(
+    console.warn(
       "Safe address dictionary is not defined in the environment variables.",
     );
-    process.exit(1);
+    return "";
   }
   try {
     const safeAddressObj = JSON.parse(safeAddressDict);

agents-fun/src/config/index.ts

@@ -84,6 +84,12 @@ export async function triggerPluginActions(
     undefined,
   );
   if (result) {
+    const checkSafeAddress = runtime.getSetting("SAFE_ADDRESS");
+    if (!checkSafeAddress) {
+      elizaLogger.warn("SAFE_ADDRESS setting is not set");
+      elizaLogger.warn("Token Interaction behaviour won't be executed");
+      return false;
+    }
     elizaLogger.log(
       `[Trigger] Tweet was successful. Executing meme interaction...`,
     );

agents-fun/src/utils.ts

@@ -10,7 +10,7 @@
 - [Set Docker permissions so you can run containers as non-root user](https://docs.docker.com/engine/install/linux-postinstall/)
 
 
-## Run you own agent
+## Run your own agent
 
 ### Get the code
 
@@ -25,21 +25,44 @@
     git submodule update --init --recursive
     ```
 
-2. Create the virtual environment:
+2. Install dependencies:
 
     ```
     cd agents-fun-eliza
     pnpm install
     ```
 
-3. Build the packages:
+3. Define your character description in agents-fun/characters/eliza.character.json and update the system, bio and lore section as per your liking.
+
+4. Build and push the agent to your docker hub :
   ```
-   pnpm build
+   pnpm build:agent
    ```
+## RUN USING OLAS SDK(Provides a deployed safe with contracts)
 
 #### Prepare the data
 
 1. Edit the character file in agents-fun/characters/eliza.character.json and update the system, bio and lore section as per your liking.
 2. Follow the steps mentioned in [Olas-sdk-docs](https://github.com/valory-xyz/docs/blob/main/docs/olas-sdk/index.md), to build a olas agent using [Olas SDK Starter](https://github.com/valory-xyz/olas-sdk-starter/blob/main/README.md) and the docker image of the agent.
 
 For the Eliza Memeooorr agent we support agentic runs using olas-sdk. Which provides a set of tools to build and run agents, with a automatic safe account creation and management.
+
+## RUN LOCALLY
+
+> :warning: **Warning**
+> Agent won't perform token interaction behaviour unless you deploy your own safe on base network with the required contracts.
+
+#### Prepare the data
+
+1. Edit the character file in agents-fun/characters/eliza.character.json and update the system, bio and lore section as per your liking.
+2. Prepare the env
+  ```
+  cp .env.example .env
+  ```
+
+
+3. Run the docker file built previously, with the env file:
+
+```
+docker run -it --rm --env-file .env <IMAGE_NAME>
+```

docker-compose.yaml

@@ -5,6 +5,7 @@
   "author": "",
   "scripts": {
     "build": "lerna run build --stream",
+    "build:agent": "./scripts/build.sh",
     "start": "pnpm --filter \"agents-fun\" start --isRoot",
     "start:with-args": "tsc && node --loader ts-node/esm src/index.ts --",
     "clean": "lerna clean",

docs/agents.md

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+# Prompt the user to enter their Docker username
+read -p "Enter your Docker username: " DOCKER_USERNAME
+
+# Check if the Docker username is empty
+if [ -z "$DOCKER_USERNAME" ]; then
+  echo "Docker username cannot be empty."
+  exit 1
+fi
+
+# Ask if the user has an IPFS hash for their image
+read -p "Do you have an IPFS hash for your image? (y/n): " HAS_IPFS_HASH
+
+if [ "$HAS_IPFS_HASH" != "y" ]; then
+  echo "Please visit the following link to learn more about how to register and mint your agent to generate an IPFS hash for your image:"
+  echo "https://github.com/valory-xyz/olas-sdk-starter/blob/main/README.md"
+  echo "Once you are ready with your hash, you can come back and build again."
+  exit 0
+fi
+
+# Prompt the user to enter their IPFS hash
+read -p "Enter your IPFS hash: " IPFS_HASH
+
+# Check if the IPFS hash is empty
+if [ -z "$IPFS_HASH" ]; then
+  echo "IPFS hash cannot be empty."
+  exit 1
+fi
+
+# Navigate to the directory containing the Dockerfile
+cd "$(dirname "$0")/.."
+
+# Build the Docker image
+docker buildx build --platform=linux/amd64 -t ${DOCKER_USERNAME}/oar-memeooorr_eliza:${IPFS_HASH} .
+
+# Check if the build was successful
+if [ $? -eq 0 ]; then
+  echo "Docker image built successfully."
+  echo "Image Name: ${DOCKER_USERNAME}/oar-memeooorr_eliza:${IPFS_HASH}"
+  # Ask if user will push the image to Docker Hub
+  read -p "Would you like to push the image to Docker Hub? (y/n): " PUSH_IMAGE
+  if [ "$PUSH_IMAGE" == "y" ]; then
+    docker push ${DOCKER_USERNAME}/oar-memeooorr_eliza:${IPFS_HASH}
+    echo "Image pushed to Docker Hub."
+  fi
+else
+  echo "Docker image build failed."
+  exit 1
+fi

package.json

@@ -2,6 +2,7 @@
 
 # Navigate to the script's directory
 #
+echo "This script is used for running the agent in olas operate environment inside a docker container"
 echo "Reading wallet and safe address from agents folder"
 # wallet ovt key will be present inside the /agent_key/ethereum_private_key.txt folder
 # safe address will be present inside the /agent_key/safe_address.txt folder