Include IPNS Record in Gateway CAR responses

Abierto
#369 8 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado

Línea de trabajo

Comienza con la especificación de Trustless Gateway y los materiales enlazados de IPIP-351, IPIP-402 e IPIP-412; después, revisa la estructura de CAR propuesta en el issue, basada primero en records. Resuelve las preguntas abiertas sobre las raíces de CAR y la señalización de requests, y define el comportamiento requerido de Trustless Gateway y Kubo para la importación y exportación de content-paths; el trabajo estará terminado cuando la especificación y el alcance de la implementación ya no sean ambiguos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
HTML
Estrellas
1.2k
Forks
250
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ipfs/specs

Todos los issues de ipfs/specs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.