search

bitcashorg / smartsale

SmartSale streamlines the auction process on EVM
MIT License
17 stars 3 forks source link

chore(alchemy): update webhook creation scripts #381

Closed gaboesquivel closed 1 month ago

gaboesquivel commented 1 month ago

Summary by Sourcery

Restore Alchemy signature validation in the activity route to enhance security. Remove unused configuration entries and update the webhook URL in the address activity notification. Add a new script to log all webhooks by URL using the Alchemy SDK.

New Features:

Enhancements:

Chores:

Summary by CodeRabbit

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bitlauncher ❌ Failed (Inspect) Sep 13, 2024 7:25am
smartsale-faucet ❌ Failed (Inspect) Sep 13, 2024 7:25am
sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request restores Alchemy signature checks and makes several changes to the Alchemy webhook configuration. It removes some environment variables, updates webhook URLs, and adds a new script to log all webhooks.

File-Level Changes

Change Details Files
Restored Alchemy signature validation in the activity API route
  • Uncommented the validateAlchemySignature function call
  • Removed TODO comment about restoring signature validation
 apps/web/app/api/activity/route.ts
Simplified environment configuration for Alchemy services
  • Removed ALCHEMY_ACTIVITY_WEBHOOK_URL from environment schema
  • Removed PRESALE_ADDRESS from environment schema
  • Removed corresponding properties from appConfig object
 services/alchemy/src/config.ts
Updated Alchemy webhook configuration
  • Replaced dynamic webhook URL with hardcoded URL
  • Removed imports for evmChains and chainIdAlchemyNetwork
  • Updated address used for activity notification to a hardcoded value
 services/alchemy/webhooks/activity.ts
services/alchemy/webhooks/activity-dev.ts
Added new script to log all Alchemy webhooks
  • Created a new file with a function to fetch and log all webhooks
  • Implemented grouping of webhooks by URL
  • Added error handling for webhook fetching
 services/alchemy/webhooks/get-webhook.ts
Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve updates to the Alchemy service's webhook handling and configuration management. Key modifications include re-enabling signature validation for incoming requests, introducing a new environment variable for notification tokens, and enhancing dependency management by adding lodash. Additionally, validations for certain environment variables were removed, and hardcoded values were introduced for webhook URLs and deposit addresses, which simplifies the configuration but may reduce flexibility.

Changes

File Path Change Summary
apps/web/app/api/activity/route.ts Restored validation of the Alchemy signature in the POST function, returning a 401 Unauthorized response if validation fails.
services/alchemy/env.sample Added new environment variable ALCHEMY_NOTIFY_TOKEN for notification purposes.
services/alchemy/package.json Added lodash dependency and removed duplicate entry for @repo/chains.
services/alchemy/src/config.ts Removed validations for ALCHEMY_ACTIVITY_WEBHOOK_URL and PRESALE_ADDRESS, simplifying configuration.
services/alchemy/webhooks/activity-dev.ts Changed addresses parameter in createAddressActivityNotification to a hardcoded Ethereum address.
services/alchemy/webhooks/activity.ts Updated webhook URL from a configuration variable to a hardcoded URL. Removed unused imports.
services/alchemy/webhooks/get-webhook.ts Introduced a new file implementing functionality to fetch and log webhooks using the Alchemy SDK.

Assessment against linked issues

Objective Addressed Explanation
Restore signature validation ✅
Introduce notification token ✅
Improve dependency management ✅
Validate environment variables ❌ Validation for ALCHEMY_ACTIVITY_WEBHOOK_URL and PRESALE_ADDRESS was removed.
Simplify webhook handling ❓ Unclear if the impact of hardcoded values meets the simplification goal.

Possibly related issues

Possibly related PRs

🐰 In the meadow, we hop and play,
With changes brightening up the day.
Validations restored, a token in tow,
Dependencies streamlined, watch us grow!
Webhooks now dance, with logs to show,
In the world of Alchemy, we steal the show! 🌼✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.