README.md

⛔️ DEPRECATED

As of 1.1.0 the @helia/delegated-routing-v1-http-api-client module supports both the libp2p ContentRouting and PeerRouting interfaces so should be used instead.

This library will not be maintained.

---

@libp2p/ipni-content-routing

Use an IPNI service to discover content providers

Table of contents

• ⛔️ DEPRECATED
  • Install
    • Browser <script> tag
  • About
  • Example
  • API Docs
  • License
  • Contribution

Install

$ 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.

<script src="https://unpkg.com/@libp2p/ipni-content-routing/dist/index.min.js"></script>

About

This is an implementation of the libp2p content routing interface that uses an IPNI HTTP endpoint.

An alternative is HTTP Routing V1 (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, at which point one can use the HTTP Routing V1 interface/implementation directly.

Example

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

• https://libp2p.github.io/js-ipni-content-routing

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)

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.