RFQ: support multiple rebalance methods #2556
Merged
Conversation
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
WalkthroughThe recent updates focus on refining the rebalance functionality in the inventory management system. Changes include variable renaming for clarity, improved rebalance calculations based on token data, and enhanced error handling. Configuration and testing frameworks now support new rebalance methods, boosting flexibility in managing token balances across diverse blockchain environments. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Deploying sanguine-fe with
|
| Latest commit: |
93d1a3e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://05769513.sanguine-fe.pages.dev |
| Branch Preview URL: | https://feat-multiple-rebalance.sanguine-fe.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (1)
services/rfq/relayer/inventory/manager.go (1)
434-434: Consider handling theRebalanceMethodNonemore explicitly.It might be beneficial to add a log statement or metric recording when no rebalancing is performed due to the method being
None. This could help in debugging and monitoring the system's behavior.
Comment on lines
478
to
480
| manager, ok := i.rebalanceManagers[methodOrigin] | ||
| if !ok { | ||
| return fmt.Errorf("no rebalance manager for method: %s", method) | ||
| return fmt.Errorf("no rebalance manager for method: %s", methodOrigin) |
There was a problem hiding this comment.
Validate the existence of a rebalance manager before attempting to execute.
- manager, ok := i.rebalanceManagers[methodOrigin]
- if !ok {
- return fmt.Errorf("no rebalance manager for method: %s", methodOrigin)
+ if manager, ok := i.rebalanceManagers[methodOrigin]; !ok {
+ return fmt.Errorf("no rebalance manager for method: %s", methodOrigin)
+ } else {
+ err = manager.Execute(ctx, rebalance)
+ if err != nil {
+ return fmt.Errorf("could not execute rebalance: %w", err)
+ }
+ }This change ensures that the method execution is only attempted if the manager exists, reducing the potential for runtime errors.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| manager, ok := i.rebalanceManagers[methodOrigin] | |
| if !ok { | |
| return fmt.Errorf("no rebalance manager for method: %s", method) | |
| return fmt.Errorf("no rebalance manager for method: %s", methodOrigin) | |
| if manager, ok := i.rebalanceManagers[methodOrigin]; !ok { | |
| return fmt.Errorf("no rebalance manager for method: %s", methodOrigin) | |
| } else { | |
| err = manager.Execute(ctx, rebalance) | |
| if err != nil { | |
| return fmt.Errorf("could not execute rebalance: %w", err) | |
| } | |
| } |
Comment on lines
+525
to
+535
| // evaluate the origin and dest of the rebalance based on min/max token balances | ||
| var destTokenData, originTokenData *TokenMetadata | ||
| for _, tokenMap := range tokens { | ||
| for _, tokenData := range tokenMap { | ||
| if tokenData.Name == rebalanceTokenData.Name { | ||
| totalBalance.Add(totalBalance, tokenData.Balance) | ||
| if destTokenData == nil || tokenData.Balance.Cmp(destTokenData.Balance) < 0 { | ||
| destTokenData = tokenData | ||
| } | ||
| if originTokenData == nil || tokenData.Balance.Cmp(originTokenData.Balance) > 0 { | ||
| originTokenData = tokenData | ||
| } |
There was a problem hiding this comment.
Optimize the logic for determining the rebalance origin and destination.
Consider using a more efficient method to determine the minimum and maximum balances, such as maintaining sorted lists of balances or using priority queues. This could significantly reduce the computational complexity, especially if the number of tokens is large.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2556 +/- ##
===================================================
- Coverage 39.18607% 38.94070% -0.24538%
===================================================
Files 91 92 +1
Lines 5627 5683 +56
Branches 83 83
===================================================
+ Hits 2205 2213 +8
- Misses 3229 3271 +42
- Partials 193 199 +6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| } | ||
|
|
||
| // validate the rebalance method pair | ||
| methodOrigin, err := cfg.GetRebalanceMethod(int(originTokenData.ChainID), originTokenData.Addr.Hex()) |
There was a problem hiding this comment.
Remove unnecessary conversions in GetRebalanceMethod calls.
- methodOrigin, err := cfg.GetRebalanceMethod(int(originTokenData.ChainID), originTokenData.Addr.Hex())
+ methodOrigin, err := cfg.GetRebalanceMethod(originTokenData.ChainID, originTokenData.Addr.Hex())
- methodDest, err := cfg.GetRebalanceMethod(int(destTokenData.ChainID), destTokenData.Addr.Hex())
+ methodDest, err := cfg.GetRebalanceMethod(destTokenData.ChainID, destTokenData.Addr.Hex())Also applies to: 559-559
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| methodOrigin, err := cfg.GetRebalanceMethod(int(originTokenData.ChainID), originTokenData.Addr.Hex()) | |
| methodOrigin, err := cfg.GetRebalanceMethod(originTokenData.ChainID, originTokenData.Addr.Hex()) |
| } | ||
| }() | ||
| if originTokenData.ChainID != chainID { | ||
| return nil, nil |
There was a problem hiding this comment.
Use a sentinel error instead of returning both nil error and invalid value.
- return nil, nil
+ return nil, ErrInvalidRebalanceAlso applies to: 572-572
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| return nil, nil | |
| return nil, ErrInvalidRebalance |
| @@ -506,7 +506,7 @@ func (i *inventoryManagerImpl) registerPendingRebalance(ctx context.Context, reb | |||
| return nil | |||
| } | |||
|
|
|||
| //nolint:cyclop,gocognit | |||
| //nolint:cyclop,gocognit,nilnil | |||
There was a problem hiding this comment.
Refactor the getRebalance function to reduce complexity.
Consider breaking down this function into smaller, more manageable functions. This could improve readability and maintainability, especially as the function handles multiple responsibilities such as fetching token metadata, determining rebalance origin and destination, and calculating rebalance amounts.
* Feat: check for unsupported chain in inventory manager * Cleanup: lint
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (6)
services/rfq/relayer/service/handlers.go (3)
98-98: Consider adding a comment explaining the use of thecyclopdirective.Adding a brief comment above the
//nolint:cyclopdirective to explain why it is necessary here (e.g., due to the complexity of the function's logic involving multiple conditions and steps) would improve code maintainability and clarity.
Line range hint
97-140: Review the error handling and event logging for clarity and accuracy.Consider enhancing the clarity of event logs and error messages to provide more detailed context about the failures, especially in a complex function like this which handles multiple conditional branches and external calls.
Line range hint
97-140: Optimize the handling of relay logs to prevent unnecessary status updates.+ if reqID.Status == reldb.RelayStarted { + err = r.db.UpdateQuoteRequestStatus(ctx, req.TransactionId, reldb.RelayCompleted) + if err != nil { + return fmt.Errorf("could not update request status: %w", err) + } + err = r.db.UpdateDestTxHash(ctx, req.TransactionId, req.Raw.TxHash) + if err != nil { + return fmt.Errorf("could not update dest tx hash: %w", err) + } + }Refactoring this block to only execute if the status is
RelayStartedprevents unnecessary database calls and potential errors from incorrect status updates.services/rfq/relayer/inventory/manager.go (3)
Line range hint
86-101: Clarify error handling for unsupported chains inGetCommittableBalance.+ if !ok || gasBalance == nil { + return nil, ErrUnsupportedChain + }This addition ensures that the function returns an appropriate error when it cannot find a gas balance for an unsupported chain, preventing further processing with invalid data.
Line range hint
86-101: Optimize the aggregation logic inGetCommittableBalancesto improve performance.Consider using more efficient data structures or algorithms to handle the aggregation of balances, especially when dealing with a large number of tokens and chains. This could involve using hash maps to track balances and reduce the complexity of the nested loops.
Line range hint
432-484: Refactor theRebalancemethod to simplify its logic and improve readability.Consider breaking down the
Rebalancemethod into smaller, more focused sub-functions. This could involve separating the logic for fetching rebalance methods, building rebalance actions, and executing rebalances into distinct methods. This would make the code easier to understand and maintain.
Comment on lines
+128
to
+136
| if errors.Is(err, inventory.ErrUnsupportedChain) { | ||
| // don't process request if chain is currently unsupported | ||
| span.AddEvent("dropping unsupported chain") | ||
| err = q.db.UpdateQuoteRequestStatus(ctx, request.TransactionID, reldb.WillNotProcess) | ||
| if err != nil { | ||
| return fmt.Errorf("could not update request status: %w", err) | ||
| } | ||
| return nil | ||
| } |
There was a problem hiding this comment.
Ensure proper handling of unsupported chains to prevent processing errors.
+ if err != nil {
+ return fmt.Errorf("could not get committable balance: %w", err)
+ }Adding this check ensures that any errors encountered when fetching the committable balance are properly handled, preventing the function from proceeding with potentially invalid data.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| if errors.Is(err, inventory.ErrUnsupportedChain) { | |
| // don't process request if chain is currently unsupported | |
| span.AddEvent("dropping unsupported chain") | |
| err = q.db.UpdateQuoteRequestStatus(ctx, request.TransactionID, reldb.WillNotProcess) | |
| if err != nil { | |
| return fmt.Errorf("could not update request status: %w", err) | |
| } | |
| return nil | |
| } | |
| if errors.Is(err, inventory.ErrUnsupportedChain) { | |
| // don't process request if chain is currently unsupported | |
| span.AddEvent("dropping unsupported chain") | |
| err = q.db.UpdateQuoteRequestStatus(ctx, request.TransactionID, reldb.WillNotProcess) | |
| if err != nil { | |
| return fmt.Errorf("could not update request status: %w", err) | |
| } | |
| if err != nil { | |
| return fmt.Errorf("could not get committable balance: %w", err) | |
| } | |
| return nil | |
| } |
|
@coderabbitai review |
| @@ -60,7 +59,7 @@ func (s *PricerSuite) TestGetOriginFee() { | |||
| s.Equal(expectedFee, fee) | |||
|
|
|||
| // Ensure that the fee has been cached. | |||
| client.On(testsuite.GetFunctionName(client.HeaderByNumber), mock.Anything, mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
There was a problem hiding this comment.
Consider handling the error from SuggestGasPrice more explicitly in the test.
- client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ s.NotNil(err, "Error should not be nil when header fetch fails")Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| s.NotNil(err, "Error should not be nil when header fetch fails") |
| @@ -109,7 +108,7 @@ | |||
| s.Equal(expectedFee, fee) | |||
|
|
|||
| // Ensure that the fee has been cached. | |||
| client.On(testsuite.GetFunctionName(client.HeaderByNumber), mock.Anything, mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
There was a problem hiding this comment.
Explicit error handling for SuggestGasPrice should be added to ensure robustness.
- client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ s.NotNil(err, "Error should not be nil when header fetch fails")Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| s.NotNil(err, "Error should not be nil when header fetch fails") |
| @@ -145,7 +144,7 @@ | |||
| s.Equal(expectedFee, fee) | |||
|
|
|||
| // Ensure that the fee has been cached. | |||
| client.On(testsuite.GetFunctionName(client.HeaderByNumber), mock.Anything, mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
There was a problem hiding this comment.
Add explicit error handling for SuggestGasPrice to improve test robustness.
- client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ s.NotNil(err, "Error should not be nil when header fetch fails")Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| s.NotNil(err, "Error should not be nil when header fetch fails") |
Comment on lines
+165
to
+166
| currentHeader := big.NewInt(500_000_000_000) // 500 gwei | ||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil) |
There was a problem hiding this comment.
Tip
Codebase Verification
The output from the executed script shows various usages of the SuggestGasPrice function across different files in the codebase. Specifically, in the file services/rfq/relayer/pricer/fee_pricer_test.go, there are multiple instances where the function is mocked with both successful returns and simulated errors (e.g., fmt.Errorf("could not fetch header")). This indicates that error scenarios are being considered and tested.
However, the specific lines mentioned in the review comment (165-166) do not directly handle or assert the error returned by SuggestGasPrice. Instead, they set up a mock expectation that does not include error handling at that point. This suggests that while error handling is tested elsewhere in the file, it may not be directly addressed in the specific instance cited in the review comment.
Given this analysis, it appears that the review comment is accurate in pointing out the need for explicit error handling or assertion in the test at the specified lines. The broader context shows that error handling is considered within the file, but not necessarily in the exact place highlighted by the review comment.
Final Response:
The review comment is correct. The specific lines in question (165-166 in fee_pricer_test.go) do not handle or assert the error from SuggestGasPrice. While error scenarios are tested elsewhere in the file, they are not addressed at the mentioned lines. It would be beneficial to ensure that all instances of this function call within tests are accompanied by appropriate error handling or assertions to maintain consistency and robustness in testing.
- File:
services/rfq/relayer/pricer/fee_pricer_test.go- Lines: 165-166
- Issue: Error from
SuggestGasPriceis not handled or asserted.
Analysis chain
Ensure that the error from SuggestGasPrice is properly handled or asserted in the test.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that error handling for `SuggestGasPrice` is implemented correctly in this context.
# Test: Search for error handling patterns in the function usage. Expect: Proper error handling.
rg --type go $'SuggestGasPrice'
Length of output: 9675
| @@ -194,7 +193,7 @@ | |||
| s.Equal(expectedFee, fee) | |||
|
|
|||
| // Ensure that the fee has been cached. | |||
| client.On(testsuite.GetFunctionName(client.HeaderByNumber), mock.Anything, mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |||
There was a problem hiding this comment.
Consider adding explicit error handling for SuggestGasPrice in this test scenario.
- client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header"))
+ s.NotNil(err, "Error should not be nil when header fetch fails")Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Once().Return(nil, fmt.Errorf("could not fetch header")) | |
| s.NotNil(err, "Error should not be nil when header fetch fails") |
Comment on lines
+252
to
+253
| currentHeader = big.NewInt(200_000_000_000) // 200 gwei | ||
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil) |
There was a problem hiding this comment.
Add explicit error handling for SuggestGasPrice to ensure test robustness.
- client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil)
+ client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil)
+ s.NotNil(err, "Error should not be nil when header fetch fails")Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| currentHeader = big.NewInt(200_000_000_000) // 200 gwei | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil) | |
| currentHeader = big.NewInt(200_000_000_000) // 200 gwei | |
| client.On(testsuite.GetFunctionName(client.SuggestGasPrice), mock.Anything).Return(currentHeader, nil) | |
| s.NotNil(err, "Error should not be nil when header fetch fails") |
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- services/rfq/relayer/quoter/suite_test.go (2 hunks)
Additional comments not posted (1)
services/rfq/relayer/quoter/suite_test.go (1)
110-111: Ensure proper synchronization when using goroutines in tests.
Defi-Moses
added a commit
that referenced
this pull request
May 31, 2024
* Update bl * chore: lint bl * RFQ: support multiple rebalance methods (#2556) * WIP: refactor GetRebalanceMethod() * Feat: implement more robust rebalance method handling * Feat: move method validation to getRebalance() func * Feat: manual impl for String() on RebalanceMethod * Fix: tests * Feat: add rebalance method clauses to TestGetRebalance * Feat: use rebalance.Method to choose executor * Cleanup: lint * [goreleaser] * [goreleaser] * RFQ: drop requests for unsupported chains (#2563) * Feat: check for unsupported chain in inventory manager * Cleanup: lint * [goreleaser] * Fix: check for nil base fee * [goreleaser] * Feat: fee pricer gets gas price from SuggestGasPrice() * [goreleaser] * Fix: tests * lint, add err around clientSuggestGasPrice * Fix: tests --------- Co-authored-by: aureliusbtc <82057759+aureliusbtc@users.noreply.github.com> * RFQ: add decimals cache (#2502) * Feat: add decimalsCache, refactor decimal fetching * Cleanup: comments * Fix: build * Fix: use concurrent map * CCTP: use chain listener instead of scribe (#2592) * WIP: replace scribe with chain listener * Fix: build * Fix: tests * Fix: rfq build * Cleanup: remove unused enum * Cleanup: revert test change * Cleanup: comments * Cleanup: lint * Fix: build * Fix: test * docs(contracts-communication): move natspec from interfaces (#2595) * docs: SynapseExecutionServiceV1 * docs: SynapseGasOracleV1 * docs: Interchain app templates * docs: InterchainClientV1 * docs: InterchainDB * docs: interchain modules * docs: MessageBus * style: make interfaces easier to read * chore: fix linter warnings * Publish - contracts-communication@1.5.4 * fix(sdk-rouder): remove cache hydration (#2597) * fix: disable hydration * chore: don't log quotes in the integration test * Publish - @synapsecns/rest-api@1.0.63 - @synapsecns/sdk-router@0.5.1 - @synapsecns/synapse-interface@0.22.4 - @synapsecns/widget@0.1.17 * update bl * Revert "update bl" This reverts commit ab56c7a. * update bl * feat(webhook): add webhook (#2538) * add models and endpoint, lacking logic * just stuff * just stuff * made general db interface * cleanup * trying to test * trying to test * trying ot fix test * remove interface{} from gorm models, start tests, rework db interface * add signature * secret * look away for now * finish db test * finish tests * add auth * remove debugging log * comments and nits * lint * appsecret and appid * resolve comments * swagger, lint * feat(synapse-interface): maintenance aggregator using PAUSED_CHAINS (#2345) * Aggregate maintenance events for banners and warning message * Dynamically render countdown progress bars based on PAUSED_CHAIN * Dynamically rendering banners * Slightly organize * ChainPause type applied to enforce maintenance event structure, pass in component messages as a prop * Working with multiple events * Add dev comments to MaintenanceBanner; refactor * Add dev comments for MaintenanceWarningMessage; refactor * Dev comments * Organize components * isChainIncluded util * Clean * Add ability to specify paused chains by from/to side (#2346) * Allow indefinite maintenance components by setting end date to null * Banners to show indefinitely as well * Add props to disable banner / warning / countdown * Implement disable warning * Implement disable countdown, bridge pause still working * Example * Clean * Update naming on Bridge page * Update comment for isChainIncluded * Create maintenance events reading from pausedChains.json * Remove custom margins to allow Bridge parent gap styling to handle spacing * Require all props to be defined * Add Swap to maintenance warning messages * Update useMaintenanceCountdownProgresses to allow distinction between Swap and Bridge pauses * Move MaintenanceBanners into LandingPageWrapper so banner appears on all pages * Add ability to specify whether to pause bridge / swap with maintenance event in json * Clean * Unused code * Update dev comments * Update pause start/end time name for legibility * Create type guard to check for paused bridge module * usePausedBridgeModules * usePausedBridgeModules to filter out SDK quotes * Initialize paused routes to handle specific route pauses instead of grouping with chain pauses * Update paused route structure * Filter for valid quotes based on paused routes * Create a Set with paused bridge module names to improve time complexity * Allow for all bridge modules to be paused with ALL * Add ability to pause bridge modules for all chains, if chainId is left undefined * Move json files to /v1/ version control folder * Compare quotes against paused bridge modules more cleanly * Paused bridge modules json control working * Fix pausedChains json * Create examples folder for pause jsons * Retrigger build * Fix banner flashing after clearing * Add padding to banner Close button * Update text sizing on progress bar * Update prop naming to prevent confusion on start/end * Clear chain pauses to ready PR * Change json file naming to be more readable * Use inputWarningMessage prop name to indicate warning placement * Pause Doge activity using Maintenance, to replace prior Chain pause mechanism * Doge chain paused chain prop values * Remove paused from/to chainId constants * Publish - @synapsecns/synapse-interface@0.21.0 * Exempt gh pages (#2541) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Deploy: `FastBridge` to Scroll (#2525) * chore: add Base to `.env.example` * chore: add Scroll config * chore: bump devops dependency * chore: yarn * feat: deploy `FastBridge` on scroll * Publish - FastBridge@0.2.1 * fix: update `forge-std` to 1.8.1, remove `ds-test`, use `solhint` for linting (#2545) * chore: forge-std v1.8.1, remove ds-test dep * chore: remove ds-test from remappings * refactor: state mutability * chore: add solhint * chore: yarn * fix: unused imports * fix: max line length * Publish - contracts-communication@1.3.1 - FastBridge@0.2.2 - @synapsecns/solidity-devops@0.3.3 * chore: remove submodules from `contracts-rfq` (#2547) * build: install OZ as npm module * chore: update remappings * refactor: fix compiler warnings in test contract * chore: remove forge-std submodule * chore: remove `openzeppelin-contracts` submodule * fix: restore padding in `.gitmodules` * Publish - FastBridge@0.2.3 * gogenerate * Revert "gogenerate" This reverts commit b40e602. * im dumb * generate * tidy * update swagger doc * [goreleaser] * [goreleaser] --------- Co-authored-by: shampoobera <shampoo@berachain.com> Co-authored-by: bigboydiamonds <57741810+bigboydiamonds@users.noreply.github.com> Co-authored-by: bigboydiamonds <bigboydiamonds@users.noreply.github.com> Co-authored-by: trajan0x <83933037+trajan0x@users.noreply.github.com> Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> Co-authored-by: χ² <88190723+ChiTimesChi@users.noreply.github.com> Co-authored-by: ChiTimesChi <ChiTimesChi@users.noreply.github.com> * rfq api cache (#2562) * cache api result [goreleaser] * clean up * clean up 2 --------- Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * add trace to sync (#2601) * trace more * cleanup * allow use of mustache templates --------- Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * remove iconfig file (#2602) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * feat(contracts-communication): remove batching (#2599) * feat: scaffold InterchainDB interface changes * feat: scaffold Module interface changes * feat: update InterchainEntry * test: update DB tests * test: update Client tests * refactor: ModuleBatch -> ModuleEntry * feat: remove `entryIndex` from InterchainTx * feat: scaffold Client interface changes * feat: start updating the Module * test: update integration tests * cleanup: remove BatchingV1 * feat: update InterchainDB * cleanup: remove entryIndex from apps * cleanup: remove entryIndex from Client events * feat: update ClientV1 * cleanup: remove entryIndex from DB * test: update SynapseModule tests * cleanup: ClientV1 * cleanup: DB * cleanup: Module * cleanup: remove batch lib * docs: smol fixes * Publish - contracts-communication@1.6.0 * optional screener for cctp relayer (#2600) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Sin/testnet 9 (#2567) * fix: remove `ExecutionFees` references * New set of deployments * Adjust config files to the latest changes * adding spectral coingecko ids for pricing (#2596) * feat(widget): suppress console errors (#2594) * Allow widget to suppress Synapse console errors * feat(sdk-router): router cache error log (#2591) * Improve RouterCache error logging * Add common error string to target at Consumer level * Add common string to all console errors * feat(widget): error logs (#2593) * Add common base string to allow hiding Widget related errors outputted in Consumer app * Convert logs into errors if firing in catch statement * Update README * Optional prop * Switch catch log to error * Re-trigger action * Remove line * Publish - @synapsecns/rest-api@1.0.64 - @synapsecns/sdk-router@0.6.0 - @synapsecns/synapse-interface@0.22.5 - @synapsecns/widget@0.2.0 * fix(contracts-communication): interchain module ignore nonces (#2604) * feat: remove dbNonce from Module interface * cleanup: update Module interface references * refactor: lint * Publish - contracts-communication@1.6.1 * feat(synapse-interface): bridge gas handler (#2437) * Initial gas data slice state * Async thunk fetchGasData * Add gas data reducers * useFetchGasDataOnInterval added to Bridge Listener * Explicitly declare fetching gas data in gwei * Calculate max bridgeable amount * On max balance factoring in gas cost * Add comment * Differentiate max balance vs max bridgeable balance * Add error toaster for when max balance less than bridge fee * refactor; calculateGasFeeInGwei() * Move to util * Fix lint error * Fetch gas when fromChainId on bridge card changes * Use exact token balance when calculate max bridgeable amount * Conditions for showing max button * showMaxOption to determine display * Disable max button if gas fees more than gas balance * Clean jsx * AvailableBalance component to track subscript detail in bridge origin input * Return raw and formatted gas cost in calculateGasCost * Update comments * Fix imports based on name cange * Use parsed * calculateMaxBridgeableGas * Clean * refactor: clean InputContainer * Replace onMaxBalance() with onMaxBridgeableBalance()` * Allow undefined object when destructuring * Display when token balance is trace balance * Typing * showGasReserved * Update avail balance text and color when gas cost greater than balance * Detect when input value is less than required estimated gas * onAvailableBalance applied * Make opacity greater when Max button disabled * Fix calculations for when gas input is enough to cover gas * Clean * Add hover tooltip for warning gas states * Use tooltip to describe gas status * Update tooltip text * Add buffer to calculate gas cost, use 1.5x * AvailableBalance component to replace label in AmountInput * Display trace balances in AvailableBalance * Fix naming * Add HoverTooltip to Available Balance * Add conditions for displaying gas error based on input * Use full parsed balance when making comparisons for gas checks * Show gas reserved in Available Balance * hasOnlyZeroes to return true if string contains only zeroes and periods * Display estimated gas cost in tool tip * Remove Available Balance elements from AmountInput, migrated to AvailableBalance * Display trace amount for input when displaying how much is reserved for gas * Fetch estimated gas limit based on real bridge quote using max gas balance * Fetching accurate gasLimit * Fix Trace balance * Set gasLimit to 0 if not valid bridge data avail * ... * Fix when gas covered msg appears * Available Balance * Clean available balance flow * useGasEstimator hook to encapsulate logic to clean InputContainer * Fix prop issue * Remove duplicate HoverTooltip * Move HoverTooltip to shared component folder * Update gas fetch for wagmi v2, up limit to 1.7 * Estimated gas bridge quote fetched on load * Update var naming * Improve Available Balance flow * Display estimated bridgeable balance on hover * Show gas estimate when estimated gas cost available * Do not show negative bridgable balance * Separate out bridge gas limit calculations into smaller functions * Wrap async functions with try catch * Implement updated gas estimation flow * Move gas estimate logic to useGasEstimator * Move async sdk fetch functions to useGasEstimator file * Remove unused vars * Shorten est gas cost * Improve code legibility in AvailableBalance * Assign conditions to vars to reduce clutter * Reset gas price data when fromChainId changes * Reset fetched gas limit when fromChainId changes * Clean * Fix old import * Fix max button placement * Add loading state for useGasEstimator * Remove available balance states for gas est * Remove unused props * Clean gas token detection in PortfolioTokenAsset * Simplify onMaxBalance() * Clean constants in InputContainer * Clean token detail destructuring * Include gas estimate when updating input from Portfolio token selection * Fire error toaster if gas fees exceed balance * Render error toaster when firing onMaxBalance callback instead of a side effect * Clean useGasEstimator * Ensure available balance does not show if wallet not connected, set default value if balances not loaded * Replicate onMax behavior in Portfolio * Use fetched gas * Improve error handling in gas estimator * ... * Remove tooltip on AvailableBalance * Remove balance prefill from Portfolio Token selection * Update available balance in input based on max bridgeable gas toke * Destructure estimateGasLimit callback from useGasEstimator to retrigger fetching gas estimate * Refetch gas ata in estimateGasLimit callback * Display total vs bridgeable balance on hover in Portfolio gas token when gas data available * Update balance shown on hover * Clean * Simplify useFetchGasDataOnInterval * Prevent unnecessary fetches, fix chain update old gas issue * Fetch estimated bridgeable max gas amount onClick token max input, fill input once amount fetched * Clean * onMaxBalance will use default balanceif fetched bridgeable balance estimate returns null * Show dust gas amounts on hover in Portfolio * Clean * Available balance including gas estimates moved to within Input to synchronize data * Move gasLimit to global store to share data between Bridge components * Display max bridgeable balance on hover in Portfolio, add onMaxBalance onClick Portfolio asset * Portfolio and Input available balance onClick behave the same * Fetch gas prices to provide most accurate gas cost * Remove hover on AvailableBalance * Fix Token Selector width * Remove onClick Portfolio Token Balance, allow Token selection from Portfolio only without Balance input update * Cursor default on Portfolio Token Balance * Show available/max buttons when bridge valid selections * Swap input to have available balance * Clean * Basic MaxButton onClick and hidden when loading gas data * Show MaxButton when input is not full balance or bridgeable balance * Implement Max button and placement in Bridge/Swap * Hide MaxButton until connected * Hide MaxButton conditions * Show Max when all input selections are made * Remove click states for AvailableBalance on Bridge/Swap * Style Input / Max * Max mobile size * Fe/format amount (#2598) * formatAmount util function, use rounded shortened values in Bridge/Swap Input * Update Bridge/Swap page with parsed / formatted balances * Clean imports * Clean imports * Swap Max spacing * Improve html element composition * Prevent layout shift in Swap UI * Publish - @synapsecns/synapse-interface@0.23.0 * add "and" (#2608) * fix(contracts-communication): default settings for Guard service (#2605) * test: should ignore optimistic period w/o guard * test: app should have empty config be default * test: should allow setting zero optimistic period * fix: ignore optimistic period without a guard * fix: use GUARD_DISABLED flag by default * fix: don't revert on zero optimistic period * test: different optimistic periods for integration tests * fix: use default guard for PingPongApp * refactor: fix linter warnings * Publish - contracts-communication@1.6.2 - @synapsecns/synapse-interface@0.23.1 * Fix: put blocking call to Start() in new goroutine (#2614) * feat(contracts-communication): default values for modules/required respones (#2612) * feat: scaffold defaultModule in Client * test: expected behavior for setting default module * feat: setting default Module in Client * refactor: Client views test * test: appConfig with zero modules/responses * feat: module config defaults * cleanup: remove `ZeroRequiredResponses` error * refactor: prep for 0 and 1 module tests * test: ClientV1 + app with 1 module * test: ClientV1 + app with 0 modules * Publish - contracts-communication@1.7.0 * RFQ: rebalance edge cases & refactoring (#2613) * Fix: filter rebalance origin / dest on rebalance method * Cleanup: move getRebalance() into rebalance.go * Cleanup: add helpers to getRebalance() * Cleanup: comments * Feat: remove Rebalance() call upon deposit claimed * Feat: getRebalance() takes in dest chain id * Cleanup: comments * Feat: extra check that we don't exceed origin maintenance * Feat: add new test case for mismatched methods but existing rebalance * Feat: break down TestGetRebalance into sub tests * Cleanup: lint * [goreleaser] * [goreleaser] * refactor: move opinionated stuff into SynapseModule (#2617) * Publish - contracts-communication@1.7.1 * Document Modules (#2611) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * cleanup (#2618) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * fix tests (#2620) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * RFQ API: replace `otelresty` with `otelhhtp` package (#2606) * Feat: replace otelresty usage with otelhttp pkg * [goreleaser] * make coverage aggregator public (#2621) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Publish - @synapsecns/coverage-aggregator@1.0.5 * publish aggregator fix (#2622) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Publish - @synapsecns/coverage-aggregator@1.0.6 * fix(solidity-devops): update forge-std to 1.8.2 (#2619) * build: update `forge-std` to 1.8.2 * chore: yarn * Publish - contracts-communication@1.7.2 - FastBridge@0.2.5 - @synapsecns/solidity-devops@0.3.5 * feat(docs): auto deploy vercel to prod (only vercel) (#2627) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * fix(ci): fixes bug in #2627, deploys go to prod (#2628) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * docs(contributing) add a guide on adding js packages (#2629) * docs(contributing) add a guide on adding js packages * Update CONTRIBUTING.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * revert coderabbit fix (#2630) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * prod release fix (#2631) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Publish - @synapsecns/bridge-docs@0.1.0 * add grafana dashboard and fix broken link (#2634) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * add scroll (#2635) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Submitter: bump MaxResultsPerChain (#2633) * Feat: bump MaxResultsPerChain * [goreleaser] * fast bridge regen (#2636) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * omnirpc doc fixes (#2637) * swagger * embed swagger ui * generic lint fixer --------- Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * fix typo (#2638) Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> * Update bl * Add SPECTRAL token support (#2640) * Publish - @synapsecns/synapse-interface@0.23.2 - @synapsecns/widget@0.2.1 * feat(synapse-interface): Adds Scroll via RFQ (#2526) * Adds Scroll via RFQ * Adds NewTag * Adds RFQ logic into the generateMaps script * Adds announcement banner * Linting * Adjusts order * API call for quotes * Updates bridgeMap for live Scroll quotes * For reusing NewTag * Adjust dates * Publish - @synapsecns/synapse-interface@0.24.0 * feat(widget): maintenance (#2616) * Fetch pause data and store JSON object in client browser * Refetch only if last fetch was more than 24 hours ago * Read chain + module pause from local storage * Maintenance components rendering based off of fetched pause data * Pause Bridge button based on Maintenance status * Filter quotes based on paused modules * Use user defined styling or defaults * Style Progress Bar * Refactor getSynapsePauseData * Clean * Fix bridge quote filter * Adjust text size for maintenance * Add comments + clean * Update comment * Refresh data every hour * Clean * Add key to warning messages * Fix render issues, start move event countdown component directly to Widget to resolve hooks issue * Resolve hooks render issue with localized component * Progress bar renders when not isabled * Clean and simplify Maintenance components * getMaintenanceData * Organize back into useMaintenance hook * Clean / organize * Use prod urls * Organizational updates * Fetch pause data every render, set fetching status flag * Rm timestamp key --------- Co-authored-by: abtestingalpha <abtestingalpha@gmail.com> * Publish - @synapsecns/widget@0.3.0 * RFQ API: add GET /ack endpoint (#2643) * WIP: add relay ack cache and GetRelayAck endpoint * Feat: register AckRoute * Feat: add ackMux * Feat: add GetRelayAck test * Feat: add GetRelayAck to UnauthenticatedClient * Feat: relayer fetches ack before updating to CommittedPending * [goreleaser] * Feat: move GET /ack to PUT /ack * WIP: generalize AuthMiddleware() * Fix: working refactor for auth * Feat: add PutAckRequest and parse in auth middleware * Feat: impl PUT /ack request with json req body * Feat: bump default timeout from 5 to 10 * Feat: add swagger comments * Cleanup: pass API client into quoter * Feat: return RelayerAddress in PutRelayAckResponse * Cleanup: add clarifying comment * [goreleaser] * Cleanup: lint * [goreleaser] * Cleanup: add tracing * [goreleaser] * Config: bump relay ack timeout to 30 seconds * [goreleaser] * Feat: lower submitter retry interval (#2645) * update bl * Adjusts banner date (#2647) * Publish - @synapsecns/synapse-interface@0.24.1 * Add SPEC token pricing to the manual cache (#2646) * adding spectral coingecko ids for pricing * adding spec token to cache * Update bl * fix(screener): fix screener http 502 (#2650) Co-authored-by: trajan0x <83933037+trajan0x@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * update bl * update bl --------- Co-authored-by: aureliusbtc <82057759+aureliusbtc@users.noreply.github.com> Co-authored-by: ChiTimesChi <88190723+ChiTimesChi@users.noreply.github.com> Co-authored-by: dwasse <wassermandaniel8@gmail.com> Co-authored-by: ChiTimesChi <ChiTimesChi@users.noreply.github.com> Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com> Co-authored-by: vro <168573323+golangisfun123@users.noreply.github.com> Co-authored-by: shampoobera <shampoo@berachain.com> Co-authored-by: bigboydiamonds <57741810+bigboydiamonds@users.noreply.github.com> Co-authored-by: bigboydiamonds <bigboydiamonds@users.noreply.github.com> Co-authored-by: trajan0x <83933037+trajan0x@users.noreply.github.com> Co-authored-by: Moses <103143573+Defi-Moses@users.noreply.github.com> Co-authored-by: Simon <ak.simonm@gmail.com> Co-authored-by: aureliusbtc <aureliusbtc@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: abtestingalpha <abtestingalpha@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by CodeRabbit