@across-protocol/sdk 4.0.3-beta.0 → 4.0.4

package/src/utils/AddressUtils.ts

@@ -39,10 +39,14 @@ export function compareAddressesSimple(addressA?: string, addressB?: string): bo
   return addressA.toLowerCase() === addressB.toLowerCase();
 }
 
-// Converts an input (assumed to be) bytes32 string into a bytes20 string.
-// If the input is not a bytes32 but is less than type(uint160).max, then this function
-// will still succeed.
-// Throws an error if the string as an unsigned integer is greater than type(uint160).max.
+// Converts an input hex data string into a bytes32 string. Note that the output bytes will be lowercase
+// so that it naturally matches with ethers event data.
+// Throws an error if the input string is already greater than 32 bytes.
+export function toBytes32(address: string): string {
+  return utils.hexZeroPad(address, 32).toLowerCase();
+}
+
+// Checks if the input string can be coerced into a bytes20 evm address. Returns true if it is possible, and false otherwise.
 export function toAddress(hexString: string): string {
   // rawAddress is the address which is not properly checksummed.
   const rawAddress = utils.hexZeroPad(utils.hexStripZeros(hexString), 20);

package/src/utils/CachingUtils.ts

@@ -2,7 +2,7 @@ import { DEFAULT_CACHING_SAFE_LAG, DEFAULT_CACHING_TTL } from "../constants";
 import { CachingMechanismInterface, Deposit, Fill, SlowFillRequest } from "../interfaces";
 import { assert } from "./LogUtils";
 import { composeRevivers, objectWithBigNumberReviver } from "./ReviverUtils";
-import { getRelayHashFromEvent } from "./SpokeUtils";
+import { getRelayEventKey } from "./SpokeUtils";
 import { getCurrentTime } from "./TimeUtils";
 import { isDefined } from "./TypeGuards";
 
@@ -51,6 +51,6 @@ export async function setDepositInCache(
  * @returns The key for caching the event.
  */
 export function getDepositKey(bridgeEvent: Deposit | Fill | SlowFillRequest): string {
-  const relayHash = getRelayHashFromEvent(bridgeEvent);
+  const relayHash = getRelayEventKey(bridgeEvent);
   return `deposit_${bridgeEvent.originChainId}_${bridgeEvent.depositId.toString()}_${relayHash}`;
 }

package/src/utils/DepositUtils.ts

@@ -3,9 +3,10 @@ import { SpokePoolClient } from "../clients";
 import { DEFAULT_CACHING_TTL, EMPTY_MESSAGE, ZERO_BYTES } from "../constants";
 import { CachingMechanismInterface, Deposit, DepositWithBlock, Fill, SlowFillRequest } from "../interfaces";
 import { getNetworkName } from "./NetworkUtils";
+import { bnZero } from "./BigNumberUtils";
 import { getDepositInCache, getDepositKey, setDepositInCache } from "./CachingUtils";
 import { validateFillForDeposit } from "./FlowUtils";
-import { isUnsafeDepositId } from "./SpokeUtils";
+import { getMessageHash, isUnsafeDepositId } from "./SpokeUtils";
 import { getCurrentTime } from "./TimeUtils";
 import { isDefined } from "./TypeGuards";
 import { isDepositFormedCorrectly } from "./ValidatorUtils";
@@ -122,6 +123,8 @@ export async function queryHistoricalDepositForFill(
     }
   }
 
+  deposit.messageHash ??= getMessageHash(deposit.message);
+
   const match = validateFillForDeposit(fill, deposit);
   if (match.valid) {
     return { found: true, deposit };
@@ -146,8 +149,10 @@ export function isZeroValueDeposit(deposit: Pick<Deposit, "inputAmount" | "messa
   return deposit.inputAmount.eq(0) && isMessageEmpty(deposit.message);
 }
 
-export function isZeroValueFillOrSlowFillRequest(e: Pick<Fill | SlowFillRequest, "inputAmount" | "message">): boolean {
-  return e.inputAmount.eq(0) && isFillOrSlowFillRequestMessageEmpty(e.message);
+export function isZeroValueFillOrSlowFillRequest(
+  e: Pick<Fill | SlowFillRequest, "inputAmount" | "messageHash">
+): boolean {
+  return e.inputAmount.eq(bnZero) && e.messageHash === ZERO_BYTES;
 }
 
 /**

package/src/utils/FlowUtils.ts

@@ -1,5 +1,6 @@
 import { isDefined } from "../utils";
 import { Deposit, RelayData } from "../interfaces";
+import { UNDEFINED_MESSAGE_HASH } from "../constants";
 
 export const RELAYDATA_KEYS = [
   "depositId",
@@ -14,14 +15,14 @@ export const RELAYDATA_KEYS = [
   "fillDeadline",
   "exclusivityDeadline",
   "exclusiveRelayer",
-  "message",
+  "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: RelayData & { destinationChainId: number },
-  deposit?: Deposit
+  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" };
@@ -30,7 +31,12 @@ export function validateFillForDeposit(
   // 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.
-  const invalidKey = RELAYDATA_KEYS.find((key) => relayData[key].toString() !== deposit[key].toString());
+  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]})` }

package/src/utils/SpokeUtils.ts

@@ -1,7 +1,7 @@
 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 { Deposit, Fill, FillStatus, FillWithBlock, RelayData, SlowFillRequest } from "../interfaces";
+import { Deposit, FillStatus, FillWithBlock, RelayData } from "../interfaces";
 import { SpokePoolClient } from "../clients";
 import { chunk } from "./ArrayUtils";
 import { BigNumber, toBN, bnOne, bnZero } from "./BigNumberUtils";
@@ -64,7 +64,9 @@ export function populateV3Relay(
  * is required to compute a complete RelayData hash.
  * note: This function should _not_ be used to query the SpokePool.fillStatuses mapping.
  */
-export function getRelayEventKey(data: RelayData & { destinationChainId: number }): string {
+export function getRelayEventKey(
+  data: Omit<RelayData, "message"> & { messageHash: string; destinationChainId: number }
+): string {
   return [
     data.depositor,
     data.recipient,
@@ -78,7 +80,7 @@ export function getRelayEventKey(data: RelayData & { destinationChainId: number
     data.depositId,
     data.fillDeadline,
     data.exclusivityDeadline,
-    data.message,
+    data.messageHash,
   ]
     .map(String)
     .join("-");
@@ -284,7 +286,7 @@ export function getRelayDataHash(relayData: RelayData, destinationChainId: numbe
   );
 }
 
-export function getRelayHashFromEvent(e: Deposit | Fill | SlowFillRequest): string {
+export function getRelayHashFromEvent(e: RelayData & { destinationChainId: number }): string {
   return getRelayDataHash(e, e.destinationChainId);
 }
 
@@ -455,6 +457,7 @@ export async function findFillEvent(
   const fill = {
     ...spreadEventWithBlockNumber(event),
     destinationChainId,
+    messageHash: getMessageHash(event.args.message),
   } as FillWithBlock;
   return fill;
 }