[skip ci] wip: chainflip swapper #8049
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| import type { AssetId } from '@shapeshiftoss/caip' | ||
| import type { BTCSignTx } from '@shapeshiftoss/hdwallet-core' | ||
| import type { Asset } from '@shapeshiftoss/types' | ||
|
|
||
| import type { BuyAssetBySellIdInput, Swapper, UtxoTransactionExecutionProps } from '../../types' | ||
| import { executeEvmTransaction } from '../../utils' | ||
| import { CHAINFLIP_SUPPORTED_CHAIN_IDS } from './constants' | ||
| import { isSupportedAssetId } from './utils/helpers' | ||
|
|
||
| export const chainflipSwapper: Swapper = { | ||
| executeEvmTransaction, | ||
|
|
||
| executeUtxoTransaction: async ( | ||
| txToSign: BTCSignTx, | ||
| { signAndBroadcastTransaction }: UtxoTransactionExecutionProps, | ||
| ): Promise<string> => { | ||
| return await signAndBroadcastTransaction(txToSign) | ||
| }, | ||
|
|
||
| filterAssetIdsBySellable: (assets: Asset[]): Promise<AssetId[]> => { | ||
| return Promise.resolve( | ||
| assets | ||
| .filter(asset => CHAINFLIP_SUPPORTED_CHAIN_IDS.sell.includes(asset.chainId)) | ||
| .filter(asset => isSupportedAssetId(asset.chainId, asset.assetId)) | ||
| .map(asset => asset.assetId), | ||
| ) | ||
| }, | ||
|
|
||
| filterBuyAssetsBySellAssetId: (input: BuyAssetBySellIdInput): Promise<AssetId[]> => { | ||
| return Promise.resolve( | ||
| input.assets | ||
| .filter(asset => CHAINFLIP_SUPPORTED_CHAIN_IDS.buy.includes(asset.chainId)) | ||
| .filter(asset => isSupportedAssetId(asset.chainId, asset.assetId)) | ||
| .map(asset => asset.assetId), | ||
| ) | ||
| }, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import type { SwapperApi } from '../../types' | ||
| import { checkTradeStatus } from './swapperApi/checkTradeStatus' | ||
| import { getTradeQuote } from './swapperApi/getTradeQuote' | ||
| import { getUnsignedEvmTransaction } from './swapperApi/getUnsignedEvmTransaction' | ||
| import { getUnsignedUtxoTransaction } from './swapperApi/getUnsignedUtxoTransaction' | ||
|
|
||
| export const chainflipApi: SwapperApi = { | ||
| getTradeQuote, | ||
| getUnsignedEvmTransaction, | ||
| getUnsignedUtxoTransaction, | ||
| checkTradeStatus, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { | ||
| arbitrumAssetId, | ||
| type AssetId, | ||
| btcAssetId, | ||
| type ChainId, | ||
| ethAssetId, | ||
| flipAssetId, | ||
| solAssetId, | ||
| usdcAssetId, | ||
| usdcOnArbitrumOneAssetId, | ||
| usdcOnSolanaAssetId, | ||
| usdtAssetId, | ||
| } from '@shapeshiftoss/caip' | ||
| import type { Asset } from '@shapeshiftoss/types' | ||
| import { KnownChainIds } from '@shapeshiftoss/types' | ||
|
|
||
| import type { SupportedChainIds, SwapSource } from '../../types' | ||
| import { SwapperName } from '../../types' | ||
|
|
||
| export const CHAINFLIP_REGULAR_QUOTE = 'regular' | ||
| export const CHAINFLIP_DCA_QUOTE = 'dca' | ||
| export const CHAINFLIP_BAAS_COMMISSION = 5 | ||
|
|
||
| export const ChainflipSupportedChainIds = [ | ||
| KnownChainIds.EthereumMainnet, | ||
| KnownChainIds.ArbitrumMainnet, | ||
| KnownChainIds.BitcoinMainnet, | ||
| KnownChainIds.SolanaMainnet, | ||
| ] as const | ||
|
|
||
| export type ChainflipSupportedChainId = (typeof ChainflipSupportedChainIds)[number] | ||
|
|
||
| export const ChainflipSupportedAssetIdsByChainId: Partial<Record<KnownChainIds, AssetId[]>> = { | ||
| [KnownChainIds.EthereumMainnet]: [ethAssetId, flipAssetId, usdcAssetId, usdtAssetId], | ||
| [KnownChainIds.ArbitrumMainnet]: [arbitrumAssetId, usdcOnArbitrumOneAssetId], | ||
| [KnownChainIds.BitcoinMainnet]: [btcAssetId], | ||
| [KnownChainIds.SolanaMainnet]: [solAssetId, usdcOnSolanaAssetId], | ||
| } | ||
|
|
||
| export const chainIdToChainflipNetwork: Partial<Record<KnownChainIds, string>> = { | ||
| [KnownChainIds.EthereumMainnet]: 'eth', | ||
| [KnownChainIds.ArbitrumMainnet]: 'arb', | ||
| [KnownChainIds.BitcoinMainnet]: 'btc', | ||
| [KnownChainIds.SolanaMainnet]: 'sol', | ||
| } | ||
|
|
||
| export const CHAINFLIP_SUPPORTED_CHAIN_IDS: SupportedChainIds = { | ||
| sell: ChainflipSupportedChainIds as unknown as ChainId[], | ||
| buy: ChainflipSupportedChainIds as unknown as ChainId[], | ||
| } | ||
|
|
||
| export const CHAINFLIP_SWAP_SOURCE: SwapSource = SwapperName.Chainflip | ||
| export const CHAINFLIP_BOOST_SWAP_SOURCE: SwapSource = `${SwapperName.Chainflip} • Boost` | ||
| 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 = { | ||
|
There was a problem hiding this comment. A fyi, the reason I copied this here is because the There was a problem hiding this comment. That's absolutely fine @CumpsD! Asking because we may be able to simply use There was a problem hiding this comment. 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 Will double check! There was a problem hiding this comment. Yep, so the second leg seems to be always usdc.eth for the liquidity fee. There was a problem hiding this comment. 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. There was a problem hiding this comment.
Pretty much the reason I added all branches too :D |
||
| assetId: 'eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', | ||
| chainId: KnownChainIds.EthereumMainnet, | ||
| color: '#2373CB', | ||
| explorer: 'https://etherscan.io', | ||
| explorerAddressLink: 'https://etherscan.io/address/', | ||
| explorerTxLink: 'https://etherscan.io/tx/', | ||
| icon: 'https://rawcdn.githack.com/trustwallet/assets/master/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png', | ||
| name: 'USDC on Ethereum', | ||
| precision: 6, | ||
| relatedAssetKey: 'eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', | ||
| symbol: 'USDC', | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| // @ts-nocheck | ||
| /* tslint:disable */ | ||
| /* eslint-disable */ | ||
| /** | ||
| * Chainflip Broker as a Service | ||
| * Run your own Chainflip Broker without any hassle. | ||
| * | ||
| * The version of the OpenAPI document: v1 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
|
|
||
| import { exists, mapValues } from '../runtime'; | ||
| import type { ChainflipBaasQuoteBoostQuote } from './ChainflipBaasQuoteBoostQuote'; | ||
| import { | ||
| ChainflipBaasQuoteBoostQuoteFromJSON, | ||
| ChainflipBaasQuoteBoostQuoteFromJSONTyped, | ||
| ChainflipBaasQuoteBoostQuoteToJSON, | ||
| } from './ChainflipBaasQuoteBoostQuote'; | ||
| import type { ChainflipBaasQuotePoolInfo } from './ChainflipBaasQuotePoolInfo'; | ||
| import { | ||
| ChainflipBaasQuotePoolInfoFromJSON, | ||
| ChainflipBaasQuotePoolInfoFromJSONTyped, | ||
| ChainflipBaasQuotePoolInfoToJSON, | ||
| } from './ChainflipBaasQuotePoolInfo'; | ||
| import type { ChainflipBaasQuoteQuoteFee } from './ChainflipBaasQuoteQuoteFee'; | ||
| import { | ||
| ChainflipBaasQuoteQuoteFeeFromJSON, | ||
| ChainflipBaasQuoteQuoteFeeFromJSONTyped, | ||
| ChainflipBaasQuoteQuoteFeeToJSON, | ||
| } from './ChainflipBaasQuoteQuoteFee'; | ||
|
|
||
| /** | ||
| * | ||
| * @export | ||
| * @interface ChainflipBaasQuoteQuote | ||
| */ | ||
| export interface ChainflipBaasQuoteQuote { | ||
| /** | ||
| * The type of quote. | ||
| * @type {string} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly type?: ChainflipBaasQuoteQuoteTypeEnum; | ||
| /** | ||
| * The asset to send. | ||
| * @type {string} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| ingressAsset?: string; | ||
| /** | ||
| * The amount to send. | ||
| * @type {number} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| ingressAmount?: number; | ||
| /** | ||
| * The amount to send in native units. | ||
| * @type {string} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly ingressAmountNative?: string; | ||
| /** | ||
| * The asset to receive. | ||
| * @type {string} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| egressAsset?: string; | ||
| /** | ||
| * The amount to receive. | ||
| * @type {number} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly egressAmount?: number; | ||
| /** | ||
| * The amount to receive in native units. | ||
| * @type {string} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly egressAmountNative?: string; | ||
| /** | ||
| * The fee structure, this includes all fees. | ||
| * @type {Array<ChainflipBaasQuoteQuoteFee>} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly includedFees?: Array<ChainflipBaasQuoteQuoteFee>; | ||
| /** | ||
| * A warning in case liquidity is low and there is a risk of high slippage. | ||
| * @type {boolean} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly lowLiquidityWarning?: boolean; | ||
| /** | ||
| * Liquidity pools involved in the swap, as well as estimated liquidity provider fees. | ||
| * @type {Array<ChainflipBaasQuotePoolInfo>} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| poolInfo?: Array<ChainflipBaasQuotePoolInfo>; | ||
| /** | ||
| * The estimated time the swap will take. | ||
| * @type {number} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| readonly estimatedDurationSeconds?: number; | ||
| /** | ||
| * The number of "sub-swaps" to perform for a DCA swap. | ||
| * @type {number} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| chunkIntervalBlocks?: number | null; | ||
| /** | ||
| * The delay between the "sub-swaps" of a DCA swap in number of blocks. | ||
| * @type {number} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| numberOfChunks?: number | null; | ||
| /** | ||
| * | ||
| * @type {ChainflipBaasQuoteBoostQuote} | ||
| * @memberof ChainflipBaasQuoteQuote | ||
| */ | ||
| boostQuote?: ChainflipBaasQuoteBoostQuote; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @export | ||
| */ | ||
| export const ChainflipBaasQuoteQuoteTypeEnum = { | ||
| Regular: 'regular', | ||
| Dca: 'dca' | ||
| } as const; | ||
| export type ChainflipBaasQuoteQuoteTypeEnum = typeof ChainflipBaasQuoteQuoteTypeEnum[keyof typeof ChainflipBaasQuoteQuoteTypeEnum]; | ||
|
|
||
|
|
||
| /** | ||
| * Check if a given object implements the ChainflipBaasQuoteQuote interface. | ||
| */ | ||
| export function instanceOfChainflipBaasQuoteQuote(value: object): boolean { | ||
| let isInstance = true; | ||
|
|
||
| return isInstance; | ||
| } | ||
|
|
||
| export function ChainflipBaasQuoteQuoteFromJSON(json: any): ChainflipBaasQuoteQuote { | ||
| return ChainflipBaasQuoteQuoteFromJSONTyped(json, false); | ||
| } | ||
|
|
||
| export function ChainflipBaasQuoteQuoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChainflipBaasQuoteQuote { | ||
| if ((json === undefined) || (json === null)) { | ||
| return json; | ||
| } | ||
| return { | ||
|
|
||
| 'type': !exists(json, 'type') ? undefined : json['type'], | ||
| 'ingressAsset': !exists(json, 'ingressAsset') ? undefined : json['ingressAsset'], | ||
| 'ingressAmount': !exists(json, 'ingressAmount') ? undefined : json['ingressAmount'], | ||
| 'ingressAmountNative': !exists(json, 'ingressAmountNative') ? undefined : json['ingressAmountNative'], | ||
| 'egressAsset': !exists(json, 'egressAsset') ? undefined : json['egressAsset'], | ||
| 'egressAmount': !exists(json, 'egressAmount') ? undefined : json['egressAmount'], | ||
| 'egressAmountNative': !exists(json, 'egressAmountNative') ? undefined : json['egressAmountNative'], | ||
| 'includedFees': !exists(json, 'includedFees') ? undefined : ((json['includedFees'] as Array<any>).map(ChainflipBaasQuoteQuoteFeeFromJSON)), | ||
| 'lowLiquidityWarning': !exists(json, 'lowLiquidityWarning') ? undefined : json['lowLiquidityWarning'], | ||
| 'poolInfo': !exists(json, 'poolInfo') ? undefined : ((json['poolInfo'] as Array<any>).map(ChainflipBaasQuotePoolInfoFromJSON)), | ||
| 'estimatedDurationSeconds': !exists(json, 'estimatedDurationSeconds') ? undefined : json['estimatedDurationSeconds'], | ||
| 'chunkIntervalBlocks': !exists(json, 'chunkIntervalBlocks') ? undefined : json['chunkIntervalBlocks'], | ||
| 'numberOfChunks': !exists(json, 'numberOfChunks') ? undefined : json['numberOfChunks'], | ||
| 'boostQuote': !exists(json, 'boostQuote') ? undefined : ChainflipBaasQuoteBoostQuoteFromJSON(json['boostQuote']), | ||
| }; | ||
| } | ||
|
|
||
| export function ChainflipBaasQuoteQuoteToJSON(value?: ChainflipBaasQuoteQuote | null): any { | ||
| if (value === undefined) { | ||
| return undefined; | ||
| } | ||
| if (value === null) { | ||
| return null; | ||
| } | ||
| return { | ||
|
|
||
| 'ingressAsset': value.ingressAsset, | ||
| 'ingressAmount': value.ingressAmount, | ||
| 'egressAsset': value.egressAsset, | ||
| 'poolInfo': value.poolInfo === undefined ? undefined : ((value.poolInfo as Array<any>).map(ChainflipBaasQuotePoolInfoToJSON)), | ||
| 'chunkIntervalBlocks': value.chunkIntervalBlocks, | ||
| 'numberOfChunks': value.numberOfChunks, | ||
| 'boostQuote': ChainflipBaasQuoteBoostQuoteToJSON(value.boostQuote), | ||
| }; | ||
| } | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@CumpsD just to be sure, we can parametrize fee bps right i.e this isn't tied to the API key used?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 🙏🏽
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you can pass in
commissionBpsfor both quote and opening a deposit channel (I think I added that in the PR already even! taking in affiliateBps from shapeshift)