Merge branch 'master' into james/acx-1507-add-ability-to-mock-block-r…

…anges-in-disputer-local-runs

.eslintrc.js

@@ -34,6 +34,7 @@ module.exports = {
     // Disable warnings for { a, b, ...rest } variables, since this is typically used to remove variables.
     "@typescript-eslint/no-unused-vars": ["error", { ignoreRestSiblings: true }],
     "chai-expect/missing-assertion": 2,
+    "no-duplicate-imports": "error",
   },
   settings: {
     node: {

package.json

@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "@across-protocol/contracts-v2": "2.4.3",
-    "@across-protocol/sdk-v2": "0.15.18",
+    "@across-protocol/sdk-v2": "0.15.20",
     "@arbitrum/sdk": "^3.1.3",
     "@defi-wonderland/smock": "^2.3.5",
     "@eth-optimism/sdk": "^3.1.0",
@@ -26,7 +26,7 @@
     "@uma/common": "2.33.0",
     "@uma/contracts-node": "^0.4.16",
     "@uma/financial-templates-lib": "^2.32.11",
-    "@uma/sdk": "^0.34.0",
+    "@uma/sdk": "^0.34.2",
     "async": "^3.2.4",
     "axios": "^1.4.0",
     "dotenv": "^16.3.1",

src/clients/BundleDataClient.ts

@@ -1,4 +1,3 @@
-import { winston, BigNumber, toBN } from "../utils";
 import * as _ from "lodash";
 import {
   DepositWithBlock,
@@ -11,12 +10,13 @@ import {
 } from "../interfaces";
 import { SpokePoolClient } from "../clients";
 import {
+  winston,
+  BigNumber,
+  toBN,
   assignValidFillToFillsToRefund,
   getRefundInformationFromFill,
   updateTotalRefundAmount,
   updateTotalRealizedLpFeePct,
-} from "../utils";
-import {
   flattenAndFilterUnfilledDepositsByOriginChain,
   updateUnfilledDepositsWithMatchedDeposit,
   getUniqueDepositsInRange,
@@ -371,16 +371,14 @@ export class BundleDataClient {
         const fillsForOriginChain = destinationClient
           .getFillsForOriginChain(Number(originChainId))
           .filter((fillWithBlock) => fillWithBlock.blockNumber <= blockRangeForChain[1]);
+        // In the UBA model, fills that request repayment on another chain must send a separate refund request
+        // in order to mark their place in the outflow queue for that chain. This is because the UBA determines
+        // fees based on sequencing of events. Pre-UBA, the fee model treats each fill independently so there
+        // is no need to mark a fill's place in line on the repayment chain.
         await Promise.all(
-          fillsForOriginChain.map(async (fill) => {
-            // In the UBA model, fills that request repayment on another chain must send a separate refund request
-            // in order to mark their place in the outflow queue for that chain. This is because the UBA determines
-            // fees based on sequencing of events. Pre-UBA, the fee model treats each fill independently so there
-            // is no need to mark a fill's place in line on the repayment chain.
-            if (!isUBA || fill.destinationChainId === fill.repaymentChainId) {
-              validateFillAndSaveData(fill, blockRangeForChain);
-            }
-          })
+          fillsForOriginChain
+            .filter((fill) => !isUBA || fill.destinationChainId === fill.repaymentChainId)
+            .map((fill) => validateFillAndSaveData(fill, blockRangeForChain))
         );
       }
 

src/clients/InventoryClient.ts

@@ -4,7 +4,7 @@ import {
   toBN,
   getNetworkName,
   createFormatFunction,
-  etherscanLink,
+  blockExplorerLink,
   Contract,
   runTransaction,
   isDefined,
@@ -362,7 +362,7 @@ export class InventoryClient {
               cumulativeBalance.toString()
             )} ${symbol} over all chains (ignoring hubpool repayments). This chain has a shortfall of ` +
             `${formatter(this.getTokenShortFall(l1Token, chainId).toString())} ${symbol} ` +
-            `tx: ${etherscanLink(hash, this.hubPoolClient.chainId)}\n`;
+            `tx: ${blockExplorerLink(hash, this.hubPoolClient.chainId)}\n`;
         }
       }
 
@@ -502,7 +502,7 @@ export class InventoryClient {
           `${this.formatWei(unwrapWethTarget.toString())} (trigger of ` +
           `${this.formatWei(unwrapWethThreshold.toString())} ETH), ` +
           `current balance of ${this.formatWei(balance.toString())} ` +
-          `tx: ${etherscanLink(hash, chainId)}\n`;
+          `tx: ${blockExplorerLink(hash, chainId)}\n`;
       }
 
       for (const { chainInfo, amount } of unexecutedUnwraps) {

src/clients/TokenClient.ts

@@ -1,7 +1,18 @@
-import { BigNumber, winston, assign, ERC20, Contract, toBN, MAX_SAFE_ALLOWANCE } from "../utils";
-import { runTransaction, getNetworkName, etherscanLink, MAX_UINT_VAL } from "../utils";
 import { HubPoolClient, SpokePoolClient } from ".";
 import { Deposit } from "../interfaces";
+import {
+  BigNumber,
+  Contract,
+  ERC20,
+  MAX_SAFE_ALLOWANCE,
+  MAX_UINT_VAL,
+  assign,
+  blockExplorerLink,
+  getNetworkName,
+  runTransaction,
+  toBN,
+  winston,
+} from "../utils";
 
 type TokenDataType = { [chainId: number]: { [token: string]: { balance: BigNumber; allowance: BigNumber } } };
 type TokenShortfallType = {
@@ -133,9 +144,9 @@ export class TokenClient {
       const contract = new Contract(token, ERC20.abi, targetSpokePool.signer);
       const tx = await runTransaction(this.logger, contract, "approve", [targetSpokePool.address, MAX_UINT_VAL]);
       mrkdwn +=
-        ` - Approved SpokePool ${etherscanLink(targetSpokePool.address, chainId)} ` +
-        `to spend ${await contract.symbol()} ${etherscanLink(token, chainId)} on ${getNetworkName(chainId)}. ` +
-        `tx: ${etherscanLink(tx.hash, chainId)}\n`;
+        ` - Approved SpokePool ${blockExplorerLink(targetSpokePool.address, chainId)} ` +
+        `to spend ${await contract.symbol()} ${blockExplorerLink(token, chainId)} on ${getNetworkName(chainId)}. ` +
+        `tx: ${blockExplorerLink(tx.hash, chainId)}\n`;
     }
     this.logger.info({ at: "TokenBalanceClient", message: "Approved whitelisted tokens! 💰", mrkdwn });
   }
@@ -155,9 +166,9 @@ export class TokenClient {
         MAX_UINT_VAL,
       ]);
       const mrkdwn =
-        ` - Approved HubPool ${etherscanLink(this.hubPoolClient.hubPool.address, 1)} ` +
-        `to spend ${await this.bondToken.symbol()} ${etherscanLink(this.bondToken.address, 1)}. ` +
-        `tx ${etherscanLink(tx.hash, 1)}\n`;
+        ` - Approved HubPool ${blockExplorerLink(this.hubPoolClient.hubPool.address, 1)} ` +
+        `to spend ${await this.bondToken.symbol()} ${blockExplorerLink(this.bondToken.address, 1)}. ` +
+        `tx ${blockExplorerLink(tx.hash, 1)}\n`;
       this.logger.info({ at: "hubPoolClient", message: "Approved bond tokens! 💰", mrkdwn });
     } else {
       this.logger.debug({ at: "hubPoolClient", message: "Bond token approval set" });

src/clients/TransactionClient.ts

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { utils as sdkUtils } from "@across-protocol/sdk-v2";
+import { utils as sdkUtils, typeguards } from "@across-protocol/sdk-v2";
 import {
   winston,
   getNetworkName,
   Contract,
   runTransaction,
   BigNumber,
-  etherscanLink,
+  blockExplorerLink,
   toBNWei,
   TransactionResponse,
   TransactionSimulationResult,
@@ -29,6 +29,7 @@ export interface AugmentedTransaction {
 }
 
 const { fixedPointAdjustment: fixedPoint } = sdkUtils;
+const { isError } = typeguards;
 
 const DEFAULT_GASLIMIT_MULTIPLIER = 1.0;
 
@@ -95,14 +96,16 @@ export class TransactionClient {
           at: "TransactionClient#submit",
           message: `Transaction ${idx + 1} submission on ${networkName} failed or timed out.`,
           mrkdwn,
+          // @dev `error` _sometimes_ doesn't decode correctly (especially on Polygon), so fish for the reason.
+          errorMessage: isError(error) ? (error as Error).message : undefined,
           error,
           notificationPath: "across-error",
         });
         return txnResponses;
       }
 
       nonce = response.nonce + 1;
-      const blockExplorer = etherscanLink(response.hash, txn.chainId);
+      const blockExplorer = blockExplorerLink(response.hash, txn.chainId);
       mrkdwn += `  ${idx + 1}. ${txn.message || "No message"} (${blockExplorer}): ${txn.mrkdwn || "No markdown"}\n`;
       txnResponses.push(response);
     }

src/clients/bridges/ArbitrumAdapter.ts

@@ -9,13 +9,15 @@ import {
   isDefined,
   TransactionResponse,
   resolveTokenSymbols,
+  toBN,
+  toWei,
+  paginatedEventQuery,
+  Event,
 } from "../../utils";
-import { toBN, toWei, paginatedEventQuery, Event } from "../../utils";
 import { SpokePoolClient } from "../../clients";
 import { BaseAdapter } from "./BaseAdapter";
-import { SortableEvent } from "../../interfaces";
+import { SortableEvent, OutstandingTransfers } from "../../interfaces";
 import { constants } from "@across-protocol/sdk-v2";
-import { OutstandingTransfers } from "../../interfaces";
 import { CONTRACT_ADDRESSES } from "../../common";
 const { TOKEN_SYMBOLS_MAP, CHAIN_IDs } = constants;
 

src/clients/bridges/BaseAdapter.ts

@@ -1,31 +1,35 @@
 /* eslint-disable @typescript-eslint/ban-types */
+import { constants as sdkConstants } from "@across-protocol/sdk-v2";
 import { Provider } from "@ethersproject/abstract-provider";
 import { Signer } from "@ethersproject/abstract-signer";
-import { constants as sdkConstants } from "@across-protocol/sdk-v2";
 import { AugmentedTransaction, SpokePoolClient, TransactionClient } from "../../clients";
 import {
-  toBN,
-  MAX_SAFE_ALLOWANCE,
+  AnyObject,
+  BigNumber,
   Contract,
+  DefaultLogLevels,
   ERC20,
-  winston,
   EventSearchConfig,
-  DefaultLogLevels,
+  MAX_SAFE_ALLOWANCE,
+  MAX_UINT_VAL,
   MakeOptional,
-  AnyObject,
-  BigNumber,
-  matchTokenSymbol,
+  TransactionResponse,
   ZERO_ADDRESS,
   assert,
+  blockExplorerLink,
   compareAddressesSimple,
   formatUnitsForToken,
+  getNetworkName,
+  matchTokenSymbol,
+  runTransaction,
+  toBN,
+  winston,
+  createFormatFunction,
+  BigNumberish,
 } from "../../utils";
-import { etherscanLink, getNetworkName, MAX_UINT_VAL, runTransaction } from "../../utils";
 
-import { OutstandingTransfers, SortableEvent } from "../../interfaces";
-import { TransactionResponse } from "../../utils";
 import { CONTRACT_ADDRESSES } from "../../common";
-import { BigNumberish, createFormatFunction } from "../../utils/FormattingUtils";
+import { OutstandingTransfers, SortableEvent } from "../../interfaces";
 interface DepositEvent extends SortableEvent {
   amount: BigNumber;
   to: string;
@@ -149,9 +153,9 @@ export abstract class BaseAdapter {
       const hubNetwork = getNetworkName(hubChainId);
       const spokeNetwork = getNetworkName(this.chainId);
       mrkdwn +=
-        ` - Approved canonical ${spokeNetwork} token bridge ${etherscanLink(targetContract, hubChainId)} ` +
-        `to spend ${await l1Token.symbol()} ${etherscanLink(l1Token.address, hubChainId)} on ${hubNetwork}.` +
-        `tx: ${etherscanLink(receipt.transactionHash, hubChainId)}\n`;
+        ` - Approved canonical ${spokeNetwork} token bridge ${blockExplorerLink(targetContract, hubChainId)} ` +
+        `to spend ${await l1Token.symbol()} ${blockExplorerLink(l1Token.address, hubChainId)} on ${hubNetwork}.` +
+        `tx: ${blockExplorerLink(receipt.transactionHash, hubChainId)}\n`;
     }
     this.log("Approved whitelisted tokens! 💰", { mrkdwn }, "info");
   }

src/clients/bridges/PolygonAdapter.ts

@@ -9,13 +9,14 @@ import {
   BigNumberish,
   TransactionResponse,
   resolveTokenSymbols,
+  ZERO_ADDRESS,
+  spreadEventWithBlockNumber,
+  paginatedEventQuery,
 } from "../../utils";
-import { ZERO_ADDRESS, spreadEventWithBlockNumber, paginatedEventQuery } from "../../utils";
 import { SpokePoolClient } from "../../clients";
 import { BaseAdapter } from "./";
-import { SortableEvent } from "../../interfaces";
+import { SortableEvent, OutstandingTransfers } from "../../interfaces";
 import { constants } from "@across-protocol/sdk-v2";
-import { OutstandingTransfers } from "../../interfaces";
 import { CONTRACT_ADDRESSES } from "../../common";
 const { TOKEN_SYMBOLS_MAP, CHAIN_IDs } = constants;
 

src/clients/bridges/ZKSyncAdapter.ts

@@ -1,4 +1,4 @@
-import { BigNumber, Contract } from "ethers";
+import { BigNumber, BigNumberish, Contract } from "ethers";
 import { BaseAdapter } from "./BaseAdapter";
 import { OutstandingTransfers, SortableEvent } from "../../interfaces";
 import {
@@ -19,7 +19,6 @@ import { TOKEN_SYMBOLS_MAP } from "@across-protocol/contracts-v2";
 import { isDefined } from "../../utils/TypeGuards";
 import { gasPriceOracle, utils } from "@across-protocol/sdk-v2";
 import { zkSync as zkSyncUtils } from "../../utils/chains";
-import { BigNumberish } from "../../utils/FormattingUtils";
 
 /**
  * Responsible for providing a common interface for interacting with the ZKSync Era

src/clients/bridges/op-stack/OpStackAdapter.ts

@@ -7,12 +7,13 @@ import {
   Event,
   checkAddressChecksum,
   ethers,
+  spreadEventWithBlockNumber,
+  assign,
+  winston,
 } from "../../../utils";
-import { spreadEventWithBlockNumber, assign, winston } from "../../../utils";
 import { SpokePoolClient } from "../..";
 import { BaseAdapter } from "..";
-import { SortableEvent } from "../../../interfaces";
-import { OutstandingTransfers } from "../../../interfaces";
+import { SortableEvent, OutstandingTransfers } from "../../../interfaces";
 import { CONTRACT_ADDRESSES } from "../../../common";
 import { constants } from "@across-protocol/sdk-v2";
 import { OpStackBridge } from "./OpStackBridgeInterface";

src/dataworker/Dataworker.ts

@@ -9,8 +9,10 @@ import {
   isDefined,
   buildPoolRebalanceLeafTree,
   updateTotalRefundAmountRaw,
+  toBNWei,
+  getFillsInRange,
+  ZERO_ADDRESS,
 } from "../utils";
-import { toBNWei, getFillsInRange, ZERO_ADDRESS } from "../utils";
 import {
   DepositWithBlock,
   FillsToRefund,
@@ -22,16 +24,14 @@ import {
   SlowFillLeaf,
   SpokePoolClientsByChain,
   UnfilledDeposit,
-} from "../interfaces";
-import {
   PendingRootBundle,
   RunningBalances,
   PoolRebalanceLeaf,
   RelayerRefundLeaf,
   BigNumberForToken,
 } from "../interfaces";
 import { DataworkerClients } from "./DataworkerClientHelper";
-import { SpokePoolClient, UBAClient } from "../clients";
+import { SpokePoolClient, UBAClient, BalanceAllocator } from "../clients";
 import * as PoolRebalanceUtils from "./PoolRebalanceUtils";
 import {
   blockRangesAreInvalidForSpokeClients,
@@ -45,7 +45,6 @@ import {
   _buildRelayerRefundRoot,
   _buildSlowRelayRoot,
 } from "./DataworkerUtils";
-import { BalanceAllocator } from "../clients";
 import _ from "lodash";
 import { spokePoolClientsToProviders } from "../common";
 import * as sdk from "@across-protocol/sdk-v2";