Skale-contracts integration

[Masterix0]

Overview

This pull request introduces a major overhaul of the environment configuration and validation in node-cli. The key changes include:

• Simplified Environment Variable Handling:

  • Replaces the previous ABI JSON download mechanism (using MANAGER_CONTRACTS_ABI_URL and IMA_CONTRACTS_ABI_URL) with a new approach that uses the environment variables MANAGER_CONTRACTS and IMA_CONTRACTS.
  • The new approach forwards these values (which can be either direct contract addresses or recognized aliases) to other SKALE network components that use the skale-contracts library for dynamic ABI access.

• Refactored Validation Logic:

  • The env.py file has been refactored to introduce helper functions to modularize the process of loading and validating environment variables.
  • Validation now explicitly checks the new variables (checking if alias is present in skale repo or if contract addresses have code in provided endpoint), ensuring that the environment is correctly configured before node-cli proceeds.
  • Deprecated validation code related to ABI JSON files has been removed.

• Enhanced Testing:

  • A new test suite (tests/configs/configs_env_validate_test.py) has been created to extensively test the updated environment functions.
  • External HTTP requests are patched using requests_mock to simulate network responses, ensuring that the tests remain isolated.

• Workflow and Documentation Improvements:

  • The README has been updated to reflect the new environment variable names and usage instructions.
  • The GitHub Actions workflow now includes a new step to run ruff for linting and code formatting, improving our code quality checks.
  • Adjustments were made to the build process (specifically the generation of info.py) to avoid development-time import errors.

Detailed Changes

• Environment Configuration Updates:

  • New Variables:
    • Replace MANAGER_CONTRACTS_ABI_URL and IMA_CONTRACTS_ABI_URL with MANAGER_CONTRACTS and IMA_CONTRACTS.
    • These variables now contain either a direct contract address or an alias.
  • Refactoring:
    • Split the environment loading into three parts: checking and loading the file (load_env_file()), building a base parameters dictionary (build_params()), and populating it with environment values (populate_params()).
  • Validation:
    • validate_params() now calls validate_env_type() for environment type variable and validate_env_alias_or_address() for both the IMA and Manager contracts using the new variables.
    • Online validations (e.g., fetching the chain ID and network metadata) are performed only after basic checks have passed.

• Testing Enhancements:

  • A dedicated test suite for the new environment configuration is added, covering:
    • Missing or unreadable env files.
    • Correct population of parameters from the environment.
    • Successful and failing validations for environment types, contract addresses, and aliases.
  • External HTTP calls are mocked using requests_mock to isolate tests from real network dependencies.

• Workflow & Linting:

  • Integrated ruff into our CI/CD pipelines via GitHub Actions.
  • Updated the README with instructions regarding the new environment variables and the use of ruff.

• Build Process Improvement:

  • The generation of info.py is now handled in a separate script (referenced in the README and CI), reducing development-time import errors.

Impact

• Breaking Changes:
  • Scripts or integrations relying on the old ABI URL environment variables will need to be updated to use the new alias/contract address variables.
  • The deprecated validate command group has been removed.

Testing

• All unit and integration tests for environment configuration now pass.
• CI/CD has been updated to run ruff for code style and formatting checks and to only run test pipeline on push.

[Copilot]

Copilot reviewed 33 out of 33 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

node_cli/operations/skale_node.py:43

• The 'else' branch in download_skale_node is unreachable because the function already errors out when both 'src' and 'stream' are not provided. Removing this redundant block would simplify the code.

else: