eth-index 0.4.1

black

The source code is formatted with black. If you choose not to use the pre-commit hook, you should be able to format the source code with black setup.py src.

flake8

We use flake8 to check for errors. Run flake8 src to check for errors.

mypy

mypy is used to check for type errors. Run mypy --ignore-missing-imports src to check manually.

tox

Running tox will run black, flake8, mypy and pytest locally.

Since we also do run some tests for postgres, the postgres database server must be installed on the local machine. It doesn’t have to be started though, since the tests do start postgres with a temporary data directory.

On a debian based system apt install postgresql will install the postgresql database.

pre-commit

The repository comes with a configuration file for pre-commit. pre-commit will be installed as part of the development dependencies specified in requirements.txt. The git commit hooks can be activated with pre-commit install inside the py-eth-index repository.

ethindex importabi

Before importing events into the postgres database, the ABIs must be known.

ethindex importabi can be used to import ABIs into the postgres database. By default it reads the json file addresses.json from the current directory and adds the default abi for currency networks to the abis table. A custom abi file can be provided via --contracts option. The location of the addresses.json file can be specified via the --addresses command line argument.

Usage:

Usage: ethindex importabi [OPTIONS]

Options:
  --addresses TEXT
  --contracts TEXT
  --help            Show this message and exit.

ethindex runsync

ethindex runsync will start the actual synchronization process. On the first start it will read all of the abis and create one entry in the sync table containing all contract addresses. It then imports all of the events into the postgres table events.

Usage

Usage: ethindex runsync [OPTIONS]

Options:
  --jsonrpc TEXT                  jsonrpc URL to use
  --required-confirmations INTEGER
                                  number of confirmations until we consider a
                                  block final
  --waittime INTEGER              time to sleep in milliseconds waiting for a
                                  new block
  --startblock INTEGER            Block from where events should be synced
  --syncid TEXT                   syncid to use
  --merge-with-syncid TEXT        syncid to merge with
  --help                          Show this message and exit.