makarid/kwenta-python-sdk

Kwenta Python SDK

Python SDK to interact with Kwenta's smart contracts, subgraphs, and Synthetix perps.

Installation

Install the SDK using pip:

  pip install kwenta

For more information on usage, see the Usage section and the sample scripts.

Development

Create a python virtual environment, activate it and install libraries:

python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
pip install -e ./module

This method will install the local version of the module in editable mode. You can make changes to the SDK and test them without reinstalling the module.

Usage

To configure an instance of the Kwenta SDK, you need to specify some parameters. At minimum you need to specify the network_id and provider_rpc to read data from the contracts. If you specify a wallet_address and private_key you can also submit transactions or create transaction data using the SDK.:

from kwenta import Kwenta

kwenta = Kwenta(
    network_id=10,
    provider_rpc=YOUR_RPC,
    wallet_address=YOUR_ADDRESS,
    private_key=YOUR_PRIVATE_KEY
)

To extend the functionality to query subgraphs, Pyth price services, or message on Telegram, you can specify additional parameters.

Queries / Subgraphs:

Queries will default to Kwenta's public Hosted Service endpoints for The Graph.

• To fetch perps data specify endpoint gql_endpoint_perps: defaults to Optimism-perps subgraph
• To fetch rates specify endpoint gql_endpoint_perps: defaults to Optimism-perps subgraph

Pyth:

• Specify the endpoint of a Pyth price service as price_service_endpoint defaults to the public Pyth price service. This should be updated for any production applications to use a private Pyth price service.

Telegram:

1. Search telegram for bot named "@botfather"
2. Message the bot with and type "/newbot"
3. Input bot name (This will become channel name)
4. Specify API token as telegram_token
5. Specify channel name as telegram_channel_name

Features

kwenta:

• Fetch market info
• Fetch position info
• Open positions
• Close positions
• Modify open positions
• Transfer margin
• Execute and cancel orders
• Limit and stop limit orders

kwenta.queries:

• Fetch historical trades
• Fetch historical positions

kwenta.pyth:

• Fetch price update data from Pyth price feed