Synthetix Python SDK

This is a Python SDK designed to help you interact with Synthetix smart contracts and subgraphs. Visit the documentation for more information.

Features

• Interfaces for all Synthetix V3 contracts
• Simple tools for trading Synthetix perps
• Interfaces for synth swapping and wrapping
• Inferfaces for managing LP positions
• Seamless integration with Cannon for fetching deployments from IPFS

Installation

To get started, install the synthetix library in your Python environment:

pip install synthetix

Documentation

There are a few guides to help you get started:

• Getting Started
• Trade Perps

For complete documentation, visit our documentation site.

Development

If you are interested in contributing to the library's development, you can clone the repository and set up the dependencies for editable mode:

python3 -m venv env
source env/bin/activate

pip install --upgrade pip
pip install -r requirements.txt
pip install -e ./src

Using this method, you'll have the package installed in an 'editable mode'. This means you can easily modify the code and test your changes without the hassle of reinstalling the package every time.