Skip to content

Latest commit

 

History

History
287 lines (194 loc) · 14.5 KB

CONTRIBUTING.md

File metadata and controls

287 lines (194 loc) · 14.5 KB
Raw

Contribution Guidelines

Thanks for your interest in contributing to Lodestar. It's people like you that push the Ethereum ecosystem forward.

Prerequisites

MacOS Specifics

When using MacOS, there are a couple of extra prerequisites that are required.

  • python
  • coreutils (e.g. via brew install coreutils)

Getting Started

  • ⚙️ Run yarn to install dependencies.
  • ⚙️ Run yarn build to build lib from source.
  • 📦 A lodestar binary will be bundled in ./packages/cli/bin.
  • 💻 Run ./lodestar --help to get a list of available commands and arguments.

Tests

To run tests:

  • 🧪 Run yarn test:unit for unit tests.
  • 🧪 Run yarn test:e2e for end-to-end tests.
  • 🧪 Run yarn test:spec for spec tests.
  • 🧪 Run yarn test to run all tests.
  • 🧪 Run yarn check-types to check TypeScript types.
  • 🧪 Run yarn lint to run the linter (ESLint).

Note that to run test:e2e, first ensure that the environment is correctly setup by running the run_e2e_env.sh script. This script requires a running docker engine.

./scripts/run_e2e_env.sh start

Similarly, run yarn download-spec-tests before running yarn test:spec.

Contributing to tests:

  • Test must not depend on external live resources, such that running tests for a commit must be deterministic:
    • Do not pull data from external APIs like execution JSON RPC (instead run a local node).
    • Do not pull unpinned versions from DockerHub (use deterministic tag) or Github (checkout commit not branch).
    • Carefully design tests that depend on timing sensitive events like p2p network e2e tests. Consider that Github runners are significantly less powerful than your development environment.

Common Issues

Error: [vitest] Cannot mock "../../src/db/repositories/index.js" because it is already loaded by "src/db/beacon.ts"

If you observe any error in tests with matching to above error message, that implies you are loading the mocks in the wrong order. The correct order is to import the mocks first and then the actual module. We suggest to import the mocks on very top before any local modules.

✖ Error: Cannot find package 'async_hooks' imported from

If you observe following error running any of the test files that means you are running a file which itself or any dependency of that file imports vitest, but you are not running that file with vitest runner. Try running it with yarn vitest command, not with node command.

Debugging Spec Tests

  • To fix errors always focus on passing all minimal tests first without running mainnet tests.
  • Spec tests often compare full expected vs actual states in JSON format.
  • A single logical error can cause many spec tests to fail. To focus on a single test at a time you can use vitest's option --bail 1 to stop at the first failed test
  • To then run only that failed test you can run against a specific file as use vitest's filters option -t <pattern> to run only one case
  • Before running the tests, make sure to switch to the package directory (e.g. packages/beacon-node) to speed up test execution
LODESTAR_PRESET=minimal yarn vitest --run --bail 1 --config vitest.spec.config.ts test/spec/presets/sanity.test.ts -t attester_slashing

Docker

The docker-compose file requires that a .env file be present in this directory. The default.env file provides a template and can be copied .env:

cp default.env .env
Beacon node only
docker-compose up -d
Beacon node and validator

First, you must have keystores and their secrets available locally at ./keystores and your password.txt in ./secrets

docker-compose -f docker-compose.yml -f docker-compose.validator.yml up -d
Dockerized metrics + local beacon node

Run a local beacon with --metrics enabled. Then start Prometheus + Grafana with all dashboards in ./dashboards automatically loaded running:

./docker/docker-compose.local_dev.sh

First Time Contributor?

Unsure where to begin contributing to Lodestar? Here are some ideas!

  • ✏️ See any typos? See any verbiage that should be changed or updated? Go for it! Github makes it easy to make contributions right from the browser.
  • 🔎 Look through our outstanding unassigned issues. (Hint: look for issues labeled good first issue or help-wanted!)
  • 💬 Join our Discord chat! Discord

Reporting A Bug?

  • 🗒️ Create a new issue! Select the type of issue that best fits, and please fill out as much of the information as you can.

Contribution Process

  1. Make sure you're familiar with our contribution guidelines (this document)!
  2. Create your own fork of this repository.
  3. Make your changes in your local fork.
  4. If you've made a code change, make sure to lint and test your changes (yarn lint and yarn test:unit).
  5. Make an open pull request when you're ready for it to be reviewed. We review PRs on a regular basis. See Pull request etiquette for more information.
  6. You may be asked to sign a Contributor License Agreement (CLA). We make it relatively painless with CLA-bot.

Github Style Guide

Branch Naming

If you are contributing from this repository prefix the branch name with your Github username (i.e. myusername/short-description)

Pull Request Naming

Pull request titles must be:

  • Adhering to the conventional commits spec
  • Short and descriptive summary
  • Written in imperative present tense
  • Not end with a period

For example:

  • feat: add lodestar prover for execution api
  • fix: ignore known block in publish blinded block flow
  • refactor(reqresp)!: support byte based handlers

Pull Request Etiquette

  • Pull requests should remain as drafts when they are not ready for review by maintainers. Open pull requests signal to the maintainers that it's ready for review.
  • If your pull request is no longer applicable or validated to fix an issue, close your pull request.
  • If your pull request is fixable and needs additional changes or commits within a short period of time, switch your pull request into a draft until it's ready.
  • Otherwise, close your pull request and create a new issue instead.

Lodestar Monorepo

We're currently experimenting with hosting the majority of lodestar packages and support packages in this repository as a monorepo. We're using Lerna to manage the packages. See packages/ for a list of packages hosted in this repository.

