From 3097c6e3cc14f0ba86d46201ae5759b4edf3a6ec Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Thu, 8 Dec 2022 12:57:44 +0100 Subject: [PATCH] Update 0351-gateway-ipns-record-response-format.md --- ...351-gateway-ipns-record-response-format.md | 42 +++++++++++-------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/IPIP/0351-gateway-ipns-record-response-format.md b/IPIP/0351-gateway-ipns-record-response-format.md index d77de9c09..f3aa19df0 100644 --- a/IPIP/0351-gateway-ipns-record-response-format.md +++ b/IPIP/0351-gateway-ipns-record-response-format.md @@ -1,4 +1,4 @@ -# IPIP 0351: IPNS Signed Records Response Format on HTTP Gateways +# IPIP 0351: IPNS Signed Records Response Format on HTTP Gateways - Start Date: 2022-11-29 - Related Issues: @@ -34,7 +34,17 @@ requesting it using either the `Accept` HTTP header or the `format` URL query. ## Test fixtures -TODO +IPNS records for testing can be generated in Kubo by creating an IPNS record: + +```bash +$ ipfs key gen +k51Key + +$ ipfs name publish /ipfs/bafyHash --key= --ttl= +Published to k51Key: /ipfs/bafyHash + +$ ipfs routing get /ipns/k51Key > key.pb +``` ## Design rationale @@ -44,28 +54,24 @@ one more supported format to that list. ### User benefit -TODO +By providing IPNS records through the gateway, IPFS light clients are able +to race multiple gateways in search for an IPNS record for a certain IPNS key. +This way, IPFS light clients do not necessarily need to implement the required +machinery to fetch IPNS records from other IPFS nodes through the DHT or PubSub. -- Good for light clients -- Trustless retrieval of IPNS records +In addition, the retrieval of IPNS records is trustless in the sense that they can +be verified by the client since the IPNS record includes a cryptographic signature +provided by its creator. ### Compatibility -- New format; and -- Probably add it to [](../http-gateways/TRUSTLESS_GATEWAY.md) - -### Security - -TODO - -- Caching notes - -### Alternatives - -TODO +This IPIP proposes a new format to be added to the gateway, but does not change +any prior format. Therefore, this IPIP is backwards compatible. Please note +that IPNS records are also added to the [Trustless Gateway](../http-gateways/TRUSTLESS_GATEWAY.md) +specification. ### Copyright Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). -[ipld-record]: ../ipns/IPNS.md#ipns-record \ No newline at end of file +[ipld-record]: ../ipns/IPNS.md#ipns-record