py

This directory will host the code to call contracts using cairo-lang python package, and other utilities:

• src/generate_test_storage_tree.py -- generates the patricia tree for a single contract from stdin
• src/generate_test_global_tree.py -- generates the main patricia tree from stdin
• src/compute_contract_hash.py -- similar to cargo run -p pathfinder --bin compute_contract_hash
• src/call.py -- python side of pathfinder_lib:cairo::ext_py in pathfinder database

See files for usage instructions.

Development

Setup development environment by creating a virtual environment and entering it. Call this after entering the $CHECKOUT_ROOT/py:

$ python3 -m venv .venv
$ source .venv/bin/activate

Then install tools:

$ PIP_REQUIRE_VIRTUALENV=true pip install --upgrade pip

Then install development tools:

$ PIP_REQUIRE_VIRTUALENV=true pip install -r requirements-dev.txt

That is currently the only list we have, and it doesn't have too large extras.

Upgrading dependencies

Re-use the PIP_REQUIRE_VIRTUALENV=true pip install -r requirements-dev.txt to upgrade the virtual environment.

Testing

Inside the virtual environment, in the same directory as this README, after installing all of the dependencies:

$ pytest

At the moment pytest ignores all warnings, which are from dependencies.

Formatting

Running this will modify your files, regardless if they staged in git or not.

Inside the virtual environment, similar to testing:

$ black src/

Linting

Many lints consider formatting, so format before linting.

Inside the virtual environment, similar to testing:

$ flake8 src/