@across-protocol/sdk 4.2.0 → 4.2.2-alpha.0

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -25,7 +25,6 @@ import {
   BigNumber,
   bnZero,
   bnOne,
-  toAddress,
   toBytes32,
   spreadEventWithBlockNumber,
 } from "../../utils";
@@ -85,6 +84,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       lastDepositId = _depositIds[i];
     }
   }
+
   _getDepositIdAtBlock(blockTag: number): Promise<BigNumber> {
     return Promise.resolve(this.depositIdAtBlock[blockTag]);
   }
@@ -129,10 +129,6 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     return this._deposit("FundsDeposited", deposit);
   }
 
-  depositV3(deposit: Omit<Deposit, "messageHash"> & Partial<SortableEvent>): Log {
-    return this._deposit("V3FundsDeposited", deposit);
-  }
-
   protected _deposit(event: string, deposit: Omit<Deposit, "messageHash"> & Partial<SortableEvent>): Log {
     const { blockNumber, txnIndex } = deposit;
     let { depositId, destinationChainId, inputAmount, outputAmount } = deposit;
@@ -140,12 +136,11 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     this.numberOfDeposits = depositId.add(bnOne);
 
     destinationChainId ??= random(1, 42161, false);
-    const addressModifier = event === "FundsDeposited" ? toBytes32 : toAddress;
-    const depositor = addressModifier(deposit.depositor ?? randomAddress());
-    const recipient = addressModifier(deposit.recipient ?? depositor);
-    const inputToken = addressModifier(deposit.inputToken ?? randomAddress());
-    const outputToken = addressModifier(deposit.outputToken ?? inputToken);
-    const exclusiveRelayer = addressModifier(deposit.exclusiveRelayer ?? ZERO_ADDRESS);
+    const depositor = toBytes32(deposit.depositor ?? randomAddress());
+    const recipient = toBytes32(deposit.recipient ?? depositor);
+    const inputToken = toBytes32(deposit.inputToken ?? randomAddress());
+    const outputToken = toBytes32(deposit.outputToken ?? inputToken);
+    const exclusiveRelayer = toBytes32(deposit.exclusiveRelayer ?? ZERO_ADDRESS);
 
     inputAmount ??= toBNWei(random(1, 1000, false));
     outputAmount ??= inputAmount.mul(toBN("0.95"));
@@ -180,17 +175,13 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
-  fillV3Relay(fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>): Log {
-    return this._fillRelay("FilledV3Relay", fill);
-  }
-
-  fillRelay(fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>): Log {
+  fillRelay(fill: Omit<Fill, "messageHash"> & { message?: string } & Partial<SortableEvent>): Log {
     return this._fillRelay("FilledRelay", fill);
   }
 
   protected _fillRelay(
     event: string,
-    fill: Omit<Fill, "messageHash"> & { message: string } & Partial<SortableEvent>
+    fill: Omit<Fill, "messageHash"> & { message?: string } & Partial<SortableEvent>
   ): Log {
     const { blockNumber, txnIndex } = fill;
     let { originChainId, depositId, inputAmount, outputAmount, fillDeadline } = fill;
@@ -200,15 +191,14 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     outputAmount ??= inputAmount;
     fillDeadline ??= getCurrentTime() + 60;
 
-    const addressModifier = event === "FilledRelay" ? toBytes32 : toAddress;
-    const depositor = addressModifier(fill.depositor ?? randomAddress());
-    const recipient = addressModifier(fill.recipient ?? depositor);
-    const inputToken = addressModifier(fill.inputToken ?? randomAddress());
-    const outputToken = addressModifier(fill.outputToken ?? ZERO_ADDRESS);
-    const exclusiveRelayer = addressModifier(fill.exclusiveRelayer ?? ZERO_ADDRESS);
-    const relayer = addressModifier(fill.relayer ?? randomAddress());
+    const depositor = toBytes32(fill.depositor ?? randomAddress());
+    const recipient = toBytes32(fill.recipient ?? depositor);
+    const inputToken = toBytes32(fill.inputToken ?? randomAddress());
+    const outputToken = toBytes32(fill.outputToken ?? ZERO_ADDRESS);
+    const exclusiveRelayer = toBytes32(fill.exclusiveRelayer ?? ZERO_ADDRESS);
+    const relayer = toBytes32(fill.relayer ?? randomAddress());
 
-    const topics = [originChainId, depositId, relayer]; // @todo verify
+    const topics = [originChainId, depositId, relayer];
     const message = fill.message ?? EMPTY_MESSAGE;
     const updatedMessage = fill.relayExecutionInfo?.updatedMessage ?? message;
 
@@ -239,25 +229,14 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       },
     };
 
-    const args =
-      event === "FilledRelay"
-        ? {
-            ..._args,
-            messageHash: getMessageHash(message),
-            relayExecutionInfo: {
-              ...relayExecutionInfo,
-              updatedMessageHash: getMessageHash(updatedMessage),
-            },
-          }
-        : {
-            // FilledV3Relay
-            ..._args,
-            message,
-            relayExecutionInfo: {
-              ...relayExecutionInfo,
-              updatedMessage,
-            },
-          };
+    const args = {
+      ..._args,
+      messageHash: getMessageHash(message),
+      relayExecutionInfo: {
+        ...relayExecutionInfo,
+        updatedMessageHash: getMessageHash(updatedMessage),
+      },
+    };
 
     return this.eventManager.generateEvent({
       event,
@@ -269,17 +248,12 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
-  speedUpV3Deposit(speedUp: SpeedUp): Log {
-    return this._speedUpDeposit("RequestedSpeedUpV3Deposit", speedUp);
-  }
-
   speedUpDeposit(speedUp: SpeedUp): Log {
     return this._speedUpDeposit("RequestedSpeedUpDeposit", speedUp);
   }
 
   protected _speedUpDeposit(event: string, speedUp: SpeedUp): Log {
-    const addressModifier = event === "RequestedSpeedUpDeposit" ? toBytes32 : toAddress;
-    const depositor = addressModifier(speedUp.depositor);
+    const depositor = toBytes32(speedUp.depositor);
     const topics = [speedUp.depositId, depositor];
     const args = { ...speedUp };
 
@@ -290,7 +264,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       args: {
         ...args,
         depositor,
-        updatedRecipient: addressModifier(speedUp.updatedRecipient),
+        updatedRecipient: toBytes32(speedUp.updatedRecipient),
       },
     });
   }
@@ -308,24 +282,19 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
     });
   }
 
