uniswap-breakouts

Library and utility to help break out underlying token amounts from uniswap positions and generate pool liquidity profiles at arbitrary block heights.

Usage

clone the repo and install with pip: pip install .

fill out chain resource and position config files like the examples in the example_configs directory. The source code can be used as a library or a command line tool as shown in usage below.

run the command line tool by pointing to the configs via the environment or on the commandline.

You can specify an output file for the JSON position report via the command line. Use verbose mode (-v) to log more detail on the process.

$ python -m uniswap_breakouts -h

options:
  -h, --help            show this help message and exit
  -c CHAIN_CONFIG, --chain-config CHAIN_CONFIG
                        Path to a chain resource config file. This can also be specified via the environment
  -p POSITION_CONFIG, --position-config POSITION_CONFIG
                        Path to a position config file. This can also be specified via the environment
  -o OUT_FILE, --out-file OUT_FILE
                        If specified, reports will be output to path specified rather than the default STDOUT
  -v, --verbose

Tests and Contribution

If you would like to contribute, please install the linting dependencies and make sure the black, pylint and mypy checks pass.

To run tests, put your chain info config in the path test/test_chain_resource_configs/default.toml and run test with the unittest module

TODO

• More Logging
• Option to export reports somewhere other than STDOUT
• Test
  • Integration
  • Unit
• Examples
• Linting and Clean Up