ipfs/ipfs-companion

Redirect ipfs.io/api/v0/*

Open

#870 opened on Apr 23, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (364 forks)batch import
P2effort/hourshelp wantedkind/enhancementstatus/ready

Repository metrics

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

Description

I suspect some apps may leverage the fact that a subset of APIs is exposed under ipfs.io/api/v0/.

Companion should redirect things like https://ipfs.io/api/v0/cat?arg=/ipns/docs.ipfs.io/assets/logo.svg (especially ones with ranges and offsets) to maximize the use of local nodes.

  • Q: could this be a partial replacement for window.ipfs?
    • A: Yes, for basic read-only commands like ipfs.cat. People could simply code against https://ipfs.io/api/v0 and browsers with native support (or companion extension) would just redirect those requests to local node.

Contributor guide

Research direction
Understand how IPFS Companion intercepts HTTP requests and add logic to redirect /api/v0/* to local IPFS node.
Tech stack
javascript
Domain
apifrontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptbrowser extension basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60