build: add nix flake for hermetic dev environments

[corduroybera]

Summary by CodeRabbit

• Documentation
  • Updated README with setup instructions for standard and Nix Flakes development environments.
• New Features
  • Added instructions and commands for setting up and testing the Nix Flakes environment alongside the existing standard development environment setup.

[coderabbitai]

Walkthrough

The project has expanded to support a new development setup, integrating the Nix Flakes system for reproducible builds, alongside the traditional development environment. This involves updating the documentation to guide users through the new setup process and modifying the .gitignore to exclude environment-specific files generated by these changes.

Changes

File(s)	Change Summary
.gitignore	Added .envrc and .direnv/ to ignored files/directories.
README.md	Updated to include setup instructions for both standard and Nix Flakes development environments for the Polaris framework.
flake.nix	Introduced an EVM framework for Cosmos, defining a Nix Flakes development environment for the "polaris-dev" shell.

Poem

🐇✨
In the code garden, changes bloom,
Nix Flakes grow, giving devs room.
.envrc, .direnv, now ignored,
Polaris sets sail, its devs aboard. 🚀🌌

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-tests for this file.
• 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 from git 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: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 25fbe13 and 0f57689.

Files ignored due to path filters (1)

• flake.lock is excluded by: !**/*.lock

Files selected for processing (3)

• .gitignore (2 hunks)
• README.md (2 hunks)
• flake.nix (1 hunks)

Files skipped from review due to trivial changes (2)

• .gitignore
• README.md

Additional comments: 6

flake.nix (6)

• 1-3: The description provided is succinct and relevant.
• 4-8: The inputs section correctly specifies the sources for nixpkgs, flake-utils, and foundry. Ensure that the nixpkgs-unstable and monthly branches are appropriate for the project's stability requirements.
• 11-17: The outputs function signature includes ..., which allows for additional inputs. This is a flexible approach but ensure that it doesn't lead to unexpected behavior if additional inputs are provided that are not handled by the code.
• 14-17: The pkgs variable is defined using the nixpkgs input with an overlay from foundry. This is a standard approach to include additional packages. Verify that the foundry.overlay is correctly providing all necessary dependencies.
• 19-26: The devShell is defined with a clear name and includes essential build tools such as gnumake, go, jq, and foundry-bin. Ensure that all required native build inputs for the Polaris framework are included.
• 29-31: The shellHook sets a custom prompt indicating the developer is in the "dev" environment. This is a helpful visual cue for developers. Ensure that no additional environment setup is required that is not included in the shellHook.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0f57689 and 519f539.

Files selected for processing (1)

• README.md (2 hunks)

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

• README.md