feat: support requesting raw IPNS records in @helia/verified-fetch #443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Let users get raw data back from CIDs that would otherwise trigger
decoding as JSON or CBOR etc by specifying an `Accept` header.
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/octet-stream'
}
})
console.info(res.headers.get('accept')) // application/octet-stream
```
Make sure the content-type matches the accept header:
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/vnd.ipld.raw'
}
})
console.info(res.headers.get('accept')) // application/vnd.ipld.raw
```
Support multiple values, match the first one:
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/vnd.ipld.raw, application/octet-stream, */*'
}
})
console.info(res.headers.get('accept')) // application/vnd.ipld.raw
```
If they specify an Accept header we can't honor, return a [406](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406):
```typescript
const res = await verifiedFetch(cid, {
headers: {
accept: 'application/what-even-is-this'
}
})
console.info(res.status) // 406
```
…ader-for-raw-types
Adds support for the `application/vnd.ipld.car` accept header to allow downloading CAR files of DAGs.
Adds support for downloading tar archives of UnixFS directories
Adds support for the `application/vnd.ipfs.ipns-record` Accept header to return raw IPNS records.
achingbrain
commented
Feb 21, 2024
| @@ -153,17 +153,20 @@ | |||
| "@ipld/dag-json": "^10.2.0", | |||
| "@ipld/dag-pb": "^4.1.0", | |||
| "@libp2p/interface": "^1.1.2", | |||
| "@libp2p/kad-dht": "^12.0.7", | |||
There was a problem hiding this comment.
This is only here to be able to deserialize stored IPNS records that are wrapped in a libp2p record.
Longer term we may wish to split the libp2p record code out of the dht code to make the bundle size a bit smaller.
There was a problem hiding this comment.
Do we have a tracking issue for this?
Base automatically changed from
feat/download-tars-from-verified-fetch
to
main
February 22, 2024 10:55
Merged
2color
reviewed
Feb 23, 2024
| await stop(helia, verifiedFetch) | ||
| }) | ||
|
|
||
| it('should support fetching a raw IPNS record', async () => { |
There was a problem hiding this comment.
Now that we have this test, we can remove https://github.com/ipfs/helia/blob/main/packages/verified-fetch/test/accept-header.spec.ts#L227-L248 which is skipped anyways
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds support for the
application/vnd.ipfs.ipns-recordAccept header to return raw IPNS records.