feat: add exponential backoff for withdrawals queries #2133
+32
−11
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import { backOff as _backOff, BackoffOptions } from 'exponential-backoff' | ||
|
|
||
| const backoffOptions: BackoffOptions = { | ||
| startingDelay: 1_000, | ||
| timeMultiple: 1.5 | ||
| } | ||
|
|
||
| export function backOff<T>(request: () => Promise<T>): Promise<T> { | ||
| return _backOff(request, backoffOptions) | ||
| } | ||
|
|
||
| export function wait(ms: number) { | ||
| return new Promise(resolve => setTimeout(resolve, ms)) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| import { constants } from 'ethers' | ||
| import { Provider, BlockTag } from '@ethersproject/providers' | ||
| import { Erc20Bridger, getArbitrumNetwork } from '@arbitrum/sdk' | ||
|
|
||
| import { | ||
| fetchTokenWithdrawalsFromEventLogs, | ||
| FetchTokenWithdrawalsFromEventLogsParams | ||
| } from './fetchTokenWithdrawalsFromEventLogs' | ||
| import { getNonce } from '../AddressUtils' | ||
| import { fetchL2Gateways } from '../fetchL2Gateways' | ||
| import { backOff, wait } from '../ExponentialBackoffUtils' | ||
|
|
||
| async function getGateways(provider: Provider): Promise<{ | ||
| standardGateway: string | ||
| wethGateway: string | ||
| customGateway: string | ||
| otherGateways: string[] | ||
| }> { | ||
| const network = await getArbitrumNetwork(provider) | ||
|
|
||
| const standardGateway = network.tokenBridge?.childErc20Gateway | ||
| const customGateway = network.tokenBridge?.childCustomGateway | ||
| const wethGateway = network.tokenBridge?.childWethGateway | ||
| const otherGateways = await fetchL2Gateways(provider) | ||
|
|
||
| return { | ||
| standardGateway: standardGateway ?? constants.AddressZero, | ||
| wethGateway: wethGateway ?? constants.AddressZero, | ||
| customGateway: customGateway ?? constants.AddressZero, | ||
| otherGateways | ||
| } | ||
| } | ||
|
|
||
| type TokenWithdrawalQuery = { | ||
| params: FetchTokenWithdrawalsFromEventLogsParams | ||
| priority: number | ||
| } | ||
|
|
||
| export type FetchTokenWithdrawalsFromEventLogsSequentiallyParams = { | ||
| sender?: string | ||
| receiver?: string | ||
| provider: Provider | ||
| fromBlock?: BlockTag | ||
| toBlock?: BlockTag | ||
| /** | ||
| * How long to delay in-between queries of different priority. | ||
| */ | ||
| delayMs?: number | ||
| } | ||
|
|
||
| export type FetchTokenWithdrawalsFromEventLogsSequentiallyResult = Awaited< | ||
| ReturnType<Erc20Bridger['getWithdrawalEvents']> | ||
| > | ||
|
|
||
| export async function fetchTokenWithdrawalsFromEventLogsSequentially({ | ||
| sender, | ||
| receiver, | ||
| provider, | ||
| fromBlock = 0, | ||
| toBlock = 'latest', | ||
| delayMs = 2_000 | ||
| }: FetchTokenWithdrawalsFromEventLogsSequentiallyParams): Promise<FetchTokenWithdrawalsFromEventLogsSequentiallyResult> { | ||
| // keep track of priority; increment as queries are added | ||
| let priority = 0 | ||
| // keep track of queries | ||
| const queries: TokenWithdrawalQuery[] = [] | ||
|
|
||
| // helper function to reuse common params | ||
| function buildQueryParams({ | ||
| sender, | ||
| receiver, | ||
| gateways = [] | ||
| }: { | ||
| sender?: string | ||
| receiver?: string | ||
| gateways?: string[] | ||
| }): TokenWithdrawalQuery['params'] { | ||
| return { | ||
| sender, | ||
| receiver, | ||
| fromBlock, | ||
| toBlock, | ||
| l2Provider: provider, | ||
| l2GatewayAddresses: gateways | ||
| } | ||
| } | ||
|
|
||
| // for sanitizing, adding queries and incrementing priority | ||
| function addQuery(params: TokenWithdrawalQuery['params']) { | ||
| const gateways = params.l2GatewayAddresses ?? [] | ||
| const gatewaysSanitized = gateways.filter(g => g !== constants.AddressZero) | ||
|
|
||
| if (gatewaysSanitized.length === 0) { | ||
| return | ||
| } | ||
|
|
||
| queries.push({ | ||
| params: { ...params, l2GatewayAddresses: gatewaysSanitized }, | ||
| priority: ++priority | ||
| }) | ||
| } | ||
|
|
||
| const gateways = await getGateways(provider) | ||
| const senderNonce = await backOff(() => getNonce(sender, { provider })) | ||
|
|
||
| // sender queries; only add if nonce > 0 | ||
| if (senderNonce > 0) { | ||
| addQuery(buildQueryParams({ sender, gateways: [gateways.standardGateway] })) | ||
| addQuery(buildQueryParams({ sender, gateways: [gateways.wethGateway] })) | ||
| addQuery(buildQueryParams({ sender, gateways: [gateways.customGateway] })) | ||
| addQuery(buildQueryParams({ sender, gateways: gateways.otherGateways })) | ||
| } | ||
|
|
||
| // receiver queries | ||
| addQuery(buildQueryParams({ receiver, gateways: [gateways.standardGateway] })) | ||
| addQuery(buildQueryParams({ receiver, gateways: [gateways.wethGateway] })) | ||
| addQuery(buildQueryParams({ receiver, gateways: [gateways.customGateway] })) | ||
| addQuery(buildQueryParams({ receiver, gateways: gateways.otherGateways })) | ||
|
|
||
| // for iterating through all priorities in the while loop below | ||
| let currentPriority = 1 | ||
|
|
||
| // final result | ||
| const result: FetchTokenWithdrawalsFromEventLogsSequentiallyResult = [] | ||
|
|
||
| while (currentPriority <= priority) { | ||
| const currentPriorityQueries = queries.filter( | ||
| query => query.priority === currentPriority | ||
| ) | ||
|
|
||
| const currentPriorityResults = await Promise.all( | ||
| currentPriorityQueries.map(query => | ||
| backOff(() => fetchTokenWithdrawalsFromEventLogs(query.params)) | ||
| ) | ||
| ) | ||
|
|
||
| currentPriorityResults.forEach(r => { | ||
| result.push(...r) | ||
| }) | ||
|
|
||
| await wait(delayMs) | ||
|
|
||
| currentPriority++ | ||
| } | ||
|
|
||
| return result | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we want to turn on full jitter?
https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
i think we do?