ipfs/kubo

API for transfer progress stats

Open

#3,054 opened on Aug 7, 2016

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
exp/novicehelp wantedstatus/deferred

Description

There has been a fair amount of demand for a way to check the 'transfer progress' of a given file, similarly to how torrent clients show.

This is not currently a very easy thing to track, but i think that we can abuse context values and the commands diagnostics api (ipfs diag cmds) codebase to get something working here.

We first should design what we want this api to look like, and what format the information it provides should be in. Then we can go ahead and try to implement it.

Contributor guide

Tech stack
go
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
GoIPFS basicsContext valuesDiagnostics commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by reading the existing `ipfs diag cmds` command implementation in the Go codebase (likely in `commands/diag.go`). Understand how context values are used to track progress. Review any comments on this issue for prior ideas. Design the API response format and then implement by extending the diagnostics API.