mimblewimble/grin

Add mining endpoint to Node API

Open

#3201 opened on Jan 20, 2020

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Rust (4,876 stars) (991 forks)batch import
good first issuehelp wanted

Description

Feature request: add a "Mining Endpoint" to the Node API, that could be used to retrieve the stats currently available on the Mining tab of the TUI. Would also be handy to get this into grin client.

Currently, when running grin in headless mode, there is no way to retrieve the mining statistics such as the connected workers.

Contributor guide

Tech stack
rust
Domain
backendapicli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RustGrin codebaseNode APICLI tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, examine the existing Node API documentation at doc/api/node api.md to understand the endpoint structure. Then, look at the TUI mining tab implementation to identify the mining stats data structure and how it's collected. Implement a new API endpoint that returns similar stats, and optionally add a corresponding CLI command in grin client using the same endpoint. Check for any ongoing work or related issues in the repository.