add magpie api key

Author: dglowinski

.env.template

@@ -42,4 +42,5 @@ OKX_SECRET_KEY=""
 ODOS_API_KEY=""
 ODOS_REFERRAL_CODE=""
 OOGABOOGA_API_KEY=""
-OX_API_KEY=""
+OX_API_KEY=""
+MAGPIE_API_KEY=""

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -1,14 +1,15 @@
 import type { IFetchService, IProviderService } from "@balmy/sdk"
 import { LocalSourceList } from "@balmy/sdk/dist/services/quotes/source-lists/local-source-list"
-import { CustomLiFiQuoteSource } from "./lifiQuoteSource"
-import { CustomNeptuneQuoteSource } from "./neptuneQuoteSource"
-import { CustomOdosQuoteSource } from "./odosQuoteSource"
-import { CustomOkuQuoteSource } from "./okuQuoteSource"
-import { CustomOneInchQuoteSource } from "./oneInchQuoteSource"
-import { CustomOogaboogaQuoteSource } from "./oogaboogaQuoteSource"
-import { CustomOpenOceanQuoteSource } from "./openOceanQuoteSource"
-import { CustomPendleQuoteSource } from "./pendleQuoteSource"
-import { CustomUniswapQuoteSource } from "./uniswapQuoteSource"
+import { CustomLiFiQuoteSource } from "./sources/lifiQuoteSource"
+import { CustomMagpieQuoteSource } from "./sources/magpieQuoteSource"
+import { CustomNeptuneQuoteSource } from "./sources/neptuneQuoteSource"
+import { CustomOdosQuoteSource } from "./sources/odosQuoteSource"
+import { CustomOkuQuoteSource } from "./sources/okuQuoteSource"
+import { CustomOneInchQuoteSource } from "./sources/oneInchQuoteSource"
+import { CustomOogaboogaQuoteSource } from "./sources/oogaboogaQuoteSource"
+import { CustomOpenOceanQuoteSource } from "./sources/openOceanQuoteSource"
+import { CustomPendleQuoteSource } from "./sources/pendleQuoteSource"
+import { CustomUniswapQuoteSource } from "./sources/uniswapQuoteSource"
 
 type ConstructorParameters = {
   providerService: IProviderService
@@ -24,6 +25,7 @@ const customSources = {
   odos: new CustomOdosQuoteSource(),
   oogabooga: new CustomOogaboogaQuoteSource(),
   uniswap: new CustomUniswapQuoteSource(),
+  magpie: new CustomMagpieQuoteSource(),
   oku_bob_icecreamswap: new CustomOkuQuoteSource(
     "icecreamswap",
     "IceCreamSwap",

src/swapService/strategies/balmySDK/lifiQuoteSource.ts renamed to src/swapService/strategies/balmySDK/sources/lifiQuoteSource.ts

@@ -0,0 +1,172 @@
+import {
+  Addresses,
+  type ChainId,
+  Chains,
+  type TokenAddress,
+  isSameAddress,
+} from "@balmy/sdk"
+import { AlwaysValidConfigAndContextSource } from "@balmy/sdk/dist/services/quotes/quote-sources/base/always-valid-source"
+import type {
+  BuildTxParams,
+  QuoteParams,
+  QuoteSourceMetadata,
+  SourceQuoteResponse,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/types"
+import {
+  addQuoteSlippage,
+  calculateAllowanceTarget,
+  failed,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import qs from "qs"
+import { parseUnits } from "viem"
+
+const SUPPORTED_CHAINS: Record<ChainId, string> = {
+  [Chains.ARBITRUM.chainId]: "arbitrum",
+  [Chains.AVALANCHE.chainId]: "avalanche",
+  [Chains.BNB_CHAIN.chainId]: "bsc",
+  [Chains.ETHEREUM.chainId]: "ethereum",
+  [Chains.POLYGON.chainId]: "polygon",
+  [Chains.OPTIMISM.chainId]: "optimism",
+  [Chains.BASE.chainId]: "base",
+  [Chains.POLYGON_ZKEVM.chainId]: "polygonzk",
+  [Chains.BLAST.chainId]: "blast",
+  [Chains.SCROLL.chainId]: "scroll",
+  [Chains.METIS_ANDROMEDA.chainId]: "metis",
+  [Chains.FANTOM.chainId]: "fantom",
+  [Chains.SONIC.chainId]: "sonic",
+}
+
+const MAGPIE_METADATA: QuoteSourceMetadata<MagpieSupport> = {
+  name: "Magpie",
+  supports: {
+    chains: Object.keys(SUPPORTED_CHAINS).map(Number),
+    swapAndTransfer: true,
+    buyOrders: false,
+  },
+  logoURI: "ipfs://QmfR2ybY1gvctAxU5KArQ1UDXFixBY8ehgTBUBvUqY4Q4b",
+}
+type MagpieSupport = { buyOrders: false; swapAndTransfer: true }
+type MagpieConfig = { sourceAllowlist?: string[]; apiKey?: string }
+type MagpieData = { quoteId: string }
+export class CustomMagpieQuoteSource extends AlwaysValidConfigAndContextSource<
+  MagpieSupport,
+  MagpieConfig,
+  MagpieData
+> {
+  getMetadata() {
+    return MAGPIE_METADATA
+  }
+
+  async quote({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      order,
+      accounts: { takeFrom, recipient },
+      config: { slippagePercentage, timeout },
+    },
+    config,
+  }: QuoteParams<MagpieSupport, MagpieConfig>): Promise<
+    SourceQuoteResponse<MagpieData>
+  > {
+    const quoteQueryParams = {
+      network: SUPPORTED_CHAINS[chainId],
+      fromTokenAddress: mapToken(sellToken),
+      toTokenAddress: mapToken(buyToken),
+      sellAmount: order.sellAmount.toString(),
+      slippage: slippagePercentage / 100,
+      liquiditySources: config.sourceAllowlist,
+      fromAddress: takeFrom,
+      toAddress: recipient ?? takeFrom,
+      gasless: false,
+    }
+
+    const quoteQueryString = qs.stringify(quoteQueryParams, {
+      skipNulls: true,
+      arrayFormat: "comma",
+    })
+    const quoteUrl = `https://api.magpiefi.xyz/aggregator/quote?${quoteQueryString}`
+    const headers: Record<string, string> = {}
+    if (config.apiKey) {
+      headers["apikey"] = config.apiKey
+    }
+    const quoteResponse = await fetchService.fetch(quoteUrl, {
+      timeout,
+      headers,
+    })
+    if (!quoteResponse.ok) {
+      failed(
+        MAGPIE_METADATA,
+        chainId,
+        sellToken,
+        buyToken,
+        await quoteResponse.text(),
+      )
+    }
+    const {
+      id: quoteId,
+      amountOut,
+      targetAddress,
+      fees,
+    } = await quoteResponse.json()
+    const estimatedGasNum: `${number}` | undefined = fees.find(
+      (fee: { type: string; value: `${number}` }) => fee.type === "gas",
+    )?.value
+    const estimatedGas = estimatedGasNum
+      ? parseUnits(estimatedGasNum, 9)
+      : undefined
+
+    const quote = {
+      sellAmount: order.sellAmount,
+      buyAmount: BigInt(amountOut),
+      estimatedGas,
+      allowanceTarget: calculateAllowanceTarget(sellToken, targetAddress),
+      customData: { quoteId, takeFrom, recipient },
+    }
+
+    return addQuoteSlippage(quote, order.type, slippagePercentage)
+  }
+
+  async buildTx({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      config: { timeout },
+      customData: { quoteId },
+    },
+  }: BuildTxParams<MagpieConfig, MagpieData>): Promise<SourceQuoteTransaction> {
+    const transactionQueryParams = {
+      quoteId,
+      estimateGas: false,
+    }
+    const transactionQueryString = qs.stringify(transactionQueryParams, {
+      skipNulls: true,
+      arrayFormat: "comma",
+    })
+    const transactionUrl = `https://api.magpiefi.xyz/aggregator/transaction?${transactionQueryString}`
+    const transactionResponse = await fetchService.fetch(transactionUrl, {
+      timeout,
+    })
+    if (!transactionResponse.ok) {
+      failed(
+        MAGPIE_METADATA,
+        chainId,
+        sellToken,
+        buyToken,
+        await transactionResponse.text(),
+      )
+    }
+    const { to, value, data } = await transactionResponse.json()
+    return { to, calldata: data, value: BigInt(value) }
+  }
+}
+
+function mapToken(address: TokenAddress) {
+  return isSameAddress(address, Addresses.NATIVE_TOKEN)
+    ? Addresses.ZERO_ADDRESS
+    : address
+}

src/swapService/strategies/balmySDK/sources/magpieQuoteSource.ts

@@ -2,12 +2,9 @@ import {
   type Address,
   Addresses,
   type ChainId,
-  Chains,
-  Contract,
   type GasPrice,
   type TimeString,
   type TokenAddress,
-  calculateDeadline,
   getChainByKey,
   isSameAddress,
 } from "@balmy/sdk"