switch token fetch to debridge api for debridge provider

Author: Apexloaded

dist/index.d.ts

@@ -4,6 +4,36 @@ import { Chain } from 'viem/chains';
 import { N as Network } from './adapter-06DuPPG-.js';
 import 'zod';
 
+declare const ChainById: {
+    abstract: number;
+    arbitrum: number;
+    avalanche: number;
+    base: number;
+    berachain: number;
+    bitrock: number;
+    bsc: number;
+    cronos: number;
+    cronoszkEVM: number;
+    crossFi: number;
+    ethereum: number;
+    fantom: number;
+    gnosis: number;
+    heco: number;
+    hyperEVM: number;
+    linea: number;
+    metis: number;
+    neon: number;
+    opBNB: number;
+    optimism: number;
+    polygon: number;
+    polygonzkEVM: number;
+    sei: number;
+    sonic: number;
+    story: number;
+    tron: number;
+};
+declare const getChainMap: (chainId: number) => string | undefined;
+
 /**
  * Get a chain from the viem chains object
  *
@@ -19,4 +49,4 @@ declare const getChain: (id: string) => Chain;
  */
 declare const getNetworkInfo: (chain: Chain) => Network;
 
-export { Network, getChain, getNetworkInfo };
+export { ChainById, Network, getChain, getChainMap, getNetworkInfo };

dist/index.js

