@across-protocol/sdk 4.1.18 → 4.1.21

package/src/utils/DepositUtils.ts

@@ -5,8 +5,7 @@ import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillReq
 import { getNetworkName } from "./NetworkUtils";
 import { bnZero } from "./BigNumberUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
-import { validateFillForDeposit } from "./FlowUtils";
-import { getMessageHash, isUnsafeDepositId } from "./SpokeUtils";
+import { getMessageHash, isUnsafeDepositId, validateFillForDeposit } from "./SpokeUtils";
 import { getCurrentTime } from "./TimeUtils";
 import { isDefined } from "./TypeGuards";
 import { isDepositFormedCorrectly } from "./ValidatorUtils";

package/src/utils/JSONUtils.ts

@@ -83,3 +83,17 @@ export function jsonReviverWithBigNumbers(_key: string, value: unknown): unknown
   }
   return value;
 }
+
+/**
+ * A replacer for `JSON.stringify` that converts BigInt to a decimal string with 'n' suffix.
+ */
+export function jsonReplacerWithBigInts(_key: string, value: unknown): unknown {
+  return typeof value === "bigint" ? value.toString() + "n" : value;
+}
+
+/**
+ * A reviver for `JSON.parse` that converts strings ending in 'n' back to BigInt.
+ */
+export function jsonReviverWithBigInts(_key: string, value: unknown): unknown {
+  return typeof value === "string" && /^-?\d+n$/.test(value) ? BigInt(value.slice(0, -1)) : value;
+}

package/src/utils/SpokeUtils.ts

@@ -1,6 +1,6 @@
 import assert from "assert";
 import { BytesLike, Contract, PopulatedTransaction, providers, utils as ethersUtils } from "ethers";
-import { CHAIN_IDs, MAX_SAFE_DEPOSIT_ID, ZERO_ADDRESS, ZERO_BYTES } from "../constants";
+import { CHAIN_IDs, MAX_SAFE_DEPOSIT_ID, UNDEFINED_MESSAGE_HASH, ZERO_ADDRESS, ZERO_BYTES } from "../constants";
 import { Deposit, FillStatus, FillWithBlock, RelayData } from "../interfaces";
 import { SpokePoolClient } from "../clients";
 import { chunk } from "./ArrayUtils";
@@ -88,6 +88,47 @@ export function getRelayEventKey(
     .join("-");
 }
 
