fix: cleanup

Author: priyajeet

src/routes/operator.ts

@@ -254,14 +254,7 @@ export default class RouteOperator {
 
     let quoteMetadata = this.quoteMetadataCache.get(routeName, quoteParams);
 
-    const isRefetchRequired =
-      !quoteMetadata?.quote ||
-      !quoteMetadata?.request ||
-      !quoteMetadata?.router;
-
-    if (isRefetchRequired) {
-      // Refetch the quote as cached quote does not exist
-      // This case should be hit rarely
+    if (!quoteMetadata) {
       quoteMetadata = await route.getQuote(
         amount,
         sourceToken,
@@ -273,12 +266,7 @@ export default class RouteOperator {
       );
     }
 
-    return route.send(
-      quoteMetadata as QuoteMetadata,
-      signer,
-      destChain,
-      recipientAddress,
-    );
+    return route.send(quoteMetadata, signer, destChain, recipientAddress);
   }
 }
 
@@ -308,7 +296,7 @@ class QuoteMetadataCache {
     )}:${params.nativeGas}:${params.recipient}`;
   }
 
-  get(routeName: string, params: QuoteParams): Partial<QuoteMetadata> | null {
+  get(routeName: string, params: QuoteParams): QuoteMetadata | null {
     const key = this.quoteParamsKey(routeName, params);
     const quoteMetadata = this.cache[key];
     const hasQuoteExpired = quoteMetadata?.ttl() <= 5_000;
@@ -321,7 +309,7 @@ class QuoteMetadataCache {
     return {
       quote: quoteMetadata.quote,
       request: quoteMetadata.request,
-      router: quoteMetadata.router,
+      routeInstance: quoteMetadata.routeInstance,
     };
   }
 
@@ -343,7 +331,7 @@ class QuoteMetadataCache {
 
     // We don't yet have a pending request for this key, so initiate one
     route
-      .computeQuote(
+      .getQuote(
         params.amount,
         params.sourceToken,
         params.destToken,
@@ -352,7 +340,7 @@ class QuoteMetadataCache {
         { nativeGas: params.nativeGas },
         params.recipient,
       )
-      .then(({ router, quote, request }: Required<QuoteMetadata>) => {
+      .then(({ routeInstance, quote, request }: QuoteMetadata) => {
         const pending = this.pending[key];
 
         for (const { resolve } of pending) {
@@ -365,7 +353,7 @@ class QuoteMetadataCache {
           quote.expires = getQuoteExpiry(quote.expires);
         }
 
-        this.cache[key] = new QuoteMetadataEntry(quote, router, request);
+        this.cache[key] = new QuoteMetadataEntry(quote, routeInstance, request);
       })
       .catch((err: any) => {
         const pending = this.pending[key];
@@ -377,10 +365,14 @@ class QuoteMetadataCache {
         delete this.pending[key];
 
         // Cache uncaught error
-        this.cache[key] = new QuoteMetadataEntry({
-          success: false,
-          error: err,
-        });
+        this.cache[key] = new QuoteMetadataEntry(
+          {
+            success: false,
+            error: err,
+          },
+          {} as routes.Route<Network>,
+          {} as routes.RouteTransferRequest<Network>,
+        );
       });
 
     return new Promise((resolve, reject) => {
@@ -418,17 +410,17 @@ class QuoteMetadataEntry {
   // Last time we fetched a quote
   timestamp: Date;
   // Optional route used for the quote
-  router?: routes.Route<Network>;
+  routeInstance: routes.Route<Network>;
   // Optional request used for the quote
-  request?: routes.RouteTransferRequest<Network>;
+  request: routes.RouteTransferRequest<Network>;
 
   constructor(
     quote: QuoteResult,
-    router?: routes.Route<Network>,
-    request?: routes.RouteTransferRequest<Network>,
+    routeInstance: routes.Route<Network>,
+    request: routes.RouteTransferRequest<Network>,
   ) {
     this.quote = quote;
-    this.router = router;
+    this.routeInstance = routeInstance;
     this.request = request;
     this.timestamp = new Date();
   }

src/routes/sdkv2/route.ts

@@ -180,6 +180,10 @@ export default class SDKv2Route {
     options?: routes.AutomaticTokenBridgeRoute.Options,
     recipient?: string,
   ): Promise<QuoteMetadata> {
+    if (!sourceChain || !destChain || !sourceToken || !destToken) {
+      throw new Error('Malformed quote request');
+    }
+
     const request = await this.createRequest(
       sourceToken,
       destToken,
@@ -188,9 +192,9 @@ export default class SDKv2Route {
       recipient,
     );
 
-    const router = await this.createRouter();
+    const routeInstance = await this.createRouteInstance();
 
-    const validationResult = await router.validate(request, {
+    const validationResult = await routeInstance.validate(request, {
       amount: sdkAmount.display(amount),
       options,
     });
@@ -199,16 +203,16 @@ export default class SDKv2Route {
       throw validationResult.error;
     }
 
-    const quote = await router.quote(request, validationResult.params);
+    const quote = await routeInstance.quote(request, validationResult.params);
 
-    return { router, quote, request };
+    return { routeInstance, quote, request };
   }
 
-  async createRouter() {
+  async createRouteInstance() {
     const wh = await getWormholeContextV2();
-    const router = new this.rc(wh);
+    const routeInstance = new this.rc(wh);
 
-    return router;
+    return routeInstance;
   }
 
   async createRequest(
@@ -239,49 +243,19 @@ export default class SDKv2Route {
     return req;
   }
 
-  async computeQuote(
-    amountIn: Amount,
-    sourceToken: Token,
-    destToken: Token,
-    fromChain: Chain,
-    toChain: Chain,
-    options?: routes.AutomaticTokenBridgeRoute.Options,
-    recipient?: string,
-  ): Promise<QuoteMetadata> {
-    if (!fromChain || !toChain) {
-      throw new Error('Need both chains to get a quote from SDKv2');
-    }
-
-    const { router, quote, request } = await this.getQuote(
-      amountIn,
-      sourceToken,
-      destToken,
-      fromChain,
-      toChain,
-      options,
-      recipient,
-    );
-
-    if (!quote.success) {
-      throw quote.error;
-    }
-
-    return { router, quote, request };
-  }
-
   async send(
     quoteMetadata: QuoteMetadata,
     signer: Signer,
     toChain: Chain,
     recipientAddress: string,
   ): Promise<[routes.Route<Network>, routes.Receipt]> {
-    const { quote, router, request } = quoteMetadata;
+    const { quote, routeInstance, request } = quoteMetadata;
 
     if (!quote.success) {
       throw quote.error;
     }
 
-    let receipt = await router.initiate(
+    let receipt = await routeInstance.initiate(
       request,
       signer,
       quote,
@@ -294,7 +268,7 @@ export default class SDKv2Route {
       receipt.state === TransferState.SourceInitiated ||
       receipt.state === TransferState.SourceFinalized
     ) {
-      return [router, receipt];
+      return [routeInstance, receipt];
     }
 
     // Otherwise track the transfer until it reaches a final state,
@@ -305,9 +279,9 @@ export default class SDKv2Route {
 
     while (retries < maxRetries) {
       try {
-        for await (receipt of router.track(receipt, 120 * 1000)) {
+        for await (receipt of routeInstance.track(receipt, 120 * 1000)) {
           if (receipt.state >= TransferState.SourceInitiated) {
-            return [router, receipt];
+            return [routeInstance, receipt];
           }
         }
       } catch (e) {

src/routes/types.ts

@@ -1,7 +1,7 @@
 import type { routes, Network } from '@wormhole-foundation/sdk';
 
 export type QuoteMetadata = {
-  router: routes.Route<Network>;
   quote: routes.QuoteResult<routes.Options>;
   request: routes.RouteTransferRequest<Network>;
+  routeInstance: routes.Route<Network>;
 };