feat: token issuance trigger part 2

[gaboesquivel]

Summary by Sourcery

Enhance documentation for the Bitlauncher Indexer and Alchemy projects by adding detailed descriptions and setup instructions. Update the Alchemy webhook URL to use the new launchpad indexer endpoint.

Enhancements:

• Update the webhook URL in the Alchemy source code to point to the new launchpad indexer endpoint.

Documentation:

• Expand the Bitlauncher Indexer README to include detailed descriptions of its key responsibilities and features.
• Add a 'Getting Started' section to the Alchemy README with a link to the Alchemy SDK Developer Challenge Guide for setup instructions.

Summary by CodeRabbit

• New Features

  • Added a "Getting Started" section to the Alchemy project's README for improved onboarding and setup guidance.
  • Introduced a new script in the Alchemy project to streamline running commands via the package manager.
  • Enhanced the Bitlauncher Indexer's README with a comprehensive overview of its functionalities and responsibilities.
  • Established a configuration module in Alchemy to validate essential environment variables, improving reliability.

• Bug Fixes

  • Updated the webhook notification URL to ensure correct delivery of address activity notifications.

[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 22, 2024 6:16pm
smartsale-faucet	❌ Failed (Inspect)			Aug 22, 2024 6:16pm

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the documentation for the Bitlauncher Indexer and Alchemy components, and updates the Alchemy webhook URL. The changes provide more detailed information about the Indexer's functionality and responsibilities, add a reference to the Alchemy SDK Developer Challenge Guide, and update the webhook URL in the Alchemy component.

File-Level Changes

Files	Changes
apps/indexer/README.md	Added comprehensive description of the Bitlauncher Indexer's functionality and responsibilities
apps/alchemy/README.md	Added reference to the Alchemy SDK Developer Challenge Guide for setup and configuration instructions
apps/alchemy/src/index.ts	Updated the Alchemy webhook URL to point to a new endpoint

---

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]

Walkthrough

The recent changes encompass the addition of a "Getting Started" section in the Alchemy project's README, the introduction of a new script in the package.json for the alchemy-hooks project, and updates to configuration management in the index.ts file. Additionally, the Bitlauncher Indexer’s README now includes a detailed overview of its functionalities and responsibilities, improving overall documentation clarity.

Changes

File	Change Summary
apps/alchemy/README.md	Added a "Getting Started" section outlining project alignment with the Alchemy SDK Developer Challenge Guide for setting up and configuring webhooks.
apps/alchemy/package.json	Introduced a new "scripts" section with a "push" script to execute bun src/index.ts and added dependencies "viem" and "zod."
apps/alchemy/src/config.ts	Introduced config.ts for environment variable management and validation using zod.
apps/alchemy/src/index.ts	Updated the createAddressActivityNotification function to use configuration-based values for the auth token, webhook URL, and monitored addresses.
apps/indexer/README.md	Enhanced documentation with a comprehensive overview of the Bitlauncher Indexer's functionality, responsibilities, and capabilities in blockchain data processing.

Poem

🐰 In the garden of code, changes bloom bright,
New scripts and webhooks, a delightful sight.
With clearer paths for all to explore,
The indexer dances, its functions soar!
Hopping along, we celebrate this cheer,
With every new line, progress is near! 🌼✨

---

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 and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟡 Security: 1 issue found
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 3 issues found

---

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2a25ee6 and a9705fc.

Files selected for processing (4)

• apps/alchemy/README.md (1 hunks)
• apps/alchemy/package.json (1 hunks)
• apps/alchemy/src/index.ts (1 hunks)
• apps/indexer/README.md (1 hunks)

Files skipped from review due to trivial changes (2)

• apps/alchemy/README.md
• apps/alchemy/package.json

Additional comments not posted (2)

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

15-15: Verify the new webhook URL.

Ensure that the new webhook URL 'https://launchpad-indexer-ymrgicuyta-uc.a.run.app/alchemy' is correct and accessible.

Consider checking the URL's accessibility and correctness in the deployment environment.

apps/indexer/README.md (1)

3-16: Documentation enhancements approved.

The added content provides a comprehensive overview of the Bitlauncher Indexer's functionalities and responsibilities, improving the overall informational value of the README.

[github-actions]

⚡️ Lighthouse report

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

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

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

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

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

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

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

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

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

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

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

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

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

13-17: Consider enhancing error logging for debugging.

While the current error handling is functional, consider logging the error stack or additional details to aid in debugging.

 if (!parsedEnv.success) {
-  console.error('Environment validation failed:', parsedEnv.error.format())
+  console.error('Environment validation failed:', parsedEnv.error.format(), parsedEnv.error)
   process.exit(1)
 }

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a9705fc and 9342895.

Files ignored due to path filters (1)

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

Files selected for processing (3)

• apps/alchemy/package.json (2 hunks)
• apps/alchemy/src/config.ts (1 hunks)
• apps/alchemy/src/index.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• apps/alchemy/package.json
• apps/alchemy/src/index.ts

Additional comments not posted (4)

apps/alchemy/src/config.ts (4)

1-3: Imports are correctly set up.

The imports of zod, isAddress, and dotenv are necessary and correctly used for environment validation and configuration.

---

5-5: Environment variables are correctly loaded.

The use of dotenv.config() is appropriate for loading environment variables from a .env file.

---

7-11: Environment schema is well-defined.

The envSchema uses zod to validate environment variables effectively, ensuring they are present and valid.

---

20-24: Configuration export is clear and effective.

The appConfig object provides a clear and effective way to access validated environment variables.