Include IPNS Record in Gateway CAR responses

オープン
#369 コメント 8 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞

調査の方向性

Trustless Gateway の仕様とリンクされている IPIP-351、IPIP-402、IPIP-412 の資料から始め、その後、issue で提案されている record-first の CAR 形式を確認します。CAR のルートと request signaling に関する未解決の疑問を解消し、content-path の import/export に必要な Trustless Gateway と Kubo の動作を定義します。仕様と実装範囲がもはや曖昧でなくなれば完了です。

索引モデルが issue の本文から書いたものです。

説明

IPIP need/triage

IPIP-351: IPNS Signed Records Response Format on HTTP Gateways will return a raw IPNS record, allowing a custom light client to verify IPNS without having to run DHT client.

Users asked for the ability to export both CIDs and IPNS record into a CAR, transport over sneakernet and load this on airgapped node, which is a good use case.

Another use case is Decentralized Gateway WG, which could benefit from the ability to have a single round-trip that includes full or partial CAR with content + ipns-record.

Broad strokes UX we want to accommodate:

$ curl http://gateway.foo/ipns/{id}?format=car&something > ipns-site-dump.car
$ ipfs import ipns-site-dump.car # imaginary command that goes beyond DAGs 
$ ipfs resolve /ipns/{id}   # works, even in offline mode
$ ipfs dag stat  /ipns/{id} # works, even in offline mode

Initial notes / subtasks

  • need to add a new ipns-record codec, to indicate special meaning of this additional block. Done: https://github.com/multiformats/multicodec/pull/312
  • Extend Trustless Gateway spec to support verifiable responses of /ipns/{libp2p-key} paths: decide if returned CAR should include two roots. One for data, second for ipns-record block. Specify if ipfs-records should be at the beginning of the CAR returned by /ipns/{id}?format=car[&something?] - to allow quick validation of response without wasting time for hashing invalid blocks that do not belong to CID in IPNS record.
    • ?format=ipns-record on /ipns/{key} landed in IPIP-351 (spec)
    • record inside the CAR response
  • Kubo CLI should have top level import / export that operates on content paths (instead of raw dags like ipfs dag versions), include all parent blocks and not just the final terminating element recursively, and be smart enough to use ipns-record and import it to local namesys cache if a block with ipns-record codec is present in a CAR

Status as of 2026Q3

Nobody is working on this. Summary of what exists and what is missing, so it can be picked up.

Trustless two-step retrieval works today, over plain HTTP:

  1. GET /ipns/{name}?format=ipns-record (IPIP-351): the client verifies the signature and resolves the record to /ipfs/{cid}, or stops on mismatch.
  2. GET /ipfs/{cid}?format=car with dag-scope, entity-bytes and order=dfs (IPIP-402): the client verifies each block as it arrives and drops the connection on the first block that fails its hash or is not expected in the DAG.

What is missing is the single round trip. GET /ipns/{name}?format=car today returns the CAR of the resolved content without the record, so the client cannot verify the IPNS step from that response alone. The smallest useful shape: a CAR with the ipns-record block (codec 0x0300) first, then the IPIP-402 stream from the root the record points at. The client checks the record before hashing anything else and can drop the connection after the first bad block. Plain HTTP, no new protocol or transport needed.

Open questions, unchanged from the list above:

  • CAR roots: only the record, only the data root, or both.
  • Request signal: an explicit format value or a CAR content-type parameter (IPIP-412 style), so a client can tell a record-first CAR from a plain one served by an older gateway.

Kubo side: no content-path import/export exists, and ipfs dag import does not know the ipns-record codec.

主要言語
HTML
スター
1.2k
フォーク
250
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ipfs/specs のほかの issue

ipfs/specs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。