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

package/src/clients/HubPoolClient.ts

@@ -213,11 +213,9 @@ export class HubPoolClient extends BaseAbstractClient {
     return l2Token.l2Token;
   }
 
-  // TODO: this might have to deal with truncated Solana addresses? Depends on what input is given actually
-  // TODO: might craete `getL1TokenForL2EVMTokenAtBlock` and some other fn
   // Returns the latest L1 token to use for an L2 token as of the input hub block.
   getL1TokenForL2TokenAtBlock(
-    l2Token: Address, // ! TODO: assuming that for Svm token, we'll have a proper full SvmAddress in this var
+    l2Token: Address,
     destinationChainId: number,
     latestHubBlock = Number.MAX_SAFE_INTEGER
   ): EvmAddress {
@@ -225,11 +223,11 @@ export class HubPoolClient extends BaseAbstractClient {
       .filter((l1Token) => this.l2TokenEnabledForL1Token(EvmAddress.from(l1Token), destinationChainId))
       .map((l1Token) => {
         // Return all matching L2 token mappings that are equal to or earlier than the target block.
+        // @dev Since tokens on L2s (like Solana) can have 32 byte addresses, filter on the lower 20 bytes of the token only.
         return this.l1TokensToDestinationTokensWithBlock[l1Token][destinationChainId].filter(
-          // ! TODO: Okay. Here, in `l1TokensToDestinationTokensWithBlock`, we might be saving truncated solana addresses (as `l1TokensToDestinationTokensWithBlock` is probably generated from events)
-          // ! TODO: Considering this, this filtering should be a bit different. If .isSvmAddress => check not for equality, but for *truncated equality*. If .isEvmAddress, check for equality
           (dstTokenWithBlock) =>
-            dstTokenWithBlock.l2Token.eq(l2Token) && dstTokenWithBlock.blockNumber <= latestHubBlock
+            dstTokenWithBlock.l2Token.truncateToBytes20() === l2Token.truncateToBytes20() &&
+            dstTokenWithBlock.blockNumber <= latestHubBlock
         );
       })
       .flat();
@@ -270,8 +268,7 @@ export class HubPoolClient extends BaseAbstractClient {
         return setPoolRebalanceRouteEvents.some((e) => {
           return (
             e.blockNumber <= hubPoolBlock &&
-            // TODO: compare the last 20 bytes of l2Token only. Solana workaround, is this correct?
-            e.l2Token.eq(l2Token) &&
+            e.l2Token.truncateToBytes20() === l2Token.truncateToBytes20() &&
             Number(_l2ChainId) === l2ChainId
           );
         });
@@ -822,7 +819,6 @@ export class HubPoolClient extends BaseAbstractClient {
     let runningBalance = toBN(0);
     if (executedRootBundle) {
       const indexOfL1Token = executedRootBundle.l1Tokens.findIndex((tokenInBundle) => tokenInBundle.eq(l1Token));
-      // TODO: not sure this if is required. Wasn't here before. Probably `getRunningBalanceForToken` is used on checked tokens only
       if (indexOfL1Token !== -1) {
         runningBalance = executedRootBundle.runningBalances[indexOfL1Token];
       }

package/src/clients/SpokePoolClient/SpokePoolClientManager.ts

@@ -0,0 +1,36 @@
+import winston from "winston";
+import { SpokePoolClient } from "./SpokePoolClient";
+
+/**
+ * SpokePoolClientManager is a wrapper around spokePoolClients. We want to use wrapper almost always
+ * instead of direct access to spokePoolClients because chainId can be invalid and we want to return undefined.
+ */
+export class SpokePoolManager {
+  private spokePoolClients: { [chainId: number]: SpokePoolClient };
+
+  constructor(
+    readonly logger: winston.Logger,
+    spokePoolClients: { [chainId: number]: SpokePoolClient }
+  ) {
+    this.spokePoolClients = spokePoolClients;
+  }
+
+  /**
+   * Retrieves a SpokePoolClient for a given chainId.
+   * @param chainId - The chainId of the spokePoolClient to retrieve.
+   * @returns SpokePoolClient | undefined
+   * @note This method returns SpokePoolClient for given chainId. If its not found, it returns undefined.
+   */
+  getClient(chainId: number): SpokePoolClient | undefined {
+    return this.spokePoolClients[chainId];
+  }
+
+  /**
+   * Retrieves all SpokePoolClients
+   * @returns SpokePoolClient[]
+   * @note This method returns all SpokePoolClients.
+   */
+  getSpokePoolClients(): { [chainId: number]: SpokePoolClient } {
+    return this.spokePoolClients;
+  }
+}

package/src/clients/mocks/MockHubPoolClient.ts

@@ -70,7 +70,7 @@ export class MockHubPoolClient extends HubPoolClient {
       [chainId],
       [
         {
-          spokePool: toAddressType(contract, chainId),
+          spokePool: toAddressType(contract, this.chainId),
           blockNumber: blockNumber,
           transactionIndex: 0,
           logIndex: 0,

package/src/interfaces/HubPool.ts

@@ -93,19 +93,16 @@ export interface LpToken {
   liquidReserves: BigNumber;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface CrossChainContractsSet extends SortableEvent {
   l2ChainId: number;
   spokePool: Address;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface DestinationTokenWithBlock extends SortableEvent {
   l2Token: Address;
   l1Token: EvmAddress;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface SetPoolRebalanceRoot extends SortableEvent {
   destinationChainId: number;
   l1Token: EvmAddress;

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})`;
 }
 
 /**