Add setup for the tool usage

.github/workflows/CI.yml

@@ -21,7 +21,7 @@ jobs:
       github.event.pull_request.base.ref == 'main'
     env:
       ETHSCAN_API_KEY: ${{ secrets.ETHSCAN_API_KEY }}
-      QUORUM_PATH: "."
+      QUORUM_PATH: "Quorum/tests"
       ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
     runs-on: ubuntu-latest
     container:
@@ -39,4 +39,4 @@ jobs:
       - name: Execute Regression Tests
         run: |
           pytest Quorum/tests --maxfail=1 --disable-warnings --tb=short
-          CheckProposal --config Quorum/regression.json
+          CheckProposal --config Quorum/tests/regression.json

Quorum/apis/block_explorers/chains_api.py

@@ -1,6 +1,7 @@
 import os
 import requests
-import json
+from json.decoder import JSONDecodeError
+import json5 as json
 
 from Quorum.utils.chain_enum import Chain
 from Quorum.apis.block_explorers.source_code import SourceCode
@@ -80,7 +81,7 @@ def get_source_code(self, proposal_address: str) -> list[SourceCode]:
         result = data['result'][0]["SourceCode"]
         try:
             json_data = json.loads(result)
-        except json.JSONDecodeError:
+        except (JSONDecodeError, ValueError):
             # Handle non-JSON formatted responses
             json_data = json.loads(result.removeprefix("{").removesuffix("}"))
 

Quorum/apis/git_api/git_manager.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from git import Repo
 
-import Quorum.config as config
+import Quorum.utils.config as config
 import Quorum.utils.pretty_printer as pp
 
 class GitManager:

Quorum/apis/price_feeds/price_feed_utils.py

@@ -3,7 +3,7 @@
 from typing import Optional
 from pydantic import BaseModel, Field
 from pathlib import Path
-import json
+import json5 as json
 import requests
 
 from Quorum.utils.chain_enum import Chain

Quorum/auto_report/aave_tags.py

@@ -1,6 +1,6 @@
 import requests
 from dataclasses import dataclass
-import json
+import json5 as json
 
 
 BASE_BGD_CACHE_REPO = 'https://raw.githubusercontent.com/bgd-labs/v3-governance-cache/refs/heads/main/cache'

Quorum/checks/check.py

@@ -1,9 +1,9 @@
 from abc import ABC
 from datetime import datetime
-import json
+import json5 as json
 from pathlib import Path
 
-import Quorum.config as config
+import Quorum.utils.config as config
 from Quorum.apis.block_explorers.source_code import SourceCode
 from Quorum.utils.chain_enum import Chain
 

Quorum/checks/new_listing.py

@@ -1,6 +1,6 @@
 from Quorum.checks.check import Check
 import Quorum.utils.pretty_printer as pp
-import Quorum.config as config
+import Quorum.utils.config as config
 from Quorum.llm.chains.first_deposit_chain import FirstDepositChain, ListingArray
 
 

Quorum/check_proposal.py → Quorum/entry_points/check_proposal.py

@@ -1,5 +1,6 @@
 import argparse
-import json
+from json import JSONDecodeError
+import json5 as json
 from typing import Any, Optional
 
 from Quorum.utils.chain_enum import Chain
@@ -44,7 +45,7 @@ def load_config(config_path: str) -> dict[str, Any] | None:
         with open(config_path, 'r') as file:
             config_data = json.load(file)
         return config_data
-    except (FileNotFoundError, json.JSONDecodeError) as e:
+    except (FileNotFoundError, JSONDecodeError) as e:
         pp.pretty_print(f"Failed to parse given config file {config_path}:\n{e}", pp.Colors.FAILURE)
 
 

Quorum/auto_report/create_report.py → Quorum/entry_points/create_report.py

@@ -7,7 +7,7 @@
 from jinja2 import Environment, FileSystemLoader
 
 
-DEFAULT_TEMPLATE_PATH = Path(__file__).parent / 'AaveReportTemplate.md.j2'
+DEFAULT_TEMPLATE_PATH = Path(__file__).parent.parent / 'auto_report/AaveReportTemplate.md.j2'
 
 
 def parse_args() -> argparse.Namespace:

