Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(webhook): add webhook #2538

Merged
merged 38 commits into from
May 9, 2024
Merged

feat(webhook): add webhook #2538

merged 38 commits into from
May 9, 2024

Conversation

golangisfun123
Copy link
Collaborator

@golangisfun123 golangisfun123 commented Apr 30, 2024

  • new DB interface wrapping RuleDB and BlacklistedAddressDB, makes it easier to migrate future models
  • CRUD HTTP for blacklisted addresses

Summary by CodeRabbit

  • New Features

    • Added functionality for blacklisting addresses in the Screener API client.
    • Enhanced Swagger documentation generation for improved API clarity and usage.
  • Documentation

    • Updated Swagger documentation to reflect new API endpoints for blacklisting addresses.
  • Refactor

    • Restructured database interfaces to consolidate blacklist-related operations.
    • Modified various internal API components to use updated database interface references, improving code maintainability and future scalability.
  • Tests

    • Expanded test coverage to include new functionalities for blacklisting addresses, ensuring robustness and reliability.

b9817506112309a66802a66abcde4088e0280d2c: synapse-interface preview link

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Walkthrough

The recent changes have enriched the Screener API by incorporating blacklisting functionality, updating imports, and introducing Swagger documentation. These updates aim to enhance functionality, security, and API documentation support, contributing to a more robust and well-documented API system.

Changes

File Path Change Summary
contrib/screener-api/client/client.go Added blacklisting functionality with authentication support.
contrib/screener-api/docs/docs.go Introduces Swagger documentation generation using swaggo/swag.
contrib/screener-api/docs/swagger.json Defines a Swagger spec for blacklisting addresses.
contrib/screener-api/docs/swagger.yaml Specifies Swagger 2.0 API definitions for address blacklisting.
contrib/screener-api/screener/screener.go Updates imports, renames db.RuleDB to db.DB, adds middleware, and functions for blacklisting and authentication.
contrib/screener-api/screener/suite_test.go Adds CRUD operation tests on a blacklist.

🐇✨
In the code's garden, changes bloom,
New paths for data, in bytes they zoom.
Blacklist grows, in digital form,
Safe from storms, they transform.
Hopping through lines, a rabbit's cheer,
For cleaner code, the goal is near! 🌟
🐇✨


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between d390ea0 and 498a067.
Files selected for processing (5)
  • contrib/screener-api/client/client.go (4 hunks)
  • contrib/screener-api/docs/docs.go (1 hunks)
  • contrib/screener-api/docs/swagger.json (1 hunks)
  • contrib/screener-api/docs/swagger.yaml (1 hunks)
  • contrib/screener-api/screener/screener.go (7 hunks)
Files not reviewed due to errors (2)
  • contrib/screener-api/client/client.go (no review received)
  • contrib/screener-api/screener/screener.go (no review received)
Files skipped from review as they are similar to previous changes (2)
  • contrib/screener-api/docs/docs.go
  • contrib/screener-api/docs/swagger.json
Additional Context Used
GitHub Check Runs (1)
Lint (contrib/screener-api) failure (4)

contrib/screener-api/screener/screener.go: [failure] 265-265:
Comment should end in a period (godot)

Additional comments not posted (3)
contrib/screener-api/docs/swagger.yaml (3)

1-22: Ensure all properties in db.BlacklistedAddress are necessary and correctly typed.

Verification successful

The verification process has confirmed that all properties defined in the db.BlacklistedAddress within the swagger.yaml file are indeed utilized across various parts of the application. Each property was found in multiple files, indicating their active use and integration within the system. This includes their presence in model definitions, API documentation, and actual application logic.

Given this comprehensive usage across the system, it can be concluded that the properties are necessary and correctly implemented as per the current application's requirements.

Files confirming the usage of properties:

  • address, createdAt, data, id, network, remark, tag, typereq, updatedAt are used in multiple files such as models.go, swagger.yaml, swagger.json, docs.go, and various other implementation files.
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that all properties in the `db.BlacklistedAddress` definition are used in the application and have correct data types.

# Search for usage of each property in the application code.
ast-grep --lang yaml --pattern $'definitions:
  db.BlacklistedAddress:
    properties:
      $$$' contrib/screener-api/docs/swagger.yaml

Length of output: 246



Script:

#!/bin/bash
# Description: Search for the usage of each property in the `db.BlacklistedAddress` definition across the application code.

# List of properties to check
properties=("address" "createdAt" "data" "id" "network" "remark" "tag" "typereq" "updatedAt")

# Loop through each property and search for its usage in the application code
for prop in "${properties[@]}"; do
    echo "Searching for property: $prop"
    rg --files-with-matches --hidden "$prop" contrib/screener-api/
done

Length of output: 5347


26-66: Review the endpoint /api/data/sync for completeness and correctness of parameters and responses.

