libp2p-noise

js-libp2p-noise

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 1.5Mb of code

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

Changelog

[2.0.1]

Bugfixes

• security update for bl dependency
• add missing type declaration files in dist