@helia/delegated-routing-v1-http-api-client
v4.2.0
Published
A Delegated Routing V1 HTTP API client
Downloads
24,970
Keywords
Readme
@helia/delegated-routing-v1-http-api-client
A Delegated Routing V1 HTTP API client
About
A client implementation of the IPFS Delegated Routing V1 HTTP API that can be used to interact with any compliant server implementation.
Example
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { CID } from 'multiformats/cid'
const client = createDelegatedRoutingV1HttpApiClient('https://example.org')
for await (const prov of getProviders(CID.parse('QmFoo'))) {
// ...
}
How to use with libp2p
The client can be configured as a libp2p service, this will enable it as both a ContentRouting and a PeerRouting implementation
Example
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p } from 'libp2p'
import { peerIdFromString } from '@libp2p/peer-id'
const client = createDelegatedRoutingV1HttpApiClient('https://example.org')
const libp2p = await createLibp2p({
// other config here
services: {
delegatedRouting: client
}
})
// later this will use the configured HTTP gateway
await libp2p.peerRouting.findPeer(peerIdFromString('QmFoo'))
Caching
By default, the client caches successful (200) delegated routing responses in browser environments (that support the Cache API) for a duration of 5 minutes. The client does this by adding an x-cache-expires
header to the response object.
If caching is enabled, the client will cache responses for the duration of cacheTTL
milliseconds.
If cacheTTL
is 0, caching is disabled:
Example
// disable caching
const client = createDelegatedRoutingV1HttpApiClient('https://example.org', { cacheTTL: 0 })
Filtering with IPIP-484
The client can be configured to pass filter options to the delegated routing server as defined in IPIP-484. The filter options be set globally, by passing them to the client constructor, or on a per-request basis.
Example
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p } from 'libp2p'
import { peerIdFromString } from '@libp2p/peer-id'
// globally set filter options
const client = createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev', {
filterProtocols: ['transport-bitswap', 'unknown', 'transport-ipfs-gateway-http'],
filterAddrs: ['webtransport', 'webrtc-direct', 'wss']
})
// per-request filter options
for await (const prov of getProviders(CID.parse('bafy'), {
filterProtocols: ['transport-ipfs-gateway-http'],
filterAddrs: ['!p2p-circuit']
})) {
// ...
}
Install
$ npm i @helia/delegated-routing-v1-http-api-client
API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribute
Contributions welcome! Please check out the issues.
Also see our contributing document for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.