Skip to content

python_backend.md

Latest commit

 

History

History
83 lines (49 loc) · 2.83 KB

python_backend.md

File metadata and controls

83 lines (49 loc) · 2.83 KB

Python Backend

The Python backend uses FastAPI to drive compilation, deployment, and interaction with Solidity smart contracts.

Backend Architecture

This page provides a deeper look into the internal structure of the FastAPI backend.

Component Diagram

Backend Component Diagram

This diagram shows how main.py, the config loader, FastAPI’s startup event, routers, contract services, and web3_connector.py integrate.

Contract Services Layer

The “Contract Services” layer represents several modules working together:

  • deploy_contract.py – compilation & deployment
  • inbox_contract.py – contract interaction helpers
  • contract_store.py – ABI/bytecode & metadata management
  • web3_connector.py – RPC connection & Web3 helpers

Together, they handle all contract-related behaviour between the FastAPI routes and the Web3 RPC provider.

Keeping this logic in one layer means the API stays clean and the Web3 code stays contained, and also makes it easier to extend later (new contract types, DB integration, etc.).

Building and Running the Python Backend

Before building and running the backend, make sure you have followed the Setup Instructions to create the necessary configuration files and environment variables.

Building the Docker Image

Navigate to the python-backend directory and build the Docker image using the following command:

cd /path/to/wildweb3/python-backend
docker build -t wildweb3-python-backend .

Running the Docker Container

Run the Docker container with the data directory mounted to ensure the config.toml file is available:

docker run -v /path/to/wildweb3/data:/app/data -p 8040:8040 wildweb3-python-backend

Replace /path/to/wildweb3 with the actual path to your project root.

Running the Backend from the Command Line

You can also run the backend directly from the command line by specifying the path to the configuration file using the --config argument:

cd python_backend
python main.py --config /path/to/wildweb3/data/config.toml

Replace /path/to/wildweb3 with the actual path to your project root.

This allows you to run the backend with different configuration files depending on the environment (e.g., Docker or local development).

Running the Tests

To run the Python tests from the project root, use the following command:

PYTHONPATH=. python -m unittest discover -s tests

This command sets the PYTHONPATH environment variable to the project root and runs all the unit tests in the tests directory.

Linting the Code

To lint the code using pylint from the project root, use the following command:

pylint python_backend tests

This command runs pylint on the python_backend directory and the tests directory, checking for coding standard violations and potential errors.