docs: update comments in interface module and elsewhere (#3107)

Fixes #2112

Author: achingbrain

packages/config/README.md

@@ -24,6 +24,8 @@ repo and examine the changes made.
 
 -->
 
+Utilities to make working with libp2p configuration simpler.
+
 ## Example - Load or create the "self" private key in a datastore
 
 Most nodes will want to persist the same private key between restarts so this
@@ -33,7 +35,7 @@ will create a new one and save it in the keystore.
 The options you pass to this function should be the same as those passed to
 the `@libp2p/keychain` service you configure your node with.
 
-```ts
+```TypeScript
 import { loadOrCreateSelfKey } from '@libp2p/config'
 import { keychain } from '@libp2p/keychain'
 import { LevelDatastore } from 'datastore-level'

packages/config/src/index.ts

@@ -1,6 +1,8 @@
 /**
  * @packageDocumentation
  *
+ * Utilities to make working with libp2p configuration simpler.
+ *
  * @example Load or create the "self" private key in a datastore
  *
  * Most nodes will want to persist the same private key between restarts so this
@@ -10,7 +12,7 @@
  * The options you pass to this function should be the same as those passed to
  * the `@libp2p/keychain` service you configure your node with.
  *
- * ```ts
+ * ```TypeScript
  * import { loadOrCreateSelfKey } from '@libp2p/config'
  * import { keychain } from '@libp2p/keychain'
  * import { LevelDatastore } from 'datastore-level'

packages/connection-encrypter-plaintext/README.md

@@ -24,9 +24,10 @@ repo and examine the changes made.
 
 -->
 
-A connection encrypter that does no connection encryption.
+A connection encrypter that does no connection encryption and trusts the
+remote peer to provide the correct PeerId.
 
-This should not be used in production should be used for research purposes only.
+This should not be used in production and is for research purposes only.
 
 ## Example
 

packages/connection-encrypter-plaintext/src/index.ts

@@ -1,9 +1,10 @@
 /**
  * @packageDocumentation
  *
- * A connection encrypter that does no connection encryption.
+ * A connection encrypter that does no connection encryption and trusts the
+ * remote peer to provide the correct PeerId.
  *
- * This should not be used in production should be used for research purposes only.
+ * This should not be used in production and is for research purposes only.
  *
  * @example
  *

packages/crypto/src/ciphers/aes-gcm.browser.ts

@@ -1,7 +1,7 @@
 import { concat } from 'uint8arrays/concat'
 import { fromString } from 'uint8arrays/from-string'
 import webcrypto from '../webcrypto/index.js'
-import type { CreateOptions, AESCipher } from './interface.js'
+import type { CreateAESCipherOptions, AESCipher } from './interface.js'
 
 // WebKit on Linux does not support deriving a key from an empty PBKDF2 key.
 // So, as a workaround, we provide the generated key as a constant. We test that
@@ -24,7 +24,7 @@ export const derivedEmptyPasswordKey = {
 
 // Based off of code from https://github.com/luke-park/SecureCompatibleEncryptionExamples
 
-export function create (opts?: CreateOptions): AESCipher {
+export function create (opts?: CreateAESCipherOptions): AESCipher {
   const algorithm = opts?.algorithm ?? 'AES-GCM'
   let keyLength = opts?.keyLength ?? 16
   const nonceLength = opts?.nonceLength ?? 12

packages/crypto/src/ciphers/aes-gcm.ts

@@ -1,11 +1,13 @@
 import crypto from 'crypto'
 import { concat as uint8ArrayConcat } from 'uint8arrays/concat'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import type { CreateOptions, AESCipher } from './interface.js'
+import type { CreateAESCipherOptions, AESCipher } from './interface.js'
+
+export type { AESCipher, CreateAESCipherOptions }
 
 // Based off of code from https://github.com/luke-park/SecureCompatibleEncryptionExamples
 
-export function create (opts?: CreateOptions): AESCipher {
+export function create (opts?: CreateAESCipherOptions): AESCipher {
   const algorithm = opts?.algorithm ?? 'aes-128-gcm'
   const keyLength = opts?.keyLength ?? 16
   const nonceLength = opts?.nonceLength ?? 12

packages/crypto/src/ciphers/interface.ts

@@ -1,4 +1,4 @@
-export interface CreateOptions {
+export interface CreateAESCipherOptions {
   algorithm?: string
   nonceLength?: number
   keyLength?: number

packages/interface-compliance-tests/src/matchers.ts

@@ -1,17 +1,18 @@
 import Sinon from 'sinon'
 import type { PeerId } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { SinonMatcher } from 'sinon'
 
 /**
  * @deprecated PeerIds can be passed to sinon matchers directly
  */
-export function matchPeerId (peerId: PeerId): Sinon.SinonMatcher {
+export function matchPeerId (peerId: PeerId): SinonMatcher {
   return Sinon.match(p => p.toString() === peerId.toString())
 }
 
 /**
  * @deprecated Multiaddrs can be passed to sinon matchers directly
  */
-export function matchMultiaddr (ma: Multiaddr): Sinon.SinonMatcher {
+export function matchMultiaddr (ma: Multiaddr): SinonMatcher {
   return Sinon.match(m => m.toString() === ma.toString())
 }

packages/interface/src/content-routing.ts

@@ -4,7 +4,7 @@ import type { CID } from 'multiformats/cid'
 
 /**
  * Any object that implements this Symbol as a property should return a
- * ContentRouting instance as the property value, similar to how
+ * Partial<ContentRouting> instance as the property value, similar to how
  * `Symbol.Iterable` can be used to return an `Iterable` from an `Iterator`.
  *
  * @example
@@ -28,7 +28,7 @@ export const contentRoutingSymbol = Symbol.for('@libp2p/content-routing')
  * interested callers.
  */
 export interface ContentRoutingProvider {
-  [contentRoutingSymbol]: ContentRouting
+  [contentRoutingSymbol]: Partial<ContentRouting>
 }
 
 export interface ContentRouting {

packages/interface/src/errors.ts

@@ -353,7 +353,7 @@ export class TooManyOutboundProtocolStreamsError extends Error {
 }
 
 /**
- * Thrown when and attempt to operate on an unsupported key was made
+ * Thrown when an attempt to operate on an unsupported key was made
  */
 export class UnsupportedKeyTypeError extends Error {
   static name = 'UnsupportedKeyTypeError'
@@ -363,3 +363,15 @@ export class UnsupportedKeyTypeError extends Error {
     this.name = 'UnsupportedKeyTypeError'
   }
 }
+
+/**
+ * Thrown when an operation has not been implemented
+ */
+export class NotImplementedError extends Error {
+  static name = 'NotImplementedError'
+
+  constructor (message = 'Not implemented') {
+    super(message)
+    this.name = 'NotImplementedError'
+  }
+}