Verification successful

The verification of the /api/data/sync endpoint in the Swagger YAML file shows that the endpoint is defined with all the necessary parameters and attributes as described in the provided snippet. The parameters include 'appid', 'timestamp', 'nonce', 'queryString', and 'signature', all required and of type string. The endpoint's description and the type of data it consumes ('application/json') are also correctly specified.

  • Endpoint: /api/data/sync
    • Parameters: Correct and complete
    • Description: Matches the provided snippet
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the completeness and correctness of the `/api/data/sync` endpoint.

# Search for the endpoint definition and its usage in the application code.
ast-grep --lang yaml --pattern $'paths:
  /api/data/sync:
    $$$' contrib/screener-api/docs/swagger.yaml

Length of output: 215



Script:

#!/bin/bash
# Description: Verify the completeness and correctness of the `/api/data/sync` endpoint using ripgrep.

# Search for the endpoint definition in the Swagger YAML file.
rg '/api/data/sync' contrib/screener-api/docs/swagger.yaml

Length of output: 76



Script:

#!/bin/bash
# Description: Extract more detailed information about the `/api/data/sync` endpoint using ripgrep with context lines.

# Search for the endpoint definition in the Swagger YAML file and include 15 lines after the match to capture the full definition.
rg -A 15 '/api/data/sync' contrib/screener-api/docs/swagger.yaml

Length of output: 443



Script:

#!/bin/bash
# Description: Extract the complete information about the `/api/data/sync` endpoint using ripgrep with extended context lines.

# Search for the endpoint definition in the Swagger YAML file and include 30 lines after the match to capture the full definition.
rg -A 30 '/api/data/sync' contrib/screener-api/docs/swagger.yaml

Length of output: 877


67-105: Ensure the endpoint /screen/{ruleset}/{address} correctly handles all specified parameters and responses.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added go Pull requests that update Go code size/m labels Apr 30, 2024
Copy link

cloudflare-workers-and-pages bot commented Apr 30, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 498a067
Status: ✅  Deploy successful!
Preview URL: https://06f3e178.sanguine-fe.pages.dev
Branch Preview URL: https://add-webhook.sanguine-fe.pages.dev

View logs

Copy link

codecov bot commented Apr 30, 2024

Codecov Report

Attention: Patch coverage is 61.25000% with 31 lines in your changes are missing coverage. Please review.

Project coverage is 46.88496%. Comparing base (bfd72d6) to head (498a067).
Report is 18 commits behind head on master.

Files Patch % Lines
contrib/screener-api/screener/screener.go 61.25000% 25 Missing and 6 partials ⚠️
Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #2538         +/-   ##
===================================================
- Coverage   46.89003%   46.88496%   -0.00508%     
===================================================
  Files            401         401                 
  Lines          30981       31059         +78     
  Branches          83          83                 
===================================================
+ Hits           14527       14562         +35     
- Misses         14926       14960         +34     
- Partials        1528        1537          +9     
Flag Coverage Δ
cctp-relayer 43.53414% <ø> (ø)
committee 62.20028% <ø> (ø)
explorer 23.87061% <ø> (ø)
omnirpc 53.23194% <ø> (ø)
promexporter 75.91241% <ø> (ø)
rfq 30.18587% <ø> (ø)
screener-api 62.80788% <61.25000%> (+0.00300%) ⬆️
scribe 52.21130% <ø> (+0.18426%) ⬆️
sin-executor 60.49383% <ø> (-3.95061%) ⬇️
stiprelayer 3.33333% <ø> (ø)
tools 21.98661% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 10

Out of diff range and nitpick comments (1)
contrib/screener-api/db/sql/base/namer.go (1)

8-8: Consider removing or replacing the placeholder comment.

The comment "// idk what this is" does not provide any useful information and should be replaced with a more descriptive comment explaining the purpose of the namer initialization.

