[skip ci] wip: chainflip swapper #8049

gomesalexandre · 2024-10-30T23:53:21Z

Description

Authored to be able to see diff, WIP.
Takes over the monster work done in #7991 by @CumpsD 🐐

Issue (if applicable)

closes #8026

Risk

High Risk PRs Require 2 approvals

What protocols, transaction types, wallets or contract interactions might be affected by this PR?

Testing

Engineering

Operations

🏁 My feature is behind a flag and doesn't require operations testing (yet)

Screenshots (if applicable)

BTC Receive

BTC Sends

Blocked for the time being

Native EVM asset send

https://jam.dev/c/bf0f392f-64c1-40ac-a0e6-7a96809e954d

EVM token send

https://jam.dev/c/9735bf9d-61aa-404d-96eb-d7e2aa92c0cd

gomesalexandre · 2024-10-30T23:58:40Z

packages/swapper/src/swappers/ChainflipSwapper/utils/helpers.ts

+  )
+}
+
+export const getGasLimit = (chainflipAsset: string) => {


This won't generalize and should be programmatic. Since we're talking sends, allowance isn't a problem - there will never be allowance required (which, on a tangent, means we should be cognicent in ensuring allowance step is never triggered in swapper)

gomesalexandre · 2024-10-31T00:52:30Z

packages/caip/src/constants.ts

+export const usdcAssetId: AssetId = 'eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
+export const usdcOnArbitrumOneAssetId: AssetId =
+  'eip155:42161/erc20:0xaf88d065e77c8cc2239327c5edb3a432268e5831'
+export const usdcOnSolanaAssetId: AssetId =
+  'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'
+export const flipAssetId: AssetId = 'eip155:1/erc20:0x826180541412d574cf1336d22c0c0a287822678a'


all common AssetIds moved into one block + some additions

CumpsD · 2024-10-31T01:58:46Z

.env.base

@@ -169,3 +171,7 @@ REACT_APP_ZERION_BASE_URL=https://api.proxy.shapeshift.com/api/v1/zerion

 # 0x
 REACT_APP_ZRX_BASE_URL=https://api.proxy.shapeshift.com/api/v1/zrx/
+
+# chainflip
+REACT_APP_CHAINFLIP_API_KEY=6ba154d4-e219-472a-9674-5fa5b1300ccf


Give me a ping to set up Shapeshift's API key when going forward, this is currently mine for testing! :) The best person to reach out to me for this would be the one who will be responsible for redeeming affiliate rewards in the future. The one controlling the wallet to sign Chainflip transactions that is (redeeming is a chainflip tx)

Sounds good @CumpsD! Is there any reason we should wait for go-live to get an actual API key here, or can we already get one? Will get the convs going already

The key in there right now is actually the one from my swapping Discord bot https://swappy.be/ :) It works, you can test with it, but it charges 0.15% fee (0.05 BaaS + 0.10 Swappy). I can make you a temp one that does only 0.05 (BaaS fee + 0% partner) if you want. You can go live with that as well and swap it out to the Shapeshift one afterwards. lmk

@CumpsD just to be sure, we can parametrize fee bps right i.e this isn't tied to the API key used?

Current one for dev is absolutely fine, so long as we go live on prod (and ideally on develop as a follow-up) with a proper API key 🙏🏽

@CumpsD just to be sure, we can parametrize fee bps right i.e this isn't tied to the API key used?

Yes, you can pass in commissionBps for both quote and opening a deposit channel (I think I added that in the PR already even! taking in affiliateBps from shapeshift)

CumpsD · 2024-10-31T02:09:39Z

packages/swapper/src/swappers/ChainflipSwapper/constants.ts

+export const CHAINFLIP_DCA_SWAP_SOURCE: SwapSource = `${SwapperName.Chainflip} • DCA`
+export const CHAINFLIP_DCA_BOOST_SWAP_SOURCE: SwapSource = `${SwapperName.Chainflip} • DCA • Boost`
+
+export const usdcAsset: Asset = {


A fyi, the reason I copied this here is because the usdcAsset in caip is only the assetId, but where I've used it, it also needed precision (in the protocol fees calculations)

That's absolutely fine @CumpsD!
Just to disambiguate here, what's the two actual flows when fees will be denominated in USDC? i.e i can see the condition is fee.type === 'network'and fee.type === 'liquidity' && fee.asset === 'usdc.eth' but not sure what this means exactly.

Asking because we may be able to simply use buyAsset / sellAsset if one of these is USDC

Network fee is always USDC, it is the 0.10% buy & burn fee the chainflip network uses.

Liquidity is the LP fee, which I would have to double check but I believe the second leg is always USDC. It's possible this if (fee.type === 'liquidity' && fee.asset === buyChainflipChainKey) return buyAsset might actually never be hit.

Will double check!

Yep, so the second leg seems to be always usdc.eth for the liquidity fee.

Happy to keep the second branch for the sake of paranoia. Tyvm for disambiguating this! Looks like indeed, we need usdc as a static asset then, which means keeping it here as a const is absolutely fine.

Happy to keep the second branch for the sake of paranoia.

Pretty much the reason I added all branches too :D

CumpsD · 2024-10-31T02:14:02Z

packages/swapper/src/swappers/ChainflipSwapper/swapperApi/getTradeQuote.ts

+    )
+  }
+
+  const sellChainflipChainKey = `${sellAsset.symbol.toLowerCase()}.${


Another fyi, if you want to improve this. The assets are available here: https://chainflip-broker.io/assets as the id property in the format asset.chain, it just so happened all of them matched the .symbol, but perhaps you want to have this in a mapping in constants as well, like the chains?

I added this to the axios cache on chainflipService by the way, if it helps :) Didn't use it though

CumpsD · 2024-10-31T02:47:51Z

packages/swapper/src/swappers/ChainflipSwapper/swapperApi/getTradeQuote.ts

+    const error = maybeQuoteResponse.unwrapErr()
+    const cause = error.cause as AxiosError<any, any>
+
+    if (


This can probably be done cleaner, the error responses follow the problem details rfc, maybe axios has some way to properly parse that to a typed thing instead of the any I had to do here

Also, minimum amounts are also on the https://chainflip-broker.io/assets endpoint as minimalAmountNative

CumpsD · 2024-11-04T02:32:47Z

packages/swapper/src/swappers/ChainflipSwapper/swapperApi/getTradeQuote.ts

        return await getUtxoTxFees({
          sellAmountCryptoBaseUnit: sellAmount,
          sellAdapter,
          publicKey,
        })
      }

-      case CHAIN_NAMESPACE.Solana: {
+      // TODO(gomes): Cosmos SDK too
+      case CHAIN_NAMESPACE.CosmosSdk:


Will this ever be the case? No idea what CosmosSdk is, but chainflip doesnt support any cosmos chains (right now)

gomesalexandre · 2024-11-04T06:29:36Z

packages/swapper/src/swappers/ChainflipSwapper/endpoints.ts

+      gasPrice: unsignedTxInput.gasPrice,
+    }
+  },
+  getUnsignedUtxoTransaction,


This should come back to this module as well since we'll need to add to trade quote meta for status polling

CumpsD · 2024-11-04T10:59:54Z

packages/swapper/src/swappers/ChainflipSwapper/endpoints.ts

+
+    // Assume any state that isn't completed is pending.
+    // Going forward, we will want to add granular status polling similar to what we do for THOR.
+    if (state !== 'completed' || !swapEgress?.transactionReference) {


completed or failed imho

CumpsD added 30 commits October 23, 2024 18:28

feat: add chainflip swagger schema

f9cf7a9

feat: add chainflip icon

b0fef83

feat: add chainflip env settings

6f4b2cd

feat: start chainflip swapper

ae0d083

fix: forgot a missing type

56a4003

feat: build sell and buy asset strings

53cfa9f

fix: dont add chainflip to unchained

8515f51

feat: add supported chains and assets for chainflip

c4131d5

feat: add chainflip csp

159650a

feat: fetch chainflip quote

cca5688

feat: add fees to quotes

09b820d

feat: add boost swaps

9f60594

fix: correct commissionBPs

8bab08e

feat: first steps to get gas prices displayed

09b9b02

fix: correct arb to eth

e6a43ac

refactor: cleanup const and types

9c2f447

chore: add todo wrt minimum amounts

20216d6

fix: deal with SellAmountBelowTradeFee error

d5b9fee

refactor: cleanup chainflip feature flag

2861ba3

refactor: move default chainflip settings to env

57e08d1

chore: newline eof

2207d5b

refactor: consistent order of swapper imports

56697f1

fix: allowanceContract 0x0

9507b73

feat: filter out assets even more

668856f

feat: provide gaslimits for simple asset sends

1765b86

chore: newline at eof

7b3cc26

feat: support amount to low

a6d42f9

refactor: delete unneeded generated openai models

dfa6a3a

chore: remove polkadot todo

ef79b52

refactor: clarify networkfee crypto base unit naming

fea992c

gomesalexandre added 5 commits October 31, 2024 08:15

Merge remote-tracking branch 'origin/develop' into add-chainflip

a906812

feat: lint and cleanup some

4924c16

feat: improve types

1fd442b

feat: cleanup unused models

dccd703

feat: cleanup

206a337

gomesalexandre commented Oct 30, 2024

View reviewed changes

gomesalexandre added 4 commits October 31, 2024 09:18

feat: cleanup some more

7cfe7c2

feat: more prgorammatic

c2def52

feat: clean diff up

5ef0169

feat: cleanup consts

2e77080

gomesalexandre commented Oct 31, 2024

View reviewed changes

gomesalexandre added 5 commits October 31, 2024 09:54

feat: consistency

c32b370

feat: stopping point

9a10db4

feat: false in base

19f5fcd

feat: stopping point for real this time

3111366

fix: lint

820283b

CumpsD reviewed Oct 31, 2024

View reviewed changes

gomesalexandre added 2 commits November 4, 2024 09:47

Merge remote-tracking branch 'origin/develop' into add-chainflip

8c25692

fix: ci

ddd1339

CumpsD reviewed Nov 4, 2024

View reviewed changes

gomesalexandre added 4 commits November 4, 2024 11:34

feat: split quotes/rates

1c1b711

feat: cleanup

3172d80

feat: trade status

388b4dc

feat: flip polling and messaging

267eb4f

gomesalexandre commented Nov 4, 2024

View reviewed changes

CumpsD reviewed Nov 4, 2024

View reviewed changes

feat: improve btc things

ae0dd35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[skip ci] wip: chainflip swapper #8049

[skip ci] wip: chainflip swapper #8049

gomesalexandre commented Oct 30, 2024 •

edited

Loading

gomesalexandre Oct 30, 2024

gomesalexandre Oct 31, 2024

CumpsD Oct 31, 2024

gomesalexandre Nov 4, 2024

CumpsD Nov 4, 2024

gomesalexandre Nov 4, 2024

gomesalexandre Nov 4, 2024

CumpsD Nov 4, 2024

CumpsD Oct 31, 2024

gomesalexandre Nov 4, 2024

CumpsD Nov 4, 2024

CumpsD Nov 4, 2024

gomesalexandre Nov 4, 2024

CumpsD Nov 4, 2024 •

edited

Loading

CumpsD Oct 31, 2024

CumpsD Oct 31, 2024 •

edited

Loading

CumpsD Oct 31, 2024

CumpsD Oct 31, 2024

CumpsD Nov 4, 2024

gomesalexandre Nov 4, 2024

CumpsD Nov 4, 2024

[skip ci] wip: chainflip swapper #8049

Are you sure you want to change the base?

[skip ci] wip: chainflip swapper #8049

Conversation

gomesalexandre commented Oct 30, 2024 • edited Loading

Description

Issue (if applicable)

Risk

Testing

Engineering

Operations

Screenshots (if applicable)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CumpsD Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CumpsD Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gomesalexandre commented Oct 30, 2024 •

edited

Loading

CumpsD Nov 4, 2024 •

edited

Loading

CumpsD Oct 31, 2024 •

edited

Loading