Merge branch 'master' into pxrl/proposerLog

Author: pxrl

src/adapter/bridges/SolanaUsdcCCTPBridge.ts

@@ -24,14 +24,14 @@ import { getCctpTokenMessenger, isCctpV2L2ChainId } from "../../utils/CCTPUtils"
 import { CCTP_NO_DOMAIN } from "@across-protocol/constants";
 import { arch } from "@across-protocol/sdk";
 import { TokenMessengerMinterIdl } from "@across-protocol/contracts";
+import { CCTP_MAX_SEND_AMOUNT } from "../../common";
 
 type MintAndWithdrawData = {
   mintRecipient: string;
   amount: bigint;
 };
 
 export class SolanaUsdcCCTPBridge extends BaseBridgeAdapter {
-  private CCTP_MAX_SEND_AMOUNT = toBN(1_000_000_000_000); // 1MM USDC.
   private IS_CCTP_V2 = false;
   private readonly l1UsdcTokenAddress: EvmAddress;
   private readonly l2UsdcTokenAddress: SvmAddress;
@@ -92,7 +92,7 @@ export class SolanaUsdcCCTPBridge extends BaseBridgeAdapter {
     const signer = await this.l1Signer.getAddress();
     assert(compareAddressesSimple(signer, toAddress.toEvmAddress()), "Cannot rebalance to a non-signer address");
     const associatedTokenAddress = await this._getAssociatedTokenAddress();
-    amount = amount.gt(this.CCTP_MAX_SEND_AMOUNT) ? this.CCTP_MAX_SEND_AMOUNT : amount;
+    amount = amount.gt(CCTP_MAX_SEND_AMOUNT) ? CCTP_MAX_SEND_AMOUNT : amount;
     return Promise.resolve({
       contract: this.getL1Bridge(),
       method: "depositForBurn",

src/adapter/bridges/UsdcCCTPBridge.ts

@@ -7,7 +7,6 @@ import {
   TOKEN_SYMBOLS_MAP,
   compareAddressesSimple,
   assert,
-  toBN,
   getCctpDomainForChainId,
   Address,
   EvmAddress,
@@ -18,9 +17,9 @@ import {
 import { processEvent } from "../utils";
 import { getCctpTokenMessenger, isCctpV2L2ChainId } from "../../utils/CCTPUtils";
 import { CCTP_NO_DOMAIN } from "@across-protocol/constants";
+import { CCTP_MAX_SEND_AMOUNT } from "../../common";
 
 export class UsdcCCTPBridge extends BaseBridgeAdapter {
-  private CCTP_MAX_SEND_AMOUNT = toBN(1_000_000_000_000); // 1MM USDC.
   private IS_CCTP_V2 = false;
   private readonly l1UsdcTokenAddress: EvmAddress;
 
@@ -66,7 +65,7 @@ export class UsdcCCTPBridge extends BaseBridgeAdapter {
     amount: BigNumber
   ): Promise<BridgeTransactionDetails> {
     assert(l1Token.eq(this.l1UsdcTokenAddress));
-    amount = amount.gt(this.CCTP_MAX_SEND_AMOUNT) ? this.CCTP_MAX_SEND_AMOUNT : amount;
+    amount = amount.gt(CCTP_MAX_SEND_AMOUNT) ? CCTP_MAX_SEND_AMOUNT : amount;
     return Promise.resolve({
       contract: this.getL1Bridge(),
       method: "depositForBurn",

src/adapter/l2Bridges/UsdcCCTPBridge.ts

@@ -21,9 +21,9 @@ import {
 } from "../../utils";
 import { BaseL2BridgeAdapter } from "./BaseL2BridgeAdapter";
 import { AugmentedTransaction } from "../../clients/TransactionClient";
+import { CCTP_MAX_SEND_AMOUNT } from "../../common";
 
 export class UsdcCCTPBridge extends BaseL2BridgeAdapter {
-  private CCTP_MAX_SEND_AMOUNT = toBN(1_000_000_000_000); // 1MM USDC.
   private IS_CCTP_V2 = false;
   private readonly l1UsdcTokenAddress: EvmAddress;
   private readonly l2UsdcTokenAddress: EvmAddress;
@@ -63,7 +63,7 @@ export class UsdcCCTPBridge extends BaseL2BridgeAdapter {
     const { decimals } = getTokenInfo(l2Token, this.l2chainId);
     const formatter = createFormatFunction(2, 4, false, decimals);
 
-    amount = amount.gt(this.CCTP_MAX_SEND_AMOUNT) ? this.CCTP_MAX_SEND_AMOUNT : amount;
+    amount = amount.gt(CCTP_MAX_SEND_AMOUNT) ? CCTP_MAX_SEND_AMOUNT : amount;
     return Promise.resolve([
       {
         contract: this.l2Bridge,

src/clients/ProfitClient.ts

@@ -71,13 +71,16 @@ export type FillProfit = {
   outputAmountUsd: BigNumber;
   grossRelayerFeePct: BigNumber; // Max of relayerFeePct and newRelayerFeePct from Deposit.
   grossRelayerFeeUsd: BigNumber; // USD value of the relay fee paid by the user.
+  auxiliaryNativeTokenCost: BigNumber; // Amount of native tokens forwarded to the user in the units of native token.
+  auxiliaryNativeTokenCostUsd: BigNumber; // Same as above, but in USD
   nativeGasCost: BigNumber; // Cost of completing the fill in the units of gas.
   tokenGasCost: BigNumber; // Cost of completing the fill in the relevant gas token.
   gasPrice: BigNumber; // Gas price in wei.
   gasPadding: BigNumber; // Positive padding applied to nativeGasCost and tokenGasCost before profitability.
   gasMultiplier: BigNumber; // Gas multiplier applied to fill cost estimates before profitability.
   gasTokenPriceUsd: BigNumber; // Price paid per unit of gas the gas token in USD.
-  gasCostUsd: BigNumber; // Estimated cost of completing the fill in USD.
+  gasCostUsd: BigNumber; // Estimated gas cost of completing the fill in USD.
+  nativeTokenFillCostUsd: BigNumber; // Estimated native token cost of completing the fill in USD: gas + auxiliary
   netRelayerFeePct: BigNumber; // Relayer fee after gas costs as a portion of relayerCapitalUsd.
   netRelayerFeeUsd: BigNumber; // Relayer fee in USD after paying for gas costs.
   totalFeePct: BigNumber; // Total fee as a portion of the fill amount.
@@ -168,11 +171,11 @@ export class ProfitClient {
     return isMessageEmpty(resolveDepositMessage(deposit)) ? this.gasMultiplier : this.gasMessageMultiplier;
   }
 
-  resolveGasToken(chainId: number): L1Token {
+  resolveNativeToken(chainId: number): L1Token {
     const symbol = getNativeTokenSymbol(chainId);
     const token = TOKEN_SYMBOLS_MAP[symbol];
     if (!isDefined(symbol) || !isDefined(token)) {
-      throw new Error(`Unable to resolve gas token for chain ID ${chainId}`);
+      throw new Error(`Unable to resolve native token for chain ID ${chainId}`);
     }
 
     const { decimals, addresses } = token;
@@ -181,6 +184,11 @@ export class ProfitClient {
     return { symbol, address, decimals };
   }
 
+  resolveGasToken(chainId: number): L1Token {
+    // Note for future: gas token and native token may not always be the same
+    return this.resolveNativeToken(chainId);
+  }
+
   getAllPrices(): { [address: string]: BigNumber } {
     return this.tokenPrices;
   }
@@ -265,6 +273,10 @@ export class ProfitClient {
     }
   }
 
+  getAuxiliaryNativeTokenCost(deposit: Deposit): BigNumber {
+    return this.relayerFeeQueries[deposit.destinationChainId].getAuxiliaryNativeTokenCost(deposit);
+  }
+
   async getTotalGasCost(deposit: Deposit): Promise<TransactionCostEstimate> {
     const { destinationChainId: chainId } = deposit;
 
@@ -289,7 +301,19 @@ export class ProfitClient {
   // Estimate the gas cost of filling this relay.
   async estimateFillCost(
     deposit: Deposit
-  ): Promise<Pick<FillProfit, "nativeGasCost" | "tokenGasCost" | "gasTokenPriceUsd" | "gasCostUsd" | "gasPrice">> {
+  ): Promise<
+    Pick<
+      FillProfit,
+      | "nativeGasCost"
+      | "tokenGasCost"
+      | "gasTokenPriceUsd"
+      | "gasCostUsd"
+      | "gasPrice"
+      | "auxiliaryNativeTokenCost"
+      | "auxiliaryNativeTokenCostUsd"
+      | "nativeTokenFillCostUsd"
+    >
+  > {
     const { destinationChainId: chainId } = deposit;
 
     const gasToken = this.resolveGasToken(chainId);
@@ -321,12 +345,23 @@ export class ProfitClient {
 
     const gasCostUsd = tokenGasCost.mul(gasTokenPriceUsd).div(bn10.pow(gasToken.decimals));
 
+    const auxiliaryNativeTokenCost = this.getAuxiliaryNativeTokenCost(deposit);
+    const nativeToken = this.resolveNativeToken(chainId);
+    const nativeTokenPriceUsd = this.getPriceOfToken(nativeToken.symbol);
+    const auxiliaryNativeTokenCostUsd = auxiliaryNativeTokenCost
+      .mul(nativeTokenPriceUsd)
+      .div(bn10.pow(nativeToken.decimals));
+
+    const nativeTokenFillCostUsd = gasCostUsd.add(auxiliaryNativeTokenCostUsd);
     return {
       nativeGasCost,
       tokenGasCost,
       gasPrice,
       gasTokenPriceUsd,
       gasCostUsd,
+      auxiliaryNativeTokenCost,
+      auxiliaryNativeTokenCostUsd,
+      nativeTokenFillCostUsd,
     };
   }
 
@@ -409,14 +444,23 @@ export class ProfitClient {
       ? grossRelayerFeeUsd.mul(fixedPoint).div(inputAmountUsd)
       : bnZero;
 
-    // Estimate the gas cost of filling this relay.
-    const { nativeGasCost, tokenGasCost, gasTokenPriceUsd, gasCostUsd, gasPrice } = await this.estimateFillCost(
-      deposit
-    );
+    const {
+      // Estimated gas cost of filling this relay
+      nativeGasCost,
+      tokenGasCost,
+      gasTokenPriceUsd,
+      gasCostUsd,
+      gasPrice,
+      // Estimated auxiliary native token cost
+      auxiliaryNativeTokenCost,
+      auxiliaryNativeTokenCostUsd,
+      // Estimated total native token cost in USD
+      nativeTokenFillCostUsd,
+    } = await this.estimateFillCost(deposit);
 
     // Determine profitability. netRelayerFeePct effectively represents the capital cost to the relayer;
     // i.e. how much it pays out to the recipient vs. the net fee that it receives for doing so.
-    const netRelayerFeeUsd = grossRelayerFeeUsd.sub(gasCostUsd);
+    const netRelayerFeeUsd = grossRelayerFeeUsd.sub(nativeTokenFillCostUsd);
     const netRelayerFeePct = outputAmountUsd.gt(bnZero)
       ? netRelayerFeeUsd.mul(fixedPoint).div(outputAmountUsd)
       : bnZero;
@@ -433,13 +477,16 @@ export class ProfitClient {
       outputAmountUsd,
       grossRelayerFeePct,
       grossRelayerFeeUsd,
+      auxiliaryNativeTokenCost,
+      auxiliaryNativeTokenCostUsd,
       nativeGasCost,
       tokenGasCost,
       gasPrice,
       gasPadding: this.gasPadding,
       gasMultiplier: this.resolveGasMultiplier(deposit),
       gasTokenPriceUsd,
       gasCostUsd,
+      nativeTokenFillCostUsd,
       netRelayerFeePct,
       netRelayerFeeUsd,
       profitable,
@@ -493,6 +540,8 @@ export class ProfitClient {
         totalFeePct: `${formatFeePct(fill.totalFeePct)}%`,
         lpFeePct: `${formatFeePct(lpFeePct)}%`,
         grossRelayerFeePct: `${formatFeePct(fill.grossRelayerFeePct)}%`,
+        auxiliaryNativeTokenCost: fill.auxiliaryNativeTokenCost,
+        auxiliaryNativeTokenCostUsd: formatEther(fill.auxiliaryNativeTokenCostUsd),
         nativeGasCost: fill.nativeGasCost,
         tokenGasCost: formatEther(fill.tokenGasCost),
         gasPrice: formatGwei(fill.gasPrice.toString()),
@@ -501,6 +550,7 @@ export class ProfitClient {
         gasTokenPriceUsd: formatEther(fill.gasTokenPriceUsd),
         grossRelayerFeeUsd: formatEther(fill.grossRelayerFeeUsd),
         gasCostUsd: formatEther(fill.gasCostUsd),
+        nativeTokenFillCostUsd: formatEther(fill.nativeTokenFillCostUsd),
         netRelayerFeeUsd: formatEther(fill.netRelayerFeeUsd),
         netRelayerFeePct: `${formatFeePct(fill.netRelayerFeePct)}%`,
         minRelayerFeePct: `${formatFeePct(minRelayerFeePct)}%`,

src/common/Constants.ts

@@ -12,6 +12,7 @@ import {
   toWei,
   BigNumber,
   winston,
+  toBN,
 } from "../utils";
 import {
   BaseBridgeAdapter,
@@ -61,6 +62,9 @@ export const CONFIG_STORE_VERSION = 6;
 
 export const RELAYER_MIN_FEE_PCT = 0.0001;
 
+// The maximum amount of USDC permitted to be sent over CCTP in a single transaction.
+export const CCTP_MAX_SEND_AMOUNT = toBN(1_000_000_000_000); // 1MM USDC.
+
 // max(uint256) - 1
 export const INFINITE_FILL_DEADLINE = bnUint32Max;
 

src/finalizer/utils/cctp/l2ToL1.ts

@@ -19,18 +19,21 @@ import {
   getStatePda,
   toAddressType,
   createFormatFunction,
+  getKitKeypairFromEvmSigner,
+  isSVMSpokePoolClient,
 } from "../../../utils";
 import {
   AttestedCCTPDeposit,
   CCTPMessageStatus,
   getAttestedCCTPDeposits,
   getCctpMessageTransmitter,
 } from "../../../utils/CCTPUtils";
+import { bridgeTokensToHubPool } from "./svm";
 import { FinalizerPromise, CrossChainMessage, AddressesToFinalize } from "../../types";
 
 export async function cctpL2toL1Finalizer(
   logger: winston.Logger,
-  _signer: Signer,
+  signer: Signer,
   hubPoolClient: HubPoolClient,
   spokePoolClient: SpokePoolClient,
   _l1SpokePoolClient: SpokePoolClient,
@@ -48,6 +51,18 @@ export async function cctpL2toL1Finalizer(
     ? await augmentSendersListForSolana(senderAddresses, spokePoolClient)
     : senderAddresses;
 
+  // Solana has a two step withdrawal process, where the funds in the spoke pool's transfer liability PDA must be manually withdrawn after
+  // a refund leaf has been executed.
+  if (finalizingFromSolana) {
+    assert(isSVMSpokePoolClient(spokePoolClient));
+    const svmSigner = await getKitKeypairFromEvmSigner(signer);
+    const bridgeTokens = await bridgeTokensToHubPool(spokePoolClient, svmSigner, logger, hubPoolClient.chainId);
+    logger[isDefined(bridgeTokens.signature) ? "info" : "debug"]({
+      at: `Finalizer#CCTPL2ToL1Finalizer:${spokePoolClient.chainId}`,
+      message: bridgeTokens.message,
+      signature: bridgeTokens.signature,
+    });
+  }
   const outstandingDeposits = await getAttestedCCTPDeposits(
     augmentedSenderAddresses,
     spokePoolClient.chainId,

src/finalizer/utils/cctp/svm/index.ts

@@ -1 +1,2 @@
 export * from "./l1Tol2";
+export * from "./l2Tol1";