contrib/screener-api/db/db.go Outdated Show resolved Hide resolved
contrib/screener-api/db/db.go Show resolved Hide resolved
contrib/screener-api/db/db.go Show resolved Hide resolved
contrib/screener-api/db/db.go Outdated Show resolved Hide resolved
contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
contrib/screener-api/client/client.go Outdated Show resolved Hide resolved
contrib/screener-api/screener/screener.go Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
Comment on lines 47 to 67
func (b *BlacklistedAddress) Scan(val interface{}) error {
if val == nil {
*b = BlacklistedAddress{}
return nil
}
var ba []byte
switch v := val.(type) {
case []byte:
ba = v
case string:
ba = []byte(v)
default:
return errors.New(fmt.Sprint("Failed to unmarshal JSONB value:", val))
}
rd := bytes.NewReader(ba)
decoder := json.NewDecoder(rd)
decoder.UseNumber()
err := decoder.Decode(b)
//nolint: wrapcheck
return err
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The verification process has confirmed that there is no unit test specifically targeting the Scan method of the BlacklistedAddress struct in the contrib/screener-api/db/models.go file. The search results included various usages of the Scan method across different contexts, but none that directly test the Scan method within the BlacklistedAddress struct.

  • The method is critical for data deserialization and should be thoroughly tested to ensure its correct implementation.
Analysis chain

Ensure Scan method is covered by unit tests.

The Scan method is critical for data deserialization, and it is important to ensure its correct implementation through testing.


The output from the executed script does not confirm the presence of unit tests for the Scan method in the BlacklistedAddress struct. The results show tests for different contexts, which are not relevant to the BlacklistedAddress. To ensure thorough verification, I will refine the search to focus specifically on the BlacklistedAddress struct.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the `Scan` method in the `BlacklistedAddress` struct is covered by unit tests.

# Find test files for the `models.go` and check for test coverage on the `Scan` method.
rg --files-with-matches --type go $'func Test.*Scan' | xargs rg 'Scan\('

Length of output: 406



Script:

#!/bin/bash
# Description: More specifically verify that the `Scan` method in the `BlacklistedAddress` struct is covered by unit tests.

# Find test files specifically related to the `BlacklistedAddress` struct and check for test coverage on the `Scan` method.
rg --files-with-matches --type go $'func Test.*BlacklistedAddress.*Scan' | xargs rg 'Scan\('

Length of output: 5016

contrib/screener-api/screener/screener.go Show resolved Hide resolved
contrib/screener-api/screener/screener.go Show resolved Hide resolved
contrib/screener-api/client/client.go Outdated Show resolved Hide resolved

// Concatenate the body.
message := fmt.Sprintf(
"%s%s%s%s%s%s%s",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

poor use of %s, just create a concat(...string) method that does this

contrib/screener-api/db/db.go Show resolved Hide resolved
Copy link
Contributor

@trajan0x trajan0x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have one other minor item that I didn't address before/was out of scope, but we can do either here or in this pr.

First, though, a note on staging. As I'll explain in slack, you can build docker images of any commit using [goreleaser] in the commit message so we can try these out without merging.

Now for the change. Up to you if you wanna do this in a seperate pr. It'd be nice if we could swagger this the same way we did rfq in #2537. I'm fresh off this so I'll walk you through it real quick:

  1. Add a go generate at the root of contrib/screener-api like this

This means the docs will regenerate when we run go generate ./.... This is useful for detecting if go generate was not run (we do this in CI, as you might be able to tell by the workflows on this pr)

  1. Once you've ran go generate ./... go ahead and add the swagger routes and set the doc title

  2. Finally you can go through and document the api (see here

Should be extremely straight forward. Make sure you run go generate after your done.

  1. At the root of the repo ~/sanguine run make tidy, this will run go mod tidy and go work sync across all our modules to update any lock files we may have missed in dependencies

Copy link
Contributor

@trajan0x trajan0x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of this is needed since BlacklistedAddress is a table not a gorm data type

Copy link
Contributor

@trajan0x trajan0x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of this is needed since BlacklistedAddress is a table not a gorm data type

contrib/screener-api/db/models.go Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

contrib/screener-api/screener/suite_test.go Show resolved Hide resolved
contrib/screener-api/screener/suite_test.go Show resolved Hide resolved
// @Param signature header string true "Signature for request validation"
// @Accept json
// @Produce json
// @Router /api/data/sync [post]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that all API documentation comments are properly punctuated.

- // @Router /api/data/sync [post]
+ // @Router /api/data/sync [post].

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
// @Router /api/data/sync [post]
// @Router /api/data/sync [post].

Comment on lines +150 to +152
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

Several files in the codebase still use the old function signature. The error handling in the blacklistAddress method appears not to be covered by unit tests, which is crucial for ensuring robustness, especially given its role in modifying sensitive data.

  • contrib/screener-api/screener/screener.go: The method blacklistAddress lacks unit tests for error handling.
Analysis chain

The error handling in the blacklistAddress method is crucial, especially given its role in modifying sensitive data.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the error handling in the `blacklistAddress` method is covered by unit tests.

# Find test files for the `screener.go` and check for test coverage on the `blacklistAddress` method error handling.
rg --files-with-matches --type go $'func Test.*blacklistAddress' | xargs rg 'blacklistAddress\('

Length of output: 197

contrib/screener-api/screener/screener.go Show resolved Hide resolved
@github-actions github-actions bot added size/l and removed size/m labels May 2, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (1)
contrib/screener-api/docs/swagger.yaml (1)

23-24: Consider adding more details to the info section, such as version, title, and description.

@trajan0x trajan0x merged commit a7d430c into master May 9, 2024
69 of 73 checks passed
@trajan0x trajan0x deleted the add-webhook branch May 9, 2024 13:36
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants