@continuumdao/ctm-mpc-defi 0.2.55 → 0.2.56

package/dist/protocols/evm/circle-cctp/index.js

@@ -226,6 +226,12 @@ function cctpSupportedRoutes(network) {
 }
 
 // src/protocols/evm/circle-cctp/fees.ts
+function cctpProtocolFeeBaseUnits(transferAmount, minimumFeeBps) {
+  if (transferAmount <= 0n || !Number.isFinite(minimumFeeBps) || minimumFeeBps <= 0) return 0n;
+  const scaledBps = BigInt(Math.round(minimumFeeBps * 100));
+  if (scaledBps <= 0n) return 0n;
+  return transferAmount * scaledBps / 1000000n;
+}
 function pickForwardFeeTier(row, tier) {
   const forwardFee = row.forwardFee;
   if (forwardFee && typeof forwardFee === "object") {
@@ -234,11 +240,25 @@ function pickForwardFeeTier(row, tier) {
     if (v != null) return BigInt(String(v));
   }
   const maxFee = row.maximumFee ?? row.maxFee ?? row.forwardFee;
-  if (maxFee != null) return BigInt(String(maxFee));
+  if (maxFee != null && typeof maxFee !== "object") return BigInt(String(maxFee));
   throw new Error("Iris fee response missing forwardFee tiers.");
 }
+function feeRows(json) {
+  if (Array.isArray(json)) return json.filter((row) => row && typeof row === "object");
+  if (json && typeof json === "object") {
+    const data = json.data;
+    if (Array.isArray(data)) return data.filter((row) => row && typeof row === "object");
+    return [json];
+  }
+  return [];
+}
+function selectCctpIrisFeeRow(rows, finalityThreshold) {
+  const match = rows.find((row) => Number(row.finalityThreshold) === finalityThreshold);
+  return match ?? rows[0] ?? {};
+}
 async function fetchCctpBurnFees(args) {
   const tier = args.feeTier ?? "med";
+  const finalityThreshold = args.minFinalityThreshold ?? CCTP_DEFAULT_MIN_FINALITY_THRESHOLD;
   const base = irisApiBaseForChainId(args.sourceChainId);
   const url = `${base}/v2/burn/USDC/fees/${args.sourceDomain}/${args.destDomain}?forward=true`;
   const res = await fetch(url, { headers: { Accept: "application/json" } });
@@ -246,20 +266,28 @@ async function fetchCctpBurnFees(args) {
     const text = await res.text().catch(() => "");
     throw new Error(`Iris fee quote failed (${res.status}): ${text.slice(0, 200)}`);
   }
-  const json = await res.json();
-  const rows = Array.isArray(json) ? json : Array.isArray(json.data) ? json.data : [json];
-  const row = rows[0] ?? {};
+  const row = selectCctpIrisFeeRow(feeRows(await res.json()), finalityThreshold);
   const low = pickForwardFeeTier(row, "low");
   const med = pickForwardFeeTier(row, "med");
   const high = pickForwardFeeTier(row, "high");
-  const maxFee = tier === "low" ? low : tier === "high" ? high : med;
+  const minimumFeeRaw = row.minimumFee;
+  const minimumFeeBps = typeof minimumFeeRaw === "number" ? minimumFeeRaw : Number(minimumFeeRaw ?? 0);
+  const transferAmount = args.transferAmount ?? 0n;
+  const protocolFee = cctpProtocolFeeBaseUnits(transferAmount, minimumFeeBps);
+  const forwardForTier = tier === "low" ? low : tier === "high" ? high : med;
   return {
     sourceDomain: args.sourceDomain,
     destDomain: args.destDomain,
-    maxFee,
+    finalityThreshold: Number(row.finalityThreshold ?? finalityThreshold),
+    minimumFeeBps: Number.isFinite(minimumFeeBps) ? minimumFeeBps : 0,
+    protocolFee,
+    maxFee: forwardForTier + protocolFee,
     forwardFeeLow: low,
     forwardFeeMed: med,
     forwardFeeHigh: high,
+    maxFeeLow: low + protocolFee,
+    maxFeeMed: med + protocolFee,
+    maxFeeHigh: high + protocolFee,
     feeTierUsed: tier
   };
 }
@@ -623,6 +651,8 @@ async function buildEvmMultisignBodyCctpBurnBatch(args) {
   const executor = getAddress(args.executorAddress);
   const mintRecipient = getAddress(args.mintRecipient ?? executor);
   const minFinality = args.minFinalityThreshold ?? CCTP_DEFAULT_MIN_FINALITY_THRESHOLD;
+  const transferAmountForFee = parseUnits(args.transferAmountHuman.trim(), CCTP_USDC_DECIMALS);
+  if (transferAmountForFee <= 0n) throw new Error("Transfer amount must be greater than zero.");
   let maxFee = args.maxFee;
   let proposalMaxFee = args.proposalMaxFee ?? maxFee;
   if (maxFee == null) {
@@ -630,7 +660,9 @@ async function buildEvmMultisignBodyCctpBurnBatch(args) {
       sourceChainId: args.sourceChainId,
       sourceDomain: src.domain,
       destDomain: dst.domain,
-      feeTier: args.feeTier
+      feeTier: args.feeTier,
+      transferAmount: transferAmountForFee,
+      minFinalityThreshold: minFinality
     });
     maxFee = fees.maxFee;
     proposalMaxFee = fees.maxFee;
@@ -720,11 +752,22 @@ async function buildEvmMultisignBodyCctpBurnBatch(args) {
   return result;
 }
 async function buildEvmMultisignBodyCctpBurnBatchFromMcp(args) {
-  let maxFee;
-  let proposalMaxFee;
+  const src = cctpChainConfig(args.chainId);
+  const dst = cctpChainConfig(args.destChainId);
+  if (!src || !dst) throw new Error("Unsupported CCTP source or destination chain.");
+  const transferAmount = parseUnits(args.transferAmountHuman.trim(), CCTP_USDC_DECIMALS);
+  const fees = await fetchCctpBurnFees({
+    sourceChainId: args.chainId,
+    sourceDomain: src.domain,
+    destDomain: dst.domain,
+    feeTier: args.feeTier,
+    transferAmount,
+    minFinalityThreshold: args.minFinalityThreshold
+  });
+  let maxFee = fees.maxFee;
   if (args.feeSnapshot?.maxFee != null) {
-    maxFee = BigInt(String(args.feeSnapshot.maxFee));
-    proposalMaxFee = maxFee;
+    const snapshotMaxFee = BigInt(String(args.feeSnapshot.maxFee));
+    if (snapshotMaxFee > maxFee) maxFee = snapshotMaxFee;
   }
   return buildEvmMultisignBodyCctpBurnBatch({
     keyGen: args.keyGen,
@@ -739,7 +782,7 @@ async function buildEvmMultisignBodyCctpBurnBatchFromMcp(args) {
     executorAddress: args.executorAddress,
     purposeText: args.purposeText,
     maxFee,
-    proposalMaxFee,
+    proposalMaxFee: maxFee,
     feeTier: args.feeTier,
     minFinalityThreshold: args.minFinalityThreshold
   });
@@ -853,14 +896,15 @@ function buildCctpMcpFeeFields(args) {
   const forwardFeeLowHuman = formatCctpUsdcHuman(fees.forwardFeeLow);
   const forwardFeeMedHuman = formatCctpUsdcHuman(fees.forwardFeeMed);
   const forwardFeeHighHuman = formatCctpUsdcHuman(fees.forwardFeeHigh);
+  const protocolFeeHuman = formatCctpUsdcHuman(fees.protocolFee);
   let totalBurn;
   let totalBurnHuman;
-  if (transferAmount != null) {
+  if (transferAmount != null && transferAmount > 0n) {
     totalBurn = transferAmount + fees.maxFee;
     totalBurnHuman = formatCctpUsdcHuman(totalBurn);
   }
-  const recipientPart = transferAmountHuman != null ? ` Recipient receives ${transferAmountHuman} USDC; wallet burns ${totalBurnHuman} USDC total (transfer + max fee).` : "";
-  const feeSummary = `Forwarding Service max fee (${fees.feeTierUsed} tier): ${maxFeeHuman} USDC.${recipientPart} Fee tiers \u2014 low: ${forwardFeeLowHuman}, med: ${forwardFeeMedHuman}, high: ${forwardFeeHighHuman} USDC. Fees refresh again at Get Sig.`;
+  const recipientPart = transferAmountHuman != null && totalBurnHuman != null ? ` Recipient receives ${transferAmountHuman} USDC; wallet burns ${totalBurnHuman} USDC total (transfer + max fee).` : " Pass transferAmountHuman so maxFee includes the fast-transfer protocol fee.";
+  const feeSummary = `CCTP max fee (${fees.feeTierUsed} tier): ${maxFeeHuman} USDC = forwarding ${formatCctpUsdcHuman(fees.feeTierUsed === "low" ? fees.forwardFeeLow : fees.feeTierUsed === "high" ? fees.forwardFeeHigh : fees.forwardFeeMed)} + protocol ${protocolFeeHuman} (${fees.minimumFeeBps} bps, finality ${fees.finalityThreshold}).${recipientPart} Combined tiers \u2014 low: ${formatCctpUsdcHuman(fees.maxFeeLow)}, med: ${formatCctpUsdcHuman(fees.maxFeeMed)}, high: ${formatCctpUsdcHuman(fees.maxFeeHigh)} USDC. Fees refresh again at Get Sig.`;
   return {
     feeTierUsed: fees.feeTierUsed,
     maxFee: fees.maxFee.toString(),
@@ -871,6 +915,16 @@ function buildCctpMcpFeeFields(args) {
     forwardFeeMedHuman,
     forwardFeeHigh: fees.forwardFeeHigh.toString(),
     forwardFeeHighHuman,
+    maxFeeLow: fees.maxFeeLow.toString(),
+    maxFeeLowHuman: formatCctpUsdcHuman(fees.maxFeeLow),
+    maxFeeMed: fees.maxFeeMed.toString(),
+    maxFeeMedHuman: formatCctpUsdcHuman(fees.maxFeeMed),
+    maxFeeHigh: fees.maxFeeHigh.toString(),
+    maxFeeHighHuman: formatCctpUsdcHuman(fees.maxFeeHigh),
+    minimumFeeBps: fees.minimumFeeBps,
+    protocolFee: fees.protocolFee.toString(),
+    protocolFeeHuman,
+    finalityThreshold: fees.finalityThreshold,
     ...transferAmount != null ? { transferAmount: transferAmount.toString() } : {},
     ...transferAmountHuman != null ? { transferAmountHuman } : {},
     ...totalBurn != null ? { totalBurn: totalBurn.toString() } : {},
@@ -968,14 +1022,16 @@ async function cctpFetchBurnFeesForRoute(args) {
   if (!src || !dst) throw new Error("Unsupported source or destination chain for CCTP.");
   if (src.network !== dst.network) throw new Error("Source and destination must be on the same network (mainnet or testnet).");
   if (src.chainId === dst.chainId) throw new Error("Source and destination must differ.");
+  const transferHuman = args.transferAmountHuman?.trim();
+  const transferAmount = transferHuman ? parseUnits(transferHuman, CCTP_USDC_DECIMALS) : void 0;
   const fees = await fetchCctpBurnFees({
     sourceChainId: args.sourceChainId,
     sourceDomain: src.domain,
     destDomain: dst.domain,
-    feeTier: args.feeTier
+    feeTier: args.feeTier,
+    transferAmount,
+    minFinalityThreshold: args.minFinalityThreshold
   });
-  const transferHuman = args.transferAmountHuman?.trim();
-  const transferAmount = transferHuman ? parseUnits(transferHuman, CCTP_USDC_DECIMALS) : void 0;
   const feeFields = buildCctpMcpFeeFields({
     fees,
     transferAmount,
@@ -1020,7 +1076,7 @@ var circleCctpProtocolModule = {
       id: "circle-cctp.fetch-fees",
       protocolId: CIRCLE_CCTP_PROTOCOL_ID,
       chainCategory: "evm",
-      description: "Quote Iris Forwarding Service burn fees for a route",
+      description: "Quote Iris forwarding fee plus fast-transfer protocol fee for a route",
       commonParams: [],
       params: {
         sourceChainId: { type: "number", required: true, description: "Source EIP-155 chain id" },
@@ -1045,6 +1101,6 @@ var circleCctpProtocolModule = {
 };
 registerProtocolModule(circleCctpProtocolModule);
 
-export { CCTP_DEFAULT_MIN_FINALITY_THRESHOLD, CCTP_DEPOSIT_FOR_BURN_FALLBACK_GAS, CCTP_ERC20_APPROVE_FALLBACK_GAS, CCTP_EVM_CHAINS, CCTP_USDC_DECIMALS, CIRCLE_CCTP_PROTOCOL_ID, FORWARDING_SERVICE_HOOK_DATA, IRIS_API_MAINNET, IRIS_API_SANDBOX, TOKEN_MESSENGER_V2_MAINNET, TOKEN_MESSENGER_V2_TESTNET, buildCctpBurnExtraJSON, buildCctpBurnSteps, buildEvmMultisignBodyCctpBurnBatch, buildEvmMultisignBodyCctpBurnBatchFromMcp, cctpAssertBurnPreconditions, cctpCanonicalUsdcAddress, cctpChainConfig, cctpFeeSummaryFromBodyForSign, cctpFetchBurnFeesForRoute, cctpFetchSupportedRoutes, cctpFetchTransferStatus, cctpFetchUsdcBalance, cctpMintRecipientAddressFromExtra, cctpSupportedRoutes, chainIdToDomain, circleCctpProtocolModule, domainToChainId, fetchCctpBurnFees, formatCctpUsdcHuman, irisApiBaseForChainId, isCctpBurnEvmSignRequest, isCctpCanonicalUsdcRow, isCctpErc20ApproveEvmSignRequest, isCctpRouteSupported, isCctpSourceChainSupported, parseCctpBurnExtraJSON, parseCctpEvmChainId, rebuildCctpBurnCalldataAtGetSig, resolveCctpBatchStepGasFromSignRequest };
+export { CCTP_DEFAULT_MIN_FINALITY_THRESHOLD, CCTP_DEPOSIT_FOR_BURN_FALLBACK_GAS, CCTP_ERC20_APPROVE_FALLBACK_GAS, CCTP_EVM_CHAINS, CCTP_USDC_DECIMALS, CIRCLE_CCTP_PROTOCOL_ID, FORWARDING_SERVICE_HOOK_DATA, IRIS_API_MAINNET, IRIS_API_SANDBOX, TOKEN_MESSENGER_V2_MAINNET, TOKEN_MESSENGER_V2_TESTNET, buildCctpBurnExtraJSON, buildCctpBurnSteps, buildEvmMultisignBodyCctpBurnBatch, buildEvmMultisignBodyCctpBurnBatchFromMcp, cctpAssertBurnPreconditions, cctpCanonicalUsdcAddress, cctpChainConfig, cctpFeeSummaryFromBodyForSign, cctpFetchBurnFeesForRoute, cctpFetchSupportedRoutes, cctpFetchTransferStatus, cctpFetchUsdcBalance, cctpMintRecipientAddressFromExtra, cctpProtocolFeeBaseUnits, cctpSupportedRoutes, chainIdToDomain, circleCctpProtocolModule, domainToChainId, fetchCctpBurnFees, formatCctpUsdcHuman, irisApiBaseForChainId, isCctpBurnEvmSignRequest, isCctpCanonicalUsdcRow, isCctpErc20ApproveEvmSignRequest, isCctpRouteSupported, isCctpSourceChainSupported, parseCctpBurnExtraJSON, parseCctpEvmChainId, rebuildCctpBurnCalldataAtGetSig, resolveCctpBatchStepGasFromSignRequest, selectCctpIrisFeeRow };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map