From 53da83f0d4f82b34004ff41ee63f1f05d79a1cc3 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Thu, 9 Nov 2023 09:17:58 +0000 Subject: [PATCH] refactor!: extract plaintext into separate module (#2221) BREAKING CHANGE: imports from `libp2p/plaintext` should be changed to `@libp2p/plaintext` --- .release-please.json | 1 + doc/migrations/v0.46-v1.0.0.md | 35 ++++++++++ .../connection-encrypter-plaintext/LICENSE | 4 ++ .../LICENSE-APACHE | 5 ++ .../LICENSE-MIT | 19 ++++++ .../connection-encrypter-plaintext/README.md | 57 ++++++++++++++++ .../package.json | 68 +++++++++++++++++++ .../src}/index.ts | 10 ++- .../src}/pb/proto.proto | 0 .../src}/pb/proto.ts | 0 .../test}/compliance.spec.ts | 2 +- .../test/index.spec.ts} | 2 +- .../tsconfig.json | 27 ++++++++ .../typedoc.json | 5 ++ packages/libp2p/.aegir.js | 2 +- packages/libp2p/package.json | 6 +- .../libp2p/test/addresses/addresses.node.ts | 2 +- .../test/circuit-relay/discovery.node.ts | 2 +- .../libp2p/test/circuit-relay/relay.node.ts | 2 +- .../libp2p/test/circuit-relay/relay.spec.ts | 2 +- .../test/connection-manager/direct.node.ts | 2 +- .../test/connection-manager/direct.spec.ts | 2 +- .../test/connection-manager/resolver.spec.ts | 2 +- .../content-routing/dht/operation.node.ts | 2 +- .../test/core/consume-peer-record.spec.ts | 2 +- packages/libp2p/test/core/encryption.spec.ts | 2 +- packages/libp2p/test/core/events.spec.ts | 2 +- .../libp2p/test/core/get-public-key.spec.ts | 2 +- packages/libp2p/test/core/listening.node.ts | 2 +- packages/libp2p/test/core/peer-id.spec.ts | 2 +- packages/libp2p/test/fetch/fetch.node.ts | 2 +- .../test/fixtures/base-options.browser.ts | 2 +- packages/libp2p/test/fixtures/base-options.ts | 2 +- .../libp2p/test/registrar/registrar.spec.ts | 2 +- .../test/transports/transport-manager.spec.ts | 2 +- .../libp2p/test/upgrading/upgrader.spec.ts | 2 +- packages/libp2p/typedoc.json | 4 +- packages/protocol-perf/README.md | 2 +- packages/protocol-perf/src/index.ts | 2 +- 39 files changed, 252 insertions(+), 39 deletions(-) create mode 100644 packages/connection-encrypter-plaintext/LICENSE create mode 100644 packages/connection-encrypter-plaintext/LICENSE-APACHE create mode 100644 packages/connection-encrypter-plaintext/LICENSE-MIT create mode 100644 packages/connection-encrypter-plaintext/README.md create mode 100644 packages/connection-encrypter-plaintext/package.json rename packages/{libp2p/src/insecure => connection-encrypter-plaintext/src}/index.ts (94%) rename packages/{libp2p/src/insecure => connection-encrypter-plaintext/src}/pb/proto.proto (100%) rename packages/{libp2p/src/insecure => connection-encrypter-plaintext/src}/pb/proto.ts (100%) rename packages/{libp2p/test/insecure => connection-encrypter-plaintext/test}/compliance.spec.ts (81%) rename packages/{libp2p/test/insecure/plaintext.spec.ts => connection-encrypter-plaintext/test/index.spec.ts} (97%) create mode 100644 packages/connection-encrypter-plaintext/tsconfig.json create mode 100644 packages/connection-encrypter-plaintext/typedoc.json diff --git a/.release-please.json b/.release-please.json index a29048d9c9..205a5caa01 100644 --- a/.release-please.json +++ b/.release-please.json @@ -3,6 +3,7 @@ "group-pull-request-title-pattern": "chore: release ${component}", "packages": { "interop": {}, + "packages/connection-encrypter-plaintext": {}, "packages/crypto": {}, "packages/interface": {}, "packages/interface-compliance-tests": {}, diff --git a/doc/migrations/v0.46-v1.0.0.md b/doc/migrations/v0.46-v1.0.0.md index 787d993009..5c726a6296 100644 --- a/doc/migrations/v0.46-v1.0.0.md +++ b/doc/migrations/v0.46-v1.0.0.md @@ -11,6 +11,7 @@ A migration guide for refactoring your application code from libp2p `v0.46` to ` - [DCUtR](#dcutr) - [KeyChain](#keychain) - [UPnPNat](#upnpnat) +- [Plaintext](#plaintext) - [Pnet](#pnet) - [Metrics](#metrics) @@ -167,6 +168,8 @@ const keychain: Keychain = libp2p.services.keychain The UPnPNat service module is now published in its own package. +**Before** + ```ts import { createLibp2p } from 'libp2p' import { uPnPNATService } from 'libp2p/upnp-nat' @@ -191,6 +194,38 @@ const node = await createLibp2p({ }) ``` +## Plaintext + +The Plaintext connection encrypter module is now published in its own package. + +Note that it is still insecure and should not be used in production. + +**Before** + +```ts +import { createLibp2p } from 'libp2p' +import { plaintext } from 'libp2p/insecure' + +const node = await createLibp2p({ + connectionEncryption: [ + plaintext: plaintext() + ] +}) +``` + +**After** + +```ts +import { createLibp2p } from 'libp2p' +import { plaintext } from '@libp2p/plaintext' + +const node = await createLibp2p({ + connectionEncryption: [ + plaintext: plaintext() + ] +}) +``` + ## Pnet The pnet module is now published in its own package. diff --git a/packages/connection-encrypter-plaintext/LICENSE b/packages/connection-encrypter-plaintext/LICENSE new file mode 100644 index 0000000000..20ce483c86 --- /dev/null +++ b/packages/connection-encrypter-plaintext/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/connection-encrypter-plaintext/LICENSE-APACHE b/packages/connection-encrypter-plaintext/LICENSE-APACHE new file mode 100644 index 0000000000..14478a3b60 --- /dev/null +++ b/packages/connection-encrypter-plaintext/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/connection-encrypter-plaintext/LICENSE-MIT b/packages/connection-encrypter-plaintext/LICENSE-MIT new file mode 100644 index 0000000000..72dc60d84b --- /dev/null +++ b/packages/connection-encrypter-plaintext/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. diff --git a/packages/connection-encrypter-plaintext/README.md b/packages/connection-encrypter-plaintext/README.md new file mode 100644 index 0000000000..8da01698a1 --- /dev/null +++ b/packages/connection-encrypter-plaintext/README.md @@ -0,0 +1,57 @@ +[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) +[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io) +[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p) +[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster) + +> An insecure connection encrypter + +# About + +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/plaintext' + +const node = await createLibp2p({ + // ...other options + connectionEncryption: [ + plaintext() + ] +}) +``` + +# Install + +```console +$ npm i @libp2p/plaintext +``` + +## Browser ` +``` + +> Implementation of the DCUtR Protocol + +# API Docs + +- + +# License + +Licensed under either of + +- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](LICENSE-MIT) / ) + +# Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/packages/connection-encrypter-plaintext/package.json b/packages/connection-encrypter-plaintext/package.json new file mode 100644 index 0000000000..e8f5bec81e --- /dev/null +++ b/packages/connection-encrypter-plaintext/package.json @@ -0,0 +1,68 @@ +{ + "name": "@libp2p/plaintext", + "version": "0.0.0", + "description": "An insecure connection encrypter", + "license": "Apache-2.0 OR MIT", + "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/connection-encrypter-plaintext#readme", + "repository": { + "type": "git", + "url": "git+https://github.com/libp2p/js-libp2p.git" + }, + "bugs": { + "url": "https://github.com/libp2p/js-libp2p/issues" + }, + "type": "module", + "types": "./dist/src/index.d.ts", + "files": [ + "src", + "dist", + "!dist/test", + "!**/*.tsbuildinfo" + ], + "exports": { + ".": { + "types": "./dist/src/index.d.ts", + "import": "./dist/src/index.js" + } + }, + "eslintConfig": { + "extends": "ipfs", + "parserOptions": { + "project": true, + "sourceType": "module" + } + }, + "scripts": { + "start": "node dist/src/main.js", + "build": "aegir build", + "test": "aegir test", + "clean": "aegir clean", + "generate": "protons ./src/pb/index.proto", + "lint": "aegir lint", + "test:chrome": "aegir test -t browser --cov", + "test:chrome-webworker": "aegir test -t webworker", + "test:firefox": "aegir test -t browser -- --browser firefox", + "test:firefox-webworker": "aegir test -t webworker -- --browser firefox", + "test:node": "aegir test -t node --cov", + "dep-check": "aegir dep-check" + }, + "dependencies": { + "@libp2p/interface": "^0.1.2", + "@libp2p/peer-id": "^3.0.6", + "@multiformats/multiaddr": "^12.1.5", + "it-handshake": "^4.1.3", + "it-length-prefixed": "^9.0.3", + "it-map": "^3.0.4", + "it-stream-types": "^2.0.1", + "protons-runtime": "^5.0.0", + "uint8arraylist": "^2.4.3" + }, + "devDependencies": { + "@libp2p/interface-compliance-tests": "^4.1.5", + "@libp2p/logger": "^3.0.2", + "@libp2p/peer-id-factory": "^3.0.8", + "aegir": "^41.0.2", + "protons": "^7.3.0", + "sinon": "^17.0.0" + } +} diff --git a/packages/libp2p/src/insecure/index.ts b/packages/connection-encrypter-plaintext/src/index.ts similarity index 94% rename from packages/libp2p/src/insecure/index.ts rename to packages/connection-encrypter-plaintext/src/index.ts index 0a0af59cd6..01f6498232 100644 --- a/packages/libp2p/src/insecure/index.ts +++ b/packages/connection-encrypter-plaintext/src/index.ts @@ -9,15 +9,13 @@ * * ```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) + * import { plaintext } from '@libp2p/plaintext' * * const node = await createLibp2p({ * // ...other options - * connectionEncryption: [plaintext()] + * connectionEncryption: [ + * plaintext() + * ] * }) * ``` */ diff --git a/packages/libp2p/src/insecure/pb/proto.proto b/packages/connection-encrypter-plaintext/src/pb/proto.proto similarity index 100% rename from packages/libp2p/src/insecure/pb/proto.proto rename to packages/connection-encrypter-plaintext/src/pb/proto.proto diff --git a/packages/libp2p/src/insecure/pb/proto.ts b/packages/connection-encrypter-plaintext/src/pb/proto.ts similarity index 100% rename from packages/libp2p/src/insecure/pb/proto.ts rename to packages/connection-encrypter-plaintext/src/pb/proto.ts diff --git a/packages/libp2p/test/insecure/compliance.spec.ts b/packages/connection-encrypter-plaintext/test/compliance.spec.ts similarity index 81% rename from packages/libp2p/test/insecure/compliance.spec.ts rename to packages/connection-encrypter-plaintext/test/compliance.spec.ts index 3bc67adc3e..3d9d4757be 100644 --- a/packages/libp2p/test/insecure/compliance.spec.ts +++ b/packages/connection-encrypter-plaintext/test/compliance.spec.ts @@ -1,7 +1,7 @@ /* eslint-env mocha */ import suite from '@libp2p/interface-compliance-tests/connection-encryption' -import { plaintext } from '../../src/insecure/index.js' +import { plaintext } from '../src/index.js' describe('plaintext compliance', () => { suite({ diff --git a/packages/libp2p/test/insecure/plaintext.spec.ts b/packages/connection-encrypter-plaintext/test/index.spec.ts similarity index 97% rename from packages/libp2p/test/insecure/plaintext.spec.ts rename to packages/connection-encrypter-plaintext/test/index.spec.ts index 0fe1cc799a..b0decafcf2 100644 --- a/packages/libp2p/test/insecure/plaintext.spec.ts +++ b/packages/connection-encrypter-plaintext/test/index.spec.ts @@ -10,7 +10,7 @@ import { createEd25519PeerId, createRSAPeerId } from '@libp2p/peer-id-factory' import { multiaddr } from '@multiformats/multiaddr' import { expect } from 'aegir/chai' import sinon from 'sinon' -import { plaintext } from '../../src/insecure/index.js' +import { plaintext } from '../src/index.js' import type { ConnectionEncrypter } from '@libp2p/interface/connection-encrypter' import type { PeerId } from '@libp2p/interface/peer-id' diff --git a/packages/connection-encrypter-plaintext/tsconfig.json b/packages/connection-encrypter-plaintext/tsconfig.json new file mode 100644 index 0000000000..025cc64f5b --- /dev/null +++ b/packages/connection-encrypter-plaintext/tsconfig.json @@ -0,0 +1,27 @@ +{ + "extends": "aegir/src/config/tsconfig.aegir.json", + "compilerOptions": { + "outDir": "dist" + }, + "include": [ + "src", + "test" + ], + "references": [ + { + "path": "../interface" + }, + { + "path": "../interface-compliance-tests" + }, + { + "path": "../logger" + }, + { + "path": "../peer-id" + }, + { + "path": "../peer-id-factory" + } + ] +} diff --git a/packages/connection-encrypter-plaintext/typedoc.json b/packages/connection-encrypter-plaintext/typedoc.json new file mode 100644 index 0000000000..f599dc728d --- /dev/null +++ b/packages/connection-encrypter-plaintext/typedoc.json @@ -0,0 +1,5 @@ +{ + "entryPoints": [ + "./src/index.ts" + ] +} diff --git a/packages/libp2p/.aegir.js b/packages/libp2p/.aegir.js index ec0454488e..9ccbcc9f9e 100644 --- a/packages/libp2p/.aegir.js +++ b/packages/libp2p/.aegir.js @@ -15,7 +15,7 @@ export default { const { yamux } = await import('@chainsafe/libp2p-yamux') const { WebSockets } = await import('@multiformats/mafmt') const { createLibp2p } = await import('./dist/src/index.js') - const { plaintext } = await import('./dist/src/insecure/index.js') + const { plaintext } = await import('@libp2p/plaintext') const { circuitRelayServer, circuitRelayTransport } = await import('./dist/src/circuit-relay/index.js') const { identify } = await import('@libp2p/identify') const { fetchService } = await import('./dist/src/fetch/index.js') diff --git a/packages/libp2p/package.json b/packages/libp2p/package.json index cb316d419a..f4352efe5a 100644 --- a/packages/libp2p/package.json +++ b/packages/libp2p/package.json @@ -55,10 +55,6 @@ "./fetch": { "types": "./dist/src/fetch/index.d.ts", "import": "./dist/src/fetch/index.js" - }, - "./insecure": { - "types": "./dist/src/insecure/index.d.ts", - "import": "./dist/src/insecure/index.js" } }, "eslintConfig": { @@ -117,7 +113,6 @@ "it-drain": "^3.0.2", "it-filter": "^3.0.1", "it-first": "^3.0.1", - "it-handshake": "^4.1.3", "it-length-prefixed": "^9.0.1", "it-map": "^3.0.3", "it-merge": "^3.0.0", @@ -150,6 +145,7 @@ "@libp2p/kad-dht": "^10.0.15", "@libp2p/mdns": "^9.0.14", "@libp2p/mplex": "^9.0.12", + "@libp2p/plaintext": "^0.0.0", "@libp2p/tcp": "^8.0.13", "@libp2p/websockets": "^7.0.13", "aegir": "^41.0.2", diff --git a/packages/libp2p/test/addresses/addresses.node.ts b/packages/libp2p/test/addresses/addresses.node.ts index c606b78aed..639503ce3c 100644 --- a/packages/libp2p/test/addresses/addresses.node.ts +++ b/packages/libp2p/test/addresses/addresses.node.ts @@ -1,12 +1,12 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { isLoopback } from '@libp2p/utils/multiaddr/is-loopback' import { webSockets } from '@libp2p/websockets' import { type Multiaddr, multiaddr, protocols } from '@multiformats/multiaddr' import { expect } from 'aegir/chai' import { pEvent } from 'p-event' import sinon from 'sinon' -import { plaintext } from '../../src/insecure/index.js' import { createNode } from '../fixtures/creators/peer.js' import { AddressesOptions } from './utils.js' import type { Libp2pNode } from '../../src/libp2p.js' diff --git a/packages/libp2p/test/circuit-relay/discovery.node.ts b/packages/libp2p/test/circuit-relay/discovery.node.ts index 19517e67be..c62175fd71 100644 --- a/packages/libp2p/test/circuit-relay/discovery.node.ts +++ b/packages/libp2p/test/circuit-relay/discovery.node.ts @@ -1,12 +1,12 @@ /* eslint-env mocha */ import { yamux } from '@chainsafe/libp2p-yamux' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { expect } from 'aegir/chai' import { pEvent } from 'p-event' import { circuitRelayServer, type CircuitRelayService, circuitRelayTransport } from '../../src/circuit-relay/index.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { getRelayAddress, hasRelay, MockContentRouting, mockContentRouting } from './utils.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/circuit-relay/relay.node.ts b/packages/libp2p/test/circuit-relay/relay.node.ts index aa5bc51ed9..d98916e08d 100644 --- a/packages/libp2p/test/circuit-relay/relay.node.ts +++ b/packages/libp2p/test/circuit-relay/relay.node.ts @@ -4,6 +4,7 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { identify } from '@libp2p/identify' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { Circuit } from '@multiformats/mafmt' import { multiaddr } from '@multiformats/multiaddr' @@ -20,7 +21,6 @@ import { DEFAULT_DATA_LIMIT, RELAY_V2_HOP_CODEC } from '../../src/circuit-relay/ import { circuitRelayServer, type CircuitRelayService, circuitRelayTransport } from '../../src/circuit-relay/index.js' import { HopMessage, Status } from '../../src/circuit-relay/pb/index.js' import { createLibp2p, type Libp2pOptions } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { discoveredRelayConfig, doesNotHaveRelay, getRelayAddress, hasRelay, notUsingAsRelay, usingAsRelay, usingAsRelayCount } from './utils.js' import type { Components } from '../../src/components.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/circuit-relay/relay.spec.ts b/packages/libp2p/test/circuit-relay/relay.spec.ts index 767d797234..e59393f3c2 100644 --- a/packages/libp2p/test/circuit-relay/relay.spec.ts +++ b/packages/libp2p/test/circuit-relay/relay.spec.ts @@ -4,6 +4,7 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { identify } from '@libp2p/identify' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import { Circuit } from '@multiformats/mafmt' @@ -11,7 +12,6 @@ import { expect } from 'aegir/chai' import { pEvent } from 'p-event' import { circuitRelayTransport } from '../../src/circuit-relay/index.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { hasRelay } from './utils.js' import type { Libp2p } from '@libp2p/interface' import type { Connection } from '@libp2p/interface/connection' diff --git a/packages/libp2p/test/connection-manager/direct.node.ts b/packages/libp2p/test/connection-manager/direct.node.ts index a345a5c8d1..76b3a471b9 100644 --- a/packages/libp2p/test/connection-manager/direct.node.ts +++ b/packages/libp2p/test/connection-manager/direct.node.ts @@ -13,6 +13,7 @@ import { mplex } from '@libp2p/mplex' import { peerIdFromString } from '@libp2p/peer-id' import { createEd25519PeerId } from '@libp2p/peer-id-factory' import { PersistentPeerStore } from '@libp2p/peer-store' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { multiaddr } from '@multiformats/multiaddr' import { expect } from 'aegir/chai' @@ -30,7 +31,6 @@ import { defaultComponents, type Components } from '../../src/components.js' import { DialQueue } from '../../src/connection-manager/dial-queue.js' import { DefaultConnectionManager } from '../../src/connection-manager/index.js' import { codes as ErrorCodes } from '../../src/errors.js' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode, type Libp2pNode } from '../../src/libp2p.js' import { DefaultTransportManager } from '../../src/transport-manager.js' import type { PeerId } from '@libp2p/interface/peer-id' diff --git a/packages/libp2p/test/connection-manager/direct.spec.ts b/packages/libp2p/test/connection-manager/direct.spec.ts index 1ed8051e75..a8667d2d27 100644 --- a/packages/libp2p/test/connection-manager/direct.spec.ts +++ b/packages/libp2p/test/connection-manager/direct.spec.ts @@ -9,6 +9,7 @@ import { mplex } from '@libp2p/mplex' import { peerIdFromString } from '@libp2p/peer-id' import { createEd25519PeerId } from '@libp2p/peer-id-factory' import { PersistentPeerStore } from '@libp2p/peer-store' +import { plaintext } from '@libp2p/plaintext' import { defaultAddressSort } from '@libp2p/utils/address-sort' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' @@ -25,7 +26,6 @@ import { LAST_DIAL_FAILURE_KEY } from '../../src/connection-manager/constants.js import { DefaultConnectionManager } from '../../src/connection-manager/index.js' import { codes as ErrorCodes } from '../../src/errors.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { DefaultTransportManager } from '../../src/transport-manager.js' import { createPeerId } from '../fixtures/creators/peer.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/connection-manager/resolver.spec.ts b/packages/libp2p/test/connection-manager/resolver.spec.ts index adccf3976d..95e63b7b55 100644 --- a/packages/libp2p/test/connection-manager/resolver.spec.ts +++ b/packages/libp2p/test/connection-manager/resolver.spec.ts @@ -5,6 +5,7 @@ import { mockConnection, mockConnectionGater, mockDuplex, mockMultiaddrConnectio import { mplex } from '@libp2p/mplex' import { peerIdFromString } from '@libp2p/peer-id' import { createEd25519PeerId } from '@libp2p/peer-id-factory' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import { multiaddr } from '@multiformats/multiaddr' @@ -14,7 +15,6 @@ import sinon from 'sinon' import { RELAY_V2_HOP_CODEC } from '../../src/circuit-relay/constants.js' import { circuitRelayServer, type CircuitRelayService, circuitRelayTransport } from '../../src/circuit-relay/index.js' import { codes as ErrorCodes } from '../../src/errors.js' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode, type Libp2pNode } from '../../src/libp2p.js' import type { PeerId } from '@libp2p/interface/peer-id' import type { Transport } from '@libp2p/interface/transport' diff --git a/packages/libp2p/test/content-routing/dht/operation.node.ts b/packages/libp2p/test/content-routing/dht/operation.node.ts index b960aa4f6a..c52c6d7f81 100644 --- a/packages/libp2p/test/content-routing/dht/operation.node.ts +++ b/packages/libp2p/test/content-routing/dht/operation.node.ts @@ -3,13 +3,13 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { kadDHT } from '@libp2p/kad-dht' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { multiaddr } from '@multiformats/multiaddr' import { expect } from 'aegir/chai' import pWaitFor from 'p-wait-for' import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string' import { createLibp2p } from '../../../src/index.js' -import { plaintext } from '../../../src/insecure/index.js' import { createPeerId } from '../../fixtures/creators/peer.js' import { subsystemMulticodecs } from './utils.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/core/consume-peer-record.spec.ts b/packages/libp2p/test/core/consume-peer-record.spec.ts index 52e1c2b6f3..9f1ad74e32 100644 --- a/packages/libp2p/test/core/consume-peer-record.spec.ts +++ b/packages/libp2p/test/core/consume-peer-record.spec.ts @@ -1,8 +1,8 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { multiaddr } from '@multiformats/multiaddr' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode, type Libp2pNode } from '../../src/libp2p.js' import { createPeerId } from '../fixtures/creators/peer.js' diff --git a/packages/libp2p/test/core/encryption.spec.ts b/packages/libp2p/test/core/encryption.spec.ts index 572fc6ceac..a51bd35a6f 100644 --- a/packages/libp2p/test/core/encryption.spec.ts +++ b/packages/libp2p/test/core/encryption.spec.ts @@ -1,8 +1,8 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { createLibp2p, type Libp2pOptions } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { createPeerId } from '../fixtures/creators/peer.js' import type { PeerId } from '@libp2p/interface/peer-id' diff --git a/packages/libp2p/test/core/events.spec.ts b/packages/libp2p/test/core/events.spec.ts index 00cfd47d07..95c4156ab5 100644 --- a/packages/libp2p/test/core/events.spec.ts +++ b/packages/libp2p/test/core/events.spec.ts @@ -1,10 +1,10 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { expect } from 'aegir/chai' import { pEvent } from 'p-event' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import type { Libp2p } from '@libp2p/interface' describe('events', () => { diff --git a/packages/libp2p/test/core/get-public-key.spec.ts b/packages/libp2p/test/core/get-public-key.spec.ts index 11c84c196f..b84031bdbf 100644 --- a/packages/libp2p/test/core/get-public-key.spec.ts +++ b/packages/libp2p/test/core/get-public-key.spec.ts @@ -1,10 +1,10 @@ /* eslint-env mocha */ import { kadDHT } from '@libp2p/kad-dht' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { expect } from 'aegir/chai' import sinon from 'sinon' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode } from '../../src/libp2p.js' import { createPeerId } from '../fixtures/creators/peer.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/core/listening.node.ts b/packages/libp2p/test/core/listening.node.ts index b09aa9d0f9..99c445581d 100644 --- a/packages/libp2p/test/core/listening.node.ts +++ b/packages/libp2p/test/core/listening.node.ts @@ -1,8 +1,8 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { expect } from 'aegir/chai' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode, type Libp2pNode } from '../../src/libp2p.js' import { createPeerId } from '../fixtures/creators/peer.js' import type { PeerId } from '@libp2p/interface/peer-id' diff --git a/packages/libp2p/test/core/peer-id.spec.ts b/packages/libp2p/test/core/peer-id.spec.ts index 220a9fbe16..c6ac0e5c21 100644 --- a/packages/libp2p/test/core/peer-id.spec.ts +++ b/packages/libp2p/test/core/peer-id.spec.ts @@ -1,9 +1,9 @@ /* eslint-env mocha */ +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { expect } from 'aegir/chai' import { createLibp2p, type Libp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' describe('peer-id', () => { let libp2p: Libp2p diff --git a/packages/libp2p/test/fetch/fetch.node.ts b/packages/libp2p/test/fetch/fetch.node.ts index 53420c9a45..ad23ce1f86 100644 --- a/packages/libp2p/test/fetch/fetch.node.ts +++ b/packages/libp2p/test/fetch/fetch.node.ts @@ -2,12 +2,12 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { expect } from 'aegir/chai' import { codes } from '../../src/errors.js' import { type FetchService, fetchService } from '../../src/fetch/index.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { createPeerId } from '../fixtures/creators/peer.js' import type { Libp2p } from '@libp2p/interface' import type { PeerId } from '@libp2p/interface/peer-id' diff --git a/packages/libp2p/test/fixtures/base-options.browser.ts b/packages/libp2p/test/fixtures/base-options.browser.ts index 14c0914169..be8b3286e5 100644 --- a/packages/libp2p/test/fixtures/base-options.browser.ts +++ b/packages/libp2p/test/fixtures/base-options.browser.ts @@ -1,10 +1,10 @@ import { mockConnectionGater } from '@libp2p/interface-compliance-tests/mocks' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import mergeOptions from 'merge-options' import { circuitRelayTransport } from '../../src/circuit-relay/index.js' -import { plaintext } from '../../src/insecure/index.js' import type { Libp2pOptions } from '../../src/index.js' import type { ServiceMap } from '@libp2p/interface' diff --git a/packages/libp2p/test/fixtures/base-options.ts b/packages/libp2p/test/fixtures/base-options.ts index b9f558d552..97812666b6 100644 --- a/packages/libp2p/test/fixtures/base-options.ts +++ b/packages/libp2p/test/fixtures/base-options.ts @@ -1,11 +1,11 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { mplex } from '@libp2p/mplex' +import { plaintext } from '@libp2p/plaintext' import { tcp } from '@libp2p/tcp' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import mergeOptions from 'merge-options' import { circuitRelayTransport } from '../../src/circuit-relay/index.js' -import { plaintext } from '../../src/insecure/index.js' import type { Libp2pOptions } from '../../src' import type { ServiceMap } from '@libp2p/interface' diff --git a/packages/libp2p/test/registrar/registrar.spec.ts b/packages/libp2p/test/registrar/registrar.spec.ts index 302e773121..4626120cca 100644 --- a/packages/libp2p/test/registrar/registrar.spec.ts +++ b/packages/libp2p/test/registrar/registrar.spec.ts @@ -6,6 +6,7 @@ import { mockDuplex, mockMultiaddrConnection, mockUpgrader, mockConnection } fro import { mplex } from '@libp2p/mplex' import { createEd25519PeerId } from '@libp2p/peer-id-factory' import { PersistentPeerStore } from '@libp2p/peer-store' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import { expect } from 'aegir/chai' import { MemoryDatastore } from 'datastore-core/memory' @@ -13,7 +14,6 @@ import pDefer from 'p-defer' import { type StubbedInstance, stubInterface } from 'sinon-ts' import { type Components, defaultComponents } from '../../src/components.js' import { DefaultConnectionManager } from '../../src/connection-manager/index.js' -import { plaintext } from '../../src/insecure/index.js' import { createLibp2pNode, type Libp2pNode } from '../../src/libp2p.js' import { DefaultRegistrar } from '../../src/registrar.js' import { createPeerId } from '../fixtures/creators/peer.js' diff --git a/packages/libp2p/test/transports/transport-manager.spec.ts b/packages/libp2p/test/transports/transport-manager.spec.ts index 075364aea9..96967480aa 100644 --- a/packages/libp2p/test/transports/transport-manager.spec.ts +++ b/packages/libp2p/test/transports/transport-manager.spec.ts @@ -5,6 +5,7 @@ import { start, stop } from '@libp2p/interface/startable' import { FaultTolerance } from '@libp2p/interface/transport' import { mockUpgrader } from '@libp2p/interface-compliance-tests/mocks' import { createEd25519PeerId } from '@libp2p/peer-id-factory' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import { multiaddr } from '@multiformats/multiaddr' @@ -13,7 +14,6 @@ import sinon from 'sinon' import { DefaultAddressManager } from '../../src/address-manager/index.js' import { codes as ErrorCodes } from '../../src/errors.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { DefaultTransportManager } from '../../src/transport-manager.js' import type { Components } from '../../src/components.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/test/upgrading/upgrader.spec.ts b/packages/libp2p/test/upgrading/upgrader.spec.ts index 0c2267d73b..7406c2c779 100644 --- a/packages/libp2p/test/upgrading/upgrader.spec.ts +++ b/packages/libp2p/test/upgrading/upgrader.spec.ts @@ -6,6 +6,7 @@ import { mockConnectionGater, mockConnectionManager, mockMultiaddrConnPair, mock import { mplex } from '@libp2p/mplex' import { createEd25519PeerId } from '@libp2p/peer-id-factory' import { PersistentPeerStore } from '@libp2p/peer-store' +import { plaintext } from '@libp2p/plaintext' import { webSockets } from '@libp2p/websockets' import * as filters from '@libp2p/websockets/filters' import { multiaddr } from '@multiformats/multiaddr' @@ -25,7 +26,6 @@ import { circuitRelayTransport } from '../../src/circuit-relay/index.js' import { type Components, defaultComponents } from '../../src/components.js' import { codes } from '../../src/errors.js' import { createLibp2p } from '../../src/index.js' -import { plaintext } from '../../src/insecure/index.js' import { DEFAULT_MAX_OUTBOUND_STREAMS } from '../../src/registrar.js' import { DefaultUpgrader } from '../../src/upgrader.js' import type { Libp2p } from '@libp2p/interface' diff --git a/packages/libp2p/typedoc.json b/packages/libp2p/typedoc.json index 8bba617743..66cdc20483 100644 --- a/packages/libp2p/typedoc.json +++ b/packages/libp2p/typedoc.json @@ -2,8 +2,6 @@ "entryPoints": [ "./src/index.ts", "./src/circuit-relay/index.ts", - "./src/dcutr/index.ts", - "./src/fetch/index.ts", - "./src/insecure/index.ts" + "./src/fetch/index.ts" ] } diff --git a/packages/protocol-perf/README.md b/packages/protocol-perf/README.md index 35770ef18c..535db1b545 100644 --- a/packages/protocol-perf/README.md +++ b/packages/protocol-perf/README.md @@ -17,7 +17,7 @@ import { yamux } from '@chainsafe/libp2p-yamux' import { mplex } from '@libp2p/mplex' import { tcp } from '@libp2p/tcp' import { createLibp2p, type Libp2p } from 'libp2p' -import { plaintext } from 'libp2p/insecure' +import { plaintext } from '@libp2p/plaintext' import { perfService, type PerfService } from '@libp2p/perf' const ONE_MEG = 1024 * 1024 diff --git a/packages/protocol-perf/src/index.ts b/packages/protocol-perf/src/index.ts index 0ba3ed1580..5108dc70ff 100644 --- a/packages/protocol-perf/src/index.ts +++ b/packages/protocol-perf/src/index.ts @@ -11,7 +11,7 @@ * import { mplex } from '@libp2p/mplex' * import { tcp } from '@libp2p/tcp' * import { createLibp2p, type Libp2p } from 'libp2p' - * import { plaintext } from 'libp2p/insecure' + * import { plaintext } from '@libp2p/plaintext' * import { perfService, type PerfService } from '@libp2p/perf' * * const ONE_MEG = 1024 * 1024