@across-protocol/sdk 4.2.16-alpha.2 → 4.2.16-alpha.4

package/src/arch/svm/SpokeUtils.ts

@@ -37,6 +37,7 @@ import {
   BigNumber,
   EvmAddress,
   SvmAddress,
+  Address as SdkAddress,
   chainIsSvm,
   chunk,
   isUnsafeDepositId,
@@ -405,6 +406,7 @@ export async function fillRelayInstruction(
   const relayDataHash = new Uint8Array(Buffer.from(_relayDataHash.slice(2), "hex"));
 
   const relayer = SvmAddress.from(signer.address);
+
   // Create ATA for the relayer and recipient token accounts
   const relayerTokenAccount = await getAssociatedTokenAddress(relayer, deposit.outputToken);
 
@@ -425,13 +427,12 @@ export async function fillRelayInstruction(
     program
   );
 
-  // @todo we need to convert the deposit's relayData to svm-like since the interface assumes the data originates
-  // from an EVM Spoke pool. Once we migrate to `Address` types, this can be modified/removed.
-  const [depositor, inputToken] = [deposit.depositor, deposit.inputToken].map(toAddress);
-  const [recipient, outputToken, exclusiveRelayer] = [
+  const [recipient, outputToken, exclusiveRelayer, depositor, inputToken] = [
     deposit.recipient,
     deposit.outputToken,
     deposit.exclusiveRelayer,
+    deposit.depositor,
+    deposit.inputToken,
   ].map(toAddress);
 
   return SvmSpokeClient.getFillRelayInstruction({
@@ -639,7 +640,7 @@ export function getRelayDataHash(relayData: RelayData, destinationChainId: numbe
   const uint32Encoder = getU32Encoder();
 
   assert(relayData.message.startsWith("0x"), "Message must be a hex string");
-  const encodeAddress = (data: SvmAddress) => Uint8Array.from(addressEncoder.encode(toAddress(data)));
+  const encodeAddress = (data: SdkAddress) => Uint8Array.from(addressEncoder.encode(toAddress(data)));
 
   const contentToHash = Buffer.concat([
     encodeAddress(relayData.depositor),

package/src/arch/svm/utils.ts

@@ -17,7 +17,7 @@ import {
 } from "@solana/kit";
 import { SvmSpokeClient } from "@across-protocol/contracts";
 import { FillType, RelayData } from "../../interfaces";
-import { BigNumber, EvmAddress, SvmAddress, getRelayDataHash, isUint8Array } from "../../utils";
+import { BigNumber, SvmAddress, getRelayDataHash, isUint8Array, Address as SdkAddress } from "../../utils";
 import { EventName, SVMEventNames, SVMProvider } from "./types";
 
 /**
@@ -45,7 +45,7 @@ export async function isDevnet(rpc: SVMProvider): Promise<boolean> {
 /**
  * Small utility to convert an Address to a Solana Kit branded type.
  */
-export function toAddress(address: EvmAddress | SvmAddress): Address<string> {
+export function toAddress(address: SdkAddress): Address<string> {
   return address.toBase58() as Address<string>;
 }
 

package/src/clients/BundleDataClient/BundleDataClient.ts

@@ -92,7 +92,7 @@ function updateBundleFillsV3(
   repaymentAddress: Address
 ): void {
   // We shouldn't pass any unrepayable fills into this function, so we perform an extra safety check.
-  if (fill.relayer.isValidOn(repaymentChainId)) {
+  if (!fill.relayer.isValidOn(repaymentChainId)) {
     return;
   }
 

package/src/clients/HubPoolClient.ts

@@ -1010,7 +1010,7 @@ export class HubPoolClient extends BaseAbstractClient {
       const [tokenInfo, lpTokenInfo] = await Promise.all([
         Promise.all(
           uniqueL1Tokens.map(async (l1Token: string) => {
-            const tokenInfo: L1TokenInfo = await fetchTokenInfo(l1Token, this.hubPool.provider);
+            const tokenInfo = await fetchTokenInfo(l1Token, this.hubPool.provider);
             return {
               ...tokenInfo,
               address: EvmAddress.from(l1Token),
@@ -1049,7 +1049,7 @@ export class HubPoolClient extends BaseAbstractClient {
             const args = spreadEventWithBlockNumber(_event) as ProposedRootBundle & { proposer: string };
             return {
               ...args,
-              proposer: toAddressType(args.proposer, this.chainId),
+              proposer: EvmAddress.from(args.proposer),
             };
           })
       );
@@ -1088,7 +1088,7 @@ export class HubPoolClient extends BaseAbstractClient {
         executedRootBundle.runningBalances = runningBalances.slice(0, nTokens);
         const executedRootBundleWithL1Tokens = {
           ...executedRootBundle,
-          l1Tokens: executedRootBundle.l1Tokens.map(toAddressType, this.chainId),
+          l1Tokens: l1Tokens.map((l1Token) => EvmAddress.from(String(l1Token))),
         };
         this.executedRootBundles.push(executedRootBundleWithL1Tokens);
       }

package/src/clients/SpokePoolClient/SpokePoolClient.ts

@@ -594,7 +594,7 @@ export abstract class SpokePoolClient extends BaseAbstractClient {
 
           return {
             ...event,
-            depositor: toAddressType(event.depositor, this.chainId),
+            depositor: EvmAddress.from(event.depositor),
             updatedRecipient: EvmAddress.from(event.updatedRecipient),
           } as SpeedUpWithBlock;
         })

package/src/clients/mocks/MockHubPoolClient.ts

@@ -1,7 +1,7 @@
 import winston from "winston";
 import { Contract } from "ethers";
 import { BigNumber, randomAddress, assign, bnZero, toAddressType, EvmAddress, Address, isDefined } from "../../utils";
-import { TokenInfo, Log, PendingRootBundle, RealizedLpFee, L1TokenInfo } from "../../interfaces";
+import { Log, PendingRootBundle, RealizedLpFee, L1TokenInfo } from "../../interfaces";
 import { AcrossConfigStoreClient as ConfigStoreClient } from "../AcrossConfigStoreClient";
 import { HubPoolClient, HubPoolUpdate, LpFeeRequest } from "../HubPoolClient";
 import { EventManager, EventOverrides, getEventManager } from "./MockEvents";
@@ -83,7 +83,7 @@ export class MockHubPoolClient extends HubPoolClient {
     this.latestHeightSearched = blockNumber;
   }
 
-  addL1Token(l1Token: TokenInfo) {
+  addL1Token(l1Token: L1TokenInfo) {
     this.l1TokensMock.push(l1Token);
   }
 
@@ -132,7 +132,7 @@ export class MockHubPoolClient extends HubPoolClient {
     return l2Token ?? super.getL2TokenForL1TokenAtBlock(l1Token, chainId, blockNumber);
   }
 
-  getTokenInfoForL1Token(l1Token: EvmAddress): TokenInfo | undefined {
+  getTokenInfoForL1Token(l1Token: EvmAddress): L1TokenInfo | undefined {
     return this.l1TokensMock.find((token) => token.address.eq(l1Token));
   }
 

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

@@ -136,7 +136,14 @@ export class SvmQuery implements QueryInterface {
       deposit.destinationChainId
     )
   ) {
-    const { depositor, recipient, inputToken, outputToken, exclusiveRelayer, destinationChainId } = deposit;
+    const {
+      depositor,
+      recipient: _recipient,
+      inputToken,
+      outputToken: _outputToken,
+      exclusiveRelayer,
+      destinationChainId,
+    } = deposit;
 
     const program = toAddress(this.spokePool);
     const _relayDataHash = getRelayDataHash(deposit, destinationChainId);
@@ -147,11 +154,12 @@ export class SvmQuery implements QueryInterface {
       getFillRelayDelegatePda(relayDataHash, BigInt(repaymentChainId), toAddress(repaymentAddress), program),
     ]);
 
+    const [recipient, outputToken] = [_recipient.forceSvmAddress(), _outputToken.forceSvmAddress()];
     const mint = toAddress(outputToken);
     const mintInfo = await fetchMint(this.provider, mint);
 
     const [recipientAta, relayerAta, fillStatus, eventAuthority] = await Promise.all([
-      getAssociatedTokenAddress(deposit.recipient, outputToken, mintInfo.programAddress),
+      getAssociatedTokenAddress(recipient, outputToken, mintInfo.programAddress),
       getAssociatedTokenAddress(SvmAddress.from(relayer.toBase58()), outputToken, mintInfo.programAddress),
       getFillStatusPda(program, deposit, destinationChainId),
       getEventAuthority(program),

package/src/utils/AddressUtils.ts

@@ -218,6 +218,10 @@ export class Address {
 
 // 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 {
+  // @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) {
     if (!EvmAddress.validate(rawAddress)) {
@@ -225,6 +229,8 @@ export class EvmAddress extends Address {
     }
 
     super(rawAddress);
+    // @dev required for TS to compile with `noUnusedLocals` rule
+    this._brandEvmAddress;
   }
 
   static validate(rawAddress: Uint8Array): boolean {
@@ -258,6 +264,10 @@ export class EvmAddress extends Address {
 
 // 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 {
+  // @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) {
     if (!SvmAddress.validate(rawAddress)) {
@@ -265,6 +275,8 @@ export class SvmAddress extends Address {
     }
 
     super(rawAddress);
+    // @dev required for TS to compile with `noUnusedLocals` rule
+    this._brandSvmAddress;
   }
 
   static validate(rawAddress: Uint8Array): boolean {

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 { L1TokenInfo, TokenInfo } from "../interfaces";
+import { TokenInfo } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { BigNumber } from "./BigNumberUtils";
 import { getNetworkName, chainIsL1, chainIsProd } from "./NetworkUtils";
@@ -111,7 +111,7 @@ export function isStablecoin(tokenSymbol: string): boolean {
  * @param tokenMapping
  * @returns
  */
-export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): L1TokenInfo {
+export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): TokenInfo {
   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