Pull requests are welcome ❤️ To start working on web3client, please follow these steps.

1. Clone the repo

This is simple:

git clone https://github.com/coccoinomane/web3client.git

2. Install dependencies

web3client uses PDM to manage dependencies. You can install it via script:

curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -

Or, if you are on Windows, you may be better off using pipx:

pipx install pdm

Then, to install web3client and its dependencies, just run:

pdm install

All packages, including web3client will be installed in a newly created virtual environment in the .venv folder.

web3client consists of two main parts:

When you are done with your changes, please make sure to run pdm test before committing to make sure that your code does not break anything.

Some tests require a local blockchain, so make sure to install ganache the first time you run pdm test!

To create a new test, feel free to copy and customize an existing one: all tests are in the tests folder.