mirror of
https://github.com/fluencelabs/js-libp2p-noise
synced 2025-04-25 11:22:26 +00:00
Update readme
This commit is contained in:
parent
8e036d9e52
commit
db3f0acb6f
24
README.md
24
README.md
@ -3,6 +3,10 @@
|
|||||||
[](https://libp2p.io/)
|
[](https://libp2p.io/)
|
||||||

|

|
||||||

|

|
||||||
|
[](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise)
|
||||||
|

|
||||||
|

|
||||||
|
[](https://discuss.libp2p.io)
|
||||||
|
|
||||||
> Noise libp2p handshake for js-libp2p
|
> Noise libp2p handshake for js-libp2p
|
||||||
|
|
||||||
@ -10,7 +14,25 @@ This repository contains TypeScript implementation of noise protocol, an encrypt
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
TBD (package not yet published)
|
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
|
## API
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user