js-libp2p-noise

npm

Noise libp2p handshake for js-libp2p

This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.

Warning: Even though this package works in browser, it will bundle around 600Kb (200Kb gzipped) of code

https://bundlephobia.com/result?p=libp2p-noise@latest

Usage

Install with yarn add libp2p-noise or npm i libp2p-noise.

Example of using default noise configuration and passing it to the libp2p config:

import {NOISE, Noise} from "libp2p-noise"


//custom noise configuration, pass it instead of NOISE instance
const noise = new Noise(privateKey, Buffer.alloc(x));

const libp2p = new Libp2p({
   modules: {
     connEncryption: [NOISE],
   },
});

Where parameters for Noise constructor are:

static Noise key - (optional) existing private Noise static key
early data - (optional) an early data payload to be sent in handshake messages

API

This module exposes a crypto interface, as defined in the repository js-interfaces.

» API Docs

Contribute

Feel free to join in. All welcome. Open an issue!

License

MIT

Current Tags

4.0.0 ... latest (3 years ago)

25 Versions

4.0.0 [deprecated] ... 3 years ago
3.1.0 [deprecated] ... 3 years ago
3.0.0 [deprecated] ... 4 years ago
2.0.5 [deprecated] ... 4 years ago
2.0.4 [deprecated] ... 4 years ago
2.0.3 [deprecated] ... 4 years ago
2.0.2 [deprecated] ... 4 years ago
2.0.1 [deprecated] ... 4 years ago
2.0.0 [deprecated] ... 4 years ago
2.0.0-beta ... 4 years ago
1.1.2 [deprecated] ... 4 years ago
1.1.1 [deprecated] ... 5 years ago
1.1.0 [deprecated] ... 5 years ago
1.1.0-rc2 ... 5 years ago
1.1.0-rc1 ... 5 years ago
1.0.0 [deprecated] ... 5 years ago
1.0.0-rc.9 ... 5 years ago
1.0.0-rc.8 ... 5 years ago
1.0.0-rc.7 ... 5 years ago
1.0.0-rc.6 ... 5 years ago
1.0.0-rc.5 ... 5 years ago
1.0.0-rc4 ... 5 years ago
1.0.0-rc3 ... 5 years ago
1.0.0-rc2 ... 5 years ago
1.0.0-rc1 ... 5 years ago