@across-protocol/sdk 3.2.11-beta.1 → 3.2.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "3.2.11-beta.1",
+  "version": "3.2.11",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [
@@ -99,8 +99,8 @@
   },
   "dependencies": {
     "@across-protocol/across-token": "^1.0.0",
-    "@across-protocol/constants": "^3.1.18",
-    "@across-protocol/contracts": "^3.0.12-beta.3",
+    "@across-protocol/constants": "^3.1.16",
+    "@across-protocol/contracts": "^3.0.11",
     "@eth-optimism/sdk": "^3.3.1",
     "@ethersproject/bignumber": "^5.7.0",
     "@pinata/sdk": "^2.1.0",

package/src/clients/BundleDataClient/utils/DataworkerUtils.ts

@@ -138,7 +138,7 @@ export function _buildPoolRebalanceRoot(
   // Realized LP fees are keyed the same as running balances and represent the amount of LP fees that should be paid
   // to LP's for each running balance.
 
-  // For each FilledRelay group, identified by { repaymentChainId, L1TokenAddress }, initialize a "running balance"
+  // For each FilledV3Relay group, identified by { repaymentChainId, L1TokenAddress }, initialize a "running balance"
   // to the total refund amount for that group.
   const runningBalances: RunningBalances = {};
   const realizedLpFees: RunningBalances = {};

package/src/clients/SpokePoolClient.ts

@@ -411,7 +411,7 @@ export class SpokePoolClient extends BaseAbstractClient {
    * @note  // We want to find the block range that satisfies these conditions:
    *        // - the low block has deposit count <= targetDepositId
    *        // - the high block has a deposit count > targetDepositId.
-   *        // This way the caller can search for a FundsDeposited event between [low, high] that will always
+   *        // This way the caller can search for a V3FundsDeposited event between [low, high] that will always
    *        // contain the event emitted when deposit ID was incremented to targetDepositId + 1. This is the same transaction
    *        // where the deposit with deposit ID = targetDepositId was created.
    */

package/src/clients/mocks/MockSpokePoolClient.ts

@@ -114,8 +114,6 @@ export class MockSpokePoolClient extends SpokePoolClient {
   // Event signatures. Not strictly required, but they make generated events more recognisable.
   public readonly eventSignatures: Record<string, string> = {
     EnabledDepositRoute: "address,uint256,bool",
-    FilledRelay: "uint256,uint256,uint256,int64,uint32,uint32,address,address,address,bytes",
-    FundsDeposited: "uint256,uint256,uint256,int64,uint32,uint32,address,address,address,bytes",
   };
 
   depositV3(deposit: DepositWithBlock): Log {

package/src/gasPriceOracle/oracle.ts

@@ -24,7 +24,6 @@ export async function getGasPriceEstimate(
   }
 
   const gasPriceFeeds: { [chainId: number]: GasPriceFeed } = {
-    [CHAIN_IDs.ALEPH_ZERO]: arbitrum.eip1559,
     [CHAIN_IDs.ARBITRUM]: arbitrum.eip1559,
     [CHAIN_IDs.BASE]: ethereum.eip1559,
     [CHAIN_IDs.BOBA]: ethereum.legacy,

package/src/providers/retryProvider.ts

@@ -5,6 +5,7 @@ import { getOriginFromURL } from "../utils/NetworkUtils";
 import { CacheProvider } from "./cachedProvider";
 import { compareRpcResults, createSendErrorWithMessage, formatProviderError } from "./utils";
 import { PROVIDER_CACHE_TTL } from "./constants";
+import { JsonRpcError, RpcError } from "./types";
 import { Logger } from "winston";
 
 export class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
@@ -88,9 +89,10 @@ export class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
     ): Promise<[ethers.providers.StaticJsonRpcProvider, unknown]> => {
       return this._trySend(provider, method, params)
         .then((result): [ethers.providers.StaticJsonRpcProvider, unknown] => [provider, result])
-        .catch((err) => {
+        .catch((err: unknown) => {
           // Append the provider and error to the error array.
-          errors.push([provider, err?.stack || err?.toString()]);
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          errors.push([provider, (err as any)?.stack || err?.toString()]);
 
           // If there are no new fallback providers to use, terminate the recursion by throwing an error.
           // Otherwise, we can try to call another provider.
@@ -98,6 +100,11 @@ export class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
             throw err;
           }
 
+          // If one RPC provider reverted, others likely will too. Skip them.
+          if (quorumThreshold === 1 && this.callReverted(method, err)) {
+            throw err;
+          }
+
           // This line does two things:
           // 1. Removes a fallback provider from the array so it cannot be used as a fallback for another required
           // provider.
@@ -260,12 +267,44 @@ export class RetryProvider extends ethers.providers.StaticJsonRpcProvider {
     return response;
   }
 
-  _trySend(provider: ethers.providers.StaticJsonRpcProvider, method: string, params: Array<unknown>): Promise<unknown> {
-    let promise = this._sendAndValidate(provider, method, params);
-    for (let i = 0; i < this.retries; i++) {
-      promise = promise.catch(() => delay(this.delay).then(() => this._sendAndValidate(provider, method, params)));
+  // For an error emitted in response to an eth_call or eth_estimateGas request, determine whether the response body
+  // indicates that the call reverted during execution. The exact RPC responses returned can vary, but `error.body` has
+  // reliably included both the code (typically 3 on revert) and the error message indicating "execution reverted".
+  // This is consistent with section 5.1 of the JSON-RPC spec (https://www.jsonrpc.org/specification).
+  protected callReverted(method: string, error: unknown): boolean {
+    if (!(method === "eth_call" || method === "eth_estimateGas") || !RpcError.is(error)) {
+      return false;
+    }
+
+    let response: unknown;
+    try {
+      response = JSON.parse(error.body);
+    } catch {
+      return false;
+    }
+
+    return JsonRpcError.is(response) && response.error.message.toLowerCase().includes("revert");
+  }
+
+  async _trySend(
+    provider: ethers.providers.StaticJsonRpcProvider,
+    method: string,
+    params: Array<unknown>
+  ): Promise<unknown> {
+    let { retries } = this;
+
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+      const [settled] = await Promise.allSettled([this._sendAndValidate(provider, method, params)]);
+      if (settled.status === "fulfilled") {
+        return settled.value;
+      }
+
+      if (retries-- <= 0 || this.callReverted(method, settled.reason)) {
+        throw settled.reason;
+      }
+      await delay(this.delay);
     }
-    return promise;
   }
 
   _getQuorum(method: string, params: Array<unknown>): number {

package/src/providers/types.ts

@@ -1,2 +1,23 @@
+import { any, literal, nullable, number, string, type, union } from "superstruct";
+
 export type RPCProvider = "ALCHEMY" | "DRPC" | "INFURA" | "INFURA_DIN";
 export type RPCTransport = "https" | "wss";
+
+// JSON-RPC 2.0 Error object
+// See JSON-RPC 2.0 Specification section 5 Reponse object
+// https://www.jsonrpc.org/specification
+export const JsonRpcError = type({
+  jsonrpc: literal("2.0"),
+  id: union([number(), string()]),
+  error: type({
+    code: number(),
+    message: string(),
+    data: nullable(any()),
+  }),
+});
+
+// Generic/unknown RPC error (may embed a JsonRpcError).
+export const RpcError = type({
+  reason: string(),
+  body: string(),
+});

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

@@ -4,11 +4,10 @@ import { getDeployedAddress } from "@across-protocol/contracts";
 import { asL2Provider } from "@eth-optimism/sdk";
 import { providers } from "ethers";
 import { DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
-import { chainIsAlephZero, chainIsMatic, chainIsOPStack, isDefined } from "../../utils";
+import { chainIsMatic, chainIsOPStack, isDefined } from "../../utils";
 import { QueryBase } from "./baseQuery";
 import { PolygonQueries } from "./polygon";
 import { DEFAULT_LOGGER, Logger } from "../relayFeeCalculator";
-import { AlephZeroQueries } from "./alephZero";
 
 /**
  * Some chains have a fixed gas price that is applied to the gas estimates. We should override
@@ -32,6 +31,7 @@ export class QueryBase__factory {
   ): QueryBase {
     assert(isDefined(spokePoolAddress));
 
+    // Currently the only chain that has a custom query class is Polygon
     if (chainIsMatic(chainId)) {
       return new PolygonQueries(
         provider,
@@ -43,19 +43,6 @@ export class QueryBase__factory {
         gasMarkup
       );
     }
-
-    if (chainIsAlephZero(chainId)) {
-      return new AlephZeroQueries(
-        provider,
-        symbolMapping,
-        spokePoolAddress,
-        simulatedRelayerAddress,
-        coingeckoProApiKey,
-        logger,
-        gasMarkup
-      );
-    }
-
     // For OPStack chains, we need to wrap the provider in an L2Provider
     provider = chainIsOPStack(chainId) ? asL2Provider(provider) : provider;
 

package/src/utils/NetworkUtils.ts

@@ -60,15 +60,6 @@ export function chainIsOPStack(chainId: number): boolean {
   return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.OP_STACK;
 }
 
-/**
- * Determines whether a chain ID is an Arbitrum Orbit implementation.
- * @param chainId Chain ID to evaluate.
- * @returns True if chainId is an Orbit chain, otherwise false.
- */
-export function chainIsOrbit(chainId: number): boolean {
-  return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.ORBIT;
-}
-
 /**
  * Determines whether a chain ID is an Arbitrum implementation.
  * @param chainId Chain ID to evaluate.
@@ -78,15 +69,6 @@ export function chainIsArbitrum(chainId: number): boolean {
   return [CHAIN_IDs.ARBITRUM, CHAIN_IDs.ARBITRUM_SEPOLIA].includes(chainId);
 }
 
-/**
- * Determines whether a chain ID is an Aleph0 implementation
- * @param chainId Chain ID to evaluate
- * @returns True if chainId is an Aleph0 chain, otherwise false.
- */
-export function chainIsAlephZero(chainId: number): boolean {
-  return [CHAIN_IDs.ALEPH_ZERO].includes(chainId);
-}
-
 /**
  * Determines whether a chain ID is a Linea implementation.
  * @param chainId Chain ID to evaluate.

package/src/utils/SpokeUtils.ts

@@ -65,7 +65,7 @@ export function populateV3Relay(
  * @note  // We want to find the block range that satisfies these conditions:
  *        // - the low block has deposit count <= targetDepositId
  *        // - the high block has a deposit count > targetDepositId.
- *        // This way the caller can search for a FundsDeposited event between [low, high] that will always
+ *        // This way the caller can search for a V3FundsDeposited event between [low, high] that will always
  *        // contain the event emitted when deposit ID was incremented to targetDepositId + 1. This is the same transaction
  *        // where the deposit with deposit ID = targetDepositId was created.
  */

package/dist/cjs/relayFeeCalculator/chain-queries/alephZero.d.ts

@@ -1,233 +0,0 @@
-import { Logger } from "../relayFeeCalculator";
-import { providers } from "ethers";
-import { QueryBase } from "./baseQuery";
-export declare class AlephZeroQueries extends QueryBase {
-    constructor(provider: providers.Provider, symbolMapping?: {
-        ACX: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        ARB: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        AZERO: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        BAL: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        BADGER: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        BOBA: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        DAI: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        ETH: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        GHO: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        LSK: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        MATIC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        OP: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        POOL: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        SNX: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        UMA: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        USDB: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        USDC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        "USDC.e": {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        USDbC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        USDzC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        USDT: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        WAZERO: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        WETH: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-        WMATIC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            addresses: {
-                [x: number]: string;
-            };
-            coingeckoId: string;
-        };
-    }, spokePoolAddress?: string | undefined, simulatedRelayerAddress?: string, coingeckoProApiKey?: string, logger?: Logger, gasMarkup?: number);
-    getTokenPrice(tokenSymbol: string): Promise<number>;
-}

package/dist/cjs/relayFeeCalculator/chain-queries/alephZero.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlephZeroQueries = void 0;
-var tslib_1 = require("tslib");
-var assert_1 = tslib_1.__importDefault(require("assert"));
-var DeploymentUtils_1 = require("../../utils/DeploymentUtils");
-var relayFeeCalculator_1 = require("../relayFeeCalculator");
-var constants_1 = require("../../constants");
-var Coingecko_1 = require("../../coingecko/Coingecko");
-var utils_1 = require("../../utils");
-var baseQuery_1 = require("./baseQuery");
-var AlephZeroQueries = (function (_super) {
-    tslib_1.__extends(AlephZeroQueries, _super);
-    function AlephZeroQueries(provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, coingeckoProApiKey, logger, gasMarkup) {
-        if (symbolMapping === void 0) { symbolMapping = constants_1.TOKEN_SYMBOLS_MAP; }
-        if (spokePoolAddress === void 0) { spokePoolAddress = (0, DeploymentUtils_1.getDeployedAddress)("SpokePool", constants_1.CHAIN_IDs.ALEPH_ZERO); }
-        if (simulatedRelayerAddress === void 0) { simulatedRelayerAddress = constants_1.DEFAULT_SIMULATED_RELAYER_ADDRESS; }
-        if (logger === void 0) { logger = relayFeeCalculator_1.DEFAULT_LOGGER; }
-        if (gasMarkup === void 0) { gasMarkup = 0; }
-        (0, assert_1.default)((0, utils_1.isDefined)(spokePoolAddress));
-        return _super.call(this, provider, symbolMapping, spokePoolAddress, simulatedRelayerAddress, gasMarkup, logger, coingeckoProApiKey, undefined, "usd") || this;
-    }
-    AlephZeroQueries.prototype.getTokenPrice = function (tokenSymbol) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var coingeckoInstance, _a, tokenPrice, _b, alephZeroPrice;
-            return tslib_1.__generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        if (!this.symbolMapping[tokenSymbol])
-                            throw new Error("".concat(tokenSymbol, " does not exist in mapping"));
-                        coingeckoInstance = Coingecko_1.Coingecko.get(this.logger, this.coingeckoProApiKey);
-                        return [4, coingeckoInstance.getCurrentPriceByContract(this.symbolMapping[tokenSymbol].addresses[constants_1.CHAIN_IDs.MAINNET], "usd")];
-                    case 1:
-                        _a = _c.sent(), tokenPrice = _a[1];
-                        return [4, coingeckoInstance.getCurrentPriceByContract(this.symbolMapping["AZERO"].addresses[constants_1.CHAIN_IDs.MAINNET], "usd")];
-                    case 2:
-                        _b = _c.sent(), alephZeroPrice = _b[1];
-                        return [2, Number((tokenPrice / alephZeroPrice).toFixed(this.symbolMapping["AZERO"].decimals))];
-                }
-            });
-        });
-    };
-    return AlephZeroQueries;
-}(baseQuery_1.QueryBase));
-exports.AlephZeroQueries = AlephZeroQueries;
-//# sourceMappingURL=alephZero.js.map

package/dist/cjs/relayFeeCalculator/chain-queries/alephZero.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"alephZero.js","sourceRoot":"","sources":["../../../../src/relayFeeCalculator/chain-queries/alephZero.ts"],"names":[],"mappings":";;;;AAAA,0DAA4B;AAC5B,+DAAiE;AACjE,4DAA+D;AAE/D,6CAAkG;AAClG,uDAAsD;AACtD,qCAAwC;AACxC,yCAAwC;AAExC;IAAsC,4CAAS;IAC7C,0BACE,QAA4B,EAC5B,aAAiC,EACjC,gBAAwE,EACxE,uBAA2D,EAC3D,kBAA2B,EAC3B,MAA+B,EAC/B,SAAa;QALb,8BAAA,EAAA,gBAAgB,6BAAiB;QACjC,iCAAA,EAAA,uBAAmB,oCAAkB,EAAC,WAAW,EAAE,qBAAS,CAAC,UAAU,CAAC;QACxE,wCAAA,EAAA,0BAA0B,6CAAiC;QAE3D,uBAAA,EAAA,SAAiB,mCAAc;QAC/B,0BAAA,EAAA,aAAa;QAEb,IAAA,gBAAM,EAAC,IAAA,iBAAS,EAAC,gBAAgB,CAAC,CAAC,CAAC;eACpC,kBACE,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,KAAK,CACN;IACH,CAAC;IAEc,wCAAa,GAA5B,UAA6B,WAAmB;;;;;;wBAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;4BAAE,MAAM,IAAI,KAAK,CAAC,UAAG,WAAW,+BAA4B,CAAC,CAAC;wBAC5F,iBAAiB,GAAG,qBAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;wBACvD,WAAM,iBAAiB,CAAC,yBAAyB,CACtE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,qBAAS,CAAC,OAAO,CAAC,EAC5D,KAAK,CACN,EAAA;;wBAHK,KAAiB,SAGtB,EAHQ,UAAU,QAAA;wBAKQ,WAAM,iBAAiB,CAAC,yBAAyB,CAC1E,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,qBAAS,CAAC,OAAO,CAAC,EACxD,KAAK,CACN,EAAA;;wBAHK,KAAqB,SAG1B,EAHQ,cAAc,QAAA;wBAIvB,WAAO,MAAM,CAAC,CAAC,UAAU,GAAG,cAAc,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAC;;;;KAC5F;IACH,uBAAC;AAAD,CAAC,AAtCD,CAAsC,qBAAS,GAsC9C;AAtCY,4CAAgB"}