Quorum/ipfs_validator.py → Quorum/entry_points/ipfs_validator.py

@@ -2,7 +2,7 @@
 import Quorum.utils.arg_validations as arg_valid
 from Quorum.apis.block_explorers.chains_api import ChainAPI
 from Quorum.llm.chains.ipfs_validation_chain import IPFSValidationChain
-import Quorum.config as config
+import Quorum.utils.config as config
 
 from pathlib import Path
 import argparse

Quorum/entry_points/setup_quorum.py

@@ -0,0 +1,67 @@
+import shutil
+import argparse
+from pathlib import Path
+import Quorum.utils.pretty_printer as pp
+
+
+def get_working_directory() -> Path:
+    parser = argparse.ArgumentParser(description="Setup Quorum project.")
+    parser.add_argument(
+        '--working_dir',
+        default=Path.cwd(),
+        type=Path,
+        help="Directory to set up the Quorum project."
+    )
+    args = parser.parse_args()
+    return args.working_dir
+
+
+def setup_quorum(working_dir: Path):
+    """
+    Initializes a Quorum environment by copying template files to the specified directory.
+
+    Args:
+        working_dir (Path): Target directory for setting up Quorum.
+
+    Raises:
+        shutil.Error: If copying files fails.
+        OSError: If directory creation fails.
+    """
+    templates_dir = Path(__file__).parent.parent / 'templates'
+    target_dir = working_dir.resolve()
+
+    if not target_dir.exists():
+        pp.pretty_print(f"Creating directory: {target_dir}", pp.Colors.INFO)
+        target_dir.mkdir(parents=True, exist_ok=True)
+
+    template_files = ['ground_truth.json', 'execution.json', '.env.example', 'Readme.md']
+
+    for file_name in template_files:
+        src = templates_dir / file_name
+        dest = target_dir / '.env' if file_name == '.env.example' else target_dir / file_name
+
+        if dest.exists():
+            pp.pretty_print(f"File exists: {dest}. Skipping.", pp.Colors.WARNING)
+            continue
+
+        shutil.copy(src, dest)
+        pp.pretty_print(f"Copied {file_name} to {dest}", pp.Colors.SUCCESS)
+
+    # Add export QUORUM_PATH="path_to_your_quorum_directory" to the new .env file
+    with open(target_dir / '.env', 'a') as f:
+        f.write(f'\nexport QUORUM_PATH="{target_dir}"\n')
+
+    pp.pretty_print("Quorum setup completed successfully!", pp.Colors.SUCCESS)
+
+
+def main():
+    working_dir = get_working_directory()
+    try:
+        setup_quorum(working_dir)
+    except Exception as e:
+        pp.pretty_print(f"Setup failed: {e}", pp.Colors.FAILURE)
+        exit(1)
+
+
+if __name__ == "__main__":
+    main()

Quorum/llm/chains/cached_llm.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from Quorum.config import ANTHROPIC_MODEL, ANTHROPIC_API_KEY
+from Quorum.utils.config import ANTHROPIC_MODEL, ANTHROPIC_API_KEY
 
 from langchain_anthropic import ChatAnthropic
 from langchain_community.cache import SQLiteCache

Quorum/templates/Readme.md