@@ -1,7 +1,9 @@
 import {
+  ChainById,
   getChain,
+  getChainMap,
   getNetworkInfo
-} from "./chunk-QYWLTMWP.js";
+} from "./chunk-DO5TJVOX.js";
 import {
   __name,
   __publicField
@@ -45,7 +47,9 @@ var _DexAi = class _DexAi {
 __name(_DexAi, "DexAi");
 var DexAi = _DexAi;
 export {
+  ChainById,
   DexAi,
   getChain,
+  getChainMap,
   getNetworkInfo
 };

src/adapters/providers/coingecko/constants.ts

@@ -54,8 +54,4 @@ export const CoingeckoPlatformId = {
   [Chain.SONIC]: "sonic",
   [Chain.STORY]: "story",
   [Chain.TRON]: "tron",
-};
-
-
-// bridge 1 LINK from bsc to USDT on sonic
-// 0x691889F5944126906F0051c5ca087e975BADABb3
+};

src/adapters/providers/debridge/constants.ts

@@ -1,4 +1,4 @@
-import { Chain } from "../../../networks/constant";
+import { Chain, getChainMap } from "../../../networks/constant";
 
 export const supportedChains = [
   Chain.ARBITRUM,
@@ -88,3 +88,13 @@ export const DLNInternalId = {
   [Chain.SONIC]: 100000014,
   [Chain.STORY]: 100000013,
 };
+
+/**
+ * Retrieve DLN internal ID by passing a chainId
+ * @param chainId
+ * @returns
+ */
+export const getDLNByChainId = (chainId: number) => {
+  const chain = getChainMap(chainId);
+  if (chain) return DLNInternalId[chain];
+};

src/adapters/providers/debridge/dln.ts

@@ -10,7 +10,8 @@ import { dlnSourceAbi } from "./abis/dlnSource";
 import { DLN, evmDLNContracts } from "./constants";
 import { getChain } from "dexai";
 import { Chain, ChainById } from "../../../networks/constant";
-import { PrepareTxResponse, ValidateChainResponse } from "./type";
+import { DeBridgeTokens, PrepareTxResponse, ValidateChainResponse } from "./type";
+import { toResult } from "@heyanon/sdk";
 
 // Define bridge step types for better type safety
 type BridgeStep = "initial" | "confirmation" | "execution";
@@ -20,7 +21,7 @@ type BridgeStep = "initial" | "confirmation" | "execution";
  * This provider provides the ability for user to bridge token from one chain to another.
  */
 export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccount> {
-  private tokensCache: LRUCache<string, Token[]>;
+  private tokensCache: LRUCache<string, DeBridgeTokens[]>;
   private bridgeStep: BridgeStep;
   private transactionTimeout: NodeJS.Timeout | null = null;
   private lastPreparedTransaction: any = null;
@@ -42,6 +43,9 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
     name: "bridge_token",
     description: `
     Bridge a token from one network chain to another network chain or token
+
+    Inputs:
+    - 
     
     Strict Rules:
     - Do not respond without querying bridge_token function
@@ -55,10 +59,7 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
       // Handle transaction cancellation
       if (this.bridgeStep === "execution" && !args.isConfirmed) {
         this.resetBridgeState(args);
-        return {
-          success: true,
-          data: "Transaction has been cancled successfully",
-        };
+        return toResult("Transaction has been cancled successfully", false);
       }
 
       // Reset confirmation if not in execution step
@@ -73,10 +74,7 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
 
       const validatedChains = validateDLNInputs(args);
       if (!validatedChains.success || !validatedChains.data)
-        return {
-          success: validatedChains.success,
-          data: validatedChains.errorMessage,
-        };
+        return toResult(validatedChains.errorMessage, true);
 
       const { fromChain, toChain } = validatedChains.data;
 
@@ -99,10 +97,10 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
 
       if (!prepareTx.success) {
         this.resetBridgeState();
-        return {
-          success: false,
-          data: "errorMessage" in prepareTx ? prepareTx.errorMessage : "Unknown error occurred",
-        };
+        return toResult(
+          "errorMessage" in prepareTx ? prepareTx.errorMessage : "Unknown error occurred",
+          true,
+        );
       }
 
       // Handle confirmation step
@@ -286,14 +284,15 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
 
     // Format token lists for display
     const sourceTokens = srcTokens
-      ?.map((t: Token, i) => `${i + 1}. ${t.symbol.toUpperCase()} - ${t.address}`)
+      ?.map((t: DeBridgeTokens, i) => `${i + 1}. ${t.symbol.toUpperCase()} - ${t.address}`)
       .join("\n");
 
     const destinationTokens = destTokens
-      ?.map((t: Token, i) => `${i + 1}. ${t.symbol.toUpperCase()} - ${t.address}`)
+      ?.map((t: DeBridgeTokens, i) => `${i + 1}. ${t.symbol.toUpperCase()} - ${t.address}`)
       .join("\n");
 
-    return `
+    return toResult(
+      `
       Stricly display below token data for user to select source and destination tokens 
       from the list below which they want to bridge.
 
@@ -304,7 +303,9 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
       ${destinationTokens}
 
       If the token you want to bridge to isn't on the list, kindly paste the token address.
-    `;
+    `,
+      false,
+    );
   }
 
   /**
@@ -319,8 +320,8 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
       ? "⚠️ Your previous transaction has expired. Please review and confirm the updated transaction details."
       : "Note: This transaction will expire in 30 seconds if not confirmed.";
 
-    return {
-      message: `
+    return toResult(
+      `
         Strictly display this entire confirmation message to user:
 
         ${wasExpired ? expiryMessage : ""}
@@ -344,7 +345,8 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
             
         ${!wasExpired ? expiryMessage : ""}
       `,
-    };
+      false,
+    );
   }
 
   /**
@@ -419,7 +421,7 @@ export class DeBridgeLiquidityAdapterProvider extends AdapterProvider<BaseAccoun
 
     // Reset bridge state after successful transaction
     this.resetBridgeState(args);
-    return { success: true, data: "Bridge transaction submitted successfully" };
+    return toResult("Bridge transaction submitted successfully", false);
   }
 
   /**

src/adapters/providers/debridge/index.ts

@@ -1 +1,9 @@
 export { dlnAdapterProvider } from "./dln";
+export {
+  DLNInternalId,
+  deBridgeGates,
+  evmDLNContracts,
+  DLN,
+  svmDLNContracts,
+  getDLNByChainId,
+} from "./constants";

src/adapters/providers/debridge/schemas/bridge.schema.ts

@@ -2,6 +2,34 @@ import { z } from "zod";
 import { supportedChains } from "../constants";
 import { zeroAddress } from "viem";
 
+// Please select the source and destination tokens from the list below for the bridging process:
+
+// ### Source Tokens:
+// 1. **ETH** - `0x0000000000000000000000000000000000000000`
+// 2. **USDT** - `0xdac17f958d2ee523a2206206994597c13d831ec7`
+// 3. **BNB** - `0x418d75f65a02b3d53b2418fb8e1fe493759c7605`
+// 4. **USDC** - `0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48`
+// 5. **STETH** - `0xae7ab96520de3a18e5e111b5eaab095312d7fe84`
+// 6. **WBTC** - `0x2260fac5e5542a773aa44fbcfedf7c193bc2c599`
+// 7. **LINK** - `0x514910771af9ca656af840dff83e8264ecf986ca`
+// 8. **WSTETH** - `0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0`
+// 9. **LEO** - `0x2af5d2ad76741191d15dfe7bf6ac92d4bd912ca3`
+// 10. **SHIB** - `0xfcaf0e4498e78d65526a507360f755178b804ba8`
+
+// ### Destination Tokens:
+// 1. **BNB** - `0x0000000000000000000000000000000000000000`
+// 2. **LINK** - `0xf8a0bf9cf54bb92f17374d9e9a321e6a111a51bd`
+// 3. **TON** - `0x76a797a59ba2c17726896976b7b3747bfd1d220f`
+// 4. **OM** - `0xf78d2e7936f5fe18308a3b2951a93b6c4a41f5e2`
+// 5. **UNI** - `0xbf5140a22578168fd562dccf235e5d43a02ce9b1`
+// 6. **PEPE** - `0xef00278d7eadf3b2c05267a2f185e468ad7eab7d`
+// 7. **AAVE** - `0xfb6115445bff7b52feb98650c87f44907e58f802`
+// 8. **ATOM** - `0x0eb3a705fc54725037cc9e008bdede697f62f335`
+// 9. **FDUSD** - `0xc5f0f7b66764f6ec8c8dff7ba683102295e16409`
+// 10. **FET** - `0x031b41e504677879370e9dbcf937283a8691fa7f`
+
+// If the token you want to bridge to isn't on the list, kindly provide the token address.
+
 /**
  * Input schema for bridging tokens on deBridge
  */
@@ -13,19 +41,25 @@ export const bridgeTokenSchema = z.object({
     .string()
     .default(zeroAddress)
     .optional()
-    .describe("The token address that will be bridged."),
+    .describe("The token address that will be bridged. use default address if not provided"),
   destinationChain: z
     .enum(supportedChains.map(sc => sc) as [string, ...string[]])
     .describe("Chain name to where the source chain sends transaction"),
   destinationTokenAddress: z
     .string()
     .default(zeroAddress)
     .optional()
-    .describe("The token address that will be recieved after the bridge"),
-  to: z.string().optional().default(zeroAddress).describe(`The address of the receiver`),
+    .describe(
+      "The token address that will be recieved after the bridge. use default address if not provided",
+    ),
+  to: z
+    .string()
+    .optional()
+    .default(zeroAddress)
+    .describe(`The address of the receiver. use default address if not provided.`),
   amount: z.string().describe("Amount of tokens in decimal format"),
   isConfirmed: z
     .boolean()
     .default(false)
-    .describe("this is the last step before transaction is done"),
+    .describe("Never ask for confirmation except if I ask you to"),
 });

src/adapters/providers/debridge/type.ts

@@ -33,8 +33,23 @@ export type PrepareTxResponse = {
   amountInUsd: number;
   estTakeValueInUsd: number;
   takeAmountInUint: number;
-  destToken: Token;
-  sourceToken: Token;
+  destToken: DeBridgeTokens;
+  sourceToken: DeBridgeTokens;
   affiliateFee: Hex;
   permitEnvelope: Hex;
 };
+
+export interface DeBridgeTokenResponse {
+  tokens: {
+    [key: string]: DeBridgeTokens;
+  };
+}
+export interface DeBridgeTokens {
+  symbol: string;
+  name: string;
+  decimals: number;
+  address: string;
+  logoURI: string;
+  tags?: [{ Name: string }];
+  eip2612?: boolean;
+}