feat/carbondefi

[tiagofilipenunes]

Closes #255

A description of the changes proposed in the pull request:

In this pull request, a Carbon DeFi AMM connector is added. The following endpoints are available:

• Functions to expose in the gateway
  • AMMish
    • amm/trade POST
    • amm/price POST
    • amm/estimateGas POST
  • Generic
    • connectors GET
    • chain/tokens GET

Tests performed by the developer:

Test for Carbonamm

• Carbon constructor
• estimateSellTrade
  • with possible trade path
  • without possible trade path
• estimateBuyTrade
  • with possible trade path
  • without possible trade path
• getAllowedSlippage
  • non-null input
  • null input
  • malformed input
• POST amm/price
  • SELL side
    • valid parameters
    • invalid parameters
  • BUY side
    • valid parameters
    • invalid parameters
• POST amm/trade
  • BUY side
    • valid parameters
    • invalid parameters
  • SELL side
    • valid parameters
    • invalid parameters
    • changing maxFeePerGas
• Creating the connector with unsupported chain
• Malformed allowedSlippage
  • in the request amm/trade
  • in the carbon.conf file

Coverage:

File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line
connectors/carbon	98.53	90	98.52	99.69
carbon.config.ts	100	100	100	100
carbon.utils.ts	100	97.29	100	100	100
carbonAMM.ts	100	100	100	100

Tips for QA testing and comments/questions:

• If using a private RPC, you can go to https://app.carbondefi.xyz/debug and input it there, then use the app to observe reflected changes coming from interacting with the gateway.
• The CarbonSDK is used, which can be found at https://github.com/bancorprotocol/carbon-sdk
• Both connectors initiate a cache and keep it up to date by polling events
  • The Carbon CLOB connector purposely hits the miss cache handler on initialisation to get all the on-chain information as it is a pre-requisite for the functionality of most CLOB endpoints
  • The Carbon AMM syncs in the background and can handle /price and /trade requests and hit cache miss handle
• jest.config.js modification - problem with jest not supporting subpath imports and exports pre version v29.4.0. Hummingbot gateway is currently using version 27.3.1. A workaround by modifying the jest.config file to manually add the subpath imports was used.

[fengtality]

Requested changes:

• Please move all tests to the test-bronze folder, so that they are not included in workflows

• I recommend that this PR should only add the AMM connector initially, that is within the bounds of the existing Gateway structure. Keep in mind that DEX connectors are only meant to be standard integrations that work with a specific strategy, like AMM-ARB. Afterwards it's merged in, I think you can add the custom functionality as another PR.

• Regarding swapping ETH, you can modify the amm/trade and amm/price endpoints to remove the check for ETH for this connector.

• I think the CLOB functionality, limit orders support, and associated endpoints could be part of this connector or as part of a different connector folder - it's up to how you want this connector to be used. Currently, Gateway assumes that these connectors are being added so that users can run standard strategies like AMM-ARB with them. However, if you want to add custom scripts that allow users to use other endpoints that this connector supports, that approach could work too.

[tiagofilipenunes]

Thank you for the review Michael. Changes:

• Move tests to test-bronze
• PR only adds AMM connector
• Split CarbonAMM and CarbonCLOB into two separate PRs (CarbonCLOB implementation is currently at https://github.com/bancorprotocol/hummingbot-gateway/tree/tiagofilipenunes-feat/carbonclob)
• Modify amm/trade and amm/price endpoints to support native ETH swapping for Carbon

[fengtality]

Thank you for the review Michael. Changes:

• Move tests to test-bronze
• PR only adds AMM connector
• Split CarbonAMM and CarbonCLOB into two separate PRs (CarbonCLOB implementation is currently at https://github.com/bancorprotocol/hummingbot-gateway/tree/tiagofilipenunes-feat/carbonclob)
• Modify amm/trade and amm/price endpoints to support native ETH swapping for Carbon

Looks good @tiagofilipenunes. I think you should be able to create a Pull Request Proposal to have us review and merge this connector into the codebase.

[notion-workspace]

feat/carbondefi #256

[nikspz]

hi @tiagofilipenunes Please resolve branch conflicts and be informed that all PRs should use development branch and be pointed to development branch (not main or master)

https://hummingbot.org/developers/contributions/#checklist

[tiagofilipenunes]

@nikspz Thanks for pointing that out, just merged and resolved conflicts.

• Did I create my branch from development?
• Did I follow the correct naming convention for my branch?
• Is my branch focused on a single main change?
• Do all of my changes directly relate to this change?
• Did I rebase the upstream development branch after I finished all my work? Merged them
• Did I write a clear pull request message detailing what changes I made?
• Did I get a code review?
• Did I make any requested changes from that code review?

[rapcmia]

PR update:

• Setup with latest development client ok
• Ran API tests:
  • GET connector displays carbonamm
  • POST balances and poll ok
  • POST allowance, approve and cancel ok
  • POST for price and estimateGas ok
  • POST trade also gets valid / insufficient balance response ok
• Current PR does not support CLOB atm and base on previous comments, a separate PR shall be submitted pending

[fengtality]

As @rapcmia's tests are successful, I will merge this PR in so that other PRs can resolve any conflicts if needed.

[david-hummingbot]

Hi @tiagofilipenunes, please add connector docs here - https://github.com/hummingbot/hummingbot-site
You can use any of the existing DEX connectors as a template - https://hummingbot.org/dex-connectors/
Thanks!

[tiagofilipenunes]

Hi @david-hummingbot thanks for the reminder! Here is the PR to add the connector docs:

hummingbot/hummingbot-site#347

[david-hummingbot]

Thanks @tiagofilipenunes, this will be included in the 1.25.0 release next week.