@@ -0,0 +1,78 @@
+# Quorum Templates Guide
+
+This guide provides instructions on how to fill out the various template files in the Quorum project.
+
+## ground_truth.json
+
+This file contains the ground truth data for different protocols. Each protocol has its own section with the following fields:
+
+- `dev_repos`: A list of URLs to the development repositories.
+- `review_repo`: The URL to the review repository.
+- `price_feed_providers`: A list of price feed providers.
+- `token_validation_providers`: A list of token validation providers.
+
+### Example
+```json
+{
+    "Aave": 
+    {
+        "dev_repos":
+        [
+            "https://github.com/bgd-labs/aave-helpers",
+            "https://github.com/bgd-labs/aave-address-book",
+            "https://github.com/aave-dao/aave-v3-origin"
+        ],
+        "review_repo": "https://github.com/bgd-labs/aave-proposals-v3",
+        "price_feed_providers": ["Chainlink"],
+        "token_validation_providers": ["Coingecko"]
+    }
+}
+```
+
+## execution.json
+
+This file contains the execution details for different protocols and networks. For each protocol, you need to specify the proposal addresses for various networks.
+
+### Instructions
+- Replace `<protocol_name>` with the name of the protocol as specified in `ground_truth.json`.
+- Fill in the proposal addresses for each network.
+
+### Example
+```jsonc
+{
+    "Aave": {
+        "Ethereum": {
+            "Proposals": ["0x..."] // Insert Ethereum proposals address here
+        },
+        "Arbitrum": {
+            "Proposals": ["0x..."] // Insert Arbitrum proposals address here
+        },
+        // ...other networks...
+    }
+}
+```
+
+## .env
+
+This file contains environment variables that need to be set for the project to run.
+fill in the required values.
+
+### Instructions
+- `ETHSCAN_API_KEY`: Your Etherscan API key.
+- `ANTHROPIC_API_KEY`: Your Anthropic API key.
+- `QUORUM_PATH`: The path to your Quorum directory.
+
+### Example
+```bash
+export ETHSCAN_API_KEY="your_etherscan_api_key"
+export ANTHROPIC_API_KEY="your_anthropic_api_key"
+export QUORUM_PATH="path_to_your_quorum_directory"
+```
+
+## Summary
+
+1. Fill in `ground_truth.json` with the appropriate data for each protocol.
+2. Update `execution.json` with the proposal addresses for each network.
+3. `.env` set the required environment variables.
+
+By following these instructions, you will ensure that the Quorum project is correctly configured and ready to use.

Quorum/templates/execution.json

@@ -0,0 +1,37 @@
+{
+    "<protocol_name>": { // Insert protocol / organization name here as specified in the ground_truth.json
+        "Ethereum": {
+            "Proposals": [] // Insert Ethereum proposals address here
+        },
+        "Arbitrum": {
+            "Proposals": [] // Insert Arbitrum proposals address here
+        },
+        "Avalanche": {
+            "Proposals": [] // Insert Avalanche proposals address here
+        },
+        "Base": {
+            "Proposals": [] // Insert Base proposals address here
+        },
+        "BNBChain": {
+            "Proposals": [] // Insert BNBChain proposals address here
+        },
+        "Gnosis": {
+            "Proposals": [] // Insert Gnosis proposals address here
+        },
+        "Metis": {
+            "Proposals": [] // Insert Metis proposals address here
+        },
+        "Optimism": {
+            "Proposals": [] // Insert Optimism proposals address here
+        },
+        "Polygon": {
+            "Proposals": [] // Insert Polygon proposals address here
+        },
+        "Scroll": {
+            "Proposals": [] // Insert Scroll proposals address here
+        },
+        "zkSync": {
+            "Proposals": [] // Insert zkSync proposals address here
+        }
+    }
+}

Quorum/templates/ground_truth.json

@@ -0,0 +1,26 @@
+{
+    // Protocol or organization with the same name to be specified in the execution json
+    "<protocol_name>":
+    {
+        // Main list of repositories for import diff checks
+        "dev_repos": [
+            "<https://github.com/org/repo1>",
+            "<https://github.com/org/repo2>"
+        ],
+
+        // Pre-deployment review repository for code verification
+        "review_repo": "<https://github.com/org/review-repo>",
+
+        // Supported price feed providers for address validation e.g. Chainlink, Chronicle
+        "price_feed_providers": [
+            "<price_feed_provider1>",
+            "<price_feed_provider2>"
+        ],
+
+        // Token validation services for address verification e.g. Coingecko
+        "token_validation_providers": [
+            "<token_validation_provider1>",
+            "<token_validation_provider2>"
+        ]
+    }
+}

Quorum/tests/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 
 from Quorum.apis.block_explorers.source_code import SourceCode
-import Quorum.config as config
+import Quorum.utils.config as config
 
 from pathlib import Path
 import shutil