@across-protocol/sdk 4.2.16-alpha.6 → 4.2.16

package/src/utils/AddressUtils.ts

@@ -81,15 +81,15 @@ export function isValidEvmAddress(address: string): boolean {
 export function toAddressType(address: string, chainId: number): Address {
   const rawAddress = address.startsWith("0x") ? utils.arrayify(address) : bs58.decode(address);
 
-  if (chainIsEvm(chainId) && EvmAddress.validate(rawAddress)) return new EvmAddress(rawAddress);
-  else if (chainIsSvm(chainId) && SvmAddress.validate(rawAddress)) return new SvmAddress(rawAddress);
-
-  return new RawAddress(rawAddress);
+  const isEvm = chainIsEvm(chainId);
+  if (isEvm && EvmAddress.validate(rawAddress)) return new EvmAddress(rawAddress);
+  if (!isEvm && SvmAddress.validate(rawAddress)) return new SvmAddress(rawAddress);
+  return new Address(rawAddress);
 }
 
 // The Address class can contain any address type. It is up to the subclasses to determine how to format the address's internal representation,
 // which for this class, is a bytes32 hex string.
-export abstract class Address {
+export class Address {
   readonly rawAddress: Uint8Array;
 
   // Keep all address types in cache so that we may lazily evaluate them when necessary.
@@ -109,6 +109,10 @@ export abstract 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 {
@@ -163,6 +167,11 @@ export abstract class Address {
     return false;
   }
 
+  // Checks if the object is an address by looking at whether it has an Address constructor.
+  static isAddress(obj: unknown): boolean {
+    return obj instanceof this;
+  }
+
   // Converts the input address to a 32-byte hex data string.
   toString(): string {
     return this.toNative();
@@ -184,7 +193,6 @@ export abstract class Address {
   }
 
   // Compares Addresses by first converting them to BigNumbers.
-  // note: Intended for use when sorting like addresses.
   compare(otherAddress: Address): 1 | -1 | 0 {
     // Convert address strings to BigNumbers and then sort numerical value of the BigNumber, which sorts the addresses
     // effectively by their hex value.
@@ -199,18 +207,20 @@ export abstract class Address {
     }
   }
 
-  isEVM(): this is EvmAddress {
-    return false;
+  static isEvmAddress(address: Address): boolean {
+    return address instanceof EvmAddress;
   }
 
-  isSVM(): this is SvmAddress {
-    return false;
+  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.
 export class EvmAddress extends Address {
-  private readonly _type = "evm";
+  // @dev This property is required for Typescript typechecker to know to distinguish between `Address`, `SvmAddress` and `EvmAddress`.
+  // Otherwise it lets any of these to use in place where other is expected.
+  private readonly _brandEvmAddress!: void;
 
   // On construction, validate that the address can indeed be coerced into an EVM address. Throw immediately if it cannot.
   constructor(rawAddress: Uint8Array) {
@@ -219,7 +229,8 @@ export class EvmAddress extends Address {
     }
 
     super(rawAddress);
-    this._type; // tsc noUnusedLocals appeasement.
+    // @dev required for TS to compile with `noUnusedLocals` rule
+    this._brandEvmAddress;
   }
 
   static validate(rawAddress: Uint8Array): boolean {
@@ -228,24 +239,34 @@ export class EvmAddress extends Address {
     );
   }
 
-  override isEVM(): this is EvmAddress {
-    return true;
-  }
-
   // Override `toAddress` to return the 20-byte representation address.
   override toNative(): string {
     return this.toEvmAddress();
   }
 
   // Constructs a new EvmAddress type.
-  static from(address: string, encoding: "base58" | "base16" = "base16"): EvmAddress {
-    return encoding === "base16" ? new this(utils.arrayify(address)) : new this(bs58.decode(address));
+  static from(address: string, encoding: "base16" | "base58" = "base16"): EvmAddress {
+    if (encoding === "base16") {
+      return new this(utils.arrayify(address));
+    }
+
+    const decodedAddress = bs58.decode(address);
+    const padding = decodedAddress.subarray(0, 12);
+    const evmAddress = decodedAddress.subarray(12);
+
+    if (padding.length !== 12 || utils.stripZeros(padding).length !== 0 || evmAddress.length !== 20) {
+      throw new Error(`Not a valid base58-encoded EVM address: ${address}`);
+    }
+
+    return new this(evmAddress);
   }
 }
 
 // Subclass of address which strictly deals SVM addresses. These addresses are guaranteed to be valid SVM addresses, so `toBase58` will always produce a valid Solana address.
 export class SvmAddress extends Address {
-  private readonly _type = "svm";
+  // @dev This property is required for Typescript typechecker to know to distinguish between `Address`, `SvmAddress` and `EvmAddress`.
+  // Otherwise it lets any of these to use in place where other is expected.
+  private readonly _brandSvmAddress!: void;
 
   // On construction, validate that the address is a point on Curve25519. Throw immediately if it is not.
   constructor(rawAddress: Uint8Array) {
@@ -254,21 +275,12 @@ export class SvmAddress extends Address {
     }
 
     super(rawAddress);
-    this._type; // tsc noUnusedLocals appeasement.
+    // @dev required for TS to compile with `noUnusedLocals` rule
+    this._brandSvmAddress;
   }
 
   static validate(rawAddress: Uint8Array): boolean {
-    // Deliberately invalidate SVM addresses w/ the upper 12 bytes zeroed. These addresses are technically valid
-    // but highly improbable and are much more likely to be a mistaken interpretation of an EVM address. Err on
-    // the side of caution for the time being. Exception: Permit the zero address (i.e. for exclusiverRelayer).
-    return (
-      rawAddress.length === 32 &&
-      (!rawAddress.slice(0, 12).every((field) => field === 0) || rawAddress.every((field) => field === 0))
-    );
-  }
-
-  override isSVM(): this is SvmAddress {
-    return true;
+    return rawAddress.length === 32;
   }
 
   // Override the toAddress function for SVM addresses only since while they will never have a defined 20-byte representation. The base58 encoded addresses are also the encodings
@@ -279,15 +291,15 @@ export class SvmAddress extends Address {
 
   // Constructs a new SvmAddress type.
   static from(address: string, encoding: "base58" | "base16" = "base58"): SvmAddress {
-    return encoding === "base58" ? new this(bs58.decode(address)) : new this(utils.arrayify(address));
-  }
-}
+    if (encoding === "base58") {
+      return new this(bs58.decode(address));
+    }
 
-export class RawAddress extends Address {
-  private readonly _type = "raw";
+    const decodedAddress = utils.arrayify(address);
+    if (decodedAddress.length !== 32) {
+      throw new Error(`Not a valid base16-encoded SVM address: ${address}`);
+    }
 
-  constructor(rawAddress: Uint8Array) {
-    super(rawAddress);
-    this._type; // tsc noUnusedLocals appeasement.
+    return new this(decodedAddress);
   }
 }

package/src/utils/NetworkUtils.ts

@@ -21,7 +21,7 @@ export const hreNetworks: Record<number, string> = {
  */
 export function getNetworkName(networkId: number | string): string {
   networkId = Number(networkId);
-  return PUBLIC_NETWORKS[networkId]?.name ?? hreNetworks[networkId] ?? "unknown";
+  return PUBLIC_NETWORKS[networkId]?.name ?? hreNetworks[networkId] ?? `unknown (${networkId})`;
 }
 
 /**

package/src/utils/SpokeUtils.ts

@@ -1,9 +1,9 @@
 import { encodeAbiParameters, Hex, keccak256 } from "viem";
 import { fixedPointAdjustment as fixedPoint } from "./common";
-import { MAX_SAFE_DEPOSIT_ID, ZERO_BYTES } from "../constants";
-import { Fill, FillType, RelayData, SlowFillLeaf } from "../interfaces";
+import { MAX_SAFE_DEPOSIT_ID, ZERO_ADDRESS, ZERO_BYTES } from "../constants";
+import { Deposit, Fill, FillType, RelayData, SlowFillLeaf } from "../interfaces";
+import { toBytes32 } from "./AddressUtils";
 import { BigNumber } from "./BigNumberUtils";
-import { Address } from "./AddressUtils";
 import { isMessageEmpty } from "./DepositUtils";
 import { chainIsSvm } from "./NetworkUtils";
 import { svm } from "../arch";
@@ -16,6 +16,28 @@ export function getSlowFillLeafLpFeePct(leaf: SlowFillLeaf): BigNumber {
   const { relayData, updatedOutputAmount } = leaf;
   return relayData.inputAmount.sub(updatedOutputAmount).mul(fixedPoint).div(relayData.inputAmount);
 }
+/**
+ * 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.
@@ -46,14 +68,14 @@ export function getRelayDataHash(relayData: RelayData, destinationChainId: numbe
 
   const _relayData = {
     ...relayData,
-    depositor: relayData.depositor.toBytes32(),
-    recipient: relayData.recipient.toBytes32(),
-    inputToken: relayData.inputToken.toBytes32(),
-    outputToken: relayData.outputToken.toBytes32(),
-    exclusiveRelayer: relayData.exclusiveRelayer.toBytes32(),
+    depositor: toBytes32(relayData.depositor),
+    recipient: toBytes32(relayData.recipient),
+    inputToken: toBytes32(relayData.inputToken),
+    outputToken: toBytes32(relayData.outputToken),
+    exclusiveRelayer: toBytes32(relayData.exclusiveRelayer),
   };
   if (chainIsSvm(destinationChainId)) {
-    return svm.getRelayDataHash(relayData, destinationChainId);
+    return svm.getRelayDataHash(_relayData, destinationChainId);
   }
   return keccak256(encodeAbiParameters(abi, [_relayData, destinationChainId]));
 }
@@ -73,8 +95,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: Address): boolean {
-  return address.toBytes32() === ZERO_BYTES;
+export function isZeroAddress(address: string): boolean {
+  return address === ZERO_ADDRESS || address === ZERO_BYTES;
 }
 
 export function getMessageHash(message: string): string {

package/src/utils/TokenUtils.ts

@@ -1,21 +1,20 @@
-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 { L1Token } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { BigNumber } from "./BigNumberUtils";
 import { getNetworkName, chainIsL1, chainIsProd } from "./NetworkUtils";
 import { isDefined } from "./TypeGuards";
-import { compareAddressesSimple, EvmAddress, toAddressType } from "./AddressUtils";
+import { compareAddressesSimple, toAddressType } from "./AddressUtils";
 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<L1Token> {
   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 };
+  return { address, symbol, decimals };
 }
 
 export const getL2TokenAddresses = (
@@ -34,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): TokenInfo {
+export function resolveSymbolOnChain(chainId: number, symbol: string): L1Token {
   // @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])) {
@@ -43,8 +42,7 @@ export function resolveSymbolOnChain(chainId: number, symbol: string): TokenInfo
   }
 
   const { decimals, addresses } = token;
-  const address = toAddressType(addresses[chainId], chainId);
-  assert(address.isEVM() || address.isSVM());
+  const address = addresses[chainId];
 
   return { symbol, decimals, address };
 }
@@ -113,7 +111,7 @@ export function isStablecoin(tokenSymbol: string): boolean {
  * @param tokenMapping
  * @returns
  */
-export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): TokenInfo {
+export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): L1Token {
   const parsedAddress = toAddressType(l2TokenAddress, chainId).toNative();
 
   // @dev This might give false positives if tokens on different networks have the same address. I'm not sure how
@@ -129,7 +127,7 @@ export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMappi
     tokenObject = tokenMapping[l1TokenSymbol as keyof typeof tokenMapping];
   }
   return {
-    address: toAddressType(l2TokenAddress, chainId),
+    address: l2TokenAddress,
     symbol: tokenObject.symbol,
     decimals: tokenObject.decimals,
   };