js-libp2p-noise v1.0.0-rc

js-libp2p-noise

Noise libp2p handshake for js-libp2p

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

Usage

When published, package should be imported as: import { Noise } from 'libp2p-noise'.

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

import {NOISE, Noise} from "@nodefactory/js-libp2p-noise"

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

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

Where parameters for Noise constructor are:

• private key - required parameter (32 bytes libp2p peer private key)
• 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