Interact directly with the pool in Uniswap connector

[fengtality]

Description

• Users have reported that the Uniswap connector is slow compared to other connectors as well as other bots, resulting in missed arbitrage opportunities
• This may be due to the fact that it uses the smart order router to estimate and execute trades, rather than getting a quote and executing a trade
• Add the ability to use these direct methods rather than the router to the Uniswap connector as an option
• Afterwards, estimateSellTrade, estimateBuyTrade, and executeTrade should be able to use the quote/trade methodology described in the Uniswap docs, but also the existing router method
• The following variables to the Uniswap connector config should be added:
  • useRouter (bool): if True, estimation and execution functions use router; if false, use quote and trade functions of SDK;
  • feeTier (string): Matches one of the Uniswap fee tier strings. If useRouter is False, then user has to specify feeTier to find the right pool
• Add these new variables to the Uniswap default config template. By default, useRouter should be True, and feeTier is "MEDIUM"

Bounty

• Sponsor: Hummingbot Foundation
• Bounty Type: Enhancement / Open Source
• Bounty Amount: 100,000 HBOT (P1)
• Developer Payment: 100,000 HBOT (100%)
• Status: Open

[zedquach]

What is the expected timeline for this ticket?

[fengtality]

What is the expected timeline for this ticket?

Do you mean when it'll be delivered? That depends on if/when a community dev picks up this bounty.

[VPashkov]

@fengtality I would like to take a shot at this. I have a few questions, though.

1. How useRouter and feeTier will be configured? Should I simply provide public getters/setters, add parameters to constructor/getInstance methods, read it from config, or something else?
2. I will need to store Quoter and Pool factory contract addresses somewhere. Should I extend UniswapConfig? If yes, I will need also to update its schema, templates, etc., right?
3. At first glance executeTrade, should just work after updating estimateSellTrade and estimateBuyTrade. Do you have something specific in mind that needs to be done with it or do I simply need to make sure it works with the quote/trade methodology?

[zedquach]

I'll take this

[fengtality]

@VPashkov Thanks - see below for answers to your questions. If you would like to be assigned this issue, you have first dibs. @zedquach we will let you know if it's open in a few days.

• I recommend this approach, which should be simplest - if it's not clear, I can provide more guidance.
• useRouter and feeTier are 2 additional params in UniswapConfig. You can store the Quoter and Pool factory contract addresses here too.
• In the future, we should provide more flexibility on a request-by-request basis, but this approach should limit scope of this task and not necessitate changes to Hummingbot client
• Update the Uniswap schema and templates accordingly. You can make all the new params optional.
• In Uniswap, read these values. Modify estimateSellTrade and estimateBuyTrade so that it gets a quote from the pool directly following the guide if useRouter is False.
• Object returned should remain the same { trade: route.trade, expectedAmount };
• Return an error message if useRouter is false and feeTier is not specified or invalid
• I believe no changes should be needed to executeTrade nor the controllers and validators
• Add unit tests to check that this new logic works

[VPashkov]

@fengtality Yes, I would like to be assigned. I think I got all the answers I need for now. Thanks.

[VPashkov]

A quick status update.
I have a working implementation. It works significantly faster.
Some naive performance testing shows 250-350ms for price requests(/amm/price) for new implementation versus 3.5-7 seconds for the old one. For trade requests(/amm/trade) it's 2-2.5 seconds versus 7-9 seconds.
I'm working on unit tests right now.

[fengtality]

wow that's amazing! looking forward to playing with it!

…

On Mon, Jun 5, 2023, 11:05 PM Vadim ***@***.***> wrote: A quick status update. I have a working implementation. It works significantly faster. Some naive performance testing shows 250-350ms for price requests( /amm/price) for new implementation versus 3.5-7 seconds for the old one. For trade requests(/amm/trade) it's 2-2.5 seconds versus 7-9 seconds. I'm working on unit tests right now. — Reply to this email directly, view it on GitHub <#112 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AANWHVXEVQFOJMEBZ7HXTYLXJ3CDLANCNFSM6AAAAAAYNUFTCI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[nikspz]

hi @VPashkov Could you please add your updates here and submit PR/draft?

[VPashkov]

Hi @nikspz.
Sorry for the delay. I'm struggling with writing tests for the executeTrade method. A lot of mocking is required, but I think it needs to be done to make sure I'm not breaking existing code. I think I will need a couple of more days to finish.

[fengtality]

Hey @VPashkov if you're having issues mocking data for tests, I suggest submitting the PR as-is.

We are aware of the challenges testing Gateway functions that require network calls and don't want to make devs spend time unnecessarily

[VPashkov]

Got it. I'm sending PR without tests for executeTrade then.

[toxicehc]

Hi @VPashkov - Would this also work on polygon uniswap?

[toxicehc]

@VPashkov - check my DM on discord also please. Sent from Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: nikspz ***@***.***> Sent: Tuesday, July 4, 2023 6:16:05 am To: hummingbot/gateway ***@***.***> Cc: Toxic Entity ***@***.***>; Comment ***@***.***> Subject: Re: [hummingbot/gateway] Interact directly with the pool in Uniswap connector (Issue #112) @VPashkov<https://github.com/VPashkov> Could you please fill up & submit the AML Policy Form via this link: https://forms.gle/ZeSRvWUU3gBeHPbH6 This is a one-time process for each ETH Address used to receive HBOT bounty. — Reply to this email directly, view it on GitHub<#112 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ABDR3MPFJWZOKTCRD6TJRJDXOOKIHANCNFSM6AAAAAAYNUFTCI>. You are receiving this because you commented.Message ID: ***@***.***>

[VPashkov]

Hey @toxicehc, sorry didn't see your message. I'll check DM on Discord. Thanks.

[nikspz]

Thanks for your participation, the bounty has been sent to @VPashkov . The fix has been deployed on development branch and next hummingbot version 1.18.0