@helia/verified-fetch 2.2.2 → 2.3.0

package/README.md

@@ -34,7 +34,13 @@ repo and examine the changes made.
 
 All content is retrieved in a [trustless manner](https://www.techopedia.com/definition/trustless), and the integrity of all bytes are verified by comparing hashes of the data.
 
-By default, providers for CIDs are found with delegated routers and retrieved over HTTP from [trustless gateways](https://specs.ipfs.tech/http-gateways/trustless-gateway/), and WebTransport and WebRTC providers if available.
+By default, providers for CIDs are found using [delegated routing endpoints](https://docs.ipfs.tech/concepts/public-utilities/#delegated-routing).
+
+Data is retrieved using the following strategies:
+
+- Directly from providers, using [Bitswap](https://docs.ipfs.tech/concepts/bitswap/) over WebSockets and WebRTC if available.
+- Directly from providers exposing a [trustless gateway](https://specs.ipfs.tech/http-gateways/trustless-gateway/) over HTTPS.
+- As a fallback, if no providers reachable from a browser are found, data is retrieved using recursive gateways, e.g. `trustless-gateway.link` which can be configured.
 
 This is a marked improvement over `fetch` which offers no such protections and is vulnerable to all sorts of attacks like [Content Spoofing](https://owasp.org/www-community/attacks/Content_Spoofing), [DNS Hijacking](https://en.wikipedia.org/wiki/DNS_hijacking), etc.
 
@@ -219,6 +225,26 @@ const fetch = await createVerifiedFetch({
 })
 ```
 
+### Custom Hashers
+
+By default, `@helia/verified-fetch` supports `sha256`, `sha512`, and `identity` hashers.
+
+If you need to use a different hasher, you can provide a [custom `hasher` function](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html) as an option to `createVerifiedFetch`.
+
+## Example - Passing a custom hashing function
+
+```typescript
+import { createVerifiedFetch } from '@helia/verified-fetch'
+import { blake2b256 } from '@multiformats/blake2/blake2b'
+
+const verifiedFetch = await createVerifiedFetch({
+  gateways: ['https://ipfs.io'],
+  hashers: [blake2b256]
+})
+
+const resp = await verifiedFetch('ipfs://cid-using-blake2b256')
+```
+
 ### IPLD codec handling
 
 IPFS supports several data formats (typically referred to as codecs) which are included in the CID. `@helia/verified-fetch` attempts to abstract away some of the details for easier consumption.