feat(backend): refactor how inference providers are added and configured

.dockerignore

@@ -22,3 +22,8 @@ frontend/src/assets/examples
 frontend/.nyc_output
 frontend/coverage
 frontend/vite.config.ts.timestamp-*
+
+# Python
+# Byte-compiled / optimized / DLL files
+**/__pycache__/
+**/*.py[cod]

.env.example

@@ -56,6 +56,9 @@ HEURISTAIMODELSURL  = 'https://raw.githubusercontent.com/heurist-network/heurist
 # If you want to use Heurist AI add your key here
 HEURISTAIAPIKEY     = '<add_your_heuristai_api_key_here>'
 
+# If you want to use Anthropic (Claude AI) add your key here and uncomment the line
+# ANTHROPIC_API_KEY   = '<add_your_anthropic_api_key_here>'
+
 # Front end container details
 VITE_JSON_RPC_SERVER_URL  = 'http://127.0.0.1:4000/api'
 VITE_WS_SERVER_URL   = 'ws://127.0.0.1:4000'

.github/workflows/backend_integration_tests_pr.yml

@@ -42,6 +42,8 @@ jobs:
       - name: Copy .env file
         run: cp .env.example .env
 
+      # TODO: we should also add also heuristai and anthropic keys to the e2e tests and test all providers
+
       - name: Set OPENAIKEY in the .env file so it can be loaded from the environment
         env:
           OPENAIKEY: ${{ secrets.OPENAIKEY }}
@@ -58,7 +60,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-buildx-
 
-      - name: Build Docker image
+      - name: Build Docker images
         run: docker compose build
 
       - name: Run Docker Compose
@@ -106,3 +108,27 @@ jobs:
       - name: Shutdown Docker Compose
         if: always()
         run: docker compose down
+
+  db-integration-test:
+    needs: triggers
+    if: ${{ needs.triggers.outputs.is_pull_request_opened == 'true' || needs.triggers.outputs.is_pull_request_review_approved == 'true' || needs.triggers.outputs.is_pull_request_labeled_with_run_tests == 'true' }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Run Docker Compose
+        run: docker compose -f tests/db-sqlalchemy/docker-compose.yml --project-directory . up tests --build --force-recreate --always-recreate-deps

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     hooks:
       - id: backend-unit-pytest
         name: backend unit tests with pytest
-        entry: python3 -m pytest backend
+        entry: pytest tests/unit
         language: system
         types: [python]
         pass_filenames: false

.vscode/settings.json

@@ -2,7 +2,11 @@
   "[vue]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "python.testing.pytestArgs": ["tests"],
+  "python.testing.pytestArgs": ["tests", "backend"],
   "python.testing.unittestEnabled": false,
-  "python.testing.pytestEnabled": true
+  "python.testing.pytestEnabled": true,
+  "sonarlint.connectedMode.project": {
+    "connectionId": "YeagerAI",
+    "projectKey": "yeagerai_genlayer-simulator"
+  }
 }

backend/consensus/base.py

@@ -17,6 +17,7 @@
 )
 from backend.database_handler.accounts_manager import AccountsManager
 from backend.database_handler.types import ConsensusData
+from backend.domain.types import LLMProvider, Validator
 from backend.node.base import Node
 from backend.node.genvm.types import ExecutionMode, Vote
 from backend.protocol_rpc.message_handler.base import MessageHandler
@@ -128,12 +129,18 @@ async def exec_transaction(
         # Create Leader
         leader_node = Node(
             contract_snapshot=contract_snapshot,
-            address=leader["address"],
             validator_mode=ExecutionMode.LEADER,
-            stake=leader["stake"],
-            provider=leader["provider"],
-            model=leader["model"],
-            config=leader["config"],
+            validator=Validator(
+                address=leader["address"],
+                stake=leader["stake"],
+                llmprovider=LLMProvider(
+                    provider=leader["provider"],
+                    model=leader["model"],
+                    config=leader["config"],
+                    plugin=leader["plugin"],
+                    plugin_config=leader["plugin_config"],
+                ),
+            ),
             msg_handler=self.msg_handler,
         )
 
@@ -149,16 +156,22 @@ async def exec_transaction(
         validator_nodes = [
             Node(
                 contract_snapshot=contract_snapshot,
-                address=validator["address"],
                 validator_mode=ExecutionMode.VALIDATOR,
-                stake=validator["stake"],
-                provider=validator["provider"],
-                model=validator["model"],
-                config=validator["config"],
+                validator=Validator(
+                    address=validator["address"],
+                    stake=validator["stake"],
+                    llmprovider=LLMProvider(
+                        provider=validator["provider"],
+                        model=validator["model"],
+                        config=validator["config"],
+                        plugin=validator["plugin"],
+                        plugin_config=validator["plugin_config"],
+                    ),
+                ),
                 leader_receipt=leader_receipt,
                 msg_handler=self.msg_handler,
             )
-            for i, validator in enumerate(remaining_validators)
+            for validator in remaining_validators
         ]
 
         # Validators execute transaction

backend/consensus/vrf.py

@@ -20,7 +20,9 @@ def select_random_validators(all_validators: list, num_validators: int) -> list:
     return [all_validators[i] for i in unique_indices]
 
 
-def get_validators_for_transaction(all_validators: list, num_validators: int) -> tuple:
+def get_validators_for_transaction(
+    all_validators: list, num_validators: int
+) -> tuple[dict, list]:
     selected_validators = select_random_validators(all_validators, num_validators)
     leader = selected_validators[0]
     remaining_validators = selected_validators[1 : num_validators + 1]

backend/database_handler/alembic.ini

@@ -13,7 +13,7 @@ script_location = migration
 
 # sys.path path, will be prepended to sys.path if present.
 # defaults to the current working directory.
-prepend_sys_path = .
+prepend_sys_path = ./backend/database_handler
 
 # timezone to use when rendering the date within the migration file
 # as well as the filename.

backend/database_handler/llm_providers.py

@@ -0,0 +1,78 @@
+from backend.domain.types import LLMProvider
+from backend.node.create_nodes.providers import get_default_providers
+from .models import LLMProviderDBModel
+from sqlalchemy.orm import Session
+
+
+class LLMProviderRegistry:
+    def __init__(self, session: Session):
+        self.session = session
+
+    def reset_defaults(self):
+        """Reset all providers to their default values."""
+        self.session.query(LLMProviderDBModel).delete()
+
+        providers = get_default_providers()
+        for provider in providers:
+            self.session.add(_to_db_model(provider))
+
+        self.session.commit()
+
+    def get_all(self) -> list[LLMProvider]:
+        return [
+            _to_domain(provider)
+            for provider in self.session.query(LLMProviderDBModel).all()
+        ]
+
+    def get_all_dict(self) -> list[dict]:
+        return [
+            _to_domain(provider).__dict__
+            for provider in self.session.query(LLMProviderDBModel).all()
+        ]
+
+    def add(self, provider: LLMProvider) -> int:
+        model = _to_db_model(provider)
+        self.session.add(model)
+        self.session.commit()
+        return model.id
+
+    def update(self, id: int, provider: LLMProvider):
+        self.session.query(LLMProviderDBModel).filter(
+            LLMProviderDBModel.id == id
+        ).update(
+            {
+                LLMProviderDBModel.provider: provider.provider,
+                LLMProviderDBModel.model: provider.model,
+                LLMProviderDBModel.config: provider.config,
+                LLMProviderDBModel.plugin: provider.plugin,
+                LLMProviderDBModel.plugin_config: provider.plugin_config,
+            }
+        )
+        self.session.commit()
+
+    def delete(self, id: int):
+        self.session.query(LLMProviderDBModel).filter(
+            LLMProviderDBModel.id == id
+        ).delete()
+        self.session.commit()
+
+
+def _to_domain(db_model: LLMProvider) -> LLMProvider:
+    return LLMProvider(
+        id=db_model.id,
+        provider=db_model.provider,
+        model=db_model.model,
+        config=db_model.config,
+        plugin=db_model.plugin,
+        plugin_config=db_model.plugin_config,
+    )
+
+
+def _to_db_model(domain: LLMProvider) -> LLMProviderDBModel:
+    return LLMProviderDBModel(
+        provider=domain.provider,
+        model=domain.model,
+        config=domain.config,
+        plugin=domain.plugin,
+        plugin_config=domain.plugin_config,
+    )

backend/database_handler/migration/env.py

@@ -1,11 +1,14 @@
 from logging.config import fileConfig
+import sys
 
 from sqlalchemy import engine_from_config
 from sqlalchemy import pool
 
 from alembic import context
 import os
 
+# set up Python path as the project root directory, so that we can import as backend...
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../../..")))
 
 DB_URL = os.environ.get("DB_URL")
 
@@ -21,7 +24,7 @@
 
 # add your model's MetaData object here
 # for 'autogenerate' support
-from models import Base
+from backend.database_handler.models import Base
 
 target_metadata = Base.metadata
 

backend/database_handler/migration/versions/986d9a6b0dda_add_plugin_and_plugin_config_to_.py

@@ -0,0 +1,91 @@
+"""add plugin and plugin_config to validators
+
+Revision ID: 986d9a6b0dda
+Revises: db38e78684a8
+Create Date: 2024-09-10 14:47:10.730407
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+from sqlalchemy import column, table
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+from backend.node.create_nodes.providers import get_default_provider_for
+
+# revision identifiers, used by Alembic.
+revision: str = "986d9a6b0dda"
+down_revision: Union[str, None] = "db38e78684a8"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.add_column("validators", sa.Column("plugin", sa.String(length=255)))
+    op.add_column(
+        "validators",
+        sa.Column("plugin_config", postgresql.JSONB(astext_type=sa.Text())),
+    )
+
+    # Modify below
+
+    # Create a table object for the validators table
+    validators = table(
+        "validators",
+        column("id", sa.Integer),
+        column("provider", sa.String),
+        column("model", sa.String),
+        column("plugin", sa.String),
+        column("plugin_config", postgresql.JSONB),
+        column("config", postgresql.JSONB),
+    )
+
+    # Fetch existing data
+    conn = op.get_bind()
+    results = conn.execute(validators.select())
+
+    # Process data and perform updates
+    for validator in results:
+        id = validator.id
+        provider = validator.provider
+        model = validator.model
+        default_provider = get_default_provider_for(provider=provider, model=model)
+        conn.execute(
+            validators.update()
+            .where(validators.c.id == id)
+            .values(
+                plugin=default_provider.plugin,
+                plugin_config=default_provider.plugin_config,
+                config=default_provider.config,
+            )
+        )
+    # Modify above
+
+    op.alter_column(
+        "validators", "plugin", existing_type=sa.VARCHAR(length=255), nullable=False
+    )
+    op.alter_column(
+        "validators",
+        "plugin_config",
+        existing_type=postgresql.JSONB(astext_type=sa.Text()),
+        nullable=False,
+    )
+    op.alter_column(
+        "validators", "provider", existing_type=sa.VARCHAR(length=255), nullable=False
+    )
+    op.alter_column(
+        "validators", "model", existing_type=sa.VARCHAR(length=255), nullable=False
+    )
+
+
+def downgrade() -> None:
+    op.alter_column(
+        "validators", "model", existing_type=sa.VARCHAR(length=255), nullable=True
+    )
+    op.alter_column(
+        "validators", "provider", existing_type=sa.VARCHAR(length=255), nullable=True
+    )
+    op.drop_column("validators", "plugin_config")
+    op.drop_column("validators", "plugin")