ipfs/ipfs-companion

Intercept URLs for JS libs at public CDNs

Open

#674 opened on Jan 31, 2019

View on GitHub
 (4 comments) (6 reactions) (0 assignees)JavaScript (364 forks)batch import
P3exp/intermediatehelp wantedkind/enhancementstatus/ready

Repository metrics

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

Description

Extracted from https://github.com/ipfs-shipyard/ipfs-companion/issues/570#issuecomment-421811923

Summary

Intercept URLs from public CDNs like unpkg.com and load them from IPFS.

Detection

Two ways:

  • Seamless: work with CDN operators to expose assets on IPFS paths /ipfs/<cid>/**/*.min.js
  • Grunt: identify the most popular assets across free CDNs, create a JSON mapping between filename/URL and CID and ship it with ipfs-companion as additional hint for creating redirects.

Additional Resources

Contributor guide

Research direction
Investigate how ipfs companion currently handles URL interception and identify the best approach to detect CDN URLs for redirecting to IPFS. Explore the two detection methods: collaborating with CDN operators or creating a static mapping file. Study prior art like Decentraleyes and the Mirroring Web to IPFS project.
Tech stack
javascript
Domain
frontendweb dev
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75