onflow / onflow/flow

Make nodeOperators a JSON instead of md

Open
#1,464 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Feedback
Dominant language
Go
Stars
361
Forks
159
PR merge metrics
No merged PRs in 30d

Description

Issue To Be Solved

Currently, we fetch names of node operators from here, https://github.com/onflow/flow/blob/master/nodeoperators/NodeOperatorList.md
The issue is that this list is a .md file. We currently parse the .md but recently it changed which broke the parsing.
The current version creates technical dept and maintenance costs for anybody who wants to use this data.

(Optional): Suggest A Solution

Create a JSON file that would contain node ids and validator names. This new JSON file would replace the list of node operators in the md file.

Alternatively, node operator names can be added to this file https://github.com/onflow/flow/blob/master/nodeoperators/nodelist.json

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with nodeoperators/NodeOperatorList.md and nodeoperators/nodelist.json, then search the repository for references to the Markdown list and its parser. Decide which JSON location is the source of truth, preserve node IDs and validator names, and verify that consumers no longer depend on the Markdown format.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.