improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete `getLatestProposedBundleData` #884

nicholaspai · 2025-02-10T17:07:21Z

To be paired with across-protocol/relayer#2085 in order to speed up relayer marginally when pending bundle data is not yet available on Arweave. Also adds safety checks to BundleDataClient in case there are duplicate events

We want to know when these events happen but we currently believe this is possible with the Indexed spoke pool client so we shouldn't throw.

src/clients/SpokePoolClient.ts

pxrl · 2025-02-10T21:17:34Z

src/clients/BundleDataClient/BundleDataClient.ts

+      (d) => d.transactionHash === deposit.transactionHash && d.logIndex === deposit.logIndex
+    )
+  ) {
+    throw new Error("Duplicate deposit in bundleDeposits");


Can we add a log message here to identify the relevant deposits? That will speed up debugging time significantly if we're able to isolate them.

src/clients/BundleDataClient/BundleDataClient.ts

src/clients/SpokePoolClient.ts

nicholaspai · 2025-02-11T00:07:08Z

@bmzig @pxrl if we do experience duplicate events, I can imagine the logs would get very noisy and be distracting. WDYT about emitting one error level log per update() run? 7545cf2

src/clients/BundleDataClient/BundleDataClient.ts

nicholaspai · 2025-02-12T19:45:56Z

src/clients/BundleDataClient/BundleDataClient.ts

@@ -431,52 +438,6 @@ export class BundleDataClient {
      }, toBN(0));
  }

-  private async getLatestProposedBundleData(): Promise<{ bundleData: LoadDataReturnValue; blockRanges: number[][] }> {


We no longer need these functions in across-protocol/relayer#2085

src/clients/BundleDataClient/BundleDataClient.ts

pxrl · 2025-02-13T12:31:13Z

src/clients/BundleDataClient/BundleDataClient.ts

+              if (
+                slowFillRequest.blockNumber >= destinationChainBlockRange[0] &&
+                _canCreateSlowFillLeaf(matchedDeposit) &&
+                !_depositIsExpired(matchedDeposit)


Side note: For a future optimisation, I wonder if this could also exclude slow fills that will be unfillable based on the fillDeadline and the challenge window required at the time of the proposal. Not sure if there are chicken and egg problems there though, since the challenge window could be modified up or down whilst the proposer is building a proposal. It would however be a way of returning deposit refunds to users faster, because the slow-fill that is ultimately unfillable is both an unfortunate use of capital as well as bad UX because the user has to wait for 2 bundles to get their repayment.

I don't think we can do this because of this non-determinism:

since the challenge window could be modified up or down whilst the proposer is building a proposal

We just don't know which block number this bundle will be proposed. Theoretically the mainnet bundle end block could be hours before the proposal lands

pxrl · 2025-02-13T12:46:55Z

src/clients/HubPoolClient.ts

+      return (
+        executedLeaf.blockNumber <= block &&
+        executedLeaf.chainId === chain &&
+        executedLeaf.l1Tokens.map((l1Token) => l1Token.toLowerCase()).includes(l1Token.toLowerCase())


This comparison sticks out to me. l1Token as passed into the function is overridden within the Array.call() closure. Additionally, l1Token is a string in either case, and String.includes() reverts to checking for substrings, rather than a complete match.

Suggested change

executedLeaf.l1Tokens.map((l1Token) => l1Token.toLowerCase()).includes(l1Token.toLowerCase())

executedLeaf.l1Tokens.some((token) => token.toLowerCase() === l1Token.toLowerCase()

thats a good point, though I don't think the .map result matters since the map returns the modified array right? (which is then thrown away)

pxrl · 2025-02-13T12:48:56Z

src/clients/HubPoolClient.ts

+        executedLeaf.chainId === chain &&
+        executedLeaf.l1Tokens.map((l1Token) => l1Token.toLowerCase()).includes(l1Token.toLowerCase())
+      );
+    }) as ExecutedRootBundle;


Is this to ward of an ...is potentially undefined warning? Is it still necessary if the above change is made?

Good call, this is an improvement: 329d44c

src/clients/SpokePoolClient.ts

This reverts commit 7264854.

Co-authored-by: Paul <[email protected]>

pxrl

LGTM!!

* improve: Use optimized version of `getLatestPoolRebalanceRoot` Improves relayer and monitor performance by loading more data from arweave optimistically Depends on across-protocol/sdk#884 * lint * Update Monitor.ts * Update InventoryClient.ts * Update InventoryClient.ts * Update InventoryClient.ts * Update InventoryClient.ts * Update InventoryClient.ts * update * use token balanceOf as fallback * revert balanceOf call * rename funcs to internal * update * improve: Make "new"/"raw" gas price oracle the default * Update gas scalers * lint * Update package.json Co-authored-by: Paul <[email protected]> * Update package.json --------- Co-authored-by: Paul <[email protected]>

improve(BundleDataClient): Log about duplicate destination chain events

b0a7a23

We want to know when these events happen but we currently believe this is possible with the Indexed spoke pool client so we shouldn't throw.

nicholaspai requested review from bmzig and pxrl February 10, 2025 17:07

Log duplicate deposits in spoke pool client

55783b7

nicholaspai changed the title ~~improve(BundleDataClient): Log about duplicate destination chain events~~ improve(BundleDataClient,SpokePoolClient): Log about duplicate events Feb 10, 2025

bmzig reviewed Feb 10, 2025

View reviewed changes

src/clients/SpokePoolClient.ts Show resolved Hide resolved

bmzig reviewed Feb 10, 2025

View reviewed changes

src/clients/SpokePoolClient.ts Outdated Show resolved Hide resolved

nicholaspai added 2 commits February 10, 2025 12:55

getLatestProposedBundleData should never load data from scratch

9850552

lint

1ab05cc

nicholaspai changed the title ~~improve(BundleDataClient,SpokePoolClient): Log about duplicate events~~ improve(BundleDataClient,SpokePoolClient): Log about duplicate events and getLatestProposedBundleData should never load data from scratch Feb 10, 2025

Update BundleDataClient.ts

7c30e1a

nicholaspai requested a review from bmzig February 10, 2025 18:01

Update BundleDataClient.ts

8c066af

pxrl reviewed Feb 10, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 10, 2025

View reviewed changes

src/clients/SpokePoolClient.ts Outdated Show resolved Hide resolved

nicholaspai added 4 commits February 10, 2025 16:34

Update SpokePoolClient.ts

ce0be1d

Update BundleDataClient.ts

bf3bae6

exit after n == 4

faebdb8

Update SpokePoolClient.ts

42fb574

nicholaspai requested a review from pxrl February 10, 2025 21:51

pxrl approved these changes Feb 10, 2025

View reviewed changes

Update BundleDataClient.ts

04d3592

reduce noisiness of logs

7545cf2

Update BundleDataClient.ts

2df77cf

nicholaspai requested a review from pxrl February 11, 2025 00:11

Update SpokePoolClient.ts

3f802dc

bmzig reviewed Feb 11, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

nicholaspai changed the title ~~improve(BundleDataClient,SpokePoolClient): Log about duplicate events and getLatestProposedBundleData should never load data from scratch~~ improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete getLatestProposedBundleData Feb 12, 2025

nicholaspai commented Feb 12, 2025

View reviewed changes

nicholaspai added 2 commits February 12, 2025 14:48

Update package.json

00e1d7b

Update BundleDataClient.ts

6e3ca4d

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/BundleDataClient/BundleDataClient.ts Outdated Show resolved Hide resolved

pxrl reviewed Feb 13, 2025

View reviewed changes

src/clients/SpokePoolClient.ts Outdated Show resolved Hide resolved

nicholaspai and others added 10 commits February 13, 2025 09:51

merge

d6b2a36

Update BundleDataClient.ts

54741d6

Update BundleDataClient.ts

7264854

Revert "Update BundleDataClient.ts"

412fa8f

This reverts commit 7264854.

Update BundleDataClient.ts

337adc8

Update BundleDataClient.ts

988356a

Update BundleDataClient.ts

34b6010

Update src/clients/HubPoolClient.ts

aab61e9

Co-authored-by: Paul <[email protected]>

Update HubPoolClient.ts

329d44c

Update SpokePoolClient.ts

4333390

nicholaspai requested a review from pxrl February 13, 2025 15:06

Update HubPoolClient.ts

70773e2

pxrl approved these changes Feb 13, 2025

View reviewed changes

Update package.json

502ed7f

nicholaspai merged commit 3066c7b into master Feb 13, 2025
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete `getLatestProposedBundleData` #884

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete `getLatestProposedBundleData` #884

nicholaspai commented Feb 10, 2025 •

edited

Loading

pxrl Feb 10, 2025

nicholaspai Feb 10, 2025

nicholaspai commented Feb 11, 2025

nicholaspai Feb 12, 2025

pxrl Feb 13, 2025

nicholaspai Feb 13, 2025

pxrl Feb 13, 2025 •

edited

Loading

nicholaspai Feb 13, 2025

pxrl Feb 13, 2025

nicholaspai Feb 13, 2025

pxrl left a comment

	executedLeaf.l1Tokens.map((l1Token) => l1Token.toLowerCase()).includes(l1Token.toLowerCase())
	executedLeaf.l1Tokens.some((token) => token.toLowerCase() === l1Token.toLowerCase()

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete getLatestProposedBundleData #884

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete getLatestProposedBundleData #884

Conversation

nicholaspai commented Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicholaspai commented Feb 11, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pxrl Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pxrl left a comment

Choose a reason for hiding this comment

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete `getLatestProposedBundleData` #884

improve(BundleDataClient,SpokePoolClient): Log about duplicate events and delete `getLatestProposedBundleData` #884

nicholaspai commented Feb 10, 2025 •

edited

Loading

pxrl Feb 13, 2025 •

edited

Loading