@libp2p/noise 17.0.1-71e8ee163 → 17.0.2-d91797b55

package/README.md

@@ -1,16 +1,9 @@
-# @chainsafe/libp2p-noise
-
-![npm](https://img.shields.io/npm/v/@chainsafe/libp2p-noise)
-[![](https://img.shields.io/github/actions/workflow/status/ChainSafe/js-libp2p-noise/js-test-and-release.yml?branch=master)](https://github.com/ChainSafe/js-libp2p-noise/actions)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/)
-![](https://img.shields.io/github/issues-raw/ChainSafe/js-libp2p-noise)
-[![License Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-![](https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D16.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/browsers-last%202%20versions%2C%20not%20ie%20%3C%3D11-orange)
-[![Twitter](https://img.shields.io/twitter/follow/ChainSafeth.svg?label=Twitter)](https://twitter.com/ChainSafeth)
-[![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord\&logo=discord)](https://discord.gg/Q6A3YA2)
+# @libp2p/noise
+
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
 
 > Noise libp2p handshake for js-libp2p
 
@@ -33,27 +26,38 @@ repo and examine the changes made.
 
 This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.
 
+Formerly published as [`@chainsafe/libp2p-noise`](https://www.npmjs.com/package/@chainsafe/libp2p-noise).
+
 ## Usage
 
-Install with `yarn add @chainsafe/libp2p-noise` or `npm i @chainsafe/libp2p-noise`.
+Install with `npm i @libp2p/noise`.
 
 Example of using default noise configuration and passing it to the libp2p config:
 
 ```ts
-import {createLibp2p} from "libp2p"
-import {noise} from "@libp2p/noise"
-
-//custom noise configuration, pass it instead of `noise()`
-//x25519 private key
-const n = noise({ staticNoiseKey });
+import { createLibp2p } from 'libp2p'
+import { noise } from '@libp2p/noise'
 
 const libp2p = await createLibp2p({
   connectionEncrypters: [noise()],
-  //... other options
+  // ... other options
 })
 ```
 
-See the [NoiseInit](https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/noise.ts#L22-L30) interface for noise configuration options.
+See the [NoiseInit](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-noise/src/noise.ts) interface for noise configuration options.
+
+To use a fixed x25519 static key instead of generating one per session, pass it as `staticNoiseKey`:
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { noise, pureJsCrypto } from '@libp2p/noise'
+
+const staticNoiseKey = pureJsCrypto.generateX25519KeyPair().privateKey
+
+const node = await createLibp2p({
+  connectionEncrypters: [noise({ staticNoiseKey })]
+})
+```
 
 ## API
 
@@ -63,32 +67,24 @@ This module exposes an implementation of the [ConnectionEncrypter](https://libp2
 
 You can provide a custom crypto implementation (instead of the default, based on [@noble](https://paulmillr.com/noble/)) by adding a `crypto` field to the init argument passed to the `Noise` factory.
 
-The implementation must conform to the `ICryptoInterface`, defined in <https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/crypto.ts>
+The implementation must conform to the `ICryptoInterface`, defined in <https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-noise/src/crypto.ts>
 
 # Install
 
 ```console
-$ npm i @chainsafe/libp2p-noise
-```
-
-## Browser `<script>` tag
-
-Loading this module through a script tag will make its exports available as `ChainsafeLibp2pNoise` in the global namespace.
-
-```html
-<script src="https://unpkg.com/@chainsafe/libp2p-noise/dist/index.min.js"></script>
+$ npm i @libp2p/noise
 ```
 
 # API Docs
 
-- <https://ChainSafe.github.io/js-libp2p-noise>
+- <https://libp2p.github.io/js-libp2p/modules/_libp2p_noise.html>
 
 # License
 
 Licensed under either of
 
-- Apache 2.0, ([LICENSE-APACHE](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-noise/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-noise/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution