https://github.com/libp2p/js-ipni-content-routing
Use an IPNI service to discover content providers
https://github.com/libp2p/js-ipni-content-routing
Last synced: 4 months ago
JSON representation
Use an IPNI service to discover content providers
- Host: GitHub
- URL: https://github.com/libp2p/js-ipni-content-routing
- Owner: libp2p
- License: other
- Archived: true
- Created: 2023-04-15T13:54:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T17:42:24.000Z (over 1 year ago)
- Last Synced: 2024-10-31T15:02:17.468Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 96.7 KB
- Stars: 3
- Watchers: 10
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⛔️ DEPRECATED
As of `1.1.0` the [@helia/delegated-routing-v1-http-api-client](https://www.npmjs.com/package/@helia/delegated-routing-v1-http-api-client) module supports both the libp2p [ContentRouting](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.content_routing.ContentRouting.html) and [PeerRouting](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.peer_routing.PeerRouting.html) interfaces so should be used instead.
_This library will not be maintained._
---
# @libp2p/ipni-content-routing
[](http://libp2p.io/)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-ipni-content-routing)
[](https://github.com/libp2p/js-ipni-content-routing/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
> Use an IPNI service to discover content providers
## Table of contents
- [⛔️ DEPRECATED](#️-deprecated)
- [Install](#install)
- [Browser `` tag](#browser-script-tag)
- [About](#about)
- [Example](#example)
- [API Docs](#api-docs)
- [License](#license)
- [Contribution](#contribution)
## Install
```console
$ npm i @libp2p/ipni-content-routing
```
### Browser `<script>` tag
Loading this module through a script tag will make it's exports available as `Libp2pIpniContentRouting` in the global namespace.
```html
<script src="https://unpkg.com/@libp2p/ipni-content-routing/dist/index.min.js">
```
## About
This is an implementation of the libp2p [content routing interface](https://libp2p.github.io/js-libp2p-interfaces/interfaces/_libp2p_interface_content_routing.ContentRouting.html) that uses an [IPNI](https://github.com/ipni/specs) HTTP endpoint.
An alternative is [HTTP Routing V1](https://github.com/libp2p/js-reframe-content-routing) (previously known as Reframe) but the advantage of IPNI at least as of 2023-05-19 is that it returns results in a streaming fashion which can be faster. Note that this will change with the rollout of [IPIP-410](https://github.com/ipfs/specs/pull/410), at which point one can use the HTTP Routing V1 interface/implementation directly.
## Example
```js
import { createLibp2p } from 'libp2p'
import { ipniContentRouting } from '@libp2p/ipni-content-routing'
const node = await createLibp2p({
contentRouters: [
ipniContentRouting('https://cid.contact')
]
//.. other config
})
await node.start()
for await (const provider of node.contentRouting.findProviders('cid')) {
console.log('provider', provider)
}
```
## API Docs
-
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-MIT) / )
## Contribution
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.