mirror of
https://github.com/fluencelabs/js-libp2p-noise
synced 2025-04-25 13:12:32 +00:00
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# js-libp2p-noise
|
|
|
|
[](https://libp2p.io/)
|
|
|
|
|
|
[](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise)
|
|
|
|
|
|
[](https://discuss.libp2p.io)
|
|
|
|
> 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 instantiating noise and passing it to the libp2p config:
|
|
```
|
|
const NOISE = new Noise(privateKey);
|
|
|
|
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](https://github.com/libp2p/js-interfaces).
|
|
|
|
[» API Docs](https://github.com/libp2p/js-interfaces/tree/master/src/crypto#api)
|
|
|
|
|
|
## Contribute
|
|
|
|
Feel free to join in. All welcome. Open an issue!
|
|
|
|
[](https://github.com/ipfs/community/blob/master/contributing.md)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|