omnirpc doc fixes #2637
Merged
omnirpc doc fixes #2637
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
trajan0x
requested review from
dwasse,
aureliusbtc and
ChiTimesChi
as code owners
WalkthroughThe update brings significant documentation enhancements to the Omnirpc service, integrating Postman and Swagger for improved API usability. Notable changes include the addition of Swagger UI routes, generation of OpenAPI specifications, and inclusion of a full Postman collection. These enhancements aim to streamline developer workflows by offering detailed API documentation and interactive resources. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Out of diff range and nitpick comments (1)
docs/bridge/docs/Services/Omnirpc.md (1)
Line range hint
1-1: Use "a" instead of "an" before "rpc".- Omnirpc is an rpc load balancer and verifier that allows users to query chain data from multiple chains. + Omnirpc is a rpc load balancer and verifier that allows users to query chain data from multiple chains.
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (19)
agents/go.modis excluded by!**/*.modagents/go.sumis excluded by!**/*.sumcommittee/go.modis excluded by!**/*.modcommittee/go.sumis excluded by!**/*.sumcontrib/promexporter/go.sumis excluded by!**/*.sumservices/cctp-relayer/go.modis excluded by!**/*.modservices/cctp-relayer/go.sumis excluded by!**/*.sumservices/explorer/go.modis excluded by!**/*.modservices/explorer/go.sumis excluded by!**/*.sumservices/omnirpc/go.modis excluded by!**/*.modservices/omnirpc/go.sumis excluded by!**/*.sumservices/rfq/go.modis excluded by!**/*.modservices/rfq/go.sumis excluded by!**/*.sumservices/scribe/go.modis excluded by!**/*.modservices/scribe/go.sumis excluded by!**/*.sumservices/stiprelayer/go.modis excluded by!**/*.modservices/stiprelayer/go.sumis excluded by!**/*.sumsin-executor/go.modis excluded by!**/*.modsin-executor/go.sumis excluded by!**/*.sum
Files selected for processing (9)
- docs/bridge/docs/Services/Omnirpc.md (1 hunks)
- services/omnirpc/README.md (3 hunks)
- services/omnirpc/modules/confirmedtofinalized/finalizedproxy.go (3 hunks)
- services/omnirpc/modules/harmonyproxy/harmonyproxy.go (3 hunks)
- services/omnirpc/proxy/server.go (2 hunks)
- services/omnirpc/swagger/gen.sh (1 hunks)
- services/omnirpc/swagger/generate.go (1 hunks)
- services/omnirpc/swagger/generator/main.go (1 hunks)
- services/omnirpc/swagger/openapi.yaml (1 hunks)
Files skipped from review due to trivial changes (3)
- services/omnirpc/modules/confirmedtofinalized/finalizedproxy.go
- services/omnirpc/swagger/gen.sh
- services/omnirpc/swagger/generate.go
Additional Context Used
LanguageTool (5)
docs/bridge/docs/Services/Omnirpc.md (2)
Near line 1: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: Omnirpc is an rpc load balancer and verifier that all...
Near line 15: Consider a more expressive alternative.
Context: ...relayer can also be run with docker. To do this, you will need to pull the [docker...services/omnirpc/README.md (3)
Near line 40: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...l: 60 ``` There are some nuances here. First of all, we can only check against "verifiable"...
Near line 96: Loose punctuation mark.
Context: ..._estimateGas-eth_sendRawTransaction`: This is because the tx might not be pen...
Near line 118: A determiner may be missing.
Context: ... block number instead of latest to make latest queries confirmable - Customizable Conf...
Additional comments not posted (7)
services/omnirpc/proxy/server.go (1)
101-101: Ensure proper error handling for the Swagger route.Verify that the Swagger route handles errors correctly and does not expose sensitive information.
services/omnirpc/modules/harmonyproxy/harmonyproxy.go (1)
76-76: Ensure proper error handling for the Swagger route.Verify that the Swagger route handles errors correctly and does not expose sensitive information.
services/omnirpc/swagger/openapi.yaml (5)
2-6: Theinfosection looks good and follows the OpenAPI specification.
7-8: Theserverssection is well-defined and uses a parameterized URL for flexibility.
10-344: The/rpc/{CHAIN_ID}path is well-defined, including the request body schema and examples.
345-684: The/confirmations/{CONFIRMATIONS}/rpc/{CHAIN_ID}path is well-defined, including the request body schema and examples.
685-687: Thetagssection is appropriately defined for the API operations.
Comment on lines
+16
to
+24
| file, err := os.Create("collection.json") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| _, err = file.Write(res) | ||
| if err != nil { | ||
| panic(err) | ||
| } |
There was a problem hiding this comment.
Ensure the file is properly closed after writing to it.
file, err := os.Create("collection.json")
if err != nil {
panic(err)
}
+ defer func() {
+ if cerr := file.Close(); cerr != nil && err == nil {
+ err = cerr
+ }
+ }()
_, err = file.Write(res)
if err != nil {
panic(err)
}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
| file, err := os.Create("collection.json") | |
| if err != nil { | |
| panic(err) | |
| } | |
| _, err = file.Write(res) | |
| if err != nil { | |
| panic(err) | |
| } | |
| file, err := os.Create("collection.json") | |
| if err != nil { | |
| panic(err) | |
| } | |
| defer func() { | |
| if cerr := file.Close(); cerr != nil && err == nil { | |
| err = cerr | |
| } | |
| }() | |
| _, err = file.Write(res) | |
| if err != nil { | |
| panic(err) | |
| } |
docs/bridge/docs/Services/Omnirpc.md
Outdated
| @@ -74,4 +74,6 @@ curl --location --request POST 'http://localhost:5000/rpc/1' \ | |||
| }' | |||
| ``` | |||
|
|
|||
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`. | |||
There was a problem hiding this comment.
Replace hard tabs with spaces in the YAML configuration example.
- "jsonrpc":"2.0",
- "method":"eth_getTransactionCount",
- "params":[
- "0x230a1ac45690b9ae1176389434610b9526d2f21b",
- "0xec1d40"
- ],
- "id":1
+ "jsonrpc":"2.0",
+ "method":"eth_getTransactionCount",
+ "params":[
+ "0x230a1ac45690b9ae1176389434610b9526d2f21b",
+ "0xec1d40"
+ ],
+ "id":1Committable 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
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`. | |
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`. |
docs/bridge/docs/Services/Omnirpc.md
Outdated
Comment on lines
+77
to
+78
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`. | ||
|
|
There was a problem hiding this comment.
Clarify the endpoint for the Postman collection and Swagger docs.
- A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`.
+ A full Postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json` endpoint. Swagger docs are also available at `/swagger`.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
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`. Swagger docs are also available at `/swagger`. | |
| A full Postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json` endpoint. Swagger docs are also available at `/swagger`. | |
services/omnirpc/README.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # OmniRPC | |||
|
|
|||
| [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc) | |||
| [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc) | |||
There was a problem hiding this comment.
Fix the URL for the Go Reference badge.
- [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc)
+ [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc)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
| [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc) | |
| [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc) |
services/omnirpc/README.md
Outdated
| @@ -73,7 +73,7 @@ | |||
|
|
|||
| You can also query using a customizable number of confirmations using (for 2 confirmations on eth): `http://localhost:5000/confirmations/2/rpc/1`. | |||
|
|
|||
| A postman collection is also available at `/collection.json` | |||
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint` | |||
There was a problem hiding this comment.
Replace hard tabs with spaces in the YAML configuration example.
- "jsonrpc":"2.0",
- "method":"eth_getTransactionCount",
- "params":[
- "0x230a1ac45690b9ae1176389434610b9526d2f21b",
- "0xec1d40"
- ],
- "id":1
+ "jsonrpc":"2.0",
+ "method":"eth_getTransactionCount",
+ "params":[
+ "0x230a1ac45690b9ae1176389434610b9526d2f21b",
+ "0xec1d40"
+ ],
+ "id":1Committable 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
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint` | |
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint` |
Clarify the endpoint for the Postman collection.
- A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`
+ A full Postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json` endpoint.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
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint` | |
| A full Postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json` endpoint. |
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 <[email protected]> * 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 - [email protected] * fix(sdk-rouder): remove cache hydration (#2597) * fix: disable hydration * chore: don't log quotes in the integration test * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * 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/[email protected] * Exempt gh pages (#2541) Co-authored-by: Trajan0x <[email protected]> * 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 - [email protected] * 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 - [email protected] - [email protected] - @synapsecns/[email protected] * 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 - [email protected] * gogenerate * Revert "gogenerate" This reverts commit b40e602. * im dumb * generate * tidy * update swagger doc * [goreleaser] * [goreleaser] --------- Co-authored-by: shampoobera <[email protected]> Co-authored-by: bigboydiamonds <[email protected]> Co-authored-by: bigboydiamonds <[email protected]> Co-authored-by: trajan0x <[email protected]> Co-authored-by: Trajan0x <[email protected]> Co-authored-by: χ² <[email protected]> Co-authored-by: ChiTimesChi <[email protected]> * rfq api cache (#2562) * cache api result [goreleaser] * clean up * clean up 2 --------- Co-authored-by: Trajan0x <[email protected]> * add trace to sync (#2601) * trace more * cleanup * allow use of mustache templates --------- Co-authored-by: Trajan0x <[email protected]> * remove iconfig file (#2602) Co-authored-by: Trajan0x <[email protected]> * 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 - [email protected] * optional screener for cctp relayer (#2600) Co-authored-by: Trajan0x <[email protected]> * 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/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] - @synapsecns/[email protected] * fix(contracts-communication): interchain module ignore nonces (#2604) * feat: remove dbNonce from Module interface * cleanup: update Module interface references * refactor: lint * Publish - [email protected] * 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/[email protected] * 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 - [email protected] - @synapsecns/[email protected] * 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 - [email protected] * 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 - [email protected] * Document Modules (#2611) Co-authored-by: Trajan0x <[email protected]> * cleanup (#2618) Co-authored-by: Trajan0x <[email protected]> * fix tests (#2620) Co-authored-by: Trajan0x <[email protected]> * 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 <[email protected]> * Publish - @synapsecns/[email protected] * publish aggregator fix (#2622) Co-authored-by: Trajan0x <[email protected]> * Publish - @synapsecns/[email protected] * fix(solidity-devops): update forge-std to 1.8.2 (#2619) * build: update `forge-std` to 1.8.2 * chore: yarn * Publish - [email protected] - [email protected] - @synapsecns/[email protected] * feat(docs): auto deploy vercel to prod (only vercel) (#2627) Co-authored-by: Trajan0x <[email protected]> * fix(ci): fixes bug in #2627, deploys go to prod (#2628) Co-authored-by: Trajan0x <[email protected]> * 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 <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * revert coderabbit fix (#2630) Co-authored-by: Trajan0x <[email protected]> * prod release fix (#2631) Co-authored-by: Trajan0x <[email protected]> * Publish - @synapsecns/[email protected] * add grafana dashboard and fix broken link (#2634) Co-authored-by: Trajan0x <[email protected]> * add scroll (#2635) Co-authored-by: Trajan0x <[email protected]> * Submitter: bump MaxResultsPerChain (#2633) * Feat: bump MaxResultsPerChain * [goreleaser] * fast bridge regen (#2636) Co-authored-by: Trajan0x <[email protected]> * omnirpc doc fixes (#2637) * swagger * embed swagger ui * generic lint fixer --------- Co-authored-by: Trajan0x <[email protected]> * fix typo (#2638) Co-authored-by: Trajan0x <[email protected]> * Update bl * Add SPECTRAL token support (#2640) * Publish - @synapsecns/[email protected] - @synapsecns/[email protected] * 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/[email protected] * 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 <[email protected]> * Publish - @synapsecns/[email protected] * 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/[email protected] * 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 <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * update bl * update bl --------- Co-authored-by: aureliusbtc <[email protected]> Co-authored-by: ChiTimesChi <[email protected]> Co-authored-by: dwasse <[email protected]> Co-authored-by: ChiTimesChi <[email protected]> Co-authored-by: Trajan0x <[email protected]> Co-authored-by: vro <[email protected]> Co-authored-by: shampoobera <[email protected]> Co-authored-by: bigboydiamonds <[email protected]> Co-authored-by: bigboydiamonds <[email protected]> Co-authored-by: trajan0x <[email protected]> Co-authored-by: Moses <[email protected]> Co-authored-by: Simon <[email protected]> Co-authored-by: aureliusbtc <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: abtestingalpha <[email protected]>
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.
Description
Add some quick docs
Summary by CodeRabbit
Documentation
openapi.yaml.New Features
/swagger/*any.Chores
c91c834140525f3acc04beafacfb59ee63dd48bb: docs preview link
1a26c7f90a4be56c1cdba2d0f952116ab8b96921: docs preview link