docs: update fetch and pnet docs (#1516)

The docs in these modules are out of date

Author: achingbrain

src/fetch/README.md

@@ -1,8 +1,13 @@
-libp2p-fetch JavaScript Implementation
+libp2p-fetch JavaScript Implementation  <!-- omit in toc -->
 =====================================
 
 > Libp2p fetch protocol JavaScript implementation
 
+## Table of contents <!-- omit in toc -->
+
+- [Overview](#overview)
+- [Usage](#usage)
+
 ## Overview
 
 An implementation of the Fetch protocol as described here: https://github.com/libp2p/specs/tree/master/fetch
@@ -27,7 +32,7 @@ async function my_subsystem_key_lookup(key) {
 }
 
 // Enable this peer to respond to fetch requests for keys that begin with '/my_subsystem_key_prefix/'
-const libp2p = Libp2p.create(...)
+const libp2p = createLibp2p()
 libp2p.fetchService.registerLookupFunction('/my_subsystem_key_prefix/', my_subsystem_key_lookup)
 
 const key = '/my_subsystem_key_prefix/{...}'

src/pnet/README.md

@@ -1,34 +1,41 @@
-js-libp2p-pnet
+js-libp2p-pnet <!-- omit in toc -->
 ==================
 
 > Connection protection management for libp2p leveraging PSK encryption via XSalsa20.
 
 **Note**: git history prior to merging into js-libp2p can be found in the original repository, https://github.com/libp2p/js-libp2p-pnet.
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-- [js-libp2p-pnet](#js-libp2p-pnet)
-  - [Table of Contents](#table-of-contents)
-  - [Usage](#usage)
-    - [Examples](#examples)
-    - [Private Shared Keys](#private-shared-keys)
-    - [PSK Generation](#psk-generation)
-      - [From libp2p-pnet](#from-libp2p-pnet)
-      - [From a module using libp2p](#from-a-module-using-libp2p)
-      - [Programmatically](#programmatically)
+- [Usage](#usage)
+- [Examples](#examples)
+- [Private Shared Keys](#private-shared-keys)
+- [PSK Generation](#psk-generation)
+    - [From a module using libp2p](#from-a-module-using-libp2p)
+    - [Programmatically](#programmatically)
 
 ## Usage
 
 ```js
-const Protector from 'libp2p-pnet')
-const protector = new Protector(swarmKeyBuffer)
-const privateConnection = protector.protect(myPublicConnection, (err) => { })
+import { createLibp2p } from 'libp2p'
+import { preSharedKey, generateKey } from 'libp2p/pnet'
+
+// Create a Uint8Array and write the swarm key to it
+const swarmKey = new Uint8Array(95)
+generateKey(swarmKey)
+
+const node = await createLibp2p({
+  // ...other options
+  connectionProtector: preSharedKey({
+    psk: swarmKey
+  })
+})
 ```
 
-### Examples
+## Examples
 [Private Networks with IPFS](../../examples/pnet-ipfs)
 
-### Private Shared Keys
+## Private Shared Keys
 
 Private Shared Keys are expected to be in the following format:
 
@@ -38,33 +45,28 @@ Private Shared Keys are expected to be in the following format:
 dffb7e3135399a8b1612b2aaca1c36a3a8ac2cd0cca51ceeb2ced87d308cac6d
 ```
 
-### PSK Generation
+## PSK Generation
 
 A utility method has been created to generate a key for your private network. You can
 use one of the methods below to generate your key.
 
-#### From libp2p-pnet
-
-If you have libp2p locally, you can run the following from the projects root.
-
-```sh
-node ./src/pnet/key-generator.js > swarm.key
-```
-
 #### From a module using libp2p
 
 If you have a module locally that depends on libp2p, you can run the following from
 that project, assuming the node_modules are installed.
 
-```sh
-node -e "require('libp2p/src/pnet').generate(process.stdout)" > swarm.key
+```console
+node -e "import('libp2p/pnet').then(({ generateKey }) => generateKey(process.stdout))" > swarm.key
 ```
 
 #### Programmatically
 
 ```js
-const writeKey from 'libp2p/src/pnet').generate
+import fs from 'fs'
+import { generateKey } from 'libp2p/pnet'
+
 const swarmKey = new Uint8Array(95)
-writeKey(swarmKey)
+generateKey(swarmKey)
+
 fs.writeFileSync('swarm.key', swarmKey)
 ```

src/pnet/key-generator.ts

@@ -5,24 +5,19 @@ import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 /**
  * Generates a PSK that can be used in a libp2p-pnet private network
  *
- * @param {Uint8Array} bytes - An object to write the psk into
+ * @param {Uint8Array | NodeJS.WriteStream} bytes - An object to write the psk into
  * @returns {void}
  */
-export function generateKey (bytes: Uint8Array) {
+export function generateKey (bytes: Uint8Array | NodeJS.WriteStream) {
   const psk = uint8ArrayToString(randomBytes(KEY_LENGTH), 'base16')
   const key = uint8ArrayFromString('/key/swarm/psk/1.0.0/\n/base16/\n' + psk)
 
-  bytes.set(key)
+  if (bytes instanceof Uint8Array) {
+    bytes.set(key)
+  } else {
+    bytes.write(key)
+  }
 }
 
 export const NONCE_LENGTH = 24
 export const KEY_LENGTH = 32
-
-try {
-  if (require.main === module) {
-    // @ts-expect-error
-    generate(process.stdout)
-  }
-} catch (error: any) {
-
-}