refactor!: extract DCUtR into separate module (libp2p#2220)

BREAKING CHANGE: imports from `libp2p/dcutr` now need to be from `@libp2p/dcutr`
maschad · Nov 10, 2023 · 395e55b · 395e55b
1 parent bed832f
commit 395e55b
Show file tree

Hide file tree

Showing 23 changed files with 289 additions and 233 deletions.
diff --git a/.release-please.json b/.release-please.json
@@ -21,6 +21,7 @@
     "packages/peer-record": {},
     "packages/peer-store": {},
     "packages/protocol-autonat": {},
+    "packages/protocol-dcutr": {},
     "packages/protocol-identify": {},
     "packages/protocol-perf": {},
     "packages/protocol-ping": {},

diff --git a/doc/migrations/v0.46-v1.0.0.md b/doc/migrations/v0.46-v1.0.0.md
@@ -8,6 +8,7 @@ A migration guide for refactoring your application code from libp2p `v0.46` to `
 - [AutoNAT](#autonat)
 - [Ping](#ping)
 - [Identify](#identify)
+- [DCUtR](#dcutr)
 - [KeyChain](#keychain)
 - [UPnPNat](#upnpnat)
 - [Pnet](#pnet)
@@ -103,6 +104,36 @@ const node = await createLibp2p({
 })
 ```
 
+## DCUtR
+
+The DCUtR service is now published in its own package.
+
+**Before**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { dcutrService } from 'libp2p/dcutr'
+
+const node = await createLibp2p({
+  services: {
+    identify: dcutrService()
+  }
+})
+```
+
+**After**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { dcutr } from '@libp2p/dcutr'
+
+const node = await createLibp2p({
+  services: {
+    dcutr: dcutr()
+  }
+})
+```
+
 ## KeyChain
 
 The KeyChain object is no longer included on Libp2p and must be instantiated explicitly if desired.

diff --git a/packages/interface/package.json b/packages/interface/package.json
@@ -39,12 +39,6 @@
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
-  "browser": {
-    "events": "./dist/src/events.browser.js"
-  },
-  "react-native": {
-    "events": "./dist/src/events.browser.js"
-  },
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
@@ -181,5 +175,11 @@
     "it-drain": "^3.0.3",
     "sinon": "^17.0.0",
     "sinon-ts": "^2.0.0"
+  },
+  "browser": {
+    "events": "./dist/src/events.browser.js"
+  },
+  "react-native": {
+    "events": "./dist/src/events.browser.js"
   }
 }
diff --git a/packages/interface/src/errors.ts b/packages/interface/src/errors.ts
@@ -71,3 +71,4 @@ export class InvalidCryptoTransmissionError extends Error {
 export const ERR_TIMEOUT = 'ERR_TIMEOUT'
 export const ERR_INVALID_PARAMETERS = 'ERR_INVALID_PARAMETERS'
 export const ERR_NOT_FOUND = 'ERR_NOT_FOUND'
+export const ERR_INVALID_MESSAGE = 'ERR_INVALID_MESSAGE'
diff --git a/packages/libp2p/package.json b/packages/libp2p/package.json
@@ -52,10 +52,6 @@
       "types": "./dist/src/circuit-relay/index.d.ts",
       "import": "./dist/src/circuit-relay/index.js"
     },
-    "./dcutr": {
-      "types": "./dist/src/dcutr/index.d.ts",
-      "import": "./dist/src/dcutr/index.js"
-    },
     "./fetch": {
       "types": "./dist/src/fetch/index.d.ts",
       "import": "./dist/src/fetch/index.js"

diff --git a/packages/libp2p/test/dcutr/dcutr.node.ts b/packages/libp2p/test/dcutr/dcutr.node.ts
diff --git a/packages/logger/src/index.ts b/packages/logger/src/index.ts
@@ -1,8 +1,7 @@
 /**
  * @packageDocumentation
  *
- * A logger for libp2p based on the venerable [debug](https://www.npmjs.com/package/debug)
- * module.
+ * A logger for libp2p based on the venerable [debug](https://www.npmjs.com/package/debug) module.
  *
  * @example
  *

diff --git a/packages/pnet/package.json b/packages/pnet/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/pnet",
-  "version": "1.0.0",
+  "version": "0.0.0",
   "description": "Implementation of Connection protection management via a shared secret",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/pnet#readme",

diff --git a/packages/protocol-dcutr/LICENSE b/packages/protocol-dcutr/LICENSE
@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0
diff --git a/packages/protocol-dcutr/LICENSE-APACHE b/packages/protocol-dcutr/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/packages/protocol-dcutr/LICENSE-MIT b/packages/protocol-dcutr/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.