Need for IPIP: Data Onboarding via HTTP POST (and future ipfs:// POST|PUT)

未关闭
#375 12 条评论 17 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清

调研方向

从 Kubo Gateway.Writable configuration documentation、WIP IPIP draft 以及 specs pull request 224 中的想法开始。定义用于 delegated files/directories 和 native blocks/CARs 的与供应商无关的 HTTP POST onboarding 协议,同时解决 TAR、form-data 和中断上传相关的问题;完成的标准是形成一份可用的 IPIP 规范和参考实现范围。

由索引模型根据 Issue 内容生成。

描述

IPIP need/community-input P2

Problem statement

HTTP Gateways are the most successful way for retrieving content-addressed data. Successful use of HTTP for retrieval use cases proves that IPFS does not replace HTTP, but augment it by providing variability and resiliency. IPFS over HTTP brings more value than the sum of its parts.

Removing the need for implementation specific RPC APIs (like one in Kubo) allowed not only faster adoption of CIDs on the web, but enabled alternative implementations of IPFS (like Iroh in Rust) to test compliance and benchmark thenselves against each other.

While we have HTTP Gateways as a standard HTTP-based answer to the retrieval of data stored with IPFS (including verifiable application/vnd.ipld.raw and application/vnd.ipld.car responses), the data onboarding over HTTP is currently done with vendor-specific APIs.

The status quo at 2023 Q1 is pretty bad from the end user/developer’s perspective: every IPFS implementation, including online services providing storage and pinning services, exposes custom opinionated HTTP API for onboarding data to IPFS.

Why we need IPIP for HTTP Data Onboarding

To illustrate, some prominent examples (2022 Q4):

Click to expand :see_no_evil:

And the CAR upload API insanity corca 2024 Q1:

This state of things introduces an artificial barrier to adoption: the user needs to learn what APIs are available, and then “pick winners” – decide which implementations and services are the most future-proof. And even then, many choices are burdened by legacy of Kubo RPC and it’s degraded performance and DX/UX in web browsers.

Goal: create data onboarding protocol for both HTTP and native IPFS

The intention here is to create IPIP with a vendor-agnostic protocol for onboarding data that:

  • is easy to use and implement in HTTP (POST https://)
    • does not require any libraries or documentation,
    • and is as easy to work with from JS with fetch API as it is in the command-line with curl
  • follow the retrieval story, where ipfs:// behavior is analogous to subdomain gateways
    • 👉 what we want, is to have a protocol that can be represented as both POST https:// AND POST ipfs:// APIs

IPIP scope

We want two IPIPs: one for onboarding data with HTTP POST, and one for authoring (modifying/pathing) it with HTTP PUT.
This allows us to ship most useful onboarding first, and then do authoring as an optional add-on, which services may support, but dont have to (if they are only onboarding to filecoin etc).

For now, focusing on the POST

POST Requests (Onboarding)

👉 This is the minimal scope we need to cover from the day one, ensuring every use case has a vendor-agnostic spec.

  • Delegated
    • Single File (UnixFS) or single (DAG-)CBOR/JSON document
    • Arbitrary Directory tree (UnixFS)
      • Option A: TAR stream
        • open question: how does this handle interrupted upload? can server tell some data is missing?
      • Option B: custom form-data? (think twice, we have lessons learned around RPC at /api/v0/add in Kubo)
  • Native
    • Raw block
    • CAR stream

The working code for this will be reference implementation that replaces/updates the legacy Gateway.Writable feature in Kubo with the above feature set.

PUT/PATCH/DELETE Requests (Authoring)

This will be a separate IPIP, but flagging this as long term plans that should feel idiomatic too.

  • TBD: Delegated vs Native
  • Critical: ensure no surprises, UX/DX is paramount. Needs research and analysis.
    • One idea is to keep it limited to patching UnixFS paths and DAG-JSON/CBOR documents.
    • Other idea is to have syntax parity with JSON-based IPLD Path and have the same JSON syntax as dag diff and dag patch commands.

References

主要语言
HTML
星标
1.2k
派生
250
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ipfs/specs 的其他 Issue

查看 ipfs/specs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。