feat: presale token issuance part 3

[gaboesquivel]

Summary by Sourcery

Implement presale token issuance by adding support for Alchemy webhook events and address activity notifications. Refactor chain configurations and improve logging for webhook processing.

New Features:

• Introduce a new feature to handle Alchemy webhook events for address activity, including validation of network and asset types before processing.
• Add functionality to create Alchemy address activity notifications using the Alchemy SDK.

Enhancements:

• Refactor the chain configuration to streamline the list of production chains, removing unsupported or unused chains.
• Improve the logging of webhook processing by including the webhook ID in the response message.

Chores:

• Move the Alchemy webhook event and activity type definitions to a separate types file for better organization.

Summary by CodeRabbit

• New Features

  • Introduced a new webhook creation function for monitoring address activity on the MATIC_MAINNET blockchain.
  • Added a new configuration parameter for presale functionality in the application.
  • Enhanced type safety with new TypeScript interfaces for handling webhook events.

• Improvements

  • Simplified package structure and naming conventions for better modularity.
  • Improved validation and security for incoming Alchemy webhook requests.
  • Streamlined chain configurations focusing on EVM-compatible chains.

• Bug Fixes

  • Enhanced error handling and logging within the address activity task function.

• Chores

  • Updated dependencies for better integration and performance.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
bitlauncher	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 23, 2024 8:09am
smartsale-faucet	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 23, 2024 8:09am

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements the third part of the presale token issuance feature. It focuses on enhancing the Alchemy webhook handling, refining the supported blockchain networks, and improving the address activity processing.

File-Level Changes

Change	Details	Files
Enhanced Alchemy webhook handling and validation	Added type definitions for Alchemy webhook events and activities Implemented network validation to ensure only supported networks are processed Added asset validation to only process USDC and USDT transactions Implemented address validation to ensure transactions are to the presale address	apps/indexer/src/routes/alchemy.ts apps/alchemy/src/types.ts
Refined supported blockchain networks	Updated the list of production chains to include only specific networks Removed several previously supported networks Added a mapping of chain IDs to Alchemy Network types	packages/app-env/src/chains.ts apps/indexer/src/routes/alchemy.ts
Improved address activity processing	Updated the addressActivityTask to use typed AlchemyWebhookEvent Enhanced error logging in the address activity task	apps/trigger/src/trigger/activity.ts
Restructured Alchemy-related code	Moved Alchemy types to a separate file Relocated the createAddressActivityNotification function to a new file	apps/alchemy/src/index.ts apps/alchemy/src/create.ts
Updated configuration	Added PRESALE_ADDRESS to the environment schema Included presaleAddress in the appConfig object	apps/indexer/src/config.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:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes include updates to configuration files, dependencies, and TypeScript interfaces across various applications. Notable modifications involve restructuring package names, adding new types for webhook events, enhancing validation logic, and streamlining the production chain list. These adjustments focus on improving code organization and refining the functionality related to the Alchemy SDK and webhook processing.

Changes

File	Change Summary
.vscode/settings.json	Added editor settings for spaces and tab size.
apps/alchemy/package.json	Updated package name to @repo/alchemy, added TypeScript types entry, and replaced push script with create.
apps/alchemy/src/create.ts	Introduced a new function createAddressActivityNotification for setting up webhooks.
apps/alchemy/src/index.ts	Removed createAddressActivityNotification function; added export for all entities from ./types.
apps/alchemy/src/types.ts	Added several TypeScript interfaces and types for Alchemy webhook events and activities.
apps/indexer/package.json	Added dependency on @repo/alchemy.
apps/indexer/src/config.ts	Introduced PRESALE_ADDRESS as a new configuration parameter.
apps/indexer/src/routes/alchemy.ts	Enhanced alchemyWebhook function with validation for incoming webhook requests and improved security checks.
apps/trigger/package.json	Updated dependencies, adding @repo/alchemy and alchemy-sdk.
apps/trigger/src/trigger/activity.ts	Updated addressActivityTask to improve type safety and streamline logging and error handling.
packages/app-env/src/chains.ts	Removed multiple chains from prodChains, leaving a focused list of production chains.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Alchemy as Alchemy SDK
    participant Webhook as Webhook Handler
    participant Config as Configuration

    User->>Webhook: Send webhook event
    Webhook->>Config: Validate event type and network
    alt Valid event
        Webhook->>Alchemy: Process event
        Alchemy-->>Webhook: Acknowledge processing
    else Invalid event
        Webhook-->>User: Respond with 401 Unauthorized
    end

Loading

🐰 In the meadow, changes sprout,
New paths for coding, there's no doubt!
A webhook here, a type defined,
In the code, harmony we find.
With every hop, our project grows,
A world of logic, where creativity flows! 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 as 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.

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

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 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.

[sourcery-ai]

Hey @gaboesquivel - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider changing the absolute import path in alchemy.ts to a relative or aliased import to avoid potential issues with file system differences.
• The TODO comments in the code should be addressed before merging. If they represent future work, consider creating separate issues and referencing them in the code instead.
• The error handling in addressActivityTask could be improved. Consider adding more context to the error or implementing a more robust error handling strategy.

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 85ff357 and 5034075.

Files ignored due to path filters (1)

• bun.lockb is excluded by !**/bun.lockb

Files selected for processing (11)

• .vscode/settings.json (1 hunks)
• apps/alchemy/package.json (1 hunks)
• apps/alchemy/src/create.ts (1 hunks)
• apps/alchemy/src/index.ts (1 hunks)
• apps/alchemy/src/types.ts (1 hunks)
• apps/indexer/package.json (1 hunks)
• apps/indexer/src/config.ts (2 hunks)
• apps/indexer/src/routes/alchemy.ts (3 hunks)
• apps/trigger/package.json (1 hunks)
• apps/trigger/src/trigger/activity.ts (1 hunks)
• packages/app-env/src/chains.ts (2 hunks)

Files skipped from review due to trivial changes (3)

• .vscode/settings.json
• apps/alchemy/src/index.ts
• apps/trigger/package.json

Additional context used

Biome

apps/alchemy/src/types.ts

[error] 7-7: Unexpected any. Specify a different type.

any disables many type checking rules. Its use should be avoided.

(lint/suspicious/noExplicitAny)

---

[error] 7-7: Unexpected any. Specify a different type.

any disables many type checking rules. Its use should be avoided.

(lint/suspicious/noExplicitAny)

---

[error] 1-1: All these imports are only used as types.

Importing the types with import type ensures that they are removed by the transpilers and avoids loading unnecessary modules.
Safe fix: Use import type.

(lint/style/useImportType)

Additional comments not posted (15)

apps/alchemy/package.json (3)

2-2: Scoped package name change is appropriate.

The update to a scoped package name enhances modularity and versioning control within a larger repository.

---

4-4: Addition of TypeScript types is beneficial.

Including TypeScript type definitions enhances type safety and developer experience for consumers of the package.

---

7-7: Script command update aligns with new workflows.

Replacing the "push" script with a "create" script likely reflects a new workflow or functionality that the project aims to support.

apps/trigger/src/trigger/activity.ts (3)

7-7: Function signature update enhances type safety.

Updating the function signature to use AlchemyWebhookEvent improves type safety and clarity regarding the expected structure of the input payload.

---

9-13: Internal logic changes streamline logging and error handling.

The changes improve performance and readability by reducing unnecessary data output and simplifying error handling.

---

1-1: Use import type for type-only imports.

To ensure types are removed by the transpilers and avoid loading unnecessary modules, use import type.

Apply this diff to update the import statement:

-import { AlchemyWebhookEvent, AlchemyActivity } from '@repo/alchemy'
+import type { AlchemyWebhookEvent, AlchemyActivity } from '@repo/alchemy'

Likely invalid or redundant comment.

apps/alchemy/src/types.ts (1)

15-31: Interfaces AlchemyActivity and AlchemyActivityEvent are well-defined.

The interfaces provide a clear structure for activities and events, aligning with the expected data structure.

packages/app-env/src/chains.ts (1)

34-46: Streamlined production chains and clear documentation.

The removal of certain chains from prodChains and the addition of a comment about Solana's exclusion reflect a strategic focus on EVM-compatible chains. The exports are consistent and enhance clarity.

apps/indexer/package.json (1)

19-19: Dependency addition approved. Verify its usage.

The addition of @repo/alchemy to the dependencies is approved. Ensure that this package is correctly integrated and utilized in the codebase.

Run the following script to verify the usage of @repo/alchemy:

Verification successful

---

Dependency usage verified. The @repo/alchemy package is actively and correctly utilized in the codebase, with its types being used in task definitions and request handling.

• apps/trigger/src/trigger/activity.ts: AlchemyWebhookEvent and AlchemyActivity are used in task logic.
• apps/indexer/src/routes/alchemy.ts: AlchemyWebhookEvent is used for request body typing.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `@repo/alchemy` in the codebase.

# Test: Search for imports or usage of `@repo/alchemy`. Expect: Occurrences of its usage.
rg --type js --type ts '@repo/alchemy'

Length of output: 242

---

Script:

#!/bin/bash
# Check the usage of AlchemyWebhookEvent and AlchemyActivity in the identified files.

# Search for usage of AlchemyWebhookEvent and AlchemyActivity in apps/trigger/src/trigger/activity.ts
rg 'AlchemyWebhookEvent|AlchemyActivity' apps/trigger/src/trigger/activity.ts -A 5

# Search for usage of AlchemyWebhookEvent in apps/indexer/src/routes/alchemy.ts
rg 'AlchemyWebhookEvent' apps/indexer/src/routes/alchemy.ts -A 5

Length of output: 1211

apps/indexer/src/config.ts (2)

24-29: LGTM! The addition of PRESALE_ADDRESS is consistent.

The validation logic for PRESALE_ADDRESS using isAddress is consistent with other address validations in the file.

---

43-43: LGTM! The update to appConfig is straightforward.

The addition of presaleAddress to appConfig is correctly implemented.

apps/indexer/src/routes/alchemy.ts (4)

11-19: LGTM! Ensure chainIdToNetwork covers all necessary chain IDs.

The mapping is correctly implemented for the specified chain IDs.

---

42-50: LGTM! The validation logic is comprehensive.

The validation logic in alchemyWebhook is well-implemented and enhances security.

---

58-58: LGTM! Including the event ID in the response message is a good enhancement.

The change provides clearer feedback on the specific webhook processed.

---

2-2: Verify the correctness of the import path for AlchemyWebhookEvent.

Ensure that AlchemyWebhookEvent is correctly imported from @repo/alchemy and that this aligns with the removal of the interface declaration from the file.

Run the following script to verify the import path:

[github-actions]

⚡️ Lighthouse report

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/
Report undefined

Category	Score
🔴 Performance	28
🟠 Accessibility	59
🟠 Best practices	74
🟠 SEO	79
🔴 PWA	38

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/about
Report undefined

Category	Score
🔴 Performance	10
🟠 Accessibility	59
🟠 Best practices	74
🟠 SEO	79
🔴 PWA	38

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/security
Report undefined

Category	Score
🔴 Performance	12
🟠 Accessibility	59
🟠 Best practices	74
🟠 SEO	79
🔴 PWA	38

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/bitcash-bitlauncher
Report undefined

Category	Score
🔴 Performance	37
🟠 Accessibility	65
🟠 Best practices	74
🟠 SEO	86
🔴 PWA	38

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/blog
Report undefined

Category	Score
🔴 Performance	41
🟠 Accessibility	66
🟠 Best practices	74
🟠 SEO	86
🟠 PWA	63

Page: https://bitlauncher-ocze1zlry-bitcash.vercel.app/blog/ai
Report undefined

Category	Score
🔴 Performance	37
🟠 Accessibility	59
🟠 Best practices	74
🟠 SEO	79
🔴 PWA	38