libp2p 0.41.0-1b30f81 → 0.41.0-3e53c19

package/src/insecure/index.ts

@@ -1,3 +1,27 @@
+/**
+ * @packageDocumentation
+ *
+ * A connection encrypter that does no connection encryption.
+ *
+ * This should not be used in production should be used for research purposes only.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { plaintext } from 'libp2p/insecure'
+ *
+ * // Create a Uint8Array and write the swarm key to it
+ * const swarmKey = new Uint8Array(95)
+ * generateKey(swarmKey)
+ *
+ * const node = await createLibp2p({
+ *   // ...other options
+ *   connectionEncryption: [plaintext()]
+ * })
+ * ```
+ */
+
 import { logger } from '@libp2p/logger'
 import { handshake } from 'it-handshake'
 import * as lp from 'it-length-prefixed'

package/src/keychain/index.ts

@@ -17,7 +17,7 @@ import type { Datastore } from 'interface-datastore'
 
 const log = logger('libp2p:keychain')
 
-export interface DekOptions {
+export interface DEKConfig {
   hash: string
   salt: string
   iterationCount: number
@@ -26,7 +26,7 @@ export interface DekOptions {
 
 export interface KeyChainInit {
   pass?: string
-  dek?: DekOptions
+  dek?: DEKConfig
 }
 
 /**

package/src/nat-manager.ts

@@ -149,11 +149,16 @@ export class NatManager implements Startable {
 
       const client = await this._getClient()
       const publicIp = this.externalAddress ?? await client.externalIp()
+      const isPrivate = isPrivateIp(publicIp)
 
-      if (isPrivateIp(publicIp)) {
+      if (isPrivate === true) {
         throw new Error(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`)
       }
 
+      if (isPrivate == null) {
+        throw new Error(`${publicIp} is not an IP address`)
+      }
+
       const publicPort = highPort()
 
       log(`opening uPnP connection from ${publicIp}:${publicPort} to ${host}:${port}`)

package/src/pnet/index.ts

@@ -1,3 +1,27 @@
+/**
+ * @packageDocumentation
+ *
+ * Connection protection management for libp2p leveraging PSK encryption via XSalsa20.
+ *
+ * @example
+ *
+ * ```typescript
+ * 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
+ *   })
+ * })
+ * ```
+ */
+
 import { logger } from '@libp2p/logger'
 import { pipe } from 'it-pipe'
 import errCode from 'err-code'

package/src/version.ts

@@ -1,2 +1,2 @@
-export const version = '0.41.0-1b30f81'
+export const version = '0.41.0-3e53c19'
 export const name = 'libp2p'