Merge pull request #13 from chatxbt/feature/swap-tokens

.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

Dockerfile

@@ -1,25 +1,34 @@
 # Use an official Python runtime as a parent image
 FROM python:3.11-slim
 
+# Create a user and set permissions
+RUN useradd -m -u 1000 user
+
 # Set the working directory in the container
 WORKDIR /app
 
-# Install PostgreSQL client libraries and development headers
+# Install system dependencies
+USER root
 RUN apt-get update && apt-get install -y \
+    python3-dev \
     libpq-dev \
     gcc \
     && rm -rf /var/lib/apt/lists/*
 
+# Ensure .files directory exists and is writable
+RUN mkdir -p /app/.files && chown -R user:user /app/.files
+
+# Switch back to the non-root user
+USER user
+
 # Copy the rest of the application code into the container
-COPY . .
+COPY --chown=user . .
 
 # Install any needed packages specified in requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt
 
-# Make port 8501 available to the world outside this container
-#EXPOSE 8000
-EXPOSE 8080
+# Expose port 8080 to the world outside this container
+EXPOSE 7860
 
 # Run chainlit when the container launches
-CMD ["python", "-m", "chainlit", "run", "chatxbt-assistant.py", "-h", "--port", "8080"]
-
+CMD ["python", "-m", "chainlit", "run", "chatxbt-assistant.py", "-h", "--port", "7860"]

README.md

@@ -1,11 +1,21 @@
-# ChatXBT Web3 AI Assitant Service
+---
+title: ChatXBT
+emoji: 💬
+colorFrom: purple
+colorTo: pink
+sdk: docker
+sdk_version: "latest"
+app_file: chatxbt-assistant.py
+pinned: false
+---
+
+# ChatXBT Web3 AI Assistant Service
 
 AI-powered unification and execution protocol for web3 applications
 
-
 ## Requirements
 
-The list below contains all the requirements needed to have a complete developer environment to sart working on this project.
+The list below contains all the requirements needed to have a complete developer environment to start working on this project.
 Follow the links to install or update these tools on your machine.
 
 1. [Python 3.12+](https://www.python.org/downloads/release/python-3120/)
@@ -13,17 +23,15 @@ Follow the links to install or update these tools on your machine.
 3. [Pip Installer](https://pip.pypa.io/en/stable/installation/)
 4. [Python Venv](https://docs.python.org/3/library/venv.html)
 
-
 ## Installation
 
 1. Clone the repository: `git clone https://github.com/ChatXBT/chatxbt-web3-ai-assistant.git`
-2. Get a copy of the `\`.env`\` file from the project manager`
+2. Get a copy of the `.env` file from the project manager
 3. Create a virtual environment: `python -m venv env`
 4. Activate the virtual environment: `source env/bin/activate`
-4. Install the dependencies: `pip install -r requirements.txt`
-5. Run the application: `chainlit run chatxbt-assistant.py -w`
-6. Open the application in your browser: `http://localhost:8000`
-
+5. Install the dependencies: `pip install -r requirements.txt`
+6. Run the application: `chainlit run chatxbt-assistant.py -w`
+7. Open the application in your browser: `http://localhost:8000`
 
 ## Project Overview
 
@@ -36,17 +44,15 @@ The project is structured as follows:
 5. src/search_services: `a list of search services that can be used to retrieve data for the AI assistant.`
 6. src/tools: `a list of tools that can be used to extend the functionality of the AI assistant.`
 
-
 ## Guides
 
 1. Follow the development, structure and documentation patterns of the `src/tools/coin_data_toolkit.py` to build custom toolkits
 2. Follow the development, structure and documentation patterns of the `src/tools/coin_data_toolkit.py` to build classes 
-3. Pay attention to the `constants` variables and `caching` decorators to optimize perfomance of class functions/methods across the project
+3. Pay attention to the `constants` variables and `caching` decorators to optimize performance of class functions/methods across the project
 4. Create new classes in the appropriate folders to maintain an organized codebase and project
 5. After installing any new package run `` to update the dependency requirements list
 6. Expose RPC functions for SDKs that do not support python runtime. use [DeepKit](https://deepkit.io/documentation/rpc) and [BunJS](https://bun.sh/) if possible.
 
-
 ## Git Workflow
 
 For this project, we will be using a very simple version of the Gitflow workflow. This workflow is designed to manage the development, release, and maintenance of software projects. It provides a clear and structured approach to managing branches, releases, and feature development.
@@ -68,21 +74,19 @@ For this project, we will be using a very simple version of the Gitflow workflow
 3. Push your changes to the remote repository: `git push origin bugfix/my-bugfix`
 4. Open a pull request on GitHub and request a review from a team member.
 5. Deploy the bugfix branch to a staging environment for testing.
-6. Once testing is finished, merge the pull  request into the main branch.
+6. Once testing is finished, merge the pull request into the main branch.
 7. Once the pull request is approved, merge it into the main branch.
 8. Delete the bugfix branch: `git branch -d bugfix/my-bugfix`
 9. Update your local main branch: `git checkout main && git pull origin main`
 
-
-## Deplopyment to producton
+## Deployment to production
 
 To be finalised and added
 
-
 ## TODO
 
 1. Add deployment instructions
 2. Setup CI/CD pipelines for automatic deployment
 3. Setup and integrate `LiteLLM` instance for LLM service high availability
-4. Add RPC class for remmote method calls to other chatxbt services written in other launguages such as `JS`, `TS` & `GO`
-5. Write enough unit test to ensure class and function input and output correctness
+4. Add RPC class for remote method calls to other ChatXBT services written in other languages such as `JS`, `TS` & `GO`
+5. Write enough unit tests to ensure class and function input and output correctness

docker-compose.yml

@@ -3,7 +3,7 @@ services:
     image: chatxbt-web3-ai-assistant
     build: .
     ports:
-      - "8080:8080"
+      - "7860:7860"
     env_file:
       - .env
     depends_on:

src/config/nemoguardrails/config.yml

@@ -0,0 +1,27 @@
+# config.yml
+models:
+  - type: main
+    engine: openai
+    model: gpt-3.5-turbo-instruct
+
+rails:
+  # Input rails are invoked when new input from the user is received.
+  input:
+    flows:
+      - check jailbreak
+      - mask sensitive data on input
+
+  # Output rails are triggered after a bot message has been generated.
+  output:
+    flows:
+      - self check facts
+      - self check hallucination
+      - activefence moderation
+
+  config:
+    # Configure the types of entities that should be masked on user input.
+    sensitive_data_detection:
+      input:
+        entities:
+          - PERSON
+          - EMAIL_ADDRESS

src/libs/rpc_client.py

@@ -49,4 +49,4 @@ async def rpc_call(
             return response.json()
     except httpx.RequestError as e:
         print(f"Error making RPC call: {e}")
-        return None
+        raise ValueError(f"Error making RPC call: {e}")

src/tools/crypto_swap_toolkit.py

@@ -99,58 +99,49 @@ class CryptoSwapTools(Toolkit):
         response = asyncio.run(rpc_call(method_name="getSwapSources"))
         return f"{response}"
 
-    def execute_swap(self, buy_token: str, sell_token: str, sell_amount: str, eth_address: str) -> str:
+    def execute_swap(
+            self,
+            buy_token: str,
+            sell_token: str,
+            sell_amount: str,
+            user_email: str,
+            chain: str = "base",
+    ) -> str:
         """
         Executes a swap using the 0x Swap API.
 
         Args:
-        buy_token (str): The token to buy (e.g., 'DAI').
-        sell_token (str): The token to sell (e.g., 'ETH').
-        sell_amount (str): The amount of the sell token to swap, in the smallest unit (e.g., wei for ETH).
-        eth_address (str): The Ethereum address of the user executing the swap.
+        -buy_token (str): The token to buy (e.g., 'DAI').
+        -sell_token (str): The token to sell (e.g., 'ETH').
+        -sell_amount (str): The amount of the sell token to swap, in the smallest unit (e.g., wei for ETH).
+        - user_email (str): The email of the user for whom the wallet is being fetched.
+        - chain (str): The EVM chain for which the wallet is being fetched and used to execute this transaction. use chain base as default
 
         Returns:
         dict: The transaction receipt of the swap transaction.
 
         Example:
-        >>> execute_swap('DAI', 'ETH', '1000000000000000000', '0xYourEthereumAddress')
+        >>> execute_swap('DAI', 'ETH', '1000000000000000000', 'userEmail', 'base')
         """
-        # Get the swap quote
-        quote = json.loads(self.get_swap_quote(buy_token, sell_token, sell_amount))
-        logger.info(f"Swap quote: {quote}")
-
-        if 'error' in quote:
-            # return {"error": "Failed to get swap quote"}
-            return f"Error: Failed to get swap quote"
-
-        # Approve the token if needed (skip if selling ETH)
-        if sell_token != 'ETH':
-            approval_receipt = self.token_approval_helper.approve_token(sell_token, quote['allowanceTarget'],
-                                                                        sell_amount, eth_address)
-            logger.info(f"Approval receipt: {approval_receipt}")
-
-            if 'status' not in approval_receipt or approval_receipt['status'] != 1:
-                # return {"error": "Token approval failed"}
-                return f"Error: Token approval failed"
 
-        # Execute the swap
+        logger.info("executing swap")
         try:
-            swap_tx = {
-                'from': eth_address,
-                'to': quote['to'],
-                'data': quote['data'],
-                'value': int(quote['value']),
-                'gas': 200000,
-                'gasPrice': self.web3.to_wei('20', 'gwei'),
-                'nonce': self.web3.eth.get_transaction_count(eth_address)
+            params = {
+                'buyToken': buy_token,
+                'sellToken': sell_token,
+                'sellAmount': sell_amount,
+                'wallet': {
+                  "userEmail": user_email,
+                  "chain": chain,
+                  "testnet": True,
+                  "gasless": True,
+                  "connected": True
+                }
             }
-            signed_swap_tx = self.web3.eth.account.signTransaction(swap_tx, private_key=get_private_key())
-            tx_hash = self.web3.eth.send_raw_transaction(signed_swap_tx.rawTransaction)
-            receipt = self.web3.eth.wait_for_transaction_receipt(tx_hash)
-            logger.info(f"Swap transaction receipt: {receipt}")
-            # return receipt
-            return f"{(receipt)}"
-        except Exception as e:
+            response = asyncio.run(rpc_call(method_name="swapTokens", params=params))
+            logger.info(f"Swap transaction receipt: {response}")
+            return f"{response}"
+        except requests.exceptions.RequestException as e:
             logger.warning(f"Failed to execute swap: {e}")
             # return {"error": str(e)}
             return f"Error: {e}"

src/tools/user_profile_toolkit.py

@@ -21,6 +21,9 @@ class UserProfileToolkit(Toolkit):
         self.register(self.update_user_picture)
         self.register(self.get_user_id)
 
+        # fetching user email
+        self.email = self.get_user_email()
+
     @cl.on_chat_start
     def get_user_info(self, info_type: str) -> str:
         """