Style Guide

  • Lodestar has migrated to using ES modules.
  • Many module class constructors have the following signature: (options, dependencies)
    • e.g.: public constructor(opts: IExampleOptions, {db, logger}: IExampleModules)
  • Modules should be designed to "do one thing and do it well!"
    • Consider the interface of a module -- events included, and make sure it is coherent
  • Make sure your code is properly linted
    • use an IDE that will show linter errors/warnings
    • run yarn lint from the command line
    • common rules:
      • Functions and variables should be camelCase, classes should be PascalCase, constants should be UPPERCASE_WITH_UNDERSCORES.
      • Use " instead of '
      • All functions should have types declared for all parameters and return value
      • You shouldn't be using TypeScript type any
      • Private class properties should not be prefixed with a _
        • e.g.: private dirty;, not private _dirty;
  • Make sure that your code is properly type checked:
    • use an IDE that will show type errors
    • run yarn check-types from the command line
  • Make sure that the tests are still passing:
    • run yarn test:unit from the command line
  • Commenting: If your code does something that is not obvious or deviates from standards, leave a comment for other developers to explain your logic and reasoning.
    • Use // commenting format unless it's a comment you want people to see in their IDE.
    • Use /** */ commenting format for documenting a function/variable.
  • Code white space can be helpful for reading complex code, please add some.
  • For unit tests, we forbid import stubbing when other approaches are feasible.
  • Metrics are a critical part of Lodestar, every large feature should be documented with metrics
    • Metrics need to follow the Prometheus Best Practices
    • For metric names, make sure to add the unit as suffix, e.g. _seconds or _bytes
    • Metric code variables on the other hand should not be suffixed, i.e. Sec-suffix should be omitted
    • Time-based metrics must use seconds as the unit

Tests style guide

Test must not depend on external live resources, such that running tests for a commit must be deterministic:

  • Do not pull data from external APIs like execution JSON RPC (instead run a local node).
  • Do not pull unpinned versions from dockerhub (use deterministic tag) or Github (checkout commit not branch).
  • Carefully design tests that depend on timing sensitive events like p2p network e2e tests. Consider that Github runners are significantly less powerful than your development environment.

Add assertion messages where possible to ease fixing tests if they fail. If an assertion message is called from multiple times with the same stack trace, you MUST include an assertion message. For example, if an assertion is inside a for loop add some metadata to be able to locate the error source:

for (const blockResult of blocksResult) {
  expect(blockResult.status).equals("processed", `wrong block ${blockResult.id} result status`);
}

Logging policy

Logging Levels

Contributors must choose the log level carefully to ensure a consistent experience for every type of user:

  • error: Critical issues that prevent the application from functioning correctly or cause significant disruption to users. Examples include failed network connections, crashes, or data corruption.
  • warn: Situations that may lead to critical issues if not addressed but do not prevent the application from functioning. Examples include configuration issues, deprecated features, or temporary network disruptions.
  • info: General sporadic informational about the node's state. Examples include initialization messages, infrequent periodic status updates, or high-level progress reports.
  • debug: Detailed diagnostic information that can help developers or users troubleshoot specific issues. Examples include individual request logs for every REST API, networking interactions, or internal components status changes. Alias to verbose.

Logging guidelines

  • Avoid excessive logging. Log messages should be clear and concise, providing enough information to understand the context and severity of the issue.
  • Do not log sensitive data, such as private keys, user credentials, or personal information.
  • Do not log arbitrary data from the network as ASCII or UTF8 at levels higher or equal to info.
  • Use clear and concise language. Prefer to log variables in JSON format log.debug("Action", {slot}) instead of formatting the text yourself log.debug('slot=${slot}').
  • Include only relevant context in log messages, sufficient to debug the issue or action it refers to.

Contributing to Grafana dashboards

To edit or extend an existing Grafana dashboard with minimal diff:

  1. Grab the .json dashboard file from current unstable
  2. Import the file to Grafana via the web UI at /dashboard/import without modifying the UID of the dashboard
  3. Visually edit the dashboard
  4. Once done make sure to leave the exact same visual aspect as before: same refresh interval, time range, etc.
  5. Save the dashboard (CTRL+S)
  6. Run download script, see below on how to use it
  7. Check git diff of updated dashboards, commit, push and open your PR

Using Download Script

Create a file .secrets.env with envs

GRAFANA_API_KEY=$token
GRAFANA_URL=https://yourgrafanaapi.io

Run script to download dashboards to ./dashboards folder

node scripts/download_dashboards.mjs

Contributing to Documentation

When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. First generate the CLI documentation with yarn docs:build. Then build and serve the documentation locally with yarn docs:serve.

Your locally served documentation will then be accessible at http://localhost:3000/lodestar/.

We also use a spelling word list as part of our documentation checks. If using unrecognized words or abbreviations, please extend the word list to pass checks. Make sure the list is sorted with ./scripts/wordlist_sort.sh and checked with ./scripts/wordlist_sort_check.sh for sorting and duplicates.

Label Guide

Issues and pull requests are subject to the following labeling guidelines.

  • PRs may have a status label to indicate deviation from the normal process such as status-blocked or status-do-not-merge
  • Issues and PRs will be tagged with a scope and prio to indicate type and priority for triage.
  • All other labels allow for further evaluation and organization.

Label descriptions can be found below.

status.* Issues and Pull Request Status

Status labels apply to issues and pull requests which deviate from normal processes.

scope.* Scope Indicator

Scope is comparable to Module labels but less strict with the definition of components. It applies to both, issues and pull requests.

prio.* Prioritization Indicator

A simple indicator of issue prioritization. It mainly applies to issues.

spec.* Ethereum Consensus Spec Version Target

Issues that target a specific version of the Ethereum consensus spec, shall be tagged accordingly.

Community

Come chat with us on Discord and join our public weekly planning meetings!