[Enhancemenet] Show automatic redemption route even if insufficient funds are available (#1360)

Co-authored-by: M-Picco <martin@xlabs.xyz>

Author: yuli-ferna

wormhole-connect/src/routes/abstracts/routeAbstract.ts

@@ -20,7 +20,16 @@ export abstract class RouteAbstract {
   // protected abstract sendGasFallback: { [key: ChainName]: TokenConfig };
   // protected abstract claimGasFallback: { [key: ChainName]: TokenConfig };
 
-  // Is this route available for the given chain, token and amount specifications?
+  // Is this route supported for the given chain, token and amount specifications?
+  public abstract isRouteSupported(
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean>;
+
+  // Is this route available for the given chain, fee and amount specifications?
   public abstract isRouteAvailable(
     sourceToken: string,
     destToken: string,

wormhole-connect/src/routes/bridge/baseRoute.ts

@@ -86,6 +86,16 @@ export abstract class BaseRoute extends RouteAbstract {
     });
   }
 
+  async isRouteAvailable(
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean> {
+    return true;
+  }
+
   async getPreview(
     token: TokenConfig,
     destToken: TokenConfig,

wormhole-connect/src/routes/bridge/bridge.ts

@@ -28,7 +28,7 @@ export class BridgeRoute extends BaseRoute {
   readonly NATIVE_GAS_DROPOFF_SUPPORTED: boolean = false;
   readonly AUTOMATIC_DEPOSIT: boolean = false;
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,

wormhole-connect/src/routes/cctpManual/cctpManual.ts

@@ -143,7 +143,7 @@ export class CCTPManualRoute extends BaseRoute {
     });
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,

wormhole-connect/src/routes/cctpRelay/cctpRelay.ts

@@ -150,7 +150,7 @@ export class CCTPRelayRoute extends CCTPManualRoute implements RelayAbstract {
     });
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,
@@ -186,8 +186,17 @@ export class CCTPRelayRoute extends CCTPManualRoute implements RelayAbstract {
     const bothHaveRelayer =
       CHAINS[sourceChainName]?.contracts.cctpContracts?.wormholeCircleRelayer &&
       CHAINS[destChainName]?.contracts.cctpContracts?.wormholeCircleRelayer;
-    if (!bothHaveRelayer) return false;
 
+    return !!bothHaveRelayer;
+  }
+
+  async isRouteAvailable(
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean> {
     let relayerFee;
     try {
       relayerFee = await this.getRelayerFee(

wormhole-connect/src/routes/cosmosGateway/cosmosGateway.ts

@@ -57,7 +57,7 @@ export class CosmosGatewayRoute extends BaseRoute {
     return isGatewayChain(chain);
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,

wormhole-connect/src/routes/hashflow/hashflow.ts

@@ -22,7 +22,7 @@ export class HashflowRoute extends RouteAbstract {
     return false;
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,
@@ -35,6 +35,16 @@ export class HashflowRoute extends RouteAbstract {
 
     throw new Error('Method not implemented.');
   }
+
+  public isRouteAvailable(
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
   isSupportedSourceToken(
     token: TokenConfig | undefined,
     destToken: TokenConfig | undefined,

wormhole-connect/src/routes/operator.ts

@@ -113,6 +113,27 @@ export class Operator {
       : Route.Bridge;
   }
 
+  async isRouteSupported(
+    route: Route,
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean> {
+    if (!ROUTES.includes(route)) {
+      return false;
+    }
+
+    const r = this.getRoute(route);
+    return await r.isRouteSupported(
+      sourceToken,
+      destToken,
+      amount,
+      sourceChain,
+      destChain,
+    );
+  }
   async isRouteAvailable(
     route: Route,
     sourceToken: string,
@@ -134,7 +155,6 @@ export class Operator {
       destChain,
     );
   }
-
   allSupportedChains(): ChainName[] {
     const supported = new Set<ChainName>();
     for (const key in CHAINS) {

wormhole-connect/src/routes/relay/relay.ts

@@ -59,7 +59,7 @@ export class RelayRoute extends BridgeRoute implements RelayAbstract {
     return !!sdkConfig.chains[chain]?.contracts.relayer;
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,
@@ -70,7 +70,7 @@ export class RelayRoute extends BridgeRoute implements RelayAbstract {
       return false;
     }
 
-    const isBridgeRouteAvailable = await super.isRouteAvailable(
+    const isBridgeRouteAvailable = await super.isRouteSupported(
       sourceToken,
       destToken,
       amount,
@@ -85,10 +85,18 @@ export class RelayRoute extends BridgeRoute implements RelayAbstract {
     }
     const tokenConfig = TOKENS[sourceToken]!;
     const tokenId = getWrappedTokenId(tokenConfig);
-    const accepted = await isAcceptedToken(tokenId);
-
-    if (!accepted) return false;
+    return isAcceptedToken(tokenId);
+  }
 
+  async isRouteAvailable(
+    sourceToken: string,
+    destToken: string,
+    amount: string,
+    sourceChain: ChainName | ChainId,
+    destChain: ChainName | ChainId,
+  ): Promise<boolean> {
+    const tokenConfig = TOKENS[sourceToken]!;
+    const tokenId = getWrappedTokenId(tokenConfig);
     let relayerFee;
     try {
       relayerFee = await this.getRelayerFee(

wormhole-connect/src/routes/tbtc/tbtc.ts

@@ -85,7 +85,7 @@ export class TBTCRoute extends BaseRoute {
     return wh.toChainId(token.nativeChain) === CHAIN_ID_ETH;
   }
 
-  async isRouteAvailable(
+  async isRouteSupported(
     sourceToken: string,
     destToken: string,
     amount: string,