ipfs/kubo

dir-index-html: add indicator if CID is cached in local datastore

Open

#8,817 opened on Dec 14, 2021

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Go (2,725 forks)batch import
P3effort/daysexp/intermediatehelp wantedkind/enhancement

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

As a user of IPFS, it's difficult to visualize if files are cached on the gateway you're connected to vs if the files need to be retrieved from the network.

Describe the solution you'd like An indicator to show if a CID is cached on the current gateway.

Example (horrible) mock up:

pin

The first three entries are cached on the gateway, the final one would require pulling from other IPFS nodes. Three indicators may be needed:

  • Fully cached locally
  • Partially cached locally
  • Not cached locally

Contributor guide

Research direction
Explore how the directory index HTML is generated in the `dir index html` package and determine how to query the local datastore for CID caching status. Implement indicators for fully cached, partially cached, and not cached.
Tech stack
gohtmlcssjavascript
Domain
backendfrontend
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45