WT-1662 Bridge and swap route

[imx-mikhala]

Summary

This PR adds the bridge -> swap route.

• The bridge -> swap route reuse the bridge & swap routes but have some additional logic.
• Firstly, the bridge -> swap route filters all the swappable tokens by ones that can also be bridged by checking against the indexer for L1 addresses and then filteriing these using the bridgeable tokens.
• Next, we get all the quotes from the DEX for swappable tokens.
  • Using this we construct all the possible bridge requirements, which is basically an array of all the tokens we want to check for bridging and the amount of each token to bridge.
  • The amount checks for things like fees and balance requirements to ensure we bridge enough across if the fees and requirements include the same token to ensure we bridge enough for swapping and covering any fees etc.
  • We are applying a 1% slippage to the DEX to accommodate token pairing price flucs
    • May need to adjust the % to something higher but just using this for now
• Using the bridge requirements we perform the bridge route n times.
• After this we check all the bridges that were successful and fake the balances as if the bridge occurred (so when we run the swap route it uses the balance as if we bridged)
• The swap route is then called against each of the tokens that could be bridged to see what can be swapped.
• Once we have the swap routes we then reset the balances on the routes to the original balances.
• All of the bridge->swap routes are then returned

Demo

This demo has a requirement of zkYEET. The wallet I am testing with has a small about of IMX on L2 but not quite enough to perform the swap into zkYEET. The wallet also has enough ETH to pay for bridge fees. However, the wallet has enough IMX on L1 that can be bridged across and then swapped into zkYEET. Smart checkout suggests a Bridge->Swap route since I can bridge across enough IMX to perform the swap and cover all fees.

Screen.Recording.2023-09-28.at.8.51.57.am.mov

[dreamoftrees]

Awesome work @imx-mikhala 🎉 Just some minor comments.

[dreamoftrees]

I like this work, at some future point I think worth considering to refactor into mockUtils or mockDexQuotes as mocking functions we can share across checkout.

[imx-mikhala]

100%

[dreamoftrees]

Do you think it's worth expanding on what the logic/business rule is here that is being validated, rather than the focus only on the response.. for example

Suggested change

	it('should return no bridge and swap routes', async () => {
	it('should return no bridge and swap routes if no bridgeable and swappable tokens available', async () => {

[dreamoftrees]

Nice encapsulation here, looks nice and clean 🌮

[imx-mikhala]

got the idea from a comment you left on another pr haha