feat: start using a custom Address class #904
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
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 |
|---|---|---|
|
|
@@ -40,7 +40,7 @@ import { | |
| findFillEvent, | ||
| isZeroValueFillOrSlowFillRequest, | ||
| chainIsEvm, | ||
| Address, | ||
| duplicateEvent, | ||
| } from "../../utils"; | ||
| import winston from "winston"; | ||
|
|
@@ -67,18 +67,20 @@ type DataCache = Record<string, Promise<LoadDataReturnValue>>; | |
| // V3 dictionary helper functions | ||
| function updateExpiredDepositsV3(dict: ExpiredDepositsToRefundV3, deposit: V3DepositWithBlock): void { | ||
| // A deposit refund for a deposit is invalid if the depositor has a bytes32 address input for an EVM chain. It is valid otherwise. | ||
| if (chainIsEvm(deposit.originChainId) && !deposit.depositor.isValidEvmAddress()) { | ||
| return; | ||
| } | ||
| const { originChainId, inputToken: _inputToken } = deposit; | ||
| const inputToken = _inputToken.toString(); | ||
|
There was a problem hiding this comment. @dohaki @gsteenkamp89 Can you think of any way we can make the toString automatic, so we can rely on it happening in the background when |
||
| if (!dict?.[originChainId]?.[inputToken]) { | ||
| assign(dict, [originChainId, inputToken], []); | ||
| } | ||
| dict[originChainId][inputToken].push(deposit); | ||
| } | ||
|
|
||
| function updateBundleDepositsV3(dict: BundleDepositsV3, deposit: V3DepositWithBlock): void { | ||
| const { originChainId, inputToken: _inputToken } = deposit; | ||
| const inputToken = _inputToken.toString(); | ||
| if (!dict?.[originChainId]?.[inputToken]) { | ||
| assign(dict, [originChainId, inputToken], []); | ||
| } | ||
|
|
@@ -90,16 +92,16 @@ function updateBundleFillsV3( | |
| fill: V3FillWithBlock, | ||
| lpFeePct: BigNumber, | ||
| repaymentChainId: number, | ||
| repaymentToken: Address, | ||
| repaymentAddress: Address | ||
| ): void { | ||
| // We shouldn't pass any unrepayable fills into this function, so we perform an extra safety check. | ||
| assert( | ||
| chainIsEvm(repaymentChainId) && fill.relayer.isValidEvmAddress(), | ||
| "validatedBundleV3Fills dictionary should only contain fills with valid repayment information" | ||
| ); | ||
| if (!dict?.[repaymentChainId]?.[repaymentToken.toString()]) { | ||
| assign(dict, [repaymentChainId, repaymentToken.toString()], { | ||
| fills: [], | ||
| totalRefundAmount: bnZero, | ||
| realizedLpFees: bnZero, | ||
|
|
@@ -113,7 +115,7 @@ function updateBundleFillsV3( | |
| assign(dict, [repaymentChainId, repaymentToken, "fills"], [bundleFill]); | ||
|
|
||
| // All fills update the bundle LP fees. | ||
| const refundObj = dict[repaymentChainId][repaymentToken.toString()]; | ||
| const realizedLpFee = bundleFill.inputAmount.mul(bundleFill.lpFeePct).div(fixedPointAdjustment); | ||
| refundObj.realizedLpFees = refundObj.realizedLpFees ? refundObj.realizedLpFees.add(realizedLpFee) : realizedLpFee; | ||
|
|
||
|
|
@@ -127,10 +129,11 @@ function updateBundleFillsV3( | |
| // Instantiate dictionary if it doesn't exist. | ||
| refundObj.refunds ??= {}; | ||
|
|
||
| if (refundObj.refunds[bundleFill.relayer.toString()]) { | ||
| refundObj.refunds[bundleFill.relayer.toString()] = | ||
| refundObj.refunds[bundleFill.relayer.toString()].add(refundAmount); | ||
| } else { | ||
| refundObj.refunds[bundleFill.relayer.toString()] = refundAmount; | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -139,18 +142,20 @@ function updateBundleExcessSlowFills( | |
| dict: BundleExcessSlowFills, | ||
| deposit: V3DepositWithBlock & { lpFeePct: BigNumber } | ||
| ): void { | ||
| const { destinationChainId, outputToken: _outputToken } = deposit; | ||
| const outputToken = _outputToken.toString(); | ||
| if (!dict?.[destinationChainId]?.[outputToken]) { | ||
| assign(dict, [destinationChainId, outputToken], []); | ||
| } | ||
| dict[destinationChainId][outputToken].push(deposit); | ||
| } | ||
|
|
||
| function updateBundleSlowFills(dict: BundleSlowFills, deposit: V3DepositWithBlock & { lpFeePct: BigNumber }): void { | ||
| if (chainIsEvm(deposit.destinationChainId) && !deposit.recipient.isValidEvmAddress()) { | ||
| return; | ||
| } | ||
| const { destinationChainId, outputToken: _outputToken } = deposit; | ||
| const outputToken = _outputToken.toString(); | ||
| if (!dict?.[destinationChainId]?.[outputToken]) { | ||
| assign(dict, [destinationChainId, outputToken], []); | ||
| } | ||
|
|
@@ -410,21 +415,23 @@ export class BundleDataClient { | |
| // worst from the relayer's perspective. | ||
| const { relayer, inputAmount: refundAmount } = fill; | ||
| refundsForChain[chainToSendRefundTo] ??= {}; | ||
| refundsForChain[chainToSendRefundTo][repaymentToken.toString()] ??= {}; | ||
| const existingRefundAmount = | ||
| refundsForChain[chainToSendRefundTo][repaymentToken.toString()][relayer.toString()] ?? bnZero; | ||
| refundsForChain[chainToSendRefundTo][repaymentToken.toString()][relayer.toString()] = | ||
| existingRefundAmount.add(refundAmount); | ||
| }); | ||
| } | ||
| return refundsForChain; | ||
| } | ||
|
|
||
| getUpcomingDepositAmount(chainId: number, l2Token: Address, latestBlockToSearch: number): BigNumber { | ||
| if (this.spokePoolClients[chainId] === undefined) { | ||
| return toBN(0); | ||
| } | ||
| return this.spokePoolClients[chainId] | ||
| .getDeposits() | ||
|
There was a problem hiding this comment. @dohaki @gsteenkamp89 Are you aware of any eslint rule we could use to flag checking equality between Address instances? @bmzig has removed all known instances from this PR but it seems like something we'd trip on in future. |
||
| .filter((deposit) => deposit.blockNumber > latestBlockToSearch && deposit.inputToken.eq(l2Token)) | ||
| .reduce((acc, deposit) => { | ||
| return acc.add(deposit.inputAmount); | ||
| }, toBN(0)); | ||
|
|
@@ -546,14 +553,14 @@ export class BundleDataClient { | |
| .filter((leaf) => leaf.rootBundleId === bundle.rootBundleId); | ||
| const executedRefunds: { [tokenAddress: string]: { [relayer: string]: BigNumber } } = {}; | ||
| for (const refundLeaf of executedRefundLeaves) { | ||
| const tokenAddress = refundLeaf.l2TokenAddress.toString(); | ||
| if (executedRefunds[tokenAddress] === undefined) { | ||
| executedRefunds[tokenAddress] = {}; | ||
| } | ||
| const executedTokenRefunds = executedRefunds[tokenAddress]; | ||
|
|
||
| for (let i = 0; i < refundLeaf.refundAddresses.length; i++) { | ||
| const relayer = refundLeaf.refundAddresses[i].toString(); | ||
| const refundAmount = refundLeaf.refundAmounts[i]; | ||
| if (executedTokenRefunds[relayer] === undefined) { | ||
| executedTokenRefunds[relayer] = bnZero; | ||
|
|
@@ -599,15 +606,15 @@ export class BundleDataClient { | |
| return allRefunds; | ||
| } | ||
|
|
||
| getRefundsFor(bundleRefunds: CombinedRefunds, relayer: Address, chainId: number, token: Address): BigNumber { | ||
| if (!bundleRefunds[chainId] || !bundleRefunds[chainId][token.toString()]) { | ||
| return BigNumber.from(0); | ||
| } | ||
| const allRefunds = bundleRefunds[chainId][token.toString()]; | ||
| return allRefunds && allRefunds[relayer.toString()] ? allRefunds[relayer.toString()] : BigNumber.from(0); | ||
bmzig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| getTotalRefund(refunds: CombinedRefunds[], relayer: Address, chainId: number, refundToken: Address): BigNumber { | ||
| return refunds.reduce((totalRefund, refunds) => { | ||
| return totalRefund.add(this.getRefundsFor(refunds, relayer, chainId, refundToken)); | ||
| }, bnZero); | ||
|
|
@@ -820,7 +827,11 @@ export class BundleDataClient { | |
| "Not using correct bundle deposit hash key" | ||
| ); | ||
| if (deposit.blockNumber >= originChainBlockRange[0]) { | ||
| if ( | ||
| bundleDepositsV3?.[originChainId]?.[deposit.inputToken.toString()]?.find((d) => | ||
| duplicateEvent(deposit, d) | ||
| ) | ||
| ) { | ||
| this.logger.debug({ | ||
| at: "BundleDataClient#loadData", | ||
| message: "Duplicate deposit detected", | ||
|
|
||
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.
wdyt about internalising the chain -> address type mapping within the Address class, such that we could write:
!deposit.depositor.isValidOn(deposit.originChainId)?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.
Good call. Done here 16dbd7e