@across-protocol/sdk 4.3.104 → 4.3.106-beta.0

package/src/relayFeeCalculator/chain-queries/svmQuery.ts

@@ -4,13 +4,27 @@ import {
   TransactionSigner,
   fetchEncodedAccount,
   isSome,
+  Rpc,
+  pipe,
+  appendTransactionMessageInstruction,
 } from "@solana/kit";
-import { SVMProvider, SolanaVoidSigner, getFillRelayTx, toAddress, getAssociatedTokenAddress } from "../../arch/svm";
+import {
+  SVMProvider,
+  SolanaVoidSigner,
+  getFillRelayTx,
+  getIPFillRelayTx,
+  getFillRelayViaInstructionParamsInstructions,
+  toAddress,
+  createDefaultTransaction,
+  getAssociatedTokenAddress,
+  isSVMFillTooLarge,
+} from "../../arch/svm";
+import { JitoInterface } from "../../providers/solana";
 import { Coingecko } from "../../coingecko";
 import { CHAIN_IDs } from "../../constants";
 import { getGasPriceEstimate } from "../../gasPriceOracle";
 import { RelayData } from "../../interfaces";
-import { Address, BigNumber, BigNumberish, SvmAddress, TransactionCostEstimate, toBN } from "../../utils";
+import { Address, BigNumber, BigNumberish, SvmAddress, TransactionCostEstimate, toBN, mapAsync } from "../../utils";
 import { Logger, QueryInterface, getDefaultRelayer } from "../relayFeeCalculator";
 import { SymbolMappingType } from "./";
 import { TOKEN_PROGRAM_ADDRESS } from "@solana-program/token";
@@ -77,15 +91,35 @@ export class SvmQuery implements QueryInterface {
     assert(relayer.isSVM());
 
     const [repaymentChainId, repaymentAddress] = [destinationChainId, relayer]; // These are not important for gas cost simulation.
-    const fillRelayTx = await this.getFillRelayTx(
+
+    // For solana, we algorithmically estimate gas based on the size of the message.
+    const _fillRelayTx = await this.getFillRelayTx(
       { ...relayData, recipient, outputToken, exclusiveRelayer },
       SolanaVoidSigner(relayer.toBase58()),
       repaymentChainId,
       repaymentAddress
     );
 
-    const [computeUnitsConsumed, gasPriceEstimate, tokenAccountInfo] = await Promise.all([
-      toBN(await this.computeUnitEstimator(fillRelayTx)),
+    const fillTooLarge = isSVMFillTooLarge(_fillRelayTx);
+    // If the fill is too large, we need to construct a dummy fill relay transaction which estimates the priority fee of the fillRelay instruction call. To guarantee
+    // that the transaction won't be too large, we overwrite the message with empty bytes.
+    const fillRelayTx = fillTooLarge.tooLarge
+      ? await this.getFillRelayTx(
+          { ...relayData, recipient, outputToken, exclusiveRelayer, message: "0x" },
+          SolanaVoidSigner(relayer.toBase58()),
+          repaymentChainId,
+          repaymentAddress
+        )
+      : _fillRelayTx;
+    const [_computeUnitsConsumed, gasPriceEstimate, tokenAccountInfo] = await Promise.all([
+      fillTooLarge.tooLarge
+        ? this.estimateComputeUnits(
+            { ...relayData, recipient, outputToken, exclusiveRelayer },
+            relayer,
+            repaymentChainId,
+            repaymentAddress
+          )
+        : this.computeUnitEstimator(fillRelayTx),
       getGasPriceEstimate(this.provider, {
         unsignedTx: fillRelayTx,
         baseFeeMultiplier: options.baseFeeMultiplier,
@@ -93,6 +127,7 @@ export class SvmQuery implements QueryInterface {
       }),
       this.provider.getAccountInfo(toAddress(outputToken), { encoding: "base58" }).send(),
     ]);
+    const computeUnitsConsumed = toBN(_computeUnitsConsumed);
 
     // If the owner of the token account is not the token program, then we can assume that it is the 2022 token program address, in which
     // case we need to determine the extensions the token has to properly calculate rent exemption.
@@ -211,4 +246,44 @@ export class SvmQuery implements QueryInterface {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }
+
+  // The fill is too large; we need to simulate the transaction in a bundle.
+  async estimateComputeUnits(
+    relayData: RelayData & {
+      destinationChainId: number;
+      recipient: SvmAddress;
+      outputToken: SvmAddress;
+      exclusiveRelayer: SvmAddress;
+    },
+    relayer: SvmAddress,
+    repaymentChainId: number,
+    repaymentAddress: SvmAddress
+  ): Promise<number> {
+    // @dev There is no way to tell if the RPC supports the JITO interface without querying the rpc directly.
+    // Cast the rpc type to support JITO and attempt to call `simulateBundle`. Throw and error if it fails, since
+    // the transaction message cannot be simulated otherwise.
+    const provider = this.provider as Rpc<JitoInterface>;
+
+    const spokePoolAddr = toAddress(this.spokePool);
+    const voidSigner = SolanaVoidSigner(relayer.toBase58());
+
+    const [instructionParamsIxs, fillRelayTx] = await Promise.all([
+      getFillRelayViaInstructionParamsInstructions(
+        spokePoolAddr,
+        relayData,
+        repaymentChainId,
+        repaymentAddress,
+        voidSigner
+      ),
+      getIPFillRelayTx(this.spokePool, provider, relayData, voidSigner, repaymentChainId, repaymentAddress),
+    ]);
+    const instructionParamsTxs = await mapAsync(instructionParamsIxs, async (ix) => {
+      return pipe(await createDefaultTransaction(provider, voidSigner), (tx) =>
+        appendTransactionMessageInstruction(ix, tx)
+      );
+    });
+
+    const simulateBundleResponse = await provider.simulateBundle([...instructionParamsTxs, fillRelayTx]).send();
+    return simulateBundleResponse.result.unitsConsumed;
+  }
 }