@across-protocol/sdk 4.3.0 → 4.3.2

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -15,7 +15,6 @@ import {
   isDefined,
   getMessageHash,
   isSlowFill,
-  isZeroAddress,
   validateFillForDeposit,
   chainIsProd,
   Address,
@@ -364,6 +363,14 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
     return this.depositHashesToFills[this.getDepositHash(deposit)];
   }
 
+  public isDepositFilled(deposit: Deposit): boolean {
+    const depositHash = this.getDepositHash(deposit);
+    const fills = this.depositHashesToFills[depositHash] ?? [];
+
+    return fills.some((fill) => validateFillForDeposit(fill, deposit).valid);
+  }
+
+  // @TODO: Remove this method after refactoring relayer repo.
   /**
    * Find the unfilled amount for a given deposit. This is the full deposit amount minus the total filled amount.
    * @param deposit The deposit to find the unfilled amount for.
@@ -558,7 +565,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
         deposit.fromLiteChain = this.isOriginLiteChain(deposit);
         deposit.toLiteChain = this.isDestinationLiteChain(deposit);
 
-        if (isZeroAddress(deposit.outputToken)) {
+        if (deposit.outputToken.isZeroAddress()) {
           deposit.outputToken = this.getDestinationTokenForDeposit(deposit);
         }
 

package/src/clients/SpokePoolClient/index.ts

@@ -5,6 +5,7 @@ import { SpokePoolClient } from "./SpokePoolClient";
 export { EVMSpokePoolClient } from "./EVMSpokePoolClient";
 export { SpokePoolClient, SpokePoolUpdate } from "./SpokePoolClient";
 export { SVMSpokePoolClient } from "./SVMSpokePoolClient";
+export { SpokePoolManager } from "./SpokePoolClientManager";
 
 /**
  * Checks if a SpokePoolClient is an EVMSpokePoolClient.

package/src/clients/index.ts

@@ -13,6 +13,7 @@ export {
   SVMSpokePoolClient,
   isEVMSpokePoolClient,
   isSVMSpokePoolClient,
+  SpokePoolManager,
 } from "./SpokePoolClient";
 export * as BundleDataClient from "./BundleDataClient";
 export * as mocks from "./mocks";

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

@@ -15,7 +15,6 @@ import {
   bnZero,
   chainIsOPStack,
   fixedPointAdjustment,
-  toAddressType,
   Address,
 } from "../../utils";
 import assert from "assert";
@@ -53,7 +52,7 @@ export class QueryBase implements QueryInterface {
     readonly provider: EvmProvider,
     readonly symbolMapping: SymbolMappingType,
     readonly spokePoolAddress: string,
-    readonly simulatedRelayerAddress: string,
+    readonly simulatedRelayerAddress: EvmAddress,
     readonly logger: Logger,
     readonly coingeckoProApiKey?: string,
     readonly fixedGasPrice?: BigNumberish,
@@ -74,7 +73,7 @@ export class QueryBase implements QueryInterface {
    */
   async getGasCosts(
     relayData: RelayData & { destinationChainId: number },
-    relayer = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId),
+    relayer = getDefaultRelayer(relayData.destinationChainId),
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -133,7 +132,7 @@ export class QueryBase implements QueryInterface {
       recipient: EvmAddress;
       outputToken: EvmAddress;
     },
-    relayer = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId)
+    relayer = getDefaultRelayer(relayData.destinationChainId)
   ): Promise<PopulatedTransaction> {
     return populateV3Relay(this.spokePool, relayData, relayer);
   }
@@ -146,7 +145,7 @@ export class QueryBase implements QueryInterface {
    */
   async getNativeGasCost(
     relayData: RelayData & { destinationChainId: number },
-    relayer = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId)
+    relayer = getDefaultRelayer(relayData.destinationChainId)
   ): Promise<BigNumber> {
     const { recipient, outputToken, exclusiveRelayer } = relayData;
     assert(recipient.isEVM(), `getNativeGasCost: recipient not an EVM address (${recipient})`);
@@ -171,7 +170,7 @@ export class QueryBase implements QueryInterface {
    */
   async getOpStackL1DataFee(
     unsignedTx: PopulatedTransaction,
-    relayer = toAddressType(getDefaultRelayer(unsignedTx.chainId), CHAIN_IDs.MAINNET),
+    relayer = getDefaultRelayer(unsignedTx.chainId),
     options: Partial<{
       opStackL2GasUnits: BigNumberish;
       opStackL1DataFeeMultiplier: BigNumber;

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

@@ -25,7 +25,7 @@ export class QueryBase__factory {
     provider: providers.Provider | svmProvider,
     symbolMapping = TOKEN_SYMBOLS_MAP,
     spokePoolAddress = getDeployedAddress("SpokePool", chainId),
-    simulatedRelayerAddress = getDefaultRelayer(chainId),
+    relayerAddress = getDefaultRelayer(chainId),
     coingeckoProApiKey?: string,
     logger: Logger = DEFAULT_LOGGER,
     coingeckoBaseCurrency = "eth"
@@ -34,12 +34,13 @@ export class QueryBase__factory {
 
     const customGasTokenSymbol = CUSTOM_GAS_TOKENS[chainId];
     if (customGasTokenSymbol) {
+      assert(relayerAddress.isEVM());
       return new CustomGasTokenQueries({
         queryBaseArgs: [
           provider as providers.Provider,
           symbolMapping,
           spokePoolAddress,
-          simulatedRelayerAddress,
+          relayerAddress,
           logger,
           coingeckoProApiKey,
           fixedGasPrice[chainId],
@@ -49,11 +50,12 @@ export class QueryBase__factory {
       });
     }
     if (chainIsSvm(chainId)) {
+      assert(relayerAddress.isSVM());
       return new SvmQuery(
         provider as svmProvider,
         symbolMapping,
         SvmAddress.from(spokePoolAddress),
-        SvmAddress.from(simulatedRelayerAddress),
+        relayerAddress,
         logger,
         coingeckoProApiKey,
         fixedGasPrice[chainId],
@@ -66,11 +68,12 @@ export class QueryBase__factory {
       ? asL2Provider(provider as providers.Provider)
       : (provider as providers.Provider);
 
+    assert(relayerAddress.isEVM());
     return new QueryBase(
       provider,
       symbolMapping,
       spokePoolAddress,
-      simulatedRelayerAddress,
+      relayerAddress,
       logger,
       coingeckoProApiKey,
       fixedGasPrice[chainId],

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

@@ -20,12 +20,12 @@ import { CHAIN_IDs } from "../../constants";
 import { getGasPriceEstimate } from "../../gasPriceOracle";
 import { RelayData } from "../../interfaces";
 import {
+  Address,
   BigNumber,
   BigNumberish,
   SvmAddress,
   TransactionCostEstimate,
   getRelayDataHash,
-  toAddressType,
   toBN,
 } from "../../utils";
 import { Logger, QueryInterface, getDefaultRelayer } from "../relayFeeCalculator";
@@ -76,7 +76,7 @@ export class SvmQuery implements QueryInterface {
    */
   async getGasCosts(
     relayData: RelayData & { destinationChainId: number },
-    relayer = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId),
+    relayer = getDefaultRelayer(relayData.destinationChainId),
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -84,12 +84,19 @@ export class SvmQuery implements QueryInterface {
       priorityFeeMultiplier: BigNumber;
     }> = {}
   ): Promise<TransactionCostEstimate> {
-    const { recipient, outputToken, exclusiveRelayer } = relayData;
+    const { destinationChainId, recipient, outputToken, exclusiveRelayer } = relayData;
     assert(recipient.isSVM(), `getGasCosts: recipient not an SVM address (${recipient})`);
     assert(outputToken.isSVM(), `getGasCosts: outputToken not an SVM address (${outputToken})`);
     assert(exclusiveRelayer.isSVM(), `getGasCosts: exclusiveRelayer not an SVM address (${exclusiveRelayer})`);
+    assert(relayer.isSVM());
 
-    const fillRelayTx = await this.getFillRelayTx({ ...relayData, recipient, outputToken, exclusiveRelayer }, relayer);
+    const [repaymentChainId, repaymentAddress] = [destinationChainId, relayer]; // These are not important for gas cost simulation.
+    const fillRelayTx = await this.getFillRelayTx(
+      { ...relayData, recipient, outputToken, exclusiveRelayer },
+      relayer,
+      repaymentChainId,
+      repaymentAddress
+    );
 
     const [computeUnitsConsumed, gasPriceEstimate] = await Promise.all([
       toBN(await this.computeUnitEstimator(fillRelayTx)),
@@ -121,14 +128,21 @@ export class SvmQuery implements QueryInterface {
    */
   async getNativeGasCost(
     deposit: RelayData & { destinationChainId: number },
-    _relayer = toAddressType(getDefaultRelayer(deposit.destinationChainId), deposit.destinationChainId)
+    relayer = getDefaultRelayer(deposit.destinationChainId)
   ): Promise<BigNumber> {
-    const { recipient, outputToken, exclusiveRelayer } = deposit;
+    const { destinationChainId, recipient, outputToken, exclusiveRelayer } = deposit;
     assert(recipient.isSVM(), `getNativeGasCost: recipient not an SVM address (${recipient})`);
     assert(outputToken.isSVM(), `getNativeGasCost: outputToken not an SVM address (${outputToken})`);
     assert(exclusiveRelayer.isSVM(), `getNativeGasCost: exclusiveRelayer not an SVM address (${exclusiveRelayer})`);
+    assert(relayer.isSVM());
 
-    const fillRelayTx = await this.getFillRelayTx({ ...deposit, recipient, outputToken, exclusiveRelayer }, _relayer);
+    const [repaymentChainId, repaymentAddress] = [destinationChainId, relayer]; // These are not important for gas cost simulation.
+    const fillRelayTx = await this.getFillRelayTx(
+      { ...deposit, recipient, outputToken, exclusiveRelayer },
+      relayer,
+      repaymentChainId,
+      repaymentAddress
+    );
     return toBN(await this.computeUnitEstimator(fillRelayTx));
   }
 
@@ -138,15 +152,15 @@ export class SvmQuery implements QueryInterface {
    * @param relayer SVM address of the relayer
    * @returns FillRelay transaction
    */
-  async getFillRelayTx(
+  protected async getFillRelayTx(
     relayData: Omit<RelayData, "recipent" | "outputToken"> & {
       destinationChainId: number;
       recipient: SvmAddress;
       outputToken: SvmAddress;
     },
-    relayer = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId),
-    repaymentChainId = relayData.destinationChainId,
-    repaymentAddress = toAddressType(getDefaultRelayer(relayData.destinationChainId), relayData.destinationChainId)
+    relayer: SvmAddress,
+    repaymentChainId: number,
+    repaymentAddress: Address
   ) {
     const { depositor, recipient, inputToken, outputToken, exclusiveRelayer, destinationChainId } = relayData;
 

package/src/relayFeeCalculator/relayFeeCalculator.ts

@@ -5,7 +5,7 @@ import {
   DEFAULT_SIMULATED_RELAYER_ADDRESS_SVM,
   TOKEN_SYMBOLS_MAP,
 } from "../constants";
-import { Deposit } from "../interfaces";
+import { RelayData } from "../interfaces";
 import {
   BigNumber,
   BigNumberish,
@@ -15,7 +15,6 @@ import {
   fixedPointAdjustment,
   getTokenInfo,
   isDefined,
-  isZeroAddress,
   max,
   min,
   nativeToToken,
@@ -25,14 +24,15 @@ import {
   compareAddressesSimple,
   ConvertDecimals,
   chainIsSvm,
-  toAddressType,
   Address,
+  EvmAddress,
+  SvmAddress,
 } from "../utils";
 
 // This needs to be implemented for every chain and passed into RelayFeeCalculator
 export interface QueryInterface {
   getGasCosts: (
-    deposit: Omit<Deposit, "messageHash">,
+    deposit: RelayData & { destinationChainId: number },
     relayer: Address,
     options?: Partial<{
       gasPrice: BigNumberish;
@@ -44,7 +44,7 @@ export interface QueryInterface {
     }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
-  getNativeGasCost: (deposit: Omit<Deposit, "messageHash">, relayer: Address) => Promise<BigNumber>;
+  getNativeGasCost: (deposit: RelayData & { destinationChainId: number }, relayer: Address) => Promise<BigNumber>;
 }
 
 export const expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];
@@ -114,10 +114,10 @@ export const DEFAULT_LOGGER: Logger = {
   error: (...args) => console.error(args),
 };
 
-export function getDefaultRelayer(chainId?: number) {
+export function getDefaultRelayer(chainId?: number): Address {
   return isDefined(chainId) && chainIsSvm(chainId)
-    ? DEFAULT_SIMULATED_RELAYER_ADDRESS_SVM
-    : DEFAULT_SIMULATED_RELAYER_ADDRESS;
+    ? SvmAddress.from(DEFAULT_SIMULATED_RELAYER_ADDRESS_SVM)
+    : EvmAddress.from(DEFAULT_SIMULATED_RELAYER_ADDRESS);
 }
 
 // Small amount to simulate filling with. Should be low enough to guarantee a successful fill.
@@ -253,10 +253,10 @@ export class RelayFeeCalculator {
    *       the correct parameters to see a full fill.
    */
   async gasFeePercent(
-    deposit: Deposit,
+    deposit: RelayData & { destinationChainId: number },
     outputAmount: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = toAddressType(getDefaultRelayer(deposit.destinationChainId), deposit.destinationChainId),
+    relayerAddress = getDefaultRelayer(deposit.destinationChainId),
     _tokenPrice?: number,
     tokenMapping = TOKEN_SYMBOLS_MAP,
     gasPrice?: BigNumberish,
@@ -276,7 +276,7 @@ export class RelayFeeCalculator {
         compareAddressesSimple(details.addresses[originChainId], inputToken.toNative()) &&
         isDefined(details.addresses[destinationChainId])
     );
-    const outputToken = isZeroAddress(deposit.outputToken)
+    const outputToken = deposit.outputToken.isZeroAddress()
       ? destinationChainTokenDetails!.addresses[destinationChainId]
       : deposit.outputToken.toNative();
     const outputTokenInfo = getTokenInfo(outputToken, destinationChainId, tokenMapping);
@@ -492,10 +492,10 @@ export class RelayFeeCalculator {
    * @returns A resulting `RelayerFeeDetails` object
    */
   async relayerFeeDetails(
-    deposit: Deposit,
+    deposit: RelayData & { destinationChainId: number },
     outputAmount?: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = toAddressType(getDefaultRelayer(deposit.destinationChainId), deposit.destinationChainId),
+    relayerAddress = getDefaultRelayer(deposit.destinationChainId),
     _tokenPrice?: number,
     gasPrice?: BigNumberish,
     gasUnits?: BigNumberish,

package/src/utils/DepositUtils.ts

@@ -2,7 +2,7 @@ import assert from "assert";
 import { SpokePoolClient } from "../clients";
 import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE, UNDEFINED_MESSAGE_HASH, ZERO_BYTES } from "../constants";
 import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, RelayData, SlowFillRequest } from "../interfaces";
-import { getMessageHash, isUnsafeDepositId, isZeroAddress } from "./SpokeUtils";
+import { getMessageHash, isUnsafeDepositId } from "./SpokeUtils";
 import { getNetworkName } from "./NetworkUtils";
 import { bnZero } from "./BigNumberUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
@@ -204,13 +204,13 @@ export function validateFillForDeposit(
  * @param deposit Deposit to check.
  * @returns True if deposit's input amount is 0 and message is empty.
  */
-export function isZeroValueDeposit(deposit: Pick<Deposit, "inputAmount" | "message">): boolean {
+export function isZeroValueDeposit(deposit: Pick<RelayData, "inputAmount" | "message">): boolean {
   return deposit.inputAmount.eq(0) && isMessageEmpty(deposit.message);
 }
 
-export function invalidOutputToken(deposit: Pick<DepositWithBlock, "outputToken">): boolean {
+export function invalidOutputToken(deposit: Pick<RelayData, "outputToken">): boolean {
   // If the output token is zero address, then it is invalid.
-  return isZeroAddress(deposit.outputToken);
+  return deposit.outputToken.isZeroAddress();
 }
 
 export function isZeroValueFillOrSlowFillRequest(

package/src/utils/SpokeUtils.ts

@@ -3,7 +3,6 @@ import { fixedPointAdjustment as fixedPoint } from "./common";
 import { MAX_SAFE_DEPOSIT_ID, ZERO_BYTES } from "../constants";
 import { Fill, FillType, RelayData, SlowFillLeaf } from "../interfaces";
 import { BigNumber } from "./BigNumberUtils";
-import { Address } from "./AddressUtils";
 import { isMessageEmpty } from "./DepositUtils";
 import { chainIsSvm } from "./NetworkUtils";
 import { svm } from "../arch";
@@ -72,11 +71,6 @@ export function isUnsafeDepositId(depositId: BigNumber): boolean {
   return maxSafeDepositId.lt(depositId);
 }
 
-// Determines if the input address (either a bytes32 or bytes20) is the zero address.
-export function isZeroAddress(address: Address): boolean {
-  return address.toBytes32() === ZERO_BYTES;
-}
-
 export function getMessageHash(message: string): string {
   return isMessageEmpty(message) ? ZERO_BYTES : keccak256(message as Hex);
 }

package/src/utils/TokenUtils.ts

@@ -2,7 +2,7 @@ import assert from "assert";
 import { BlockTag } from "@ethersproject/abstract-provider";
 import { Contract, providers, Signer } from "ethers";
 import * as constants from "../constants";
-import { TokenInfo } from "../interfaces";
+import { L1TokenInfo, TokenInfo } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { BigNumber } from "./BigNumberUtils";
 import { getNetworkName, chainIsL1, chainIsProd } from "./NetworkUtils";
@@ -12,7 +12,7 @@ const { TOKEN_SYMBOLS_MAP, CHAIN_IDs, TOKEN_EQUIVALENCE_REMAPPING } = constants;
 
 type SignerOrProvider = providers.Provider | Signer;
 
-export async function fetchTokenInfo(address: string, signerOrProvider: SignerOrProvider): Promise<TokenInfo> {
+export async function fetchTokenInfo(address: string, signerOrProvider: SignerOrProvider): Promise<L1TokenInfo> {
   const token = new Contract(address, ERC20__factory.abi, signerOrProvider);
   const [symbol, decimals] = await Promise.all([token.symbol(), token.decimals()]);
   return { address: EvmAddress.from(address), symbol, decimals };