connect: Added eta to quote interface

The eta tells us the estimated transfer time in milliseconds
(essentially finality time).

Author: kev1n-peters

connect/src/protocols/cctp/cctpTransfer.ts

@@ -37,6 +37,7 @@ import type {
 import { TransferState, isAttested, isSourceFinalized, isSourceInitiated } from "../../types.js";
 import { Wormhole } from "../../wormhole.js";
 import type { WormholeTransfer } from "../wormholeTransfer.js";
+import { finality } from "@wormhole-foundation/sdk-base";
 
 export class CircleTransfer<N extends Network = Network>
   implements WormholeTransfer<CircleTransfer.Protocol>
@@ -225,10 +226,10 @@ export class CircleTransfer<N extends Network = Network>
     try {
       msgIds = await fromChain.parseTransaction(txid);
     } catch (e: any) {
-      if (e.message.includes('no bridge messages found')) {
+      if (e.message.includes("no bridge messages found")) {
         // This means it's a Circle attestation; swallow
       } else {
-        throw e
+        throw e;
       }
     }
 
@@ -584,10 +585,14 @@ export namespace CircleTransfer {
     const dstToken = Wormhole.chainAddress(dstChain.chain, dstUsdcAddress);
     const srcToken = Wormhole.chainAddress(srcChain.chain, srcUsdcAddress);
 
+    // https://developers.circle.com/stablecoins/docs/required-block-confirmations
+    const eta =
+      srcChain.chain === "Polygon" ? 2_000 * 200 : finality.estimateFinalityTime(srcChain.chain);
     if (!transfer.automatic) {
       return {
         sourceToken: { token: srcToken, amount: transfer.amount },
         destinationToken: { token: dstToken, amount: transfer.amount },
+        eta,
       };
     }
 
@@ -619,6 +624,7 @@ export namespace CircleTransfer {
       destinationToken: { token: dstToken, amount: dstAmount },
       relayFee: { token: srcToken, amount: fee },
       destinationNativeGas,
+      eta,
     };
   }
 

connect/src/protocols/tokenBridge/tokenTransfer.ts

@@ -1,5 +1,5 @@
 import type { Chain, Network } from "@wormhole-foundation/sdk-base";
-import { amount, encoding, toChain as toChainName } from "@wormhole-foundation/sdk-base";
+import { amount, encoding, finality, toChain as toChainName } from "@wormhole-foundation/sdk-base";
 import type {
   AttestationId,
   AutomaticTokenBridge,
@@ -701,11 +701,13 @@ export namespace TokenTransfer {
     const dstDecimals = await dstChain.getDecimals(dstToken.address);
     const dstAmountReceivable = amount.scale(srcAmountTruncated, dstDecimals);
 
+    const eta = finality.estimateFinalityTime(srcChain.chain);
     if (!transfer.automatic) {
       return {
         sourceToken: { token: srcToken, amount: amount.units(srcAmountTruncated) },
         destinationToken: { token: dstToken, amount: amount.units(dstAmountReceivable) },
         warnings: warnings.length > 0 ? warnings : undefined,
+        eta,
       };
     }
 
@@ -796,6 +798,7 @@ export namespace TokenTransfer {
       relayFee: { token: srcToken, amount: fee },
       destinationNativeGas,
       warnings: warnings.length > 0 ? warnings : undefined,
+      eta,
     };
   }
 

connect/src/routes/portico/automatic.ts

@@ -36,6 +36,7 @@ import {
 } from "./../../index.js";
 import type { ChainAddress } from "@wormhole-foundation/sdk-definitions";
 import type { RouteTransferRequest } from "../request.js";
+import { finality } from "@wormhole-foundation/sdk-base";
 
 export const SLIPPAGE_BPS = 15n; // 0.15%
 export const BPS_PER_HUNDRED_PERCENT = 10000n;
@@ -255,6 +256,7 @@ export class AutomaticPorticoRoute<N extends Network>
             token: params.normalizedParams.destinationToken,
             amount: fee,
           },
+          eta: finality.estimateFinalityTime(request.fromChain.chain),
         },
         params,
         details,

connect/src/routes/request.ts

@@ -68,6 +68,8 @@ export class RouteTransferRequest<N extends Network> {
       dq.warnings = [...quote.warnings];
     }
 
+    dq.eta = quote.eta;
+
     if (details) {
       dq.details = details;
     }

connect/src/routes/types.ts

@@ -75,6 +75,9 @@ export type Quote<
   // If the transfer being quoted has any warnings
   // such as high slippage or a delay, they will be included here
   warnings?: QuoteWarning[];
+
+  // Estimated time to completion in milliseconds
+  eta?: number;
 };
 
 export type QuoteError = {

connect/src/types.ts

@@ -193,4 +193,6 @@ export interface TransferQuote {
   // If the transfer being quoted has any warnings
   // such as high slippage or a delay, they will be included here
   warnings?: QuoteWarning[];
+  // Estimated time to completion in milliseconds
+  eta?: number;
 }

core/base/src/constants/finality.ts

@@ -176,3 +176,18 @@ export function consistencyLevelToBlock(
       throw new Error("Only Ethereum safe is supported for now");
   }
 }
+
+/**
+ * Estimates the time required for a transaction to be considered "final"
+ * @param chain The chain to estimate finality time for
+ * @returns The estimated time in milliseconds
+ */
+export function estimateFinalityTime(chain: Chain): number {
+  const finality = finalityThreshold.get(chain);
+  if (finality === undefined) throw new Error("Cannot find finality for " + chain);
+
+  const time = blockTime.get(chain);
+  if (time === undefined) throw new Error("Cannot find block time for " + chain);
+
+  return finality * time;
+}