@across-protocol/sdk 4.2.9-alpha.1 → 4.2.9-alpha.3

package/src/relayFeeCalculator/relayFeeCalculator.ts

@@ -9,12 +9,9 @@ import { Deposit } from "../interfaces";
 import {
   BigNumber,
   BigNumberish,
-  ConvertDecimals,
   MAX_BIG_INT,
   TransactionCostEstimate,
   bnZero,
-  chainIsSvm,
-  compareAddressesSimple,
   fixedPointAdjustment,
   getTokenInfo,
   isDefined,
@@ -25,13 +22,18 @@ import {
   percent,
   toBN,
   toBNWei,
+  compareAddressesSimple,
+  ConvertDecimals,
+  chainIsSvm,
+  toAddressType,
+  Address,
 } from "../utils";
 
 // This needs to be implemented for every chain and passed into RelayFeeCalculator
 export interface QueryInterface {
   getGasCosts: (
     deposit: Omit<Deposit, "messageHash">,
-    relayer: string,
+    relayer: Address,
     options?: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -42,7 +44,7 @@ export interface QueryInterface {
     }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
-  getNativeGasCost: (deposit: Omit<Deposit, "messageHash">, relayer: string) => Promise<BigNumber>;
+  getNativeGasCost: (deposit: Omit<Deposit, "messageHash">, relayer: Address) => Promise<BigNumber>;
 }
 
 export const expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];
@@ -254,7 +256,10 @@ export class RelayFeeCalculator {
     deposit: Deposit,
     outputAmount: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
+    relayerAddress = toAddressType(
+      getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
+      deposit.destinationChainId
+    ),
     _tokenPrice?: number,
     tokenMapping = TOKEN_SYMBOLS_MAP,
     gasPrice?: BigNumberish,
@@ -271,14 +276,14 @@ export class RelayFeeCalculator {
     // undefined address on destination.
     const destinationChainTokenDetails = Object.values(tokenMapping).find(
       (details) =>
-        compareAddressesSimple(details.addresses[originChainId], inputToken) &&
+        compareAddressesSimple(details.addresses[originChainId], inputToken.toAddress()) &&
         isDefined(details.addresses[destinationChainId])
     );
     const outputToken = isZeroAddress(deposit.outputToken)
       ? destinationChainTokenDetails!.addresses[destinationChainId]
-      : deposit.outputToken;
+      : deposit.outputToken.toAddress();
     const outputTokenInfo = getTokenInfo(outputToken, destinationChainId, tokenMapping);
-    const inputTokenInfo = getTokenInfo(inputToken, originChainId, tokenMapping);
+    const inputTokenInfo = getTokenInfo(inputToken.toAddress(), originChainId, tokenMapping);
     if (!isDefined(outputTokenInfo) || !isDefined(inputTokenInfo)) {
       throw new Error(`Could not find token information for ${inputToken} or ${outputToken}`);
     }
@@ -493,7 +498,10 @@ export class RelayFeeCalculator {
     deposit: Deposit,
     outputAmount?: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
+    relayerAddress = toAddressType(
+      getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
+      deposit.destinationChainId
+    ),
     _tokenPrice?: number,
     gasPrice?: BigNumberish,
     gasUnits?: BigNumberish,
@@ -505,8 +513,8 @@ export class RelayFeeCalculator {
     const { inputToken, originChainId, outputToken, destinationChainId } = deposit;
     // We can perform a simple lookup with `getTokenInfo` here without resolving the exact token to resolve since we only need to
     // resolve the L1 token symbol and not the L2 token decimals.
-    const inputTokenInfo = getTokenInfo(inputToken, originChainId);
-    const outputTokenInfo = getTokenInfo(outputToken, destinationChainId);
+    const inputTokenInfo = getTokenInfo(inputToken.toAddress(), originChainId);
+    const outputTokenInfo = getTokenInfo(outputToken.toAddress(), destinationChainId);
     if (!isDefined(inputTokenInfo) || !isDefined(outputTokenInfo)) {
       throw new Error(`Could not find token information for ${inputToken} or ${outputToken}`);
     }

package/src/utils/AddressUtils.ts

@@ -1,7 +1,8 @@
 import { providers, utils } from "ethers";
+import assert from "assert";
 import bs58 from "bs58";
 import { Address as V2Address } from "@solana/kit";
-import { BigNumber, chainIsEvm } from "./";
+import { BigNumber, chainIsEvm, isDefined } from "./";
 
 /**
  * Checks if a contract is deployed at the given address
@@ -75,20 +76,39 @@ export function isValidEvmAddress(address: string): boolean {
  * Creates the proper address type given the input chain ID corresponding to the address's origin network.
  * @param address Stringified address type to convert. Can be either hex encoded or base58 encoded.
  * @param chainId Network ID corresponding to the input address, used to determine which address type to output.
+ * If no chain ID is specified, then fallback to inference via the structure of the address string.
  * @returns a child `Address` type most fitting for the chain ID.
  * @todo: Change this to `toAddress` once we remove the other `toAddress` function.
  */
-export function toAddressType(address: string): Address | EvmAddress | SvmAddress {
-  try {
-    if (utils.isHexString(address)) {
-      return EvmAddress.from(address);
+export function toAddressType(address: string, chainId?: number): Address | EvmAddress | SvmAddress {
+  const parseAddress = (address: string) => {
+    try {
+      if (utils.isHexString(address)) {
+        return EvmAddress.from(address);
+      }
+      return SvmAddress.from(address);
+    } catch (e) {
+      // If we hit this block, then the validation for one of the child address classes failed. We still may want to keep this address in our state, so
+      // return an unchecked address type.
+      assert(utils.isHexString(address));
+      assert(utils.hexDataLength(address) === 32);
+      return Address.__unsafeConstruct(utils.arrayify(address));
+    }
+  };
+  // If there is no network ID, then infer the address by the string format.
+  const addressType = parseAddress(address);
+  if (!isDefined(chainId)) {
+    return addressType;
+  }
+  // Wrap this in a try/catch in case we are trying to force an invalid EVM address to an EvmAddress type.
+  if (chainIsEvm(chainId)) {
+    try {
+      return addressType.forceEvmAddress();
+    } catch {
+      return addressType;
     }
-    return SvmAddress.from(address);
-  } catch (e) {
-    // If we hit this block, then the validation for one of the child address classes failed. We still may want to keep this address in our state, so
-    // return an unchecked address type.
-    return new Address(utils.arrayify(address));
   }
+  return addressType.forceSvmAddress();
 }
 
 // The Address class can contain any address type. It is up to the subclasses to determine how to format the address's internal representation,
@@ -113,12 +133,24 @@ export class Address {
     this.rawAddress = utils.zeroPad(_rawAddress, 32);
   }
 
+  static __unsafeConstruct(_rawAddress: Uint8Array): Address {
+    return new this(_rawAddress);
+  }
+
   // Converts the address into a bytes32 string. Note that the output bytes will be lowercase so that it matches ethers event data. This function will never
   // throw since address length validation was done at construction time.
   toBytes32(): string {
     return (this.bytes32Address ??= utils.hexZeroPad(utils.hexlify(this.rawAddress), 32).toLowerCase());
   }
 
+  // Returns last 20 bytes of Address as a hex string. Truncates if necessary. This function is useful for comparing some longer addresses(e.g. Solana) to Solidity events
+  // that contain truncated `address` type as one of the fields
+  truncateToBytes20(): string {
+    // Take the last 20 bytes
+    const bytes20 = this.rawAddress.slice(-20);
+    return toAddress(utils.hexlify(bytes20));
+  }
+
   // Converts the address (can be bytes32 or bytes20) to its base58 counterpart. This conversion will always succeed, even if the input address is not valid on Solana,
   // as this address may be needed to represent an EVM address on Solana.
   toBase58(): string {
@@ -160,7 +192,7 @@ export class Address {
   // Checks if this address can be coerced into a bytes20 evm address. Returns true if it is possible and false otherwise.
   isValidEvmAddress(): boolean {
     try {
-      this.toAddress();
+      this.toEvmAddress();
       return true;
     } catch {
       return false;
@@ -191,6 +223,11 @@ export class Address {
     return utils.stripZeros(this.rawAddress).length === 0;
   }
 
+  // Small utility to convert an Address to a Solana Kit branded type.
+  toV2Address(): V2Address<string> {
+    return this.toBase58() as V2Address<string>;
+  }
+
   // Forces `rawAddress` to become an SvmAddress type. This will only throw if `rawAddress.length > 32`.
   forceSvmAddress(): SvmAddress {
     return SvmAddress.from(this.toBase58());
@@ -220,6 +257,14 @@ export class Address {
       return 0;
     }
   }
+
+  static isEvmAddress(address: Address): boolean {
+    return address instanceof EvmAddress;
+  }
+
+  static isSvmAddress(address: Address): boolean {
+    return address instanceof SvmAddress;
+  }
 }
 
 // Subclass of address which strictly deals with 20-byte addresses. These addresses are guaranteed to be valid EVM addresses, so `toAddress` will always succeed.
@@ -269,16 +314,6 @@ export class SvmAddress extends Address {
     return this.toBase58();
   }
 
-  // Small utility to convert an SvmAddress to a Solana Kit branded type.
-  toV2Address(): V2Address<string> {
-    return this.toBase58() as V2Address<string>;
-  }
-
-  // Forces an SvmAddress to an EVM address string by truncating the leading 12 bytes.
-  override toEvmAddress(): string {
-    return toAddress(`0x${this.toBytes32().slice(-40)}`);
-  }
-
   // Constructs a new SvmAddress type.
   static from(address: string, encoding: "base58" | "base16" = "base58"): SvmAddress {
     if (encoding === "base58") {

package/src/utils/SpokeUtils.ts

@@ -1,34 +1,12 @@
 import { encodeAbiParameters, Hex, keccak256 } from "viem";
-import { MAX_SAFE_DEPOSIT_ID, ZERO_ADDRESS, ZERO_BYTES } from "../constants";
-import { Deposit, RelayData } from "../interfaces";
-import { toBytes32 } from "./AddressUtils";
+import { MAX_SAFE_DEPOSIT_ID, ZERO_BYTES } from "../constants";
+import { RelayData } from "../interfaces";
 import { BigNumber } from "./BigNumberUtils";
+import { Address } from "./AddressUtils";
 import { isMessageEmpty } from "./DepositUtils";
 import { chainIsSvm } from "./NetworkUtils";
 import { svm } from "../arch";
 
-/**
- * Produce the RelayData for a Deposit.
- * @param deposit Deposit instance.
- * @returns The corresponding RelayData object.
- */
-export function getDepositRelayData(deposit: Omit<Deposit, "messageHash">): RelayData {
-  return {
-    depositor: toBytes32(deposit.depositor),
-    recipient: toBytes32(deposit.recipient),
-    exclusiveRelayer: toBytes32(deposit.exclusiveRelayer),
-    inputToken: toBytes32(deposit.inputToken),
-    outputToken: toBytes32(deposit.outputToken),
-    inputAmount: deposit.inputAmount,
-    outputAmount: deposit.outputAmount,
-    originChainId: deposit.originChainId,
-    depositId: deposit.depositId,
-    fillDeadline: deposit.fillDeadline,
-    exclusivityDeadline: deposit.exclusivityDeadline,
-    message: deposit.message,
-  };
-}
-
 /**
  * Compute the RelayData hash for a fill. This can be used to determine the fill status.
  * @param relayData RelayData information that is used to complete a fill.
@@ -59,14 +37,14 @@ export function getRelayDataHash(relayData: RelayData, destinationChainId: numbe
 
   const _relayData = {
     ...relayData,
-    depositor: toBytes32(relayData.depositor),
-    recipient: toBytes32(relayData.recipient),
-    inputToken: toBytes32(relayData.inputToken),
-    outputToken: toBytes32(relayData.outputToken),
-    exclusiveRelayer: toBytes32(relayData.exclusiveRelayer),
+    depositor: relayData.depositor.toBytes32(),
+    recipient: relayData.recipient.toBytes32(),
+    inputToken: relayData.inputToken.toBytes32(),
+    outputToken: relayData.outputToken.toBytes32(),
+    exclusiveRelayer: relayData.exclusiveRelayer.toBytes32(),
   };
   if (chainIsSvm(destinationChainId)) {
-    return svm.getRelayDataHash(_relayData, destinationChainId);
+    return svm.getRelayDataHash(relayData, destinationChainId);
   }
   return keccak256(encodeAbiParameters(abi, [_relayData, destinationChainId]));
 }
@@ -86,8 +64,8 @@ export function isUnsafeDepositId(depositId: BigNumber): boolean {
 }
 
 // Determines if the input address (either a bytes32 or bytes20) is the zero address.
-export function isZeroAddress(address: string): boolean {
-  return address === ZERO_ADDRESS || address === ZERO_BYTES;
+export function isZeroAddress(address: Address): boolean {
+  return address.toBytes32() === ZERO_BYTES;
 }
 
 export function getMessageHash(message: string): string {

package/src/utils/TokenUtils.ts

@@ -1,7 +1,7 @@
 import { BlockTag } from "@ethersproject/abstract-provider";
 import { Contract, providers, Signer } from "ethers";
 import * as constants from "../constants";
-import { L1Token } from "../interfaces";
+import { TokenInfo } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { BigNumber } from "./BigNumberUtils";
 import { getNetworkName, chainIsL1, chainIsProd, chainIsSvm } from "./NetworkUtils";
@@ -11,10 +11,10 @@ const { TOKEN_SYMBOLS_MAP, CHAIN_IDs, TOKEN_EQUIVALENCE_REMAPPING } = constants;
 
 type SignerOrProvider = providers.Provider | Signer;
 
-export async function fetchTokenInfo(address: string, signerOrProvider: SignerOrProvider): Promise<L1Token> {
+export async function fetchTokenInfo(address: string, signerOrProvider: SignerOrProvider): Promise<TokenInfo> {
   const token = new Contract(address, ERC20__factory.abi, signerOrProvider);
   const [symbol, decimals] = await Promise.all([token.symbol(), token.decimals()]);
-  return { address, symbol, decimals };
+  return { address: toAddressType(address).forceEvmAddress(), symbol, decimals };
 }
 
 export const getL2TokenAddresses = (
@@ -33,7 +33,7 @@ export const getL2TokenAddresses = (
  * @param chainId Chain ID to query on.
  * @returns Symbol, decimals and contract address on the requested chain.
  */
-export function resolveSymbolOnChain(chainId: number, symbol: string): L1Token {
+export function resolveSymbolOnChain(chainId: number, symbol: string): TokenInfo {
   // @dev Suppress tsc complaints by casting symbol to the expected type.
   const token = TOKEN_SYMBOLS_MAP[symbol as keyof typeof TOKEN_SYMBOLS_MAP];
   if (!isDefined(token) || !isDefined(token.addresses[chainId])) {
@@ -44,7 +44,7 @@ export function resolveSymbolOnChain(chainId: number, symbol: string): L1Token {
   const { decimals, addresses } = token;
   const address = addresses[chainId];
 
-  return { symbol, decimals, address };
+  return { symbol, decimals, address: toAddressType(address, chainId) };
 }
 
 /**
@@ -111,7 +111,7 @@ export function isStablecoin(tokenSymbol: string): boolean {
  * @param tokenMapping
  * @returns
  */
-export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): L1Token {
+export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): TokenInfo {
   const parsedAddress = chainIsSvm(chainId)
     ? toAddressType(l2TokenAddress).toBase58()
     : toAddressType(l2TokenAddress).toEvmAddress();
@@ -128,7 +128,7 @@ export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMappi
     tokenObject = tokenMapping[l1TokenSymbol as keyof typeof tokenMapping];
   }
   return {
-    address: l2TokenAddress,
+    address: toAddressType(l2TokenAddress, chainId),
     symbol: tokenObject.symbol,
     decimals: tokenObject.decimals,
   };