feat: dockerize

[mejiasd3v]

Summary by CodeRabbit

• New Features

  • Introduced a .dockerignore file to optimize Docker builds by excluding unnecessary files.
  • Added .env.example to guide the setup of environment variables such as DATABASE_URL and MAX_BLOCK_RANGE.
  • Implemented a multi-stage Docker build process for Node.js applications, enhancing efficiency and security.
  • Configured application to use a maxBlockRange setting, allowing customization of block range limits through environment variables.

• Chores

  • Set up foundational configurations for Docker and environment variables to streamline development and deployment processes.

[coderabbitai]

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)

• package.json is excluded by: !**/*.json

Walkthrough

This update introduces a series of optimizations and configurations for a Node.js application, focusing on Docker and environment setups. A .dockerignore file is added to streamline Docker builds, excluding unnecessary files. The .env.example file sets the stage for essential environment variables. The Dockerfile is revamped for efficiency with a multi-stage build process, using PNPN for package management. Lastly, ponder.config.ts integrates a new configuration to control the maximum block range, enhancing network interactions.

Changes

Files	Change Summaries
.dockerignore, .env.example, .ponder	Excludes node_modules, .env, .env.example, and .ponder from Docker build context.
Dockerfile	Introduces a multi-stage build using PNPM, with installer and runner stages for a Node.js application.
ponder.config.ts	Adds maxBlockRange constant, using MAX_BLOCK_RANGE or defaulting to 2000, for network configuration use.

🐰✨
In the land of code and byte,
A rabbit hopped through the night.
With Docker files and .env in sight,
It set the configs just right.
🌟 "To the future," it whispered, light as air,
"With builds so swift and clean, we fare."
🚀💨

---

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4ecf038 and f524f4e.

Files ignored due to path filters (1)

• package.json is excluded by: !**/*.json

Files selected for processing (4)

• .dockerignore (1 hunks)
• .env.example (1 hunks)
• Dockerfile (1 hunks)
• ponder.config.ts (5 hunks)

Files skipped from review due to trivial changes (2)

• .dockerignore
• .env.example

Additional comments: 3

Dockerfile (2)

• 11-12: The use of --frozen-lockfile with pnpm install is a good practice as it ensures that the installed dependencies match the lock file, preventing accidental updates. This contributes to consistent and reproducible builds.
• 17-20: Copying the node_modules from the installer stage and the application code into the runner stage is done correctly. However, ensure that sensitive files (e.g., .env) are not inadvertently included in the final image. The .dockerignore file should be configured to exclude such files.

Verification successful

---

The .dockerignore file is correctly configured to exclude .env files, as evidenced by the script output. This aligns with the best practices mentioned in the review comment.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Ensure .dockerignore excludes sensitive files
grep -E '^\s*\.env($|\s)' .dockerignore

Length of output: 46

ponder.config.ts (1)

• 33-33: The usage of maxBlockRange in the network configurations for different contracts is consistent and aligns with the objective of enhancing the application's configurability. This approach allows for easy adjustments to the maximum block range without code changes.

Also applies to: 43-43, 54-54, 65-65

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f524f4e and 58f1a2d.

Files ignored due to path filters (1)

• package.json is excluded by: !**/*.json

Files selected for processing (2)

• .github/actions/setup/action.yml (1 hunks)
• .github/workflows/ci.yml (1 hunks)

Additional comments: 2

.github/actions/setup/action.yml (1)

• 8-21: The setup action is well-configured, utilizing best practices for setting up pnpm and node, and ensuring reproducibility with --frozen-lockfile. Consider documenting the expected environment variables, such as matrix.node-version, for clarity and ease of use.

.github/workflows/ci.yml (1)

• 9-31: The CI workflow is well-structured, efficiently managing concurrency and providing comprehensive linting across multiple node versions. It's good practice to ensure that the custom setup action and the commands (pnpm codegen, pnpm typecheck, pnpm lint) are well-documented and maintained to prevent potential issues in the CI process.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 58f1a2d and 55e6e14.

Files ignored due to path filters (2)

• package.json is excluded by: !**/*.json
• pnpm-lock.yaml is excluded by: !**/*.yaml

Files selected for processing (2)

• .github/actions/setup/action.yml (1 hunks)
• .github/workflows/ci.yml (1 hunks)

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

• .github/actions/setup/action.yml
• .github/workflows/ci.yml