ipfs/ipfs-companion

Add Peer URI Hint Experiment

Open

#722 opened on May 19, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (1,992 stars) (364 forks)batch import
P3good first issuehelp wantedkind/enhancement

Description

 ipfs://{cid}?provs={multiaddr1},{peerId2},{peerId3}` 
 http://127.0.0.1:8080/ipfs/{cid}?provs={multiaddr1},{peerId2},{peerId3}

The idea is to detect above hints and connect to listed peers to improve content discovery speed if possible. Due to potential privacy considerations, this should start as opt-in experiment.

Ref.

Contributor guide

Tech stack
javascript
Domain
performance
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
basic understanding of IPFSJavaScriptbrowser extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by reading the linked discussion (https://discuss.ipfs.io/t/proposal peer hint uri scheme/4649/9) to understand the proposal and any community feedback. Then examine the current IPFS Companion source code (likely in src/ or add on/ directories) to see how URI handling is implemented. Focus on how to detect the 'provs' query parameter in IPFS URIs and establish connections to listed peers. Consider privacy implications, as the issue suggests making this opt in. Look for existing experiments or feature flags in the codebase to structure the implementation. There is no linked PR or assignee, so this is open for contribution.