+const RELAYDATA_KEYS = [
+  "depositId",
+  "originChainId",
+  "destinationChainId",
+  "depositor",
+  "recipient",
+  "inputToken",
+  "inputAmount",
+  "outputToken",
+  "outputAmount",
+  "fillDeadline",
+  "exclusivityDeadline",
+  "exclusiveRelayer",
+  "messageHash",
+] as const;
+
+// Ensure that each deposit element is included with the same value in the fill. This includes all elements defined
+// by the depositor as well as destinationToken, which are pulled from other clients.
+export function validateFillForDeposit(
+  relayData: Omit<RelayData, "message"> & { messageHash: string; destinationChainId: number },
+  deposit?: Omit<Deposit, "quoteTimestamp" | "fromLiteChain" | "toLiteChain">
+): { valid: true } | { valid: false; reason: string } {
+  if (deposit === undefined) {
+    return { valid: false, reason: "Deposit is undefined" };
+  }
+
+  // Note: this short circuits when a key is found where the comparison doesn't match.
+  // TODO: if we turn on "strict" in the tsconfig, the elements of FILL_DEPOSIT_COMPARISON_KEYS will be automatically
+  // validated against the fields in Fill and Deposit, generating an error if there is a discrepency.
+  let invalidKey = RELAYDATA_KEYS.find((key) => relayData[key].toString() !== deposit[key].toString());
+
+  // There should be no paths for `messageHash` to be unset, but mask it off anyway.
+  if (!isDefined(invalidKey) && [relayData.messageHash, deposit.messageHash].includes(UNDEFINED_MESSAGE_HASH)) {
+    invalidKey = "messageHash";
+  }
+
+  return isDefined(invalidKey)
+    ? { valid: false, reason: `${invalidKey} mismatch (${relayData[invalidKey]} != ${deposit[invalidKey]})` }
+    : { valid: true };
+}
+
 /**
  * Find the block range that contains the deposit ID. This is a binary search that searches for the block range
  * that contains the deposit ID.

package/src/utils/index.ts

@@ -9,7 +9,6 @@ export * from "./TypeGuards";
 export * from "./TypeUtils";
 export * from "./TokenUtils";
 export * from "./LogUtils";
-export * from "./FlowUtils";
 export * from "./BundleUtils";
 export * from "./JSONUtils";
 export * from "./IPFSUtils";

package/dist/cjs/utils/FlowUtils.d.ts

@@ -1,11 +0,0 @@
-import { Deposit, RelayData } from "../interfaces";
-export declare const RELAYDATA_KEYS: readonly ["depositId", "originChainId", "destinationChainId", "depositor", "recipient", "inputToken", "inputAmount", "outputToken", "outputAmount", "fillDeadline", "exclusivityDeadline", "exclusiveRelayer", "messageHash"];
-export declare function validateFillForDeposit(relayData: Omit<RelayData, "message"> & {
-    messageHash: string;
-    destinationChainId: number;
-}, deposit?: Omit<Deposit, "quoteTimestamp" | "fromLiteChain" | "toLiteChain">): {
-    valid: true;
-} | {
-    valid: false;
-    reason: string;
-};

package/dist/cjs/utils/FlowUtils.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateFillForDeposit = exports.RELAYDATA_KEYS = void 0;
-var utils_1 = require("../utils");
-var constants_1 = require("../constants");
-exports.RELAYDATA_KEYS = [
-    "depositId",
-    "originChainId",
-    "destinationChainId",
-    "depositor",
-    "recipient",
-    "inputToken",
-    "inputAmount",
-    "outputToken",
-    "outputAmount",
-    "fillDeadline",
-    "exclusivityDeadline",
-    "exclusiveRelayer",
-    "messageHash",
-];
-function validateFillForDeposit(relayData, deposit) {
-    if (deposit === undefined) {
-        return { valid: false, reason: "Deposit is undefined" };
-    }
-    var invalidKey = exports.RELAYDATA_KEYS.find(function (key) { return relayData[key].toString() !== deposit[key].toString(); });
-    if (!(0, utils_1.isDefined)(invalidKey) && [relayData.messageHash, deposit.messageHash].includes(constants_1.UNDEFINED_MESSAGE_HASH)) {
-        invalidKey = "messageHash";
-    }
-    return (0, utils_1.isDefined)(invalidKey)
-        ? { valid: false, reason: "".concat(invalidKey, " mismatch (").concat(relayData[invalidKey], " != ").concat(deposit[invalidKey], ")") }
-        : { valid: true };
-}
-exports.validateFillForDeposit = validateFillForDeposit;
-//# sourceMappingURL=FlowUtils.js.map

package/dist/cjs/utils/FlowUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowUtils.js","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":";;;AAAA,kCAAqC;AAErC,0CAAsD;AAEzC,QAAA,cAAc,GAAG;IAC5B,WAAW;IACX,eAAe;IACf,oBAAoB;IACpB,WAAW;IACX,WAAW;IACX,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,kBAAkB;IAClB,aAAa;CACL,CAAC;AAIX,SAAgB,sBAAsB,CACpC,SAA2F,EAC3F,OAA2E;IAE3E,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC;KACzD;IAKD,IAAI,UAAU,GAAG,sBAAc,CAAC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAArD,CAAqD,CAAC,CAAC;IAGrG,IAAI,CAAC,IAAA,iBAAS,EAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,kCAAsB,CAAC,EAAE;QAC3G,UAAU,GAAG,aAAa,CAAC;KAC5B;IAED,OAAO,IAAA,iBAAS,EAAC,UAAU,CAAC;QAC1B,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAG,UAAU,wBAAc,SAAS,CAAC,UAAU,CAAC,iBAAO,OAAO,CAAC,UAAU,CAAC,MAAG,EAAE;QACzG,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACtB,CAAC;AArBD,wDAqBC"}

package/dist/esm/utils/FlowUtils.d.ts

@@ -1,11 +0,0 @@
-import { Deposit, RelayData } from "../interfaces";
-export declare const RELAYDATA_KEYS: readonly ["depositId", "originChainId", "destinationChainId", "depositor", "recipient", "inputToken", "inputAmount", "outputToken", "outputAmount", "fillDeadline", "exclusivityDeadline", "exclusiveRelayer", "messageHash"];
-export declare function validateFillForDeposit(relayData: Omit<RelayData, "message"> & {
-    messageHash: string;
-    destinationChainId: number;
-}, deposit?: Omit<Deposit, "quoteTimestamp" | "fromLiteChain" | "toLiteChain">): {
-    valid: true;
-} | {
-    valid: false;
-    reason: string;
-};

package/dist/esm/utils/FlowUtils.js

@@ -1,36 +0,0 @@
-import { isDefined } from "../utils";
-import { UNDEFINED_MESSAGE_HASH } from "../constants";
-export var RELAYDATA_KEYS = [
-    "depositId",
-    "originChainId",
-    "destinationChainId",
-    "depositor",
-    "recipient",
-    "inputToken",
-    "inputAmount",
-    "outputToken",
-    "outputAmount",
-    "fillDeadline",
-    "exclusivityDeadline",
-    "exclusiveRelayer",
-    "messageHash",
-];
-// Ensure that each deposit element is included with the same value in the fill. This includes all elements defined
-// by the depositor as well as destinationToken, which are pulled from other clients.
-export function validateFillForDeposit(relayData, deposit) {
-    if (deposit === undefined) {
-        return { valid: false, reason: "Deposit is undefined" };
-    }
-    // Note: this short circuits when a key is found where the comparison doesn't match.
-    // TODO: if we turn on "strict" in the tsconfig, the elements of FILL_DEPOSIT_COMPARISON_KEYS will be automatically
-    // validated against the fields in Fill and Deposit, generating an error if there is a discrepency.
-    var invalidKey = RELAYDATA_KEYS.find(function (key) { return relayData[key].toString() !== deposit[key].toString(); });
-    // There should be no paths for `messageHash` to be unset, but mask it off anyway.
-    if (!isDefined(invalidKey) && [relayData.messageHash, deposit.messageHash].includes(UNDEFINED_MESSAGE_HASH)) {
-        invalidKey = "messageHash";
-    }
-    return isDefined(invalidKey)
-        ? { valid: false, reason: "".concat(invalidKey, " mismatch (").concat(relayData[invalidKey], " != ").concat(deposit[invalidKey], ")") }
-        : { valid: true };
-}
-//# sourceMappingURL=FlowUtils.js.map

package/dist/esm/utils/FlowUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowUtils.js","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD,MAAM,CAAC,IAAM,cAAc,GAAG;IAC5B,WAAW;IACX,eAAe;IACf,oBAAoB;IACpB,WAAW;IACX,WAAW;IACX,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,kBAAkB;IAClB,aAAa;CACL,CAAC;AAEX,mHAAmH;AACnH,qFAAqF;AACrF,MAAM,UAAU,sBAAsB,CACpC,SAA2F,EAC3F,OAA2E;IAE3E,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC;KACzD;IAED,oFAAoF;IACpF,mHAAmH;IACnH,mGAAmG;IACnG,IAAI,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,UAAC,GAAG,IAAK,OAAA,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAArD,CAAqD,CAAC,CAAC;IAErG,kFAAkF;IAClF,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE;QAC3G,UAAU,GAAG,aAAa,CAAC;KAC5B;IAED,OAAO,SAAS,CAAC,UAAU,CAAC;QAC1B,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAG,UAAU,wBAAc,SAAS,CAAC,UAAU,CAAC,iBAAO,OAAO,CAAC,UAAU,CAAC,MAAG,EAAE;QACzG,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACtB,CAAC"}

package/dist/types/utils/FlowUtils.d.ts

@@ -1,12 +0,0 @@
-import { Deposit, RelayData } from "../interfaces";
-export declare const RELAYDATA_KEYS: readonly ["depositId", "originChainId", "destinationChainId", "depositor", "recipient", "inputToken", "inputAmount", "outputToken", "outputAmount", "fillDeadline", "exclusivityDeadline", "exclusiveRelayer", "messageHash"];
-export declare function validateFillForDeposit(relayData: Omit<RelayData, "message"> & {
-    messageHash: string;
-    destinationChainId: number;
-}, deposit?: Omit<Deposit, "quoteTimestamp" | "fromLiteChain" | "toLiteChain">): {
-    valid: true;
-} | {
-    valid: false;
-    reason: string;
-};
-//# sourceMappingURL=FlowUtils.d.ts.map

package/dist/types/utils/FlowUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/FlowUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAGnD,eAAO,MAAM,cAAc,+NAcjB,CAAC;AAIX,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAA;CAAE,EAC3F,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,GAAG,aAAa,CAAC,GAC1E;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAkBpD"}

package/src/utils/FlowUtils.ts

@@ -1,44 +0,0 @@
-import { isDefined } from "../utils";
-import { Deposit, RelayData } from "../interfaces";
-import { UNDEFINED_MESSAGE_HASH } from "../constants";
-
-export const RELAYDATA_KEYS = [
-  "depositId",
-  "originChainId",
-  "destinationChainId",
-  "depositor",
-  "recipient",
-  "inputToken",
-  "inputAmount",
-  "outputToken",
-  "outputAmount",
-  "fillDeadline",
-  "exclusivityDeadline",
-  "exclusiveRelayer",
-  "messageHash",
-] as const;
-
-// Ensure that each deposit element is included with the same value in the fill. This includes all elements defined
-// by the depositor as well as destinationToken, which are pulled from other clients.
-export function validateFillForDeposit(
-  relayData: Omit<RelayData, "message"> & { messageHash: string; destinationChainId: number },
-  deposit?: Omit<Deposit, "quoteTimestamp" | "fromLiteChain" | "toLiteChain">
-): { valid: true } | { valid: false; reason: string } {
-  if (deposit === undefined) {
-    return { valid: false, reason: "Deposit is undefined" };
-  }
-
-  // Note: this short circuits when a key is found where the comparison doesn't match.
-  // TODO: if we turn on "strict" in the tsconfig, the elements of FILL_DEPOSIT_COMPARISON_KEYS will be automatically
-  // validated against the fields in Fill and Deposit, generating an error if there is a discrepency.
-  let invalidKey = RELAYDATA_KEYS.find((key) => relayData[key].toString() !== deposit[key].toString());
-
-  // There should be no paths for `messageHash` to be unset, but mask it off anyway.
-  if (!isDefined(invalidKey) && [relayData.messageHash, deposit.messageHash].includes(UNDEFINED_MESSAGE_HASH)) {
-    invalidKey = "messageHash";
-  }
-
-  return isDefined(invalidKey)
-    ? { valid: false, reason: `${invalidKey} mismatch (${relayData[invalidKey]} != ${deposit[invalidKey]})` }
-    : { valid: true };
-}