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 (364 forks)batch import
P3good first issuehelp wantedkind/enhancement

Repository metrics

Stars
 (1,992 stars)
PR merge metrics
 (Avg merge 53d 3h) (1 merged PR in 30d)

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

Research direction
Investigate how to parse the IPFS URL for peer hints (multiaddr and peer IDs) and implement an opt in experiment to connect to these peers for faster content discovery. Start by reviewing the IPFS Companion codebase, especially the IPFS provider and peer connection logic.
Tech stack
javascript
Domain
networking
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
JavaScriptIPFS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65