@across-protocol/sdk 4.1.46-beta.3 → 4.1.46

package/src/clients/HubPoolClient.ts

@@ -43,6 +43,7 @@ import {
   toBN,
   getTokenInfo,
   getUsdcSymbol,
+  getL1TokenInfo,
   compareAddressesSimple,
   chainIsSvm,
   getDeployedAddress,
@@ -284,6 +285,17 @@ export class HubPoolClient extends BaseAbstractClient {
     return tokenInfo;
   }
 
+  /**
+   * @dev If tokenAddress + chain do not exist in TOKEN_SYMBOLS_MAP then this will throw.
+   * @dev if the token matched in TOKEN_SYMBOLS_MAP does not have an L1 token address then this will throw.
+   * @param tokenAddress Token address on `chain`
+   * @param chain Chain where the `tokenAddress` exists in TOKEN_SYMBOLS_MAP.
+   * @returns Token info for the given token address on the Hub chain including symbol and decimal and L1 address.
+   */
+  getL1TokenInfoForAddress(tokenAddress: string, chain: number): L1Token {
+    return getL1TokenInfo(tokenAddress, chain);
+  }
+
   /**
    * Resolve a given timestamp to a block number on the HubPool chain.
    * @param timestamp A single timestamp to be resolved to a block number on the HubPool chain.
@@ -503,6 +515,17 @@ export class HubPoolClient extends BaseAbstractClient {
     return this.getTokenInfoForL1Token(l1TokenCounterpart);
   }
 
+  getTokenInfoForDeposit(deposit: Pick<Deposit, "inputToken" | "originChainId">): L1Token | undefined {
+    return this.getTokenInfoForL1Token(
+      this.getL1TokenForL2TokenAtBlock(deposit.inputToken, deposit.originChainId, this.latestBlockSearched)
+    );
+  }
+
+  getTokenInfo(chainId: number | string, tokenAddress: string): L1Token | undefined {
+    const deposit = { originChainId: parseInt(chainId.toString()), inputToken: tokenAddress };
+    return this.getTokenInfoForDeposit(deposit);
+  }
+
   areTokensEquivalent(
     tokenA: string,
     chainIdA: number,

package/src/clients/mocks/MockHubPoolClient.ts

@@ -23,6 +23,7 @@ export class MockHubPoolClient extends HubPoolClient {
   private realizedLpFeePctOverride = false;
 
   private l1TokensMock: L1Token[] = []; // L1Tokens and their associated info.
+  private tokenInfoToReturn: L1Token = { address: "", decimals: 0, symbol: "" };
 
   private spokePoolTokens: { [l1Token: string]: { [chainId: number]: string } } = {};
 
@@ -90,6 +91,10 @@ export class MockHubPoolClient extends HubPoolClient {
     return this.l1TokensMock;
   }
 
+  getTokenInfoForDeposit() {
+    return this.tokenInfoToReturn;
+  }
+
   setTokenMapping(l1Token: string, chainId: number, l2Token: string) {
     this.spokePoolTokens[l1Token] ??= {};
     this.spokePoolTokens[l1Token][chainId] = l2Token;
@@ -131,6 +136,10 @@ export class MockHubPoolClient extends HubPoolClient {
     return this.l1TokensMock.find((token) => token.address === l1Token);
   }
 
+  setTokenInfoToReturn(tokenInfo: L1Token) {
+    this.tokenInfoToReturn = tokenInfo;
+  }
+
   _update(eventNames: string[]): Promise<HubPoolUpdate> {
     // Generate new "on chain" responses.
     const latestBlockSearched = this.eventManager.blockNumber;

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

@@ -252,4 +252,14 @@ export class QueryBase implements QueryInterface {
     );
     return price;
   }
+
+  /**
+   * Resolves the number of decimal places a token can have
+   * @param tokenSymbol A valid Across-Enabled Token ID
+   * @returns The number of decimals of precision for the corresponding tokenSymbol
+   */
+  getTokenDecimals(tokenSymbol: string): number {
+    if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
+    return this.symbolMapping[tokenSymbol].decimals;
+  }
 }

package/src/relayFeeCalculator/relayFeeCalculator.ts

@@ -34,6 +34,7 @@ export interface QueryInterface {
     }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
+  getTokenDecimals: (tokenSymbol: string) => number;
 }
 
 export const expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];

package/src/utils/TokenUtils.ts

@@ -147,8 +147,6 @@ export function getUsdcSymbol(l2Token: string, chainId: number): string | undefi
 }
 
 export function getL1TokenInfo(l2TokenAddress: string, chainId: number): L1Token {
-  if (chainId === CHAIN_IDs.MAINNET)
-    throw new Error("chainId should be an L2 chainId because many mappings re-use the same L1 token address");
   const tokenObject = Object.values(TOKEN_SYMBOLS_MAP).find(({ addresses }) => addresses[chainId] === l2TokenAddress);
   const l1TokenAddress = tokenObject?.addresses[CHAIN_IDs.MAINNET];
   if (!l1TokenAddress) {