uniswap-python 0.2.0

An unofficial python wrapper for the Uniswap exchange

uniswap-python

The unofficial Python client for the Uniswap.

I am in no way affiliated with or funded by Uniswap, uniswap.io, or any subsidiaries or affiliates of any of the previously mentioned entities.

Functionality

• A simple to use Python wrapper for both public and authenticated endpoints.
• Easy interaction with the Uniswap smart contracts
• Simple parsing of data returned from the Uniswap contract

Under Development

• Better error handling
• Tests

Getting Started

This README is documentation on the syntax of the python client presented in this repository. See function docstrings for full syntax details. This API attempts to present a clean interface to Uniswap, but in order to use it to its full potential, you must familiarize yourself with the official Uniswap documentation.

• https://docs.uniswap.io/

You may manually install the project or use pip:

pip install uniswap-python

# or

pip install git+git://github.com/shanefontaine/uniswap-python.git

Environment Variables

The program expects an environment variables to be set in order to run the program. It is:

PROVIDER  # HTTP Provider for web3

Public Client

Only some endpoints in the API are available to everyone. The public endpoints can be reached using PublicClient

import uniswap
uniswap_wrapper = uniswap.UniswapWrapper()

Market Methods

• get_fee_maker

uniswap_wrapper.get_fee_maker()

• get_fee_taker

uniswap_wrapper.get_fee_taker()

• get_eth_token_input_price

# Get the public price for ETH to Token trades with an exact input.
uniswap_wrapper.get_eth_token_input_price("bat", 1*10**18)
uniswap_wrapper.get_eth_token_input_price("dai", 5*10**18)

• get_token_eth_input_price

# Get the public price for token to ETH trades with an exact input.
uniswap_wrapper.get_token_eth_input_price("bat", 1*10**18)
uniswap_wrapper.get_token_eth_input_price("dai", 5*10**18)

• get_eth_token_output_price

# Get the public price for ETH to Token trades with an exact output
uniswap_wrapper.get_eth_token_output_price("bat", 1*10**18)
uniswap_wrapper.get_eth_token_output_price("dai", 5*10**18)

• get_token_eth_output_price

# Get the public price for token to ETH trades with an exact output.
uniswap_wrapper.get_token_eth_output_price("bat", 1*10**18)
uniswap_wrapper.get_token_eth_output_price("dai", 5*10**18)

ERC20 Pool Methods

• get_eth_balance

# Get the balance of ETH in an exchange contract.
uniswap_wrapper.get_eth_balance("bat")

• get_token_balance

# Get the balance of a token in an exchange contract.
uniswap_wrapper.get_token_balance("bat")

• get_exchange_rate

# Get the balance of a token in an exchange contract.
uniswap_wrapper.get_exchange_rate("bat")

Liquidity Methods

• add_liquidity

# Add liquidity to the pool.
uniswap_wrapper.add_liquidity("bat", 1*10**18)

• remove_liquidity

# Remove liquidity from the pool.
uniswap_wrapper.removeliquidity("bat", 1*10**18)

Testing

Unit tests are under development using the pytest framework. Contributions are welcome!

To run the full test suite and ignore warnings, in the project directory run:

python -m pytest -W ignore::DeprecationWarning

Changelog

0.2.0

• Add liquidity and ERC20 pool methods

0.1.1

• Major README update

0.1.0

• Add market endpoints
• Add tests for market endpoints