Skip to content

Commit

Permalink
Update 0351-gateway-ipns-record-response-format.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias authored Dec 8, 2022
1 parent 9273c10 commit 3097c6e
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions IPIP/0351-gateway-ipns-record-response-format.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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 <key-name>
k51Key

$ ipfs name publish /ipfs/bafyHash --key=<key-name> --ttl=<record-ttl>
Published to k51Key: /ipfs/bafyHash

$ ipfs routing get /ipns/k51Key > key.pb
```

## Design rationale

Expand All @@ -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
[ipld-record]: ../ipns/IPNS.md#ipns-record

0 comments on commit 3097c6e

Please sign in to comment.