search

polymerdao / evm-indexer

MIT License
8 stars 4 forks source link

Simplifying chain expansion #32

Closed Inkvi closed 1 month ago

Inkvi commented 2 months ago

Creating a new processor for each file is no longer required. The processor can be fully controlled via env vars and a config file.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces significant changes to the repository, including a renaming from multichain-transfers-example to evm-indexer, reflecting an expanded functionality beyond USDC transfers. Modifications include a streamlined command structure for processing various blockchain transactions, enhancements to configuration options, and the removal of specific processor files. The updates aim to simplify the setup and execution of multichain transfers, improving overall flexibility and ease of use.

Changes

File(s) Change Summary
README.md Removed initial project description and USDC Transfer references; updated quickstart section for new repository name; simplified commands for Optimism and Base chains; streamlined setup instructions and environment variables.
commands.json Consolidated individual processor commands into a general "process" command; updated command entries to point to a single processor file; simplified production command structure.
squid.yaml Simplified command arguments for processors; replaced specific RPC endpoint variables with a unified PROCESSOR_NAME variable for both processors.
src/chains/backfill.ts, Deleted file responsible for backfill processing; removed invocation of runProcessor for backfill tasks.
src/chains/optimism.ts, Deleted file for processing Optimism transactions; removed invocation of runProcessor.
src/chains/wallets/base.ts, Deleted file for processing base wallet transactions; removed invocation of runProcessor.
src/chains/wallets/eth.ts, Deleted file for processing Ethereum transactions; removed invocation of runProcessor.
src/chains/wallets/optimism.ts Deleted file for processing Optimism wallet transactions; removed invocation of runProcessor.
src/chains/processor.ts Updated runProcessor invocation to remove the first parameter, simplifying the call.
src/utils/ibc-processor.ts Enhanced ConfigSchema with optional parameters; updated IbcProcessor and runProcessor function signatures for improved configurability and error handling.

Possibly related PRs

Suggested reviewers

Poem

🐇 In the meadow where bunnies play,
Changes hop in a joyful sway.
Transfers now across the chain,
Simplified paths, no more strain.
With every leap, a new command,
Together we build, oh so grand! 🌼

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 , please review it.` -- `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@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.
mvpoyatt commented 1 month ago

@Inkvi Looking at the README it's not totally clear to me how to add a new chain. Are developers supposed to add a new configuration file, update an environment variable, or both? Can we update the .env already being tracked with examples, or do we need to add the env variable for them?

Inkvi commented 1 month ago

@Inkvi Looking at the README it's not totally clear to me how to add a new chain. Are developers supposed to add a new configuration file, update an environment variable, or both? Can we update the .env already being tracked with examples, or do we need to add the env variable for them?

They can do either or both. Env vars take precedence over the config.