fix!: rename connectionEncryption option to connectionEncrypters (#2691)

To make the options more consistent, rename `connectionEncryption` to `connectionEncrypters` in line with `streamMuxers`, `transports`, etc. BREAKING CHANGE: the `connectionEncryption` option has been renamed `connectionEncrypters`
libp2p · Sep 10, 2024 · 6d72709 · 6d72709
1 parent a142bb6
commit 6d72709
Show file tree

Hide file tree

Showing 50 changed files with 191 additions and 157 deletions.
diff --git a/doc/CONFIGURATION.md b/doc/CONFIGURATION.md
@@ -207,7 +207,7 @@ When [creating a libp2p node](https://github.com/libp2p/js-libp2p/blob/main/doc/
 const modules = {
   transports: [],
   streamMuxers: [],
-  connectionEncryption: [],
+  connectionEncrypters: [],
   contentRouting: [],
   peerRouting: [],
   peerDiscovery: [],
@@ -267,7 +267,7 @@ const node = await createLibp2p({
     webSockets()
   ],
   streamMuxers: [yamux(), mplex()],
-  connectionEncryption: [noise()],
+  connectionEncrypters: [noise()],
   peerDiscovery: [MulticastDNS],
   services: {
     dht: kadDHT(),
@@ -290,7 +290,7 @@ import { bootstrap } from '@libp2p/bootstrap'
 const node = await createLibp2p({
   transports: [tcp()],
   streamMuxers: [yamux(), mplex()],
-  connectionEncryption: [noise()],
+  connectionEncrypters: [noise()],
   peerDiscovery: [
     mdns({
       interval: 1000
@@ -336,7 +336,7 @@ const node = await createLibp2p({
       yamux(),
       mplex()
     ],
-    connectionEncryption: [
+    connectionEncrypters: [
       noise()
     ],
     services: {
@@ -373,7 +373,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   services: {
@@ -421,7 +421,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   contentRouting: [
@@ -466,7 +466,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   connectionGater: {
@@ -521,7 +521,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ]
 })
@@ -552,7 +552,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ]
 })
@@ -589,7 +589,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   keychain: {
@@ -622,7 +622,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   connectionManager: {
@@ -772,7 +772,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   transportManager: {
@@ -810,7 +810,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   metrics: {
@@ -860,7 +860,7 @@ const node = await createLibp2p({
     yamux(),
     mplex()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   peerStore: {
@@ -892,7 +892,7 @@ const node = await createLibp2p({
   streamMuxers: [
     yamux()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ]
 })
@@ -917,7 +917,7 @@ const node = await createLibp2p({
   streamMuxers: [
     yamux()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   addresses: {

diff --git a/doc/GETTING_STARTED.md b/doc/GETTING_STARTED.md
@@ -107,7 +107,7 @@ import { noise } from '@chainsafe/libp2p-noise'
 
 const node = await createLibp2p({
   transports: [webSockets()],
-  connectionEncryption: [noise()]
+  connectionEncrypters: [noise()]
 })
 ```
 
@@ -138,7 +138,7 @@ import { yamux } from '@chainsafe/libp2p-yamux'
 
 const node = await createLibp2p({
   transports: [webSockets()],
-  connectionEncryption: [noise()],
+  connectionEncrypters: [noise()],
   streamMuxers: [yamux()]
 })
 ```
@@ -168,7 +168,7 @@ const node = await createLibp2p({
     listen: ['/ip4/127.0.0.1/tcp/8000/ws']
   },
   transports: [webSockets()],
-  connectionEncryption: [noise()],
+  connectionEncrypters: [noise()],
   streamMuxers: [yamux()]
 })
 
@@ -224,7 +224,7 @@ const bootstrapMultiaddrs = [
 
 const node = await createLibp2p({
   transports: [webSockets()],
-  connectionEncryption: [noise()],
+  connectionEncrypters: [noise()],
   streamMuxers: [yamux()],
   peerDiscovery: [
     bootstrap({

diff --git a/doc/migrations/v1.0.0-v2.0.0.md b/doc/migrations/v1.0.0-v2.0.0.md
@@ -17,6 +17,7 @@ A migration guide for refactoring your application code from libp2p `v1.0.0` to
 - [`localPeer` is no longer passed to Connection Encrypters](#localpeer-is-no-longer-passed-to-connection-encrypters)
 - [The `.code` property has been removed from thrown errors, use `.name` instead](#the-code-property-has-been-removed-from-thrown-errors-use-name-instead)
 - [pubsub, identify, circuit-relay v2 and record envelope sealing use `privateKey` component](#pubsub-identify-circuit-relay-v2-and-record-envelope-sealing-use-privatekey-component)
+- [The `connectionEncryption` option has been renamed `connectionEncrypters`](#the-connectionencryption-option-has-been-renamed-connectionencrypters)
 
 ## The `PeerId` interface is now a union type
 
@@ -484,3 +485,36 @@ for use by libp2p services that contains the deserialized private key.
 
 There are no migration instructions to take advantage of this other than
 ensuring you have upgraded to the latest version of all libp2p services.
+
+## The `connectionEncryption` option has been renamed `connectionEncrypters`
+
+This makes it consistent with other options such as `streamMuxers`,
+`transports`, etc.
+
+**Before**
+
+```ts
+import { noise } from '@chainsafe/libp2p-noise'
+import { tls } from '@libp2p/tls'
+import { createLibp2p } from 'libp2p'
+
+const node = await createLibp2p({
+  connectionEncryption: [
+    noise(), tls()
+  ]
+})
+```
+
+**After**
+
+```ts
+import { noise } from '@chainsafe/libp2p-noise'
+import { tls } from '@libp2p/tls'
+import { createLibp2p } from 'libp2p'
+
+const node = await createLibp2p({
+  connectionEncrypters: [
+    noise(), tls()
+  ]
+})
+```
diff --git a/interop/test/fixtures/get-libp2p.ts b/interop/test/fixtures/get-libp2p.ts
@@ -94,7 +94,7 @@ export async function getLibp2p (): Promise<Libp2p<{ ping: PingService }>> {
       skipMuxer = true
       // Setup yamux and noise to connect to the relay node
       options.streamMuxers = [yamux()]
-      options.connectionEncryption = [noise()]
+      options.connectionEncrypters = [noise()]
       break
     default:
       // Do nothing
@@ -103,7 +103,7 @@ export async function getLibp2p (): Promise<Libp2p<{ ping: PingService }>> {
   if (!skipSecureChannel) {
     switch (SECURE_CHANNEL) {
       case 'noise':
-        options.connectionEncryption = [noise()]
+        options.connectionEncrypters = [noise()]
         break
       default:
         throw new Error(`Unknown secure channel: ${SECURE_CHANNEL ?? ''}`)

diff --git a/interop/test/fixtures/relay.ts b/interop/test/fixtures/relay.ts
@@ -17,7 +17,7 @@ export async function createRelay (): Promise<Libp2p> {
         filter: filters.all
       })
     ],
-    connectionEncryption: [noise()],
+    connectionEncrypters: [noise()],
     streamMuxers: [yamux()],
     services: {
       identify: identify(),

diff --git a/packages/connection-encrypter-plaintext/README.md b/packages/connection-encrypter-plaintext/README.md
@@ -36,7 +36,7 @@ import { plaintext } from '@libp2p/plaintext'
 
 const node = await createLibp2p({
   // ...other options
-  connectionEncryption: [
+  connectionEncrypters: [
     plaintext()
   ]
 })

diff --git a/packages/connection-encrypter-plaintext/src/index.ts b/packages/connection-encrypter-plaintext/src/index.ts
@@ -13,7 +13,7 @@
  *
  * const node = await createLibp2p({
  *   // ...other options
- *   connectionEncryption: [
+ *   connectionEncrypters: [
  *     plaintext()
  *   ]
  * })

diff --git a/packages/connection-encrypter-tls/README.md b/packages/connection-encrypter-tls/README.md
@@ -34,7 +34,7 @@ import { tls } from '@libp2p/tls'
 
 const node = await createLibp2p({
   // ...other options
-  connectionEncryption: [
+  connectionEncrypters: [
     tls()
   ]
 })

diff --git a/packages/connection-encrypter-tls/src/index.ts b/packages/connection-encrypter-tls/src/index.ts
@@ -11,7 +11,7 @@
  *
  * const node = await createLibp2p({
  *   // ...other options
- *   connectionEncryption: [
+ *   connectionEncrypters: [
  *     tls()
  *   ]
  * })

diff --git a/packages/connection-encrypter-tls/src/tls.ts b/packages/connection-encrypter-tls/src/tls.ts
@@ -11,7 +11,7 @@
  *
  * const node = await createLibp2p({
  *   // ...other options
- *   connectionEncryption: [
+ *   connectionEncrypters: [
  *     tls()
  *   ]
  * })

diff --git a/packages/integration-tests/.aegir.js b/packages/integration-tests/.aegir.js
@@ -37,7 +37,7 @@ export default {
           yamux(),
           mplex()
         ],
-        connectionEncryption: [
+        connectionEncrypters: [
           noise(),
           plaintext()
         ],

diff --git a/packages/integration-tests/test/bootstrap.spec.ts b/packages/integration-tests/test/bootstrap.spec.ts
@@ -114,7 +114,7 @@ describe('bootstrap', () => {
     ]
 
     libp2p = await createLibp2p({
-      connectionEncryption: [
+      connectionEncrypters: [
         plaintext()
       ],
       transports: [

diff --git a/packages/integration-tests/test/circuit-relay-discovery.node.ts b/packages/integration-tests/test/circuit-relay-discovery.node.ts
@@ -33,7 +33,7 @@ describe('circuit-relay discovery', () => {
       streamMuxers: [
         yamux()
       ],
-      connectionEncryption: [
+      connectionEncrypters: [
         plaintext()
       ],
       services: {
@@ -61,7 +61,7 @@ describe('circuit-relay discovery', () => {
       streamMuxers: [
         yamux()
       ],
-      connectionEncryption: [
+      connectionEncrypters: [
         plaintext()
       ],
       services: {
@@ -103,7 +103,7 @@ describe('circuit-relay discovery', () => {
         streamMuxers: [
           yamux()
         ],
-        connectionEncryption: [
+        connectionEncrypters: [
           plaintext()
         ],
         services: {
@@ -128,7 +128,7 @@ describe('circuit-relay discovery', () => {
         streamMuxers: [
           yamux()
         ],
-        connectionEncryption: [
+        connectionEncrypters: [
           plaintext()
         ],
         services: {

diff --git a/packages/integration-tests/test/circuit-relay-discovery.spec.ts b/packages/integration-tests/test/circuit-relay-discovery.spec.ts
@@ -35,7 +35,7 @@ describe('circuit-relay discovery', () => {
         yamux(),
         mplex()
       ],
-      connectionEncryption: [
+      connectionEncrypters: [
         plaintext(),
         noise()
       ],

diff --git a/packages/integration-tests/test/circuit-relay.node.ts b/packages/integration-tests/test/circuit-relay.node.ts
@@ -39,7 +39,7 @@ async function createClient (options: Libp2pOptions = {}): Promise<Libp2p> {
       yamux(),
       mplex()
     ],
-    connectionEncryption: [
+    connectionEncrypters: [
       plaintext()
     ],
     services: {
@@ -62,7 +62,7 @@ async function createRelay (options: Libp2pOptions = {}): Promise<Libp2p<{ relay
       yamux(),
       mplex()
     ],
-    connectionEncryption: [
+    connectionEncrypters: [
       plaintext()
     ],
     ...options,

diff --git a/packages/integration-tests/test/circuit-relay.spec.ts b/packages/integration-tests/test/circuit-relay.spec.ts
@@ -32,7 +32,7 @@ describe('circuit-relay', () => {
           yamux(),
           mplex()
         ],
-        connectionEncryption: [
+        connectionEncrypters: [
           plaintext()
         ],
         connectionGater: {
@@ -58,7 +58,7 @@ describe('circuit-relay', () => {
           yamux(),
           mplex()
         ],
-        connectionEncryption: [
+        connectionEncrypters: [
           plaintext()
         ],
         connectionGater: {