-  requestV3SlowFill(request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>): Log {
-    return this._requestSlowFill("RequestedV3SlowFill", request);
-  }
-
-  requestSlowFill(request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>): Log {
+  requestSlowFill(request: Omit<SlowFillRequest, "destinationChainId"> & Partial<SortableEvent>): Log {
     return this._requestSlowFill("RequestedSlowFill", request);
   }
 
   protected _requestSlowFill(
     event: string,
-    request: Omit<SlowFillRequest, "messageHash"> & Partial<SortableEvent>
+    request: Omit<SlowFillRequest, "destinationChainId"> & Partial<SortableEvent>
   ): Log {
     const { originChainId, depositId } = request;
     const topics = [originChainId, depositId];
     const args = { ...request };
 
-    const addressModifier = event === "RequestedSlowFill" ? toBytes32 : toAddress;
-    const depositor = addressModifier(args.depositor ?? randomAddress());
+    const depositor = toBytes32(args.depositor ?? randomAddress());
 
     return this.eventManager.generateEvent({
       event,
@@ -333,20 +302,21 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       topics: topics.map((topic) => topic.toString()),
       args: {
         ...args,
+        destinationChainId: this.chainId,
         depositor,
-        recipient: addressModifier(args.recipient ?? depositor),
-        inputToken: addressModifier(args.inputToken ?? randomAddress()),
-        outputToken: addressModifier(args.outputToken ?? ZERO_ADDRESS),
-        exclusiveRelayer: addressModifier(args.exclusiveRelayer ?? ZERO_ADDRESS),
+        recipient: toBytes32(args.recipient ?? depositor),
+        inputToken: toBytes32(args.inputToken ?? randomAddress()),
+        outputToken: toBytes32(args.outputToken ?? ZERO_ADDRESS),
+        exclusiveRelayer: toBytes32(args.exclusiveRelayer ?? ZERO_ADDRESS),
       },
       blockNumber: request.blockNumber,
       transactionIndex: request.txnIndex,
     });
   }
 
-  // This is a simple wrapper around fillV3Relay().
+  // This is a simple wrapper around fillRelay().
   // rootBundleId and proof are discarded here - we have no interest in verifying that.
-  executeV3SlowRelayLeaf(leaf: Omit<SlowFillLeaf, "messageHash">): Log {
+  executeSlowRelayLeaf(leaf: Omit<SlowFillLeaf, "messageHash">): Log {
     const fill = {
       ...leaf.relayData,
       destinationChainId: this.chainId,
@@ -361,7 +331,7 @@ export class MockSpokePoolClient extends EVMSpokePoolClient {
       },
     };
 
-    return this.fillV3Relay(fill);
+    return this.fillRelay(fill);
   }
 
   executeRelayerRefundLeaf(refund: RelayerRefundExecution & Partial<SortableEvent>): Log {

package/src/coingecko/Coingecko.ts

@@ -70,13 +70,14 @@ export class Coingecko {
   private platformIdMap = new Map<number, string>(); // chainId => platform_id (137 => "polygon-pos")
   private tokenIdMap: Record<string, Record<string, string>> = {}; // coinGeckoId => { platform_id : "tokenAddress":}
 
-  public static get(logger: Logger, apiKey?: string) {
+  public static get(logger: Logger, apiKey?: string, customPlatformIdMap?: Record<number, string>) {
     if (!this.instance)
       this.instance = new Coingecko(
         "https://api.coingecko.com/api/v3",
         "https://pro-api.coingecko.com/api/v3",
         logger,
-        apiKey
+        apiKey,
+        customPlatformIdMap
       );
     return this.instance;
   }
@@ -98,7 +99,8 @@ export class Coingecko {
     private readonly host: string,
     private readonly proHost: string,
     private readonly logger: Logger,
-    private readonly apiKey?: string
+    private readonly apiKey?: string,
+    private readonly customPlatformIdMap?: Record<number, string>
   ) {
     this.prices = {};
   }
@@ -115,6 +117,13 @@ export class Coingecko {
       platforms.filter((chain) => Boolean(chain.chain_identifier)).map((chain) => [chain.chain_identifier, chain.id])
     );
 
+    // Extend the platformIdMap with any custom platform ids
+    if (this.customPlatformIdMap) {
+      Object.entries(this.customPlatformIdMap).forEach(([chainId, platformId]) => {
+        this.platformIdMap.set(Number(chainId), platformId);
+      });
+    }
+
     id = this.platformIdMap.get(chainId);
     if (!id) {
       this.logger.error({

package/src/gasPriceOracle/adapters/solana.ts

@@ -34,7 +34,9 @@ export async function messageFee(provider: SVMProvider, opts: GasPriceEstimateOp
 
   // Optionally impose a minimum priority fee, denoted in microLamports/computeUnit.
   const flooredPriorityFeePerGas = parseUnits(process.env[`MIN_PRIORITY_FEE_PER_GAS_${opts.chainId}`] || "0", 6);
-  let microLamportsPerComputeUnit = toBN(totalPrioritizationFees / BigInt(nonzeroPrioritizationFees.length));
+  let microLamportsPerComputeUnit = toBN(
+    totalPrioritizationFees / BigInt(Math.max(nonzeroPrioritizationFees.length, 1))
+  );
   if (microLamportsPerComputeUnit.lt(flooredPriorityFeePerGas)) {
     microLamportsPerComputeUnit = flooredPriorityFeePerGas;
   }

package/src/interfaces/SpokePool.ts

@@ -1,11 +1,8 @@
 import { SortableEvent } from "./Common";
-import { FilledV3RelayEvent, V3FundsDepositedEvent } from "../typechain";
 import { SpokePoolClient } from "../clients";
 import { BigNumber } from "../utils";
 import { RelayerRefundLeaf } from "./HubPool";
 
-export type { FilledV3RelayEvent, V3FundsDepositedEvent };
-
 export interface RelayData {
   originChainId: number;
   depositor: string;
@@ -93,7 +90,7 @@ export interface SpeedUp {
 
 export interface SpeedUpWithBlock extends SpeedUp, SortableEvent {}
 
-export interface SlowFillRequest extends RelayData {
+export interface SlowFillRequest extends Omit<RelayData, "message"> {
   messageHash: string;
   destinationChainId: number;
 }

package/src/utils/TokenUtils.ts

@@ -4,9 +4,9 @@ import * as constants from "../constants";
 import { L1Token } from "../interfaces";
 import { ERC20__factory } from "../typechain";
 import { BigNumber } from "./BigNumberUtils";
-import { getNetworkName, chainIsL1, chainIsProd } from "./NetworkUtils";
+import { getNetworkName, chainIsL1, chainIsProd, chainIsSvm } from "./NetworkUtils";
 import { isDefined } from "./TypeGuards";
-import { compareAddressesSimple } from "./AddressUtils";
+import { compareAddressesSimple, toAddressType } from "./AddressUtils";
 const { TOKEN_SYMBOLS_MAP, CHAIN_IDs, TOKEN_EQUIVALENCE_REMAPPING } = constants;
 
 type SignerOrProvider = providers.Provider | Signer;
@@ -112,9 +112,12 @@ export function isStablecoin(tokenSymbol: string): boolean {
  * @returns
  */
 export function getTokenInfo(l2TokenAddress: string, chainId: number, tokenMapping = TOKEN_SYMBOLS_MAP): L1Token {
+  const parsedAddress = chainIsSvm(chainId)
+    ? toAddressType(l2TokenAddress).toBase58()
+    : toAddressType(l2TokenAddress).toEvmAddress();
   // @dev This might give false positives if tokens on different networks have the same address. I'm not sure how
   // to get around this...
-  let tokenObject = Object.values(tokenMapping).find(({ addresses }) => addresses[chainId] === l2TokenAddress);
+  let tokenObject = Object.values(tokenMapping).find(({ addresses }) => addresses[chainId] === parsedAddress);
   if (!tokenObject) {
     throw new Error(
       `TokenUtils#getTokenInfo: Unable to resolve token in TOKEN_SYMBOLS_MAP for ${l2TokenAddress} on chain ${chainId}`