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

BREAKING CHANGE: imports from `libp2p/dcutr` now need to be from `@libp2p/dcutr`

Author: achingbrain

.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": {},

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.

packages/interface/package.json

@@ -39,9 +39,6 @@
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
-  "browser": {
-    "events": "./dist/src/events.browser.js"
-  },
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
@@ -178,5 +175,8 @@
     "it-drain": "^3.0.3",
     "sinon": "^17.0.0",
     "sinon-ts": "^2.0.0"
+  },
+  "browser": {
+    "events": "./dist/src/events.browser.js"
   }
 }

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'

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"

packages/libp2p/test/dcutr/dcutr.node.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
  *

packages/logger/src/index.ts

@@ -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",

packages/pnet/package.json

@@ -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

packages/protocol-dcutr/LICENSE

@@ -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.