@across-protocol/sdk 4.3.136 → 4.3.137-alpha.1

package/src/gasPriceOracle/types.ts

@@ -2,7 +2,7 @@ import { type Chain, type Transport, PublicClient, FeeValuesEIP1559 } from "viem
 import { BigNumber, bnZero, isDefined } from "../utils";
 
 export type InternalGasPriceEstimate = FeeValuesEIP1559;
-export type GasPriceEstimate = EvmGasPriceEstimate | SvmGasPriceEstimate;
+export type GasPriceEstimate = EvmGasPriceEstimate | SvmGasPriceEstimate | TvmGasPriceEstimate;
 
 export type EvmGasPriceEstimate = {
   maxFeePerGas: BigNumber;
@@ -14,6 +14,11 @@ export type SvmGasPriceEstimate = {
   microLamportsPerComputeUnit: BigNumber;
 };
 
+export type TvmGasPriceEstimate = {
+  energyPrice: BigNumber;
+  bandwidthPrice: BigNumber;
+};
+
 export interface GasPriceFeed {
   (provider: PublicClient<Transport, Chain>, chainId: number): Promise<InternalGasPriceEstimate>;
 }
@@ -35,3 +40,8 @@ export function isSVMGasPrice(gasPrice: GasPriceEstimate): gasPrice is SvmGasPri
   const { baseFee, microLamportsPerComputeUnit } = gasPrice as SvmGasPriceEstimate;
   return isDefined(baseFee) && isDefined(microLamportsPerComputeUnit);
 }
+
+export function isTVMGasPrice(gasPrice: GasPriceEstimate): gasPrice is TvmGasPriceEstimate {
+  const { energyPrice, bandwidthPrice } = gasPrice as TvmGasPriceEstimate;
+  return isDefined(energyPrice) && isDefined(bandwidthPrice);
+}

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

@@ -3,13 +3,15 @@ import { CHAIN_IDs, TOKEN_SYMBOLS_MAP } from "@across-protocol/constants";
 import { getDeployedAddress } from "@across-protocol/contracts";
 import { asL2Provider } from "@eth-optimism/sdk";
 import { providers } from "ethers";
+import { TronWeb } from "tronweb";
 import { CUSTOM_GAS_TOKENS } from "../../constants";
-import { chainIsEvm, chainIsOPStack, isDefined, chainIsSvm, SvmAddress } from "../../utils";
+import { chainIsEvm, chainIsOPStack, isDefined, chainIsSvm, chainIsTvm, SvmAddress } from "../../utils";
 import { QueryBase } from "./baseQuery";
 import { SVMProvider as svmProvider } from "../../arch/svm";
 import { DEFAULT_LOGGER, getDefaultRelayer, Logger } from "../relayFeeCalculator";
 import { CustomGasTokenQueries } from "./customGasToken";
 import { SvmQuery } from "./svmQuery";
+import { TvmQuery } from "./tvmQuery";
 
 /**
  * Some chains have a fixed gas price that is applied to the gas estimates. We should override
@@ -22,14 +24,14 @@ const fixedGasPrice = {
 export class QueryBase__factory {
   static create(
     chainId: number,
-    provider: providers.Provider | svmProvider,
+    provider: providers.Provider | svmProvider | TronWeb,
     symbolMapping = TOKEN_SYMBOLS_MAP,
     spokePoolAddress = getDeployedAddress("SpokePool", chainId),
     relayerAddress = getDefaultRelayer(chainId),
     coingeckoProApiKey?: string,
     logger: Logger = DEFAULT_LOGGER,
     coingeckoBaseCurrency = "eth"
-  ): QueryBase | SvmQuery {
+  ): QueryBase | SvmQuery | TvmQuery {
     assert(isDefined(spokePoolAddress));
 
     const customGasTokenSymbol = CUSTOM_GAS_TOKENS[chainId];
@@ -62,6 +64,19 @@ export class QueryBase__factory {
         coingeckoBaseCurrency
       );
     }
+    if (chainIsTvm(chainId)) {
+      assert(relayerAddress.isEVM());
+      return new TvmQuery(
+        provider as TronWeb,
+        symbolMapping,
+        spokePoolAddress,
+        relayerAddress,
+        logger,
+        coingeckoProApiKey,
+        fixedGasPrice[chainId],
+        coingeckoBaseCurrency
+      );
+    }
 
     // For OPStack chains, we need to wrap the provider in an L2Provider
     provider = chainIsOPStack(chainId)

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

@@ -2,3 +2,4 @@ export * from "./baseQuery";
 export * from "./factory";
 export * from "./customGasToken";
 export * from "./svmQuery";
+export * from "./tvmQuery";

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

@@ -0,0 +1,88 @@
+import assert from "assert";
+import { PopulatedTransaction, providers, VoidSigner } from "ethers";
+import { TronWeb } from "tronweb";
+import { getGasPriceEstimate, GasPriceEstimateOptions } from "../../gasPriceOracle";
+import { TvmGasPriceEstimate } from "../../gasPriceOracle/types";
+import { RelayData } from "../../interfaces";
+import { Address, BigNumber, BigNumberish, bnZero, EvmAddress, TransactionCostEstimate } from "../../utils";
+import { arch } from "../..";
+import { Logger } from "../relayFeeCalculator";
+import { QueryBase, SymbolMappingType } from "./baseQuery";
+
+/**
+ * A TVM-specific query implementation for TRON.
+ *
+ * TRON's JSON-RPC is EVM-compatible for reads and gas estimation, so this
+ * class extends QueryBase and overrides only the gas price oracle dispatch
+ * to use TronWeb (energy/bandwidth pricing) instead of the EVM oracle.
+ *
+ * The ethers provider is derived from the TronWeb instance's fullNode URL.
+ */
+export class TvmQuery extends QueryBase {
+  readonly tronWeb: TronWeb;
+
+  constructor(
+    tronWeb: TronWeb,
+    symbolMapping: SymbolMappingType,
+    spokePoolAddress: string,
+    simulatedRelayerAddress: EvmAddress,
+    logger: Logger,
+    coingeckoProApiKey?: string,
+    fixedGasPrice?: BigNumberish,
+    coingeckoBaseCurrency: string = "eth"
+  ) {
+    const provider = new providers.StaticJsonRpcProvider(tronWeb.fullNode.host);
+    super(
+      provider,
+      symbolMapping,
+      spokePoolAddress,
+      simulatedRelayerAddress,
+      logger,
+      coingeckoProApiKey,
+      fixedGasPrice,
+      coingeckoBaseCurrency
+    );
+    this.tronWeb = tronWeb;
+  }
+
+  /**
+   * Estimate the gas cost of a transaction using TVM energy pricing.
+   *
+   * Gas units (energy) are estimated via the ethers provider (TRON's JSON-RPC
+   * returns energy units for eth_estimateGas). The energy price is queried
+   * from TronWeb's gas price oracle.
+   */
+  override async estimateGas(
+    unsignedTx: PopulatedTransaction,
+    senderAddress: Address,
+    provider: providers.Provider,
+    options: Partial<
+      GasPriceEstimateOptions & {
+        gasPrice: BigNumberish;
+        gasUnits: BigNumberish;
+      }
+    > = {}
+  ): Promise<TransactionCostEstimate> {
+    const { gasPrice: _gasPrice, gasUnits } = options;
+
+    const voidSigner = new VoidSigner(senderAddress.toEvmAddress(), provider);
+
+    const [nativeGasCost, gasPriceEstimate] = await Promise.all([
+      gasUnits ? Promise.resolve(BigNumber.from(gasUnits)) : voidSigner.estimateGas(unsignedTx),
+      _gasPrice
+        ? Promise.resolve({ energyPrice: BigNumber.from(_gasPrice.toString()), bandwidthPrice: bnZero })
+        : getGasPriceEstimate(this.tronWeb),
+    ]);
+
+    assert(nativeGasCost.gt(bnZero), "Gas cost should not be 0");
+
+    const gasPrice = (gasPriceEstimate as TvmGasPriceEstimate).energyPrice;
+    const tokenGasCost = nativeGasCost.mul(gasPrice);
+
+    return { nativeGasCost, tokenGasCost, gasPrice };
+  }
+
+  override getAuxiliaryNativeTokenCost(deposit: RelayData): BigNumber {
+    return arch.tvm.getAuxiliaryNativeTokenCost(deposit);
+  }
+}

package/src/utils/Multicall.ts

@@ -21,6 +21,7 @@ const MULTICALL_DEPLOYER = "0x05f32B3cC3888453ff71B01135B34FF8e41263F2";
 
 const NON_DETERMINISTIC_MULTICALL_ADDRESSES = {
   [CHAIN_IDs.LENS]: "0x6b6dEa4D80e3077D076733A04c48F63c3BA49320",
+  [CHAIN_IDs.TRON]: "0x32a4f47a74a6810bd0bf861cabab99656a75de9e", // @todo: Base58?
   [CHAIN_IDs.ZK_SYNC]: "0xF9cda624FBC7e059355ce98a31693d299FACd963",
   [CHAIN_IDs.LENS_SEPOLIA]: "0x8A44EDE8a6843a997bC0Cc4659e4dB1Da8f91116",
 };

package/src/utils/NetworkUtils.ts

@@ -134,6 +134,15 @@ export function chainIsSvm(chainId: number): boolean {
   return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.SVM;
 }
 
+/**
+ * Determines whether a chain ID runs on a TVM-like execution layer (e.g. TRON).
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chain corresponding to chainId has a TVM-like execution layer.
+ */
+export function chainIsTvm(chainId: number): boolean {
+  return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.TVM;
+}
+
 /**
  * Determines whether a chain ID has a native gas token.
  * @param chainId Chain ID to evaluate.
@@ -166,13 +175,14 @@ export function chainIsOFTEnabled(chainId: number): boolean {
   // This is backwards vs. CCTP logic because Across support for OFTs is limited vs. OFT deployments.
   const oftEnabled = [
     CHAIN_IDs.ARBITRUM,
-    CHAIN_IDs.POLYGON,
     CHAIN_IDs.HYPEREVM,
+    CHAIN_IDs.INK,
+    CHAIN_IDs.MEGAETH,
     CHAIN_IDs.MONAD,
     CHAIN_IDs.PLASMA,
-    CHAIN_IDs.MEGAETH,
+    CHAIN_IDs.POLYGON,
+    CHAIN_IDs.TRON, // tbd!!!
     CHAIN_IDs.UNICHAIN,
-    CHAIN_IDs.INK,
   ];
   return oftEnabled.includes(chainId) && PRODUCTION_NETWORKS[chainId]?.oftEid !== OFT_NO_EID;
 }

package/src/utils/TypeGuards.ts

@@ -1,6 +1,7 @@
 import { SVMProvider } from "../arch/svm/types";
 import { EvmProvider } from "../arch/evm/types";
 import { providers } from "ethers";
+import { TronWeb } from "tronweb";
 
 export function isPromiseFulfilled<T>(
   promiseSettledResult: PromiseSettledResult<T>
@@ -18,6 +19,10 @@ export function isDefined<T>(input: T | null | undefined): input is T {
   return input !== null && input !== undefined;
 }
 
-export function isEvmProvider(provider: EvmProvider | SVMProvider): provider is EvmProvider {
+export function isTvmProvider(provider: EvmProvider | SVMProvider | TronWeb): provider is TronWeb {
+  return typeof (provider as TronWeb)?.trx?.getEnergyPrices === "function";
+}
+
+export function isEvmProvider(provider: EvmProvider | SVMProvider | TronWeb): provider is EvmProvider {
   return provider instanceof providers.Provider;
 }

package/src/utils/abi/contracts/SP1AutoVerifier.json

@@ -0,0 +1,25 @@
+[
+  {
+    "type": "function",
+    "name": "verifyProof",
+    "inputs": [
+      {
+        "name": "",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "pure"
+  }
+]

package/src/utils/abi/typechain/SP1AutoVerifier.ts

@@ -0,0 +1,112 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+import type {
+  BaseContract,
+  BigNumber,
+  BytesLike,
+  CallOverrides,
+  PopulatedTransaction,
+  Signer,
+  utils,
+} from "ethers";
+import type { FunctionFragment, Result } from "@ethersproject/abi";
+import type { Listener, Provider } from "@ethersproject/providers";
+import type {
+  TypedEventFilter,
+  TypedEvent,
+  TypedListener,
+  OnEvent,
+} from "./common";
+
+export interface SP1AutoVerifierInterface extends utils.Interface {
+  functions: {
+    "verifyProof(bytes32,bytes,bytes)": FunctionFragment;
+  };
+
+  getFunction(nameOrSignatureOrTopic: "verifyProof"): FunctionFragment;
+
+  encodeFunctionData(
+    functionFragment: "verifyProof",
+    values: [BytesLike, BytesLike, BytesLike]
+  ): string;
+
+  decodeFunctionResult(
+    functionFragment: "verifyProof",
+    data: BytesLike
+  ): Result;
+
+  events: {};
+}
+
+export interface SP1AutoVerifier extends BaseContract {
+  connect(signerOrProvider: Signer | Provider | string): this;
+  attach(addressOrName: string): this;
+  deployed(): Promise<this>;
+
+  interface: SP1AutoVerifierInterface;
+
+  queryFilter<TEvent extends TypedEvent>(
+    event: TypedEventFilter<TEvent>,
+    fromBlockOrBlockhash?: string | number | undefined,
+    toBlock?: string | number | undefined
+  ): Promise<Array<TEvent>>;
+
+  listeners<TEvent extends TypedEvent>(
+    eventFilter?: TypedEventFilter<TEvent>
+  ): Array<TypedListener<TEvent>>;
+  listeners(eventName?: string): Array<Listener>;
+  removeAllListeners<TEvent extends TypedEvent>(
+    eventFilter: TypedEventFilter<TEvent>
+  ): this;
+  removeAllListeners(eventName?: string): this;
+  off: OnEvent<this>;
+  on: OnEvent<this>;
+  once: OnEvent<this>;
+  removeListener: OnEvent<this>;
+
+  functions: {
+    verifyProof(
+      arg0: BytesLike,
+      arg1: BytesLike,
+      arg2: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<[void]>;
+  };
+
+  verifyProof(
+    arg0: BytesLike,
+    arg1: BytesLike,
+    arg2: BytesLike,
+    overrides?: CallOverrides
+  ): Promise<void>;
+
+  callStatic: {
+    verifyProof(
+      arg0: BytesLike,
+      arg1: BytesLike,
+      arg2: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<void>;
+  };
+
+  filters: {};
+
+  estimateGas: {
+    verifyProof(
+      arg0: BytesLike,
+      arg1: BytesLike,
+      arg2: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<BigNumber>;
+  };
+
+  populateTransaction: {
+    verifyProof(
+      arg0: BytesLike,
+      arg1: BytesLike,
+      arg2: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<PopulatedTransaction>;
+  };
+}

package/src/utils/abi/typechain/factories/SP1AutoVerifier__factory.ts

@@ -0,0 +1,49 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+
+import { Contract, Signer, utils } from "ethers";
+import type { Provider } from "@ethersproject/providers";
+import type {
+  SP1AutoVerifier,
+  SP1AutoVerifierInterface,
+} from "../SP1AutoVerifier";
+
+const _abi = [
+  {
+    type: "function",
+    name: "verifyProof",
+    inputs: [
+      {
+        name: "",
+        type: "bytes32",
+        internalType: "bytes32",
+      },
+      {
+        name: "",
+        type: "bytes",
+        internalType: "bytes",
+      },
+      {
+        name: "",
+        type: "bytes",
+        internalType: "bytes",
+      },
+    ],
+    outputs: [],
+    stateMutability: "pure",
+  },
+] as const;
+
+export class SP1AutoVerifier__factory {
+  static readonly abi = _abi;
+  static createInterface(): SP1AutoVerifierInterface {
+    return new utils.Interface(_abi) as SP1AutoVerifierInterface;
+  }
+  static connect(
+    address: string,
+    signerOrProvider: Signer | Provider
+  ): SP1AutoVerifier {
+    return new Contract(address, _abi, signerOrProvider) as SP1AutoVerifier;
+  }
+}

package/src/utils/abi/typechain/factories/index.ts

@@ -254,6 +254,7 @@ export { ProxyAdmin__factory } from "./ProxyAdmin__factory";
 export { ReentrancyGuard__factory } from "./ReentrancyGuard__factory";
 export { ReentrancyGuardUpgradeable__factory } from "./ReentrancyGuardUpgradeable__factory";
 export { Router_Adapter__factory } from "./Router_Adapter__factory";
+export { SP1AutoVerifier__factory } from "./SP1AutoVerifier__factory";
 export { SP1Helios__factory } from "./SP1Helios__factory";
 export { SafeCast__factory } from "./SafeCast__factory";
 export { SafeERC20__factory } from "./SafeERC20__factory";

package/src/utils/abi/typechain/index.ts

@@ -254,6 +254,7 @@ export type { ProxyAdmin } from "./ProxyAdmin";
 export type { ReentrancyGuard } from "./ReentrancyGuard";
 export type { ReentrancyGuardUpgradeable } from "./ReentrancyGuardUpgradeable";
 export type { Router_Adapter } from "./Router_Adapter";
+export type { SP1AutoVerifier } from "./SP1AutoVerifier";
 export type { SP1Helios } from "./SP1Helios";
 export type { SafeCast } from "./SafeCast";
 export type { SafeERC20 } from "./SafeERC20";
@@ -572,6 +573,7 @@ export { ShortStrings__factory } from "./factories/ShortStrings__factory";
 export { SimpleContract__factory } from "./factories/SimpleContract__factory";
 export { SkinnyOptimisticOracleInterface__factory } from "./factories/SkinnyOptimisticOracleInterface__factory";
 export { Solana_Adapter__factory } from "./factories/Solana_Adapter__factory";
+export { SP1AutoVerifier__factory } from "./factories/SP1AutoVerifier__factory";
 export { SP1Helios__factory } from "./factories/SP1Helios__factory";
 export { SpokePool__factory } from "./factories/SpokePool__factory";
 export { SpokePoolEIP7702Test__factory } from "./factories/SpokePoolEIP7702Test__factory";