feat(fantom): add spiritswap and spookyswap dexs

cspell.json

@@ -214,6 +214,8 @@
         "sint",
         "solana",
         "sollet",
+        "spiritswap",
+        "spookyswap",
         "steelblue",
         "steganographic",
         "steganography",

packages/mask/src/plugins/Trader/apis/trader/index.ts

@@ -47,7 +47,7 @@ export async function getAvailableTraderProviders(chainId: ChainId) {
         case NetworkType.Celo:
             return [TradeProvider.SUSHISWAP]
         case NetworkType.Fantom:
-            return [TradeProvider.SUSHISWAP]
+            return [TradeProvider.SUSHISWAP, TradeProvider.SPOOKYSWAP, TradeProvider.SPIRITSWAP]
         case NetworkType.Aurora:
             return [TradeProvider.DODO, TradeProvider.WANNASWAP, TradeProvider.TRISOLARIS]
         case NetworkType.Boba:

packages/mask/src/plugins/Trader/constants/index.ts

@@ -13,4 +13,6 @@ export * from './traderjoe'
 export * from './pangolindex'
 export * from './wannaswap'
 export * from './trisolaris'
+export * from './spiritswap'
+export * from './spookyswap'
 export type { ERC20TokenCustomizedBase, ERC20AgainstToken } from './types'

packages/mask/src/plugins/Trader/constants/spiritswap.ts

@@ -0,0 +1,13 @@
+import { ChainId, DAI, USDC, fUSDT, WBTC, WNATIVE, WNATIVE_ONLY, SPIRIT } from '@masknet/web3-shared-evm'
+import type { ERC20AgainstToken, ERC20TokenCustomizedBase } from './types'
+
+/**
+ * Some tokens can only be swapped via certain pairs,
+ * so we override the list of bases that are considered for these tokens.
+ */
+export const SPIRITSWAP_CUSTOM_BASES: ERC20TokenCustomizedBase = {}
+
+export const SPIRITSWAP_BASE_AGAINST_TOKENS: ERC20AgainstToken = {
+    ...WNATIVE_ONLY,
+    [ChainId.Fantom]: [WNATIVE, DAI, USDC, fUSDT, WBTC, SPIRIT].map((x) => x[ChainId.Fantom]),
+}

packages/mask/src/plugins/Trader/constants/spookyswap.ts

@@ -0,0 +1,13 @@
+import { ChainId, DAI, USDC, fUSDT, WBTC, WNATIVE, WNATIVE_ONLY, BOO } from '@masknet/web3-shared-evm'
+import type { ERC20AgainstToken, ERC20TokenCustomizedBase } from './types'
+
+/**
+ * Some tokens can only be swapped via certain pairs,
+ * so we override the list of bases that are considered for these tokens.
+ */
+export const SPOOKYSWAP_CUSTOM_BASES: ERC20TokenCustomizedBase = {}
+
+export const SPOOKYSWAP_BASE_AGAINST_TOKENS: ERC20AgainstToken = {
+    ...WNATIVE_ONLY,
+    [ChainId.Fantom]: [WNATIVE, DAI, USDC, fUSDT, WBTC, BOO].map((x) => x[ChainId.Fantom]),
+}

packages/mask/src/plugins/Trader/pipes.ts

@@ -40,6 +40,8 @@ export const resolveTradeProviderName = createLookupTableResolver<TradeProvider,
         [TradeProvider.PANGOLIN]: 'PangolinDex',
         [TradeProvider.TRISOLARIS]: 'Trisolaris',
         [TradeProvider.WANNASWAP]: 'WannaSwap',
+        [TradeProvider.SPIRITSWAP]: 'SpiritSwap',
+        [TradeProvider.SPOOKYSWAP]: 'SpookySwap',
     },
     (tradeProvider) => {
         throw new Error(`Unknown provider type: ${tradeProvider}`)

packages/mask/src/plugins/Trader/trader/useAllTradeComputed.ts

@@ -198,6 +198,20 @@ export function useAllTradeComputed(
         traderEstimateGas: wannaSwapEstimateGas,
     } = useUniswapV2Like(tradeProviders, TradeProvider.WANNASWAP, inputAmount_, inputToken, outputToken)
 
+    // SpiritSwap
+    const {
+        trader_: spiritswap_,
+        trader: spiritswap,
+        traderEstimateGas: spiritswapEstimateGas,
+    } = useUniswapV2Like(tradeProviders, TradeProvider.SPIRITSWAP, inputAmount_, inputToken, outputToken)
+
+    // Spookyswap
+    const {
+        trader_: spookyswap_,
+        trader: spookyswap,
+        traderEstimateGas: spookyswapEstimateGas,
+    } = useUniswapV2Like(tradeProviders, TradeProvider.SPOOKYSWAP, inputAmount_, inputToken, outputToken)
+
     const allTradeResult = [
         { provider: TradeProvider.UNISWAP_V2, ...uniswapV2_, value: uniswapV2, gas: uniswapV2EstimateGas },
         { provider: TradeProvider.SUSHISWAP, ...sushiSwap_, value: sushiSwap, gas: sushiSwapEstimateGas },
@@ -214,6 +228,8 @@ export function useAllTradeComputed(
         { provider: TradeProvider.OPENOCEAN, ...openocean_, value: openocean, gas: openoceanSwapEstimateGas },
         { provider: TradeProvider.WANNASWAP, ...wannaswap_, value: wannaswap, gas: wannaSwapEstimateGas },
         { provider: TradeProvider.TRISOLARIS, ...trisolaris_, value: trisolaris, gas: trisolarisEstimateGas },
+        { provider: TradeProvider.SPIRITSWAP, ...spiritswap_, value: spiritswap, gas: spiritswapEstimateGas },
+        { provider: TradeProvider.SPOOKYSWAP, ...spookyswap_, value: spookyswap, gas: spookyswapEstimateGas },
     ]
 
     return nativeToken_.value

packages/mask/src/plugins/Trader/trader/useGetTradeContext.ts

@@ -21,6 +21,10 @@ import {
     WANNASWAP_CUSTOM_BASES,
     TRISOLARIS_BASE_AGAINST_TOKENS,
     TRISOLARIS_CUSTOM_BASES,
+    SPIRITSWAP_BASE_AGAINST_TOKENS,
+    SPIRITSWAP_CUSTOM_BASES,
+    SPOOKYSWAP_BASE_AGAINST_TOKENS,
+    SPOOKYSWAP_CUSTOM_BASES,
 } from '../constants'
 import { unreachable } from '@dimensiondev/kit'
 import { TargetChainIdContext } from './useTargetChainIdContext'
@@ -150,6 +154,30 @@ export function useGetTradeContext(tradeProvider?: TradeProvider) {
                     ADDITIONAL_TOKENS: {},
                     CUSTOM_TOKENS: TRISOLARIS_CUSTOM_BASES,
                 }
+            case TradeProvider.SPOOKYSWAP:
+                return {
+                    TYPE: tradeProvider,
+                    IS_UNISWAP_V2_LIKE: true,
+                    GRAPH_API: DEX_TRADE.SPOOKYSWAP_THEGRAPH,
+                    INIT_CODE_HASH: DEX_TRADE.SPOOKYSWAP_INIT_CODE_HASH,
+                    ROUTER_CONTRACT_ADDRESS: DEX_TRADE.SPOOKYSWAP_ROUTER_ADDRESS,
+                    FACTORY_CONTRACT_ADDRESS: DEX_TRADE.SPOOKYSWAP_FACTORY_ADDRESS,
+                    AGAINST_TOKENS: SPOOKYSWAP_BASE_AGAINST_TOKENS,
+                    ADDITIONAL_TOKENS: {},
+                    CUSTOM_TOKENS: SPOOKYSWAP_CUSTOM_BASES,
+                }
+            case TradeProvider.SPIRITSWAP:
+                return {
+                    TYPE: tradeProvider,
+                    IS_UNISWAP_V2_LIKE: true,
+                    GRAPH_API: DEX_TRADE.SPIRITSWAP_THEGRAPH,
+                    INIT_CODE_HASH: DEX_TRADE.SPIRITSWAP_INIT_CODE_HASH,
+                    ROUTER_CONTRACT_ADDRESS: DEX_TRADE.SPIRITSWAP_ROUTER_ADDRESS,
+                    FACTORY_CONTRACT_ADDRESS: DEX_TRADE.SPIRITSWAP_FACTORY_ADDRESS,
+                    AGAINST_TOKENS: SPIRITSWAP_BASE_AGAINST_TOKENS,
+                    ADDITIONAL_TOKENS: {},
+                    CUSTOM_TOKENS: SPIRITSWAP_CUSTOM_BASES,
+                }
             case TradeProvider.ZRX:
                 return {
                     TYPE: tradeProvider,

packages/mask/src/plugins/Trader/trader/useTradeCallback.ts

@@ -114,6 +114,10 @@ export function useTradeCallback(
             return uniswapV2Like
         case TradeProvider.OPENOCEAN:
             return openocean
+        case TradeProvider.SPIRITSWAP:
+            return uniswapV2Like
+        case TradeProvider.SPOOKYSWAP:
+            return uniswapV2Like
         default:
             if (provider) unreachable(provider)
             return []

packages/mask/src/plugins/Trader/trader/useTradeContext.ts

@@ -21,6 +21,10 @@ import {
     WANNASWAP_CUSTOM_BASES,
     TRISOLARIS_CUSTOM_BASES,
     TRISOLARIS_BASE_AGAINST_TOKENS,
+    SPOOKYSWAP_CUSTOM_BASES,
+    SPOOKYSWAP_BASE_AGAINST_TOKENS,
+    SPIRITSWAP_CUSTOM_BASES,
+    SPIRITSWAP_BASE_AGAINST_TOKENS,
 } from '../constants'
 import type { TradeContext as TradeContext_ } from '../types'
 import { TargetChainIdContext } from './useTargetChainIdContext'
@@ -171,6 +175,30 @@ export function useTradeContext(tradeProvider: TradeProvider) {
                     ADDITIONAL_TOKENS: {},
                     CUSTOM_TOKENS: PANGOLIN_CUSTOM_BASES,
                 }
+            case TradeProvider.SPIRITSWAP:
+                return {
+                    TYPE: tradeProvider,
+                    IS_UNISWAP_V2_LIKE: true,
+                    GRAPH_API: DEX_TRADE.SPIRITSWAP_THEGRAPH,
+                    INIT_CODE_HASH: DEX_TRADE.SPIRITSWAP_INIT_CODE_HASH,
+                    ROUTER_CONTRACT_ADDRESS: DEX_TRADE.SPIRITSWAP_ROUTER_ADDRESS,
+                    FACTORY_CONTRACT_ADDRESS: DEX_TRADE.SPIRITSWAP_FACTORY_ADDRESS,
+                    AGAINST_TOKENS: SPIRITSWAP_BASE_AGAINST_TOKENS,
+                    ADDITIONAL_TOKENS: {},
+                    CUSTOM_TOKENS: SPIRITSWAP_CUSTOM_BASES,
+                }
+            case TradeProvider.SPOOKYSWAP:
+                return {
+                    TYPE: tradeProvider,
+                    IS_UNISWAP_V2_LIKE: true,
+                    GRAPH_API: DEX_TRADE.SPOOKYSWAP_THEGRAPH,
+                    INIT_CODE_HASH: DEX_TRADE.SPOOKYSWAP_INIT_CODE_HASH,
+                    ROUTER_CONTRACT_ADDRESS: DEX_TRADE.SPOOKYSWAP_ROUTER_ADDRESS,
+                    FACTORY_CONTRACT_ADDRESS: DEX_TRADE.SPOOKYSWAP_FACTORY_ADDRESS,
+                    AGAINST_TOKENS: SPOOKYSWAP_BASE_AGAINST_TOKENS,
+                    ADDITIONAL_TOKENS: {},
+                    CUSTOM_TOKENS: SPOOKYSWAP_CUSTOM_BASES,
+                }
             case TradeProvider.OPENOCEAN:
                 return {
                     TYPE: tradeProvider,

packages/mask/src/plugins/Trader/types/trader.ts

@@ -75,6 +75,8 @@ export enum ZrxTradePool {
     PangolinDex = 'PangolinDex',
     Trisolaris = 'Trisolaris',
     WannaSwap = 'WannaSwap',
+    SpiritSwap = 'SpiritSwap',
+    SpookySwap = 'SpookySwap',
 }
 
 export interface TradeComputed<T = unknown> {

packages/public-api/src/web.ts

@@ -216,6 +216,8 @@ export enum TradeProvider {
     TRISOLARIS = 12,
     TRADERJOE = 13,
     PANGOLIN = 14,
+    SPIRITSWAP = 15,
+    SPOOKYSWAP = 16,
 }
 /** Supported language settings */
 export enum LanguageOptions {

packages/web3-constants/evm/token.json

@@ -899,6 +899,46 @@
         "Aurora": "",
         "Aurora_Testnet": ""
     },
+    "SPIRIT_ADDRESS": {
+        "Mainnet": "",
+        "Ropsten": "",
+        "Rinkeby": "",
+        "Kovan": "",
+        "Gorli": "",
+        "BSC": "",
+        "BSCT": "",
+        "Matic": "",
+        "Mumbai": "",
+        "Arbitrum": "",
+        "Arbitrum_Rinkeby": "",
+        "xDai": "",
+        "Avalanche": "",
+        "Avalanche_Fuji": "",
+        "Celo": "",
+        "Fantom": "0x5cc61a78f164885776aa610fb0fe1257df78e59b",
+        "Aurora": "",
+        "Aurora_Testnet": ""
+    },
+    "BOO_ADDRESS": {
+        "Mainnet": "0x55af5865807b196bd0197e0902746f31fbccfa58",
+        "Ropsten": "",
+        "Rinkeby": "",
+        "Kovan": "",
+        "Gorli": "",
+        "BSC": "",
+        "BSCT": "",
+        "Matic": "",
+        "Mumbai": "",
+        "Arbitrum": "",
+        "Arbitrum_Rinkeby": "",
+        "xDai": "",
+        "Avalanche": "0xbd83010eb60f12112908774998f65761cf9f6f9a",
+        "Avalanche_Fuji": "",
+        "Celo": "",
+        "Fantom": "0x841fad6eae12c286d1fd18d1d525dffa75c7effe",
+        "Aurora": "",
+        "Aurora_Testnet": ""
+    },
     "ETHER_ADDRESS": {
         "Mainnet": "",
         "Ropsten": "",