Rename pluginId thorchainda->swapkit

Retain original thorchainda export for backwards compatibility

Author: Jon-edge

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- changed: Changed 'thorchainda' pluginId to 'swapkit.' 'thorchainda' still exists for backwards compatibility
+
 ## 2.8.0 (2024-09-12)
 
 - added: `minReceiveAmount` passed in `EdgeSwapQuotes` for lifi and rango

src/index.ts

@@ -13,7 +13,7 @@ import { make0xGaslessPlugin } from './swap/defi/0x/0xGasless'
 import { makeCosmosIbcPlugin } from './swap/defi/cosmosIbc'
 import { makeLifiPlugin } from './swap/defi/lifi'
 import { makeRangoPlugin } from './swap/defi/rango'
-import { makeThorchainDaPlugin } from './swap/defi/swapKit'
+import { makeSwapKitPlugin } from './swap/defi/swapKit'
 import { makeThorchainPlugin } from './swap/defi/thorchain'
 import { makeSpookySwapPlugin } from './swap/defi/uni-v2-based/plugins/spookySwap'
 import { makeTombSwapPlugin } from './swap/defi/uni-v2-based/plugins/tombSwap'
@@ -33,9 +33,11 @@ const plugins = {
   rango: makeRangoPlugin,
   sideshift: makeSideshiftPlugin,
   spookySwap: makeSpookySwapPlugin,
+  swapkit: makeSwapKitPlugin,
   swapuz: makeSwapuzPlugin,
   thorchain: makeThorchainPlugin,
-  thorchainda: makeThorchainDaPlugin,
+  /** @deprecated - For backwards compatibility with swapkit */
+  thorchainda: makeSwapKitPlugin,
   tombSwap: makeTombSwapPlugin,
   transfer: makeTransferPlugin,
   velodrome: makeVelodromePlugin,

src/swap/defi/swapKit.ts

@@ -53,16 +53,16 @@ import {
   THORNODE_SERVERS_DEFAULT
 } from './thorchain'
 
-const pluginId = 'thorchainda'
+const pluginId = 'swapkit'
 const swapInfo: EdgeSwapInfo = {
   pluginId,
   isDex: true,
-  displayName: 'Thorchain DEX Aggregator',
+  displayName: 'Swap Kit',
   supportEmail: 'support@edge.app'
 }
 
 // This needs to be a type so adding the '& {}' prevents auto correction to an interface
-type ThorSwapQuoteParams = {
+type SwapKitSwapQuoteParams = {
   sellAsset: string
   buyAsset: string
   sellAmount: string
@@ -78,7 +78,7 @@ const asCalldata = asObject({
   memo: asOptional(asString)
 })
 
-const asThorSwapRoute = asObject({
+const asSwapKitSwapRoute = asObject({
   contract: asEither(asString, asNull),
   contractMethod: asEither(asString, asNull),
   contractInfo: asOptional(asString),
@@ -93,8 +93,8 @@ const asThorSwapRoute = asObject({
   deadline: asOptional(asString)
 })
 
-const asThorSwapQuoteResponse = asObject({
-  routes: asArray(asThorSwapRoute)
+const asSwapKitSwapQuoteResponse = asObject({
+  routes: asArray(asSwapKitSwapRoute)
 })
 
 /** Max slippage for 5% for estimated quotes */
@@ -111,9 +111,7 @@ const tokenProxyMap: { [currencyPluginId: string]: string } = {
   avalanche: '0x69ba883af416ff5501d54d5e27a1f497fbd97156'
 }
 
-export function makeThorchainDaPlugin(
-  opts: EdgeCorePluginOptions
-): EdgeSwapPlugin {
+export function makeSwapKitPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
   const { io, log } = opts
   const { fetchCors = io.fetch } = io
   const {
@@ -225,7 +223,7 @@ export function makeThorchainDaPlugin(
       fromCurrencyCode
     )
 
-    const quoteParams: ThorSwapQuoteParams = {
+    const quoteParams: SwapKitSwapQuoteParams = {
       sellAsset:
         `${fromMainnetCode}.${fromCurrencyCode}` +
         (fromTokenId != null ? `-0x${fromTokenId}` : ''),
@@ -263,7 +261,7 @@ export function makeThorchainDaPlugin(
     if (!iaResponse.ok) {
       const responseText = await iaResponse.text()
       throw new Error(
-        `Thorchain could not fetch inbound_addresses: ${JSON.stringify(
+        `SwapKitchain could not fetch inbound_addresses: ${JSON.stringify(
           responseText,
           null,
           2
@@ -273,7 +271,7 @@ export function makeThorchainDaPlugin(
     if (!thorSwapResponse.ok) {
       const responseText = await thorSwapResponse.text()
       throw new Error(
-        `Thorchain could not get thorswap quote: ${JSON.stringify(
+        `SwapKitchain could not get thorswap quote: ${JSON.stringify(
           responseText,
           null,
           2
@@ -285,7 +283,7 @@ export function makeThorchainDaPlugin(
     const inboundAddresses = asInboundAddresses(iaJson)
 
     const thorSwapJson = await thorSwapResponse.json()
-    const thorSwapQuote = asThorSwapQuoteResponse(thorSwapJson)
+    const thorSwapQuote = asSwapKitSwapQuoteResponse(thorSwapJson)
 
     // Check for supported chain and asset
     const inAddressObject = inboundAddresses.find(
@@ -360,7 +358,7 @@ export function makeThorchainDaPlugin(
           throw new Error(
             `Missing sourceTokenContractAddress for ${fromMainnetCode}`
           )
-        // Need to use ethers.js to craft a proper tx that calls Thorchain contract, then extract the data payload
+        // Need to use ethers.js to craft a proper tx that calls SwapKitchain contract, then extract the data payload
         // Token transactions send no ETH (or other EVM mainnet coin)
         if (tcDirect) {
           memo = await getEvmTokenData({

test/createUserDump.ts

@@ -42,6 +42,7 @@ async function main(): Promise<void> {
       avalanche: true,
       piratechain: true,
       polygon: true,
+      swapkit: true,
       thorchainda: true
     }
   })

test/testpartner.ts

@@ -97,6 +97,7 @@ async function main(): Promise<void> {
       polygon: config.POLYGON_INIT,
       piratechain: true,
       rango: config.RANGO_INIT,
+      swapkit: config.THORCHAIN_INIT,
       thorchain: config.THORCHAIN_INIT,
       thorchainda: config.THORCHAIN_INIT
     }