Botanix Protocol

A blazing fast and secure L2 for Bitcoin using the EVM as a superstructure.

Running and Testing the Project

1. Setting up nodes locally
2. Setting up nodes locally using scripts
3. Running nodes with Docker
4. Executing the test suite

Getting Help

If you have any questions, first see if the answer to your question can be found in the book.

If the answer is not there:

• Join the Telegram to get help, or
• Open a discussion with your question, or
• Open an issue with the bug

Submitting a Pull Request

To ensure code quality and consistency, please follow these steps when preparing to submit a pull request:

1. Install Pre-commit: Make sure you have pre-commit installed on your machine. This tool helps enforce code formatting and other checks before committing changes.

2. Install Dependencies: Run pnpm i in the root directory (this step only needs to be done once). Make sure you have node and pnpm installed on your system.

3. Format Code Before Pushing: Anytime you've made changes and are ready to push, run make fmt. This will format your code according to the project's standards.

4. Run Lint Checks (Optional but Recommended): Occasionally, you may want to perform a lint check by running make lint. This will run additional checks (like clippy for Rust) to catch potential improvements. Note that lint checks are not automatically enforced by the pipeline, so it is your responsibility to ensure the code quality is maintained and that clippy does not flag any issues.

---

By following these steps, you help ensure that all code contributions meet the project's quality standards. Thank you!

Security

See SECURITY.md.