fix!: consolidate interface modules (libp2p#1833)

adamlaska · Jun 19, 2023 · 4255b1e · 4255b1e
1 parent c1bee2b
commit 4255b1e
Show file tree

Hide file tree

Showing 627 changed files with 2,234 additions and 16,705 deletions.
diff --git a/packages/crypto/package.json b/packages/crypto/package.json
@@ -76,7 +76,7 @@
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
-    "dep-check": "aegir dep-check -i protons",
+    "dep-check": "aegir dep-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser",
@@ -89,15 +89,14 @@
     "generate": "protons ./src/keys/keys.proto"
   },
   "dependencies": {
-    "@libp2p/interface-keys": "^1.0.0",
-    "@libp2p/interfaces": "^3.0.0",
+    "@libp2p/interface": "~0.0.1",
     "@noble/ed25519": "^1.6.0",
     "@noble/secp256k1": "^1.5.4",
-    "multiformats": "^11.0.2",
+    "multiformats": "^12.0.1",
     "node-forge": "^1.1.0",
     "protons-runtime": "^5.0.0",
     "uint8arraylist": "^2.4.3",
-    "uint8arrays": "^4.0.3"
+    "uint8arrays": "^4.0.4"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.0",

diff --git a/packages/crypto/src/aes/cipher-mode.ts b/packages/crypto/src/aes/cipher-mode.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 
 const CIPHER_MODES = {
   16: 'aes-128-ctr',

diff --git a/packages/crypto/src/keys/ecdh-browser.ts b/packages/crypto/src/keys/ecdh-browser.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { concat as uint8ArrayConcat } from 'uint8arrays/concat'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'

diff --git a/packages/crypto/src/keys/ecdh.ts b/packages/crypto/src/keys/ecdh.ts
@@ -1,5 +1,5 @@
 import crypto from 'crypto'
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import type { ECDHKey, ECDHKeyPair } from './interface.js'
 
 const curves = {

diff --git a/packages/crypto/src/keys/ed25519-class.ts b/packages/crypto/src/keys/ed25519-class.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { base58btc } from 'multiformats/bases/base58'
 import { identity } from 'multiformats/hashes/identity'
 import { sha256 } from 'multiformats/hashes/sha2'

diff --git a/packages/crypto/src/keys/index.ts b/packages/crypto/src/keys/index.ts
@@ -1,6 +1,6 @@
 import 'node-forge/lib/asn1.js'
 import 'node-forge/lib/pbe.js'
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 // @ts-expect-error types are missing
 import forge from 'node-forge/lib/forge.js'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
@@ -11,7 +11,7 @@ import { keyStretcher } from './key-stretcher.js'
 import * as keysPBM from './keys.js'
 import * as RSA from './rsa-class.js'
 import * as Secp256k1 from './secp256k1-class.js'
-import type { PrivateKey, PublicKey } from '@libp2p/interface-keys'
+import type { PrivateKey, PublicKey } from '@libp2p/interface/keys'
 
 export { keyStretcher }
 export { generateEphemeralKeyPair }

diff --git a/packages/crypto/src/keys/key-stretcher.ts b/packages/crypto/src/keys/key-stretcher.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { concat as uint8ArrayConcat } from 'uint8arrays/concat'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import * as hmac from '../hmac/index.js'

diff --git a/packages/crypto/src/keys/rsa-browser.ts b/packages/crypto/src/keys/rsa-browser.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import randomBytes from '../random-bytes.js'

diff --git a/packages/crypto/src/keys/rsa-class.ts b/packages/crypto/src/keys/rsa-class.ts
@@ -1,5 +1,5 @@
 
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { sha256 } from 'multiformats/hashes/sha2'
 // @ts-expect-error types are missing
 import forge from 'node-forge/lib/forge.js'

diff --git a/packages/crypto/src/keys/rsa-utils.ts b/packages/crypto/src/keys/rsa-utils.ts
@@ -1,6 +1,6 @@
 import 'node-forge/lib/asn1.js'
 import 'node-forge/lib/rsa.js'
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 // @ts-expect-error types are missing
 import forge from 'node-forge/lib/forge.js'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'

diff --git a/packages/crypto/src/keys/rsa.ts b/packages/crypto/src/keys/rsa.ts
@@ -1,6 +1,6 @@
 import crypto from 'crypto'
 import { promisify } from 'util'
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import randomBytes from '../random-bytes.js'
 import * as utils from './rsa-utils.js'
 import type { JWKKeyPair } from './interface.js'

diff --git a/packages/crypto/src/keys/secp256k1-class.ts b/packages/crypto/src/keys/secp256k1-class.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { sha256 } from 'multiformats/hashes/sha2'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'

diff --git a/packages/crypto/src/keys/secp256k1.ts b/packages/crypto/src/keys/secp256k1.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import * as secp from '@noble/secp256k1'
 import { sha256 } from 'multiformats/hashes/sha2'
 

diff --git a/packages/crypto/src/pbkdf2.ts b/packages/crypto/src/pbkdf2.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 // @ts-expect-error types are missing
 import forgePbkdf2 from 'node-forge/lib/pbkdf2.js'
 // @ts-expect-error types are missing

diff --git a/packages/crypto/src/random-bytes.ts b/packages/crypto/src/random-bytes.ts
@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interfaces/errors'
+import { CodeError } from '@libp2p/interface/errors'
 import { utils } from '@noble/secp256k1'
 
 export default function randomBytes (length: number): Uint8Array {

diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json
@@ -9,10 +9,7 @@
   ],
   "references": [
     {
-      "path": "../interface-keys"
-    },
-    {
-      "path": "../interfaces"
+      "path": "../interface"
     }
   ]
 }
diff --git a/packages/interface-address-manager/CHANGELOG.md b/packages/interface-address-manager/CHANGELOG.md
diff --git a/packages/interface-address-manager/README.md b/packages/interface-address-manager/README.md
diff --git a/packages/interface-address-manager/package.json b/packages/interface-address-manager/package.json
diff --git a/packages/interface-address-manager/tsconfig.json b/packages/interface-address-manager/tsconfig.json
diff --git a/packages/interface-compliance-tests/README.md b/packages/interface-compliance-tests/README.md
@@ -10,6 +10,7 @@
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [API Docs](#api-docs)
 - [License](#license)
@@ -21,6 +22,14 @@
 $ npm i @libp2p/interface-compliance-tests
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pInterfaceComplianceTests` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/interface-compliance-tests/dist/index.min.js"></script>
+```
+
 ## Usage
 
 Each [interface](https://npmjs.org/packages/@libp2p/interfaces) has its documentation on how to use the compliance tests and should be used as the source of truth.