Skip to main content

uniswap-sdk: SDK for Uniswap smart contracts

Project description

Uniswap SDK

NOTE: Work In Progress

Usage

NOTE: Sketch of potential usage

from ape_tokens import tokens
from uniswap_sdk import v2 as uni_v2

# Uses v2's TWAP oracle pricing algorithm
price = uni_v2.price(base=tokens["USDC"], quote=tokens["YFI"])
print(f"Buying 100k USDC worth of YFI at {price} USDC/YFI")

# Will automatically discover best possible route for given trade on Uniswap v2
# NOTE: Slippage and timeout are configurable
uni_v2.swap(base=tokens["USDC"], quote=tokens["YFI"], amount_in="100_000 USDC", sender=trader)
# Eventual goal?
import uniswap_sdk as uni

# Finds most liquid price across v2 and v3
price = uni.price(base=tokens["USDC"], quote=tokens["YFI"])

# Performs best swap between v2 and v3
uni.swap(base=tokens["USDC"], quote=tokens["YFI"], amount_in="100_000 USDC", sender=trader)

Dependencies

  • python3 version 3.7 or greater, python3-dev

Installation

via pip

You can install the latest release via pip:

pip install uniswap_sdk

via setuptools

You can clone the repository and use setuptools for the most up-to-date version:

git clone https://github.com/SilverBackLtd/uniswap-sdk.git
cd uniswap-sdk
python3 setup.py install

Quick Usage

TODO: Describe library overview in code

Development

This project is in development and should be considered a beta. Things might not be in their final state and breaking changes may occur. Comments, questions, criticisms and pull requests are welcomed.

License

This project is licensed under the Apache 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uniswap-sdk-0.1.0b2.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

uniswap_sdk-0.1.0b2-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file uniswap-sdk-0.1.0b2.tar.gz.

File metadata

  • Download URL: uniswap-sdk-0.1.0b2.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for uniswap-sdk-0.1.0b2.tar.gz
Algorithm Hash digest
SHA256 6f33fb47776b763bcae27f9516f17c427a38a6328c0d26d43d7e70af7506b6b2
MD5 73ac90e6910018d41d926d11099ddbe1
BLAKE2b-256 0006be5672efde0f165814770bcb0415876851d9eb131ed18a3e4f32a01f4fe1

See more details on using hashes here.

File details

Details for the file uniswap_sdk-0.1.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for uniswap_sdk-0.1.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 875c70796575ca5ec793bf458a09a8111807c6d2ed381a263f9437f27392a39a
MD5 f4e8b18bcbda768beff4c83cfce1ce79
BLAKE2b-256 8ca921eae6b2101af2fd6322b38eda44934d728a00e13eed3523a20cdd9d3a61

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page