refactor: Generalize inventory accounting and fix Binance CEX pending withdrawal logic#3073
refactor: Generalize inventory accounting and fix Binance CEX pending withdrawal logic#3073nicholaspai wants to merge 80 commits intomasterfrom
Conversation
nicholaspai
requested review from
bmzig,
dohaki,
mrice32 and
pxrl
as code owners
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6f3cbe062b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
In aggregate balance mode, getCurrentAllocationPct reflects the combined balance across all contributor tokens, but withdrawExcessBalances only withdraws the canonical l2Token. Cap the withdrawal amount at the actual l2Token balance to avoid submitting failing transactions when the excess is mostly held in non-canonical contributor tokens (e.g. pathUSD). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update getL2ToL1TokenMap to discover L2 tokens via TOKEN_EQUIVALENCE_REMAPPING in addition to hub chain address matching. This makes pathUSD show up under the USDC row for Tempo in the relayer balance report. Also switch l2TokenAmountToL1TokenAmountConverter to use getInventoryEquivalentL1TokenAddress so it can resolve tokens like pathUSD that have no direct L1 mapping. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…rows in monitor - Bump @across-protocol/constants to ^3.1.101 which adds pathUSD to TOKEN_EQUIVALENCE_REMAPPING, enabling generic resolution without hardcoded mappings. - Generalize monitor balance report to display L2-only equivalence- remapped tokens (pathUSD, USDH) as their own rows, matching how USDC.e is displayed, rather than folding them into the parent token. - Fix RefundChain test: Tempo deposit was spreading uninitialized sampleDepositData (set in a sibling describe's beforeEach). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…tokens L2-only equivalence-remapped tokens (pathUSD, USDH) share the same L1 address as their parent (USDC). The monitor's updateLatestAndFutureRelayerRefunds and updatePendingL2Withdrawals were querying by L1 address for each report row, causing the same refunds/withdrawals to be counted under USDC, pathUSD, and USDH rows simultaneously. Skip these child rows since their refunds are already captured under the parent USDC row. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
pathUSD and USDH were initialized with balance entries for every chain in the report, showing zeroes on chains where they don't exist. Now L2-only equivalence-remapped tokens are initialized and displayed only for chains where they have an address in TOKEN_SYMBOLS_MAP, matching the pattern used for L2_ONLY_TOKENS. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This reverts commit ec31f7f.
- Add doc comments to getInventoryEquivalentL1TokenAddress and getInventoryBalanceContributorTokens in TokenUtils. - Add isL2OnlyEquivalentToken helper to TokenUtils and use it in Monitor instead of raw TOKEN_EQUIVALENCE_REMAPPING lookups. - Use getInventoryBalanceContributorTokens in Monitor's getL2ToL1TokenMap for consistent L2 token discovery. - Simplify TokenClient catch to return empty array with original comment. - Use getInventoryBalanceContributorTokens in InventoryClient's getRemoteTokensForL1Token for non-alias config to include L2-only equivalence-remapped tokens in cumulative balances. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8ac0a1ebc0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex can you respond to all outstanding threads that you started |
|
To use Codex here, create an environment for this repo. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 223e51f0fd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3b5c00cbd4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review for security regressions |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c6f34ddf45
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
1 participant
Summary
Inventory equivalence-remapping generalization
TokenUtilsfunctions (getInventoryEquivalentL1TokenAddress,getInventoryBalanceContributorTokens,isL2OnlyEquivalentToken) that useTOKEN_EQUIVALENCE_REMAPPINGto generically resolve L2-only tokens (e.g. pathUSD, USDH) to their inventory-equivalent L1 token and vice versa — replacing scattered hardcoded symbol checksRunningBalanceUtils.getLatestRunningBalancesfromInventoryClientinto a shared utility so bothInventoryClientandMonitorcan compute approximate running balances without duplicating logicMonitor.reportRelayerBalancesto usegetInventoryBalanceContributorTokensfor per-chain L2 token discovery, batch-fetch all balances in parallel, and produce a single aligned table per token — replacing the old multi-passRelayerBalanceReport/BalanceType/TokenTransferClientapproachBundleDataApproxClientnow returns values in L1 token decimals and groups deposits/refunds across all inventory-equivalent L2 tokens per chain, removing the need for callers to do decimal conversionTokenTransferClient(no longer needed),BalanceType/RelayerBalanceReport/TokenTransferinterfaces, andL2Token/l2OnlyTokensconfig — all replaced by the generic equivalence-remapping utilitieshubPoolClient.getTokenInfoForAddresscalls withgetTokenInfoutility throughoutInventoryClientandMonitor, withprotected getTokenInfooverride pattern for test mockingBinance CEX Bridge pending withdrawal fix
BinanceCEXBridge.getL2PendingWithdrawalAmountto correctly compute outstanding deposits when the Binance finalizer batches deposits from multiple L2s into a single L1 withdrawal. The old approach (total deposits minus total withdrawals per-chain) would incorrectly show zero outstanding when a withdrawal for a different L2's deposit exceeded the current chain's deposit amountgetOutstandingBinanceDepositsintoBinanceUtilsas a pure, testable function. The algorithm computes net outstanding deposit volume across all chains, then attributes it to the newest deposits (newest-first iteration) since the finalizer processes older deposits firstfloatToBNto use string manipulation instead of floating-point arithmetic, preventingMAX_SAFE_INTEGERoverflow for numbers with many decimal digits (e.g.5654.8610313399695 * 10^13). Also handles scientific notation for very small numbersBinanceDeposittype fromBinanceUtilsfor use in testsCross-chain adapter cleanup
BaseChainAdapter.getOutstandingCrossChainTransfersnow skips zero-amount entries instead of always assigning them to the result objectMockLineaEvents.sol) and generic adapter tests to use non-zero amounts and expect empty results when no transfers are outstandingTest improvements
getOutstandingBinanceDeposits,floatToBN, andgetInventoryBalanceContributorTokensInventoryClienttests to use alias config for USDC (matching production config shape)InventoryClient.RefundChaintests to pass upcoming refunds in L1 decimals (matching newBundleDataApproxClientreturn format)Test plan
BinanceUtilsunit tests pass — outstanding deposit matching, partial amounts, cross-chain filteringBNUtilsunit tests pass —floatToBNwith large decimals, scientific notation, string inputsBundleDataApproxClientunit tests pass with L1-decimal-denominated return valuesTokenUtilsunit tests pass forgetInventoryBalanceContributorTokensandgetInventoryEquivalentL1TokenAddressInventoryClienttests pass (55/55) with alias config and L1-decimal refundsMonitortests pass (3/3) withMockMonitoroverride🤖 Generated with Claude Code