npm.io
2.1.3 • Published 3 weeks ago

@helia/libp2p

Licence
Apache-2.0 OR MIT
Version
2.1.3
Deps
31
Size
4.8 MB
Vulns
0
Weekly
0
Stars
1.3K

Helia logo

@helia/libp2p

ipfs.tech Discuss codecov CI

libp2p functionality for Helia

About

Adds libp2p functionality to Helia

Example - With default config

import { createHelia } from 'helia'
import { withLibp2p } from '@helia/libp2p'

const node = await withLibp2p(createHelia()).start()

console.info(node.libp2p.peerId) // 12D3Koo...

Example - Custom config

By default withLibp2p configures a libp2p node for the current environment.

Any options passed will be merged with the default config.

For full control over your node (and the bundle size), use withLibp2pLight:

import { createHelia } from 'helia'
import { withLibp2pLight } from '@helia/libp2p'

const node = await withLibp2pLight(createHelia(), {
  //... libp2p config here
}).start()

console.info(node.libp2p.peerId) // 12D3Koo...

Install

$ npm i @helia/libp2p

Browser <script> tag

Loading this module through a script tag will make its exports available as HeliaLibp2p in the global namespace.

<script src="https://unpkg.com/@helia/libp2p/dist/index.min.js"></script>

Helia-http

API Docs

License

Licensed under either of

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.

Keywords