@chainsafe/libp2p-noise
Version:
Noise libp2p handshake for js-libp2p
96 lines (61 loc) • 3.83 kB
Markdown
# @chainsafe/libp2p-noise
[](https://github.com/ChainSafe/js-libp2p-noise/actions)
[](https://libp2p.io/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://opensource.org/licenses/MIT)
[](https://twitter.com/ChainSafeth)
[](https://discord.gg/Q6A3YA2)
> Noise libp2p handshake for js-libp2p
# About
<!--
!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->
This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.
## Usage
Install with `yarn add @chainsafe/libp2p-noise` or `npm i @chainsafe/libp2p-noise`.
Example of using default noise configuration and passing it to the libp2p config:
```ts
import {createLibp2p} from "libp2p"
import {noise} from "@chainsafe/libp2p-noise"
//custom noise configuration, pass it instead of `noise()`
//x25519 private key
const n = noise({ staticNoiseKey });
const libp2p = await createLibp2p({
connectionEncrypters: [noise()],
//... other options
})
```
See the [NoiseInit](https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/noise.ts#L22-L30) interface for noise configuration options.
## API
This module exposes an implementation of the [ConnectionEncrypter](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ConnectionEncrypter.html) interface.
## Bring your own crypto
You can provide a custom crypto implementation (instead of the default, based on [@noble](https://paulmillr.com/noble/)) by adding a `crypto` field to the init argument passed to the `Noise` factory.
The implementation must conform to the `ICryptoInterface`, defined in <https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/crypto.ts>
# Install
```console
$ npm i @chainsafe/libp2p-noise
```
## Browser `<script>` tag
Loading this module through a script tag will make its exports available as `ChainsafeLibp2pNoise` in the global namespace.
```html
<script src="https://unpkg.com/@chainsafe/libp2p-noise/dist/index.min.js"></script>
```
# API Docs
- <https://ChainSafe.github.io/js-libp2p-noise>
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/ChainSafe/js-libp2p-noise/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.