Skip to content

feat: initial support for custom deployments and routes #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ErikBjare merged 4 commits into from
May 4, 2021
Merged

feat: initial support for custom deployments and routes #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a94e680
feat: initial support for Honeyswap (on xDai)
ErikBjare Jan 11, 2021
9be2fbf
fix: removed unneeded workaround
ErikBjare Jan 11, 2021
87b24ca
test: fixed test that tried to trade an asset we didn't have
ErikBjare May 4, 2021
f18b05b
feat: parametrized factory and router contract addresses to support c…
ErikBjare May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/test_uniswap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ def test_remove_liquidity(
# ETH -> Token
(eth, bat, 1_000_000_000 * ONE_WEI, None, does_not_raise),
# Token -> Token
(dai, bat, 1_000_000_000 * ONE_WEI, None, does_not_raise),
(bat, dai, 1_000_000_000 * ONE_WEI, None, does_not_raise),
# Token -> ETH
(bat, eth, 1_000_000 * ONE_WEI, None, does_not_raise),
# (eth, bat, 0.00001 * ONE_ETH, ZERO_ADDRESS, does_not_raise),
Expand Down
111 changes: 72 additions & 39 deletions uniswap/uniswap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,35 @@ def _validate_address(a: AddressLike) -> None:
assert _addr_to_str(a)


_netid_to_name = {1: "mainnet", 3: "ropsten", 4: "rinkeby"}
# see: https://chainid.network/chains/
_netid_to_name = {1: "mainnet", 3: "ropsten", 4: "rinkeby", 56: "binance", 100: "xdai"}

_factory_contract_addresses_v1 = {
"mainnet": "0xc0a47dFe034B400B47bDaD5FecDa2621de6c4d95",
"ropsten": "0x9c83dCE8CA20E9aAF9D3efc003b2ea62aBC08351",
"rinkeby": "0xf5D915570BC477f9B8D6C0E980aA81757A3AaC36",
"kovan": "0xD3E51Ef092B2845f10401a0159B2B96e8B6c3D30",
"görli": "0x6Ce570d02D73d4c384b46135E87f8C592A8c86dA",
}


# For v2 the address is the same on mainnet, Ropsten, Rinkeby, Görli, and Kovan
# https://uniswap.org/docs/v2/smart-contracts/factory
_factory_contract_addresses_v2 = {
"mainnet": "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f",
"ropsten": "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f",
"rinkeby": "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f",
"görli": "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f",
"xdai": "0xA818b4F111Ccac7AA31D0BCc0806d64F2E0737D7",
}

_router_contract_addresses_v2 = {
"mainnet": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
"ropsten": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
"rinkeby": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
"görli": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
"xdai": "0x1C232F01118CB8B424793ae03F870aa7D0ac7f77",
}


class Uniswap:
Expand All @@ -138,6 +166,8 @@ def __init__(
web3: Web3 = None,
version: int = 1,
max_slippage: float = 0.1,
factory_contract_addr: str = None,
router_contract_addr: str = None,
) -> None:
"""
:param address: The public address of the ETH wallet to use.
Expand All @@ -146,6 +176,8 @@ def __init__(
:param web3: Can be optionally set to a custom Web3 instance.
:param version: Which version of the Uniswap contracts to use.
:param max_slippage: Max allowed slippage for a trade.
:param factory_contract_addr: Can be optionally set to override the address of the factory contract.
:param router_contract_addr: Can be optionally set to override the address of the router contract (v2 only).
"""
self.address: AddressLike = _str_to_addr(address) if isinstance(
address, str
Expand Down Expand Up @@ -185,29 +217,23 @@ def __init__(
self.max_approval_check_int = int(self.max_approval_check_hex, 16)

if self.version == 1:
factory_contract_addresses = {
"mainnet": "0xc0a47dFe034B400B47bDaD5FecDa2621de6c4d95",
"ropsten": "0x9c83dCE8CA20E9aAF9D3efc003b2ea62aBC08351",
"rinkeby": "0xf5D915570BC477f9B8D6C0E980aA81757A3AaC36",
"kovan": "0xD3E51Ef092B2845f10401a0159B2B96e8B6c3D30",
"görli": "0x6Ce570d02D73d4c384b46135E87f8C592A8c86dA",
}
if factory_contract_addr is None:
factory_contract_addr = _factory_contract_addresses_v1[self.network]

self.factory_contract = self._load_contract(
abi_name="uniswap-v1/factory",
address=_str_to_addr(factory_contract_addresses[self.network]),
address=_str_to_addr(factory_contract_addr),
)
elif self.version == 2:
# For v2 the address is the same on mainnet, Ropsten, Rinkeby, Görli, and Kovan
# https://uniswap.org/docs/v2/smart-contracts/factory
factory_contract_address_v2 = _str_to_addr(
"0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f"
)
if router_contract_addr is None:
router_contract_addr = _router_contract_addresses_v2[self.network]
self.router_address: AddressLike = _str_to_addr(router_contract_addr)

if factory_contract_addr is None:
factory_contract_addr = _factory_contract_addresses_v2[self.network]
self.factory_contract = self._load_contract(
abi_name="uniswap-v2/factory", address=factory_contract_address_v2,
)
self.router_address: AddressLike = _str_to_addr(
"0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D"
abi_name="uniswap-v2/factory",
address=_str_to_addr(factory_contract_addr),
)
# Documented here: https://uniswap.org/docs/v2/smart-contracts/router02/
self.router = self._load_contract(
Expand Down Expand Up @@ -331,19 +357,23 @@ def get_token_eth_input_price(self, token: AddressLike, qty: int) -> int:

@supports([2])
def get_token_token_input_price(
self, token0: AnyAddress, token1: AnyAddress, qty: int
self,
token0: AnyAddress,
token1: AnyAddress,
qty: int,
route: Optional[List[AnyAddress]] = None,
) -> int:
"""Public price for token to token trades with an exact input."""
# If one of the tokens are WETH, delegate to appropriate call.
# See: https://github.com/shanefontaine/uniswap-python/issues/22
if is_same_address(token0, self.get_weth_address()):
return int(self.get_eth_token_input_price(token1, qty))
elif is_same_address(token1, self.get_weth_address()):
return int(self.get_token_eth_input_price(token0, qty))

price: int = self.router.functions.getAmountsOut(
qty, [token0, self.get_weth_address(), token1]
).call()[-1]
if not route:
if is_same_address(token0, self.get_weth_address()):
return int(self.get_eth_token_input_price(token1, qty))
elif is_same_address(token1, self.get_weth_address()):
return int(self.get_token_eth_input_price(token0, qty))

route = route or [token0, self.get_weth_address(), token1]
price: int = self.router.functions.getAmountsOut(qty, route).call()[-1]
return price

@supports([1, 2])
Expand All @@ -353,9 +383,8 @@ def get_eth_token_output_price(self, token: AddressLike, qty: int) -> Wei:
ex = self.exchange_contract(token)
price: Wei = ex.functions.getEthToTokenOutputPrice(qty).call()
else:
price = self.router.functions.getAmountsIn(
qty, [self.get_weth_address(), token]
).call()[0]
route = [self.get_weth_address(), token]
price = self.router.functions.getAmountsIn(qty, route).call()[0]
return price

@supports([1, 2])
Expand All @@ -372,20 +401,24 @@ def get_token_eth_output_price(self, token: AddressLike, qty: Wei) -> int:

@supports([2])
def get_token_token_output_price(
self, token0: AnyAddress, token1: AnyAddress, qty: int
self,
token0: AnyAddress,
token1: AnyAddress,
qty: int,
route: Optional[List[AnyAddress]] = None,
) -> int:
"""Public price for token to token trades with an exact output."""
# If one of the tokens are WETH, delegate to appropriate call.
# See: https://github.com/shanefontaine/uniswap-python/issues/22
# TODO: Will these equality checks always work? (Address vs ChecksumAddress vs str)
if is_same_address(token0, self.get_weth_address()):
return int(self.get_eth_token_output_price(token1, qty))
elif is_same_address(token1, self.get_weth_address()):
return int(self.get_token_eth_output_price(token0, qty))

price: int = self.router.functions.getAmountsIn(
qty, [token0, self.get_weth_address(), token1]
).call()[0]
if not route:
if is_same_address(token0, self.get_weth_address()):
return int(self.get_eth_token_output_price(token1, qty))
elif is_same_address(token1, self.get_weth_address()):
return int(self.get_token_eth_output_price(token0, qty))

route = route or [token0, self.get_weth_address(), token1]
price: int = self.router.functions.getAmountsIn(qty, route).call()[0]
return price

# ------ Wallet balance ------------------------------------------------------------
Expand Down