From f7f28f03b01fa5bc89eaeb083b68981169b45c39 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Wed, 2 Nov 2022 16:56:11 +1100 Subject: [PATCH 01/11] feat!: extract dns discovery and enr from core --- package-lock.json | 132 +++++++++++++ packages/dns-discovery/package.json | 177 ++++++++++++++++++ packages/dns-discovery/rollup.config.js | 21 +++ .../src}/dns.spec.ts | 0 .../src}/dns.ts | 0 .../src}/dns_over_https.ts | 0 .../src}/enrtree.spec.ts | 0 .../src}/enrtree.ts | 0 .../src}/fetch_nodes.spec.ts | 0 .../src}/fetch_nodes.ts | 0 .../src}/index.spec.ts | 0 .../src}/index.ts | 0 .../src}/testdata.json | 0 packages/dns-discovery/tsconfig.dev.json | 8 + packages/dns-discovery/tsconfig.json | 54 ++++++ packages/enr/package.json | 177 ++++++++++++++++++ packages/enr/rollup.config.js | 21 +++ .../src/lib/enr => enr/src}/constants.ts | 0 .../{core/src/lib/enr => enr/src}/enr.spec.ts | 0 packages/{core/src/lib/enr => enr/src}/enr.ts | 0 .../{core/src/lib/enr => enr/src}/index.ts | 0 .../src/lib/enr => enr/src}/keypair/index.ts | 0 .../lib/enr => enr/src}/keypair/secp256k1.ts | 0 .../src/lib/enr => enr/src}/keypair/types.ts | 0 .../src}/multiaddr_from_fields.spec.ts | 0 .../enr => enr/src}/multiaddr_from_fields.ts | 0 .../enr => enr/src}/multiaddrs_codec.spec.ts | 0 .../lib/enr => enr/src}/multiaddrs_codec.ts | 0 .../{core/src/lib/enr => enr/src}/types.ts | 0 packages/{core/src/lib/enr => enr/src}/v4.ts | 0 .../lib/enr => enr/src}/waku2_codec.spec.ts | 0 .../src/lib/enr => enr/src}/waku2_codec.ts | 0 packages/enr/tsconfig.dev.json | 8 + packages/enr/tsconfig.json | 54 ++++++ 34 files changed, 652 insertions(+) create mode 100644 packages/dns-discovery/package.json create mode 100644 packages/dns-discovery/rollup.config.js rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/dns.spec.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/dns.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/dns_over_https.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/enrtree.spec.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/enrtree.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/fetch_nodes.spec.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/fetch_nodes.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/index.spec.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/index.ts (100%) rename packages/{core/src/lib/peer_discovery_dns => dns-discovery/src}/testdata.json (100%) create mode 100644 packages/dns-discovery/tsconfig.dev.json create mode 100644 packages/dns-discovery/tsconfig.json create mode 100644 packages/enr/package.json create mode 100644 packages/enr/rollup.config.js rename packages/{core/src/lib/enr => enr/src}/constants.ts (100%) rename packages/{core/src/lib/enr => enr/src}/enr.spec.ts (100%) rename packages/{core/src/lib/enr => enr/src}/enr.ts (100%) rename packages/{core/src/lib/enr => enr/src}/index.ts (100%) rename packages/{core/src/lib/enr => enr/src}/keypair/index.ts (100%) rename packages/{core/src/lib/enr => enr/src}/keypair/secp256k1.ts (100%) rename packages/{core/src/lib/enr => enr/src}/keypair/types.ts (100%) rename packages/{core/src/lib/enr => enr/src}/multiaddr_from_fields.spec.ts (100%) rename packages/{core/src/lib/enr => enr/src}/multiaddr_from_fields.ts (100%) rename packages/{core/src/lib/enr => enr/src}/multiaddrs_codec.spec.ts (100%) rename packages/{core/src/lib/enr => enr/src}/multiaddrs_codec.ts (100%) rename packages/{core/src/lib/enr => enr/src}/types.ts (100%) rename packages/{core/src/lib/enr => enr/src}/v4.ts (100%) rename packages/{core/src/lib/enr => enr/src}/waku2_codec.spec.ts (100%) rename packages/{core/src/lib/enr => enr/src}/waku2_codec.ts (100%) create mode 100644 packages/enr/tsconfig.dev.json create mode 100644 packages/enr/tsconfig.json diff --git a/package-lock.json b/package-lock.json index d5b4b905c2..75ea293c1a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5280,6 +5280,14 @@ "resolved": "packages/create", "link": true }, + "node_modules/@waku/dns-discovery": { + "resolved": "packages/dns-discovery", + "link": true + }, + "node_modules/@waku/enr": { + "resolved": "packages/enr", + "link": true + }, "node_modules/@waku/interfaces": { "resolved": "packages/interfaces", "link": true @@ -22516,6 +22524,72 @@ "node": ">=16" } }, + "packages/dns-discovery": { + "version": "0.0.1", + "license": "MIT OR Apache-2.0", + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "engines": { + "node": ">=16" + } + }, + "packages/enr": { + "version": "0.0.1", + "license": "MIT OR Apache-2.0", + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "engines": { + "node": ">=16" + } + }, "packages/interfaces": { "name": "@waku/interfaces", "version": "0.0.1", @@ -26984,6 +27058,64 @@ "typescript": "^4.6.3" } }, + "@waku/dns-discovery": { + "version": "file:packages/dns-discovery", + "requires": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + } + }, + "@waku/enr": { + "version": "file:packages/enr", + "requires": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + } + }, "@waku/interfaces": { "version": "file:packages/interfaces", "requires": { diff --git a/packages/dns-discovery/package.json b/packages/dns-discovery/package.json new file mode 100644 index 0000000000..27edee5abd --- /dev/null +++ b/packages/dns-discovery/package.json @@ -0,0 +1,177 @@ +{ + "name": "@waku/dns-discovery", + "version": "0.0.1", + "description": "DNS Peer Discovery (EIP-1459)", + "types": "./dist/index.d.ts", + "module": "./dist/index.js", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js" + } + }, + "type": "module", + "author": "Waku Team", + "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/dns-discovery#readme", + "repository": { + "type": "git", + "url": "https://github.com/waku-org/js-waku.git" + }, + "bugs": { + "url": "https://github.com/waku-org/js-waku/issues" + }, + "license": "MIT OR Apache-2.0", + "keywords": [ + "waku", + "decentralized", + "secure", + "communication", + "web3", + "ethereum", + "dapps", + "privacy" + ], + "scripts": { + "build": "run-s build:**", + "build:esm": "tsc", + "build:bundle": "rollup --config rollup.config.js", + "fix": "run-s fix:*", + "fix:prettier": "prettier . --write", + "fix:lint": "eslint src --ext .ts --ext .cjs --fix", + "check": "run-s check:*", + "check:lint": "eslint src --ext .ts", + "check:prettier": "prettier . --list-different", + "check:spelling": "cspell \"{README.md,src/**/*.ts}\"", + "check:tsc": "tsc -p tsconfig.dev.json", + "prepublish": "npm run build", + "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build", + "release": "semantic-release" + }, + "engines": { + "node": ">=16" + }, + "dependencies": {}, + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "release": { + "branches": [ + "master" + ], + "extends": "semantic-release-monorepo", + "plugins": [ + [ + "@semantic-release/commit-analyzer", + { + "preset": "conventionalcommits", + "releaseRules": [ + { + "breaking": true, + "release": "patch" + }, + { + "revert": true, + "release": "patch" + }, + { + "type": "feat", + "release": "patch" + }, + { + "type": "fix", + "release": "patch" + }, + { + "type": "doc", + "release": "patch" + }, + { + "type": "test", + "release": "patch" + }, + { + "scope": "deps", + "release": "patch" + }, + { + "scope": "no-release", + "release": false + } + ] + } + ], + [ + "@semantic-release/release-notes-generator", + { + "preset": "conventionalcommits", + "presetConfig": { + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "chore", + "section": "Trivial Changes" + }, + { + "type": "doc", + "section": "Documentation" + }, + { + "type": "test", + "section": "Tests" + } + ] + } + } + ], + "@semantic-release/changelog", + "@semantic-release/npm", + "@semantic-release/github", + "@semantic-release/git" + ] + }, + "typedoc": { + "entryPoint": "./src/index.ts" + }, + "files": [ + "dist", + "bundle", + "src/*.ts", + "src/lib/**/*.ts", + "src/proto/**/*.ts", + "!**/*.spec.*", + "!**/*.json", + "CHANGELOG.md", + "LICENSE", + "README.md" + ] +} diff --git a/packages/dns-discovery/rollup.config.js b/packages/dns-discovery/rollup.config.js new file mode 100644 index 0000000000..d22d3d231e --- /dev/null +++ b/packages/dns-discovery/rollup.config.js @@ -0,0 +1,21 @@ +import commonjs from "@rollup/plugin-commonjs"; +import json from "@rollup/plugin-json"; +import { nodeResolve } from "@rollup/plugin-node-resolve"; + +export default { + input: { + index: "dist/index.js", + }, + output: { + dir: "bundle", + format: "esm", + }, + plugins: [ + commonjs(), + json(), + nodeResolve({ + browser: true, + preferBuiltins: false, + }), + ], +}; diff --git a/packages/core/src/lib/peer_discovery_dns/dns.spec.ts b/packages/dns-discovery/src/dns.spec.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/dns.spec.ts rename to packages/dns-discovery/src/dns.spec.ts diff --git a/packages/core/src/lib/peer_discovery_dns/dns.ts b/packages/dns-discovery/src/dns.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/dns.ts rename to packages/dns-discovery/src/dns.ts diff --git a/packages/core/src/lib/peer_discovery_dns/dns_over_https.ts b/packages/dns-discovery/src/dns_over_https.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/dns_over_https.ts rename to packages/dns-discovery/src/dns_over_https.ts diff --git a/packages/core/src/lib/peer_discovery_dns/enrtree.spec.ts b/packages/dns-discovery/src/enrtree.spec.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/enrtree.spec.ts rename to packages/dns-discovery/src/enrtree.spec.ts diff --git a/packages/core/src/lib/peer_discovery_dns/enrtree.ts b/packages/dns-discovery/src/enrtree.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/enrtree.ts rename to packages/dns-discovery/src/enrtree.ts diff --git a/packages/core/src/lib/peer_discovery_dns/fetch_nodes.spec.ts b/packages/dns-discovery/src/fetch_nodes.spec.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/fetch_nodes.spec.ts rename to packages/dns-discovery/src/fetch_nodes.spec.ts diff --git a/packages/core/src/lib/peer_discovery_dns/fetch_nodes.ts b/packages/dns-discovery/src/fetch_nodes.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/fetch_nodes.ts rename to packages/dns-discovery/src/fetch_nodes.ts diff --git a/packages/core/src/lib/peer_discovery_dns/index.spec.ts b/packages/dns-discovery/src/index.spec.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/index.spec.ts rename to packages/dns-discovery/src/index.spec.ts diff --git a/packages/core/src/lib/peer_discovery_dns/index.ts b/packages/dns-discovery/src/index.ts similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/index.ts rename to packages/dns-discovery/src/index.ts diff --git a/packages/core/src/lib/peer_discovery_dns/testdata.json b/packages/dns-discovery/src/testdata.json similarity index 100% rename from packages/core/src/lib/peer_discovery_dns/testdata.json rename to packages/dns-discovery/src/testdata.json diff --git a/packages/dns-discovery/tsconfig.dev.json b/packages/dns-discovery/tsconfig.dev.json new file mode 100644 index 0000000000..ffc27ef6ba --- /dev/null +++ b/packages/dns-discovery/tsconfig.dev.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig", + "compilerOptions": { + "module": "esnext", + "noEmit": true + }, + "exclude": [] +} diff --git a/packages/dns-discovery/tsconfig.json b/packages/dns-discovery/tsconfig.json new file mode 100644 index 0000000000..7b01b30897 --- /dev/null +++ b/packages/dns-discovery/tsconfig.json @@ -0,0 +1,54 @@ +{ + "compilerOptions": { + "incremental": true, + "target": "es2020", + "outDir": "dist/", + "rootDir": "src", + "moduleResolution": "node", + "module": "es2020", + "declaration": true, + "sourceMap": true, + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, + "resolveJsonModule": true /* Include modules imported with .json extension. */, + "tsBuildInfoFile": "dist/.tsbuildinfo", + "strict": true /* Enable all strict type-checking options. */, + + /* Strict Type-Checking Options */ + "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */, + "strictNullChecks": true /* Enable strict null checks. */, + "strictFunctionTypes": true /* Enable strict checking of function types. */, + "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */, + "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */, + "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */, + + /* Additional Checks */ + "noUnusedLocals": true /* Report errors on unused locals. */, + "noUnusedParameters": true /* Report errors on unused parameters. */, + "noImplicitReturns": true /* Report error when not all code paths in function return a value. */, + "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */, + "forceConsistentCasingInFileNames": true, + + /* Debugging Options */ + "traceResolution": false /* Report module resolution log messages. */, + "listEmittedFiles": false /* Print names of generated files part of the compilation. */, + "listFiles": false /* Print names of files part of the compilation. */, + "pretty": true /* Stylize errors and messages using color and context. */, + + // Due to broken types in indirect dependencies + "skipLibCheck": true, + + /* Experimental Options */ + // "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */, + // "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */, + + "lib": ["es2020", "dom"], + "types": ["node", "mocha"], + "typeRoots": ["node_modules/@types", "src/types"] + }, + "include": ["src"], + "exclude": ["src/**/*.spec.ts", "src/test_utils"], + "compileOnSave": false, + "ts-node": { + "files": true + } +} diff --git a/packages/enr/package.json b/packages/enr/package.json new file mode 100644 index 0000000000..a6c37c6731 --- /dev/null +++ b/packages/enr/package.json @@ -0,0 +1,177 @@ +{ + "name": "@waku/enr", + "version": "0.0.1", + "description": "ENR (EIP-778) for Waku", + "types": "./dist/index.d.ts", + "module": "./dist/index.js", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js" + } + }, + "type": "module", + "author": "Waku Team", + "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/enr#readme", + "repository": { + "type": "git", + "url": "https://github.com/waku-org/js-waku.git" + }, + "bugs": { + "url": "https://github.com/waku-org/js-waku/issues" + }, + "license": "MIT OR Apache-2.0", + "keywords": [ + "waku", + "decentralized", + "secure", + "communication", + "web3", + "ethereum", + "dapps", + "privacy" + ], + "scripts": { + "build": "run-s build:**", + "build:esm": "tsc", + "build:bundle": "rollup --config rollup.config.js", + "fix": "run-s fix:*", + "fix:prettier": "prettier . --write", + "fix:lint": "eslint src --ext .ts --ext .cjs --fix", + "check": "run-s check:*", + "check:lint": "eslint src --ext .ts", + "check:prettier": "prettier . --list-different", + "check:spelling": "cspell \"{README.md,src/**/*.ts}\"", + "check:tsc": "tsc -p tsconfig.dev.json", + "prepublish": "npm run build", + "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build", + "release": "semantic-release" + }, + "engines": { + "node": ">=16" + }, + "dependencies": {}, + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "release": { + "branches": [ + "master" + ], + "extends": "semantic-release-monorepo", + "plugins": [ + [ + "@semantic-release/commit-analyzer", + { + "preset": "conventionalcommits", + "releaseRules": [ + { + "breaking": true, + "release": "patch" + }, + { + "revert": true, + "release": "patch" + }, + { + "type": "feat", + "release": "patch" + }, + { + "type": "fix", + "release": "patch" + }, + { + "type": "doc", + "release": "patch" + }, + { + "type": "test", + "release": "patch" + }, + { + "scope": "deps", + "release": "patch" + }, + { + "scope": "no-release", + "release": false + } + ] + } + ], + [ + "@semantic-release/release-notes-generator", + { + "preset": "conventionalcommits", + "presetConfig": { + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "chore", + "section": "Trivial Changes" + }, + { + "type": "doc", + "section": "Documentation" + }, + { + "type": "test", + "section": "Tests" + } + ] + } + } + ], + "@semantic-release/changelog", + "@semantic-release/npm", + "@semantic-release/github", + "@semantic-release/git" + ] + }, + "typedoc": { + "entryPoint": "./src/index.ts" + }, + "files": [ + "dist", + "bundle", + "src/*.ts", + "src/lib/**/*.ts", + "src/proto/**/*.ts", + "!**/*.spec.*", + "!**/*.json", + "CHANGELOG.md", + "LICENSE", + "README.md" + ] +} diff --git a/packages/enr/rollup.config.js b/packages/enr/rollup.config.js new file mode 100644 index 0000000000..d22d3d231e --- /dev/null +++ b/packages/enr/rollup.config.js @@ -0,0 +1,21 @@ +import commonjs from "@rollup/plugin-commonjs"; +import json from "@rollup/plugin-json"; +import { nodeResolve } from "@rollup/plugin-node-resolve"; + +export default { + input: { + index: "dist/index.js", + }, + output: { + dir: "bundle", + format: "esm", + }, + plugins: [ + commonjs(), + json(), + nodeResolve({ + browser: true, + preferBuiltins: false, + }), + ], +}; diff --git a/packages/core/src/lib/enr/constants.ts b/packages/enr/src/constants.ts similarity index 100% rename from packages/core/src/lib/enr/constants.ts rename to packages/enr/src/constants.ts diff --git a/packages/core/src/lib/enr/enr.spec.ts b/packages/enr/src/enr.spec.ts similarity index 100% rename from packages/core/src/lib/enr/enr.spec.ts rename to packages/enr/src/enr.spec.ts diff --git a/packages/core/src/lib/enr/enr.ts b/packages/enr/src/enr.ts similarity index 100% rename from packages/core/src/lib/enr/enr.ts rename to packages/enr/src/enr.ts diff --git a/packages/core/src/lib/enr/index.ts b/packages/enr/src/index.ts similarity index 100% rename from packages/core/src/lib/enr/index.ts rename to packages/enr/src/index.ts diff --git a/packages/core/src/lib/enr/keypair/index.ts b/packages/enr/src/keypair/index.ts similarity index 100% rename from packages/core/src/lib/enr/keypair/index.ts rename to packages/enr/src/keypair/index.ts diff --git a/packages/core/src/lib/enr/keypair/secp256k1.ts b/packages/enr/src/keypair/secp256k1.ts similarity index 100% rename from packages/core/src/lib/enr/keypair/secp256k1.ts rename to packages/enr/src/keypair/secp256k1.ts diff --git a/packages/core/src/lib/enr/keypair/types.ts b/packages/enr/src/keypair/types.ts similarity index 100% rename from packages/core/src/lib/enr/keypair/types.ts rename to packages/enr/src/keypair/types.ts diff --git a/packages/core/src/lib/enr/multiaddr_from_fields.spec.ts b/packages/enr/src/multiaddr_from_fields.spec.ts similarity index 100% rename from packages/core/src/lib/enr/multiaddr_from_fields.spec.ts rename to packages/enr/src/multiaddr_from_fields.spec.ts diff --git a/packages/core/src/lib/enr/multiaddr_from_fields.ts b/packages/enr/src/multiaddr_from_fields.ts similarity index 100% rename from packages/core/src/lib/enr/multiaddr_from_fields.ts rename to packages/enr/src/multiaddr_from_fields.ts diff --git a/packages/core/src/lib/enr/multiaddrs_codec.spec.ts b/packages/enr/src/multiaddrs_codec.spec.ts similarity index 100% rename from packages/core/src/lib/enr/multiaddrs_codec.spec.ts rename to packages/enr/src/multiaddrs_codec.spec.ts diff --git a/packages/core/src/lib/enr/multiaddrs_codec.ts b/packages/enr/src/multiaddrs_codec.ts similarity index 100% rename from packages/core/src/lib/enr/multiaddrs_codec.ts rename to packages/enr/src/multiaddrs_codec.ts diff --git a/packages/core/src/lib/enr/types.ts b/packages/enr/src/types.ts similarity index 100% rename from packages/core/src/lib/enr/types.ts rename to packages/enr/src/types.ts diff --git a/packages/core/src/lib/enr/v4.ts b/packages/enr/src/v4.ts similarity index 100% rename from packages/core/src/lib/enr/v4.ts rename to packages/enr/src/v4.ts diff --git a/packages/core/src/lib/enr/waku2_codec.spec.ts b/packages/enr/src/waku2_codec.spec.ts similarity index 100% rename from packages/core/src/lib/enr/waku2_codec.spec.ts rename to packages/enr/src/waku2_codec.spec.ts diff --git a/packages/core/src/lib/enr/waku2_codec.ts b/packages/enr/src/waku2_codec.ts similarity index 100% rename from packages/core/src/lib/enr/waku2_codec.ts rename to packages/enr/src/waku2_codec.ts diff --git a/packages/enr/tsconfig.dev.json b/packages/enr/tsconfig.dev.json new file mode 100644 index 0000000000..ffc27ef6ba --- /dev/null +++ b/packages/enr/tsconfig.dev.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig", + "compilerOptions": { + "module": "esnext", + "noEmit": true + }, + "exclude": [] +} diff --git a/packages/enr/tsconfig.json b/packages/enr/tsconfig.json new file mode 100644 index 0000000000..7b01b30897 --- /dev/null +++ b/packages/enr/tsconfig.json @@ -0,0 +1,54 @@ +{ + "compilerOptions": { + "incremental": true, + "target": "es2020", + "outDir": "dist/", + "rootDir": "src", + "moduleResolution": "node", + "module": "es2020", + "declaration": true, + "sourceMap": true, + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, + "resolveJsonModule": true /* Include modules imported with .json extension. */, + "tsBuildInfoFile": "dist/.tsbuildinfo", + "strict": true /* Enable all strict type-checking options. */, + + /* Strict Type-Checking Options */ + "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */, + "strictNullChecks": true /* Enable strict null checks. */, + "strictFunctionTypes": true /* Enable strict checking of function types. */, + "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */, + "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */, + "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */, + + /* Additional Checks */ + "noUnusedLocals": true /* Report errors on unused locals. */, + "noUnusedParameters": true /* Report errors on unused parameters. */, + "noImplicitReturns": true /* Report error when not all code paths in function return a value. */, + "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */, + "forceConsistentCasingInFileNames": true, + + /* Debugging Options */ + "traceResolution": false /* Report module resolution log messages. */, + "listEmittedFiles": false /* Print names of generated files part of the compilation. */, + "listFiles": false /* Print names of files part of the compilation. */, + "pretty": true /* Stylize errors and messages using color and context. */, + + // Due to broken types in indirect dependencies + "skipLibCheck": true, + + /* Experimental Options */ + // "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */, + // "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */, + + "lib": ["es2020", "dom"], + "types": ["node", "mocha"], + "typeRoots": ["node_modules/@types", "src/types"] + }, + "include": ["src"], + "exclude": ["src/**/*.spec.ts", "src/test_utils"], + "compileOnSave": false, + "ts-node": { + "files": true + } +} From 8a00bc1b8535058b5533435c3ecc95a879306b68 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Wed, 2 Nov 2022 17:03:38 +1100 Subject: [PATCH 02/11] chore!: extract utils from core --- packages/byte-utils/.eslintrc.cjs | 6 + packages/byte-utils/.prettierignore | 4 + packages/byte-utils/package.json | 177 ++++++++++++++++++ packages/byte-utils/rollup.config.js | 21 +++ .../lib/utils.ts => byte-utils/src/index.ts} | 0 packages/byte-utils/tsconfig.dev.json | 8 + packages/byte-utils/tsconfig.json | 54 ++++++ 7 files changed, 270 insertions(+) create mode 100644 packages/byte-utils/.eslintrc.cjs create mode 100644 packages/byte-utils/.prettierignore create mode 100644 packages/byte-utils/package.json create mode 100644 packages/byte-utils/rollup.config.js rename packages/{core/src/lib/utils.ts => byte-utils/src/index.ts} (100%) create mode 100644 packages/byte-utils/tsconfig.dev.json create mode 100644 packages/byte-utils/tsconfig.json diff --git a/packages/byte-utils/.eslintrc.cjs b/packages/byte-utils/.eslintrc.cjs new file mode 100644 index 0000000000..324f1f526d --- /dev/null +++ b/packages/byte-utils/.eslintrc.cjs @@ -0,0 +1,6 @@ +module.exports = { + parserOptions: { + tsconfigRootDir: __dirname, + project: "./tsconfig.dev.json", + }, +}; diff --git a/packages/byte-utils/.prettierignore b/packages/byte-utils/.prettierignore new file mode 100644 index 0000000000..fecb37a393 --- /dev/null +++ b/packages/byte-utils/.prettierignore @@ -0,0 +1,4 @@ +build +bundle +dist +node_modules diff --git a/packages/byte-utils/package.json b/packages/byte-utils/package.json new file mode 100644 index 0000000000..a832ebe6d0 --- /dev/null +++ b/packages/byte-utils/package.json @@ -0,0 +1,177 @@ +{ + "name": "@waku/byte-utils", + "version": "0.0.1", + "description": "Utilities to manipulate and convert byte arrays", + "types": "./dist/index.d.ts", + "module": "./dist/index.js", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js" + } + }, + "type": "module", + "author": "Waku Team", + "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/byte-utils#readme", + "repository": { + "type": "git", + "url": "https://github.com/waku-org/js-waku.git" + }, + "bugs": { + "url": "https://github.com/waku-org/js-waku/issues" + }, + "license": "MIT OR Apache-2.0", + "keywords": [ + "waku", + "decentralized", + "secure", + "communication", + "web3", + "ethereum", + "dapps", + "privacy" + ], + "scripts": { + "build": "run-s build:**", + "build:esm": "tsc", + "build:bundle": "rollup --config rollup.config.js", + "fix": "run-s fix:*", + "fix:prettier": "prettier . --write", + "fix:lint": "eslint src --ext .ts --ext .cjs --fix", + "check": "run-s check:*", + "check:lint": "eslint src --ext .ts", + "check:prettier": "prettier . --list-different", + "check:spelling": "cspell \"{README.md,src/**/*.ts}\"", + "check:tsc": "tsc -p tsconfig.dev.json", + "prepublish": "npm run build", + "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build", + "release": "semantic-release" + }, + "engines": { + "node": ">=16" + }, + "dependencies": {}, + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "release": { + "branches": [ + "master" + ], + "extends": "semantic-release-monorepo", + "plugins": [ + [ + "@semantic-release/commit-analyzer", + { + "preset": "conventionalcommits", + "releaseRules": [ + { + "breaking": true, + "release": "patch" + }, + { + "revert": true, + "release": "patch" + }, + { + "type": "feat", + "release": "patch" + }, + { + "type": "fix", + "release": "patch" + }, + { + "type": "doc", + "release": "patch" + }, + { + "type": "test", + "release": "patch" + }, + { + "scope": "deps", + "release": "patch" + }, + { + "scope": "no-release", + "release": false + } + ] + } + ], + [ + "@semantic-release/release-notes-generator", + { + "preset": "conventionalcommits", + "presetConfig": { + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "chore", + "section": "Trivial Changes" + }, + { + "type": "doc", + "section": "Documentation" + }, + { + "type": "test", + "section": "Tests" + } + ] + } + } + ], + "@semantic-release/changelog", + "@semantic-release/npm", + "@semantic-release/github", + "@semantic-release/git" + ] + }, + "typedoc": { + "entryPoint": "./src/index.ts" + }, + "files": [ + "dist", + "bundle", + "src/*.ts", + "src/lib/**/*.ts", + "src/proto/**/*.ts", + "!**/*.spec.*", + "!**/*.json", + "CHANGELOG.md", + "LICENSE", + "README.md" + ] +} diff --git a/packages/byte-utils/rollup.config.js b/packages/byte-utils/rollup.config.js new file mode 100644 index 0000000000..d22d3d231e --- /dev/null +++ b/packages/byte-utils/rollup.config.js @@ -0,0 +1,21 @@ +import commonjs from "@rollup/plugin-commonjs"; +import json from "@rollup/plugin-json"; +import { nodeResolve } from "@rollup/plugin-node-resolve"; + +export default { + input: { + index: "dist/index.js", + }, + output: { + dir: "bundle", + format: "esm", + }, + plugins: [ + commonjs(), + json(), + nodeResolve({ + browser: true, + preferBuiltins: false, + }), + ], +}; diff --git a/packages/core/src/lib/utils.ts b/packages/byte-utils/src/index.ts similarity index 100% rename from packages/core/src/lib/utils.ts rename to packages/byte-utils/src/index.ts diff --git a/packages/byte-utils/tsconfig.dev.json b/packages/byte-utils/tsconfig.dev.json new file mode 100644 index 0000000000..ffc27ef6ba --- /dev/null +++ b/packages/byte-utils/tsconfig.dev.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig", + "compilerOptions": { + "module": "esnext", + "noEmit": true + }, + "exclude": [] +} diff --git a/packages/byte-utils/tsconfig.json b/packages/byte-utils/tsconfig.json new file mode 100644 index 0000000000..7b01b30897 --- /dev/null +++ b/packages/byte-utils/tsconfig.json @@ -0,0 +1,54 @@ +{ + "compilerOptions": { + "incremental": true, + "target": "es2020", + "outDir": "dist/", + "rootDir": "src", + "moduleResolution": "node", + "module": "es2020", + "declaration": true, + "sourceMap": true, + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, + "resolveJsonModule": true /* Include modules imported with .json extension. */, + "tsBuildInfoFile": "dist/.tsbuildinfo", + "strict": true /* Enable all strict type-checking options. */, + + /* Strict Type-Checking Options */ + "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */, + "strictNullChecks": true /* Enable strict null checks. */, + "strictFunctionTypes": true /* Enable strict checking of function types. */, + "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */, + "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */, + "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */, + + /* Additional Checks */ + "noUnusedLocals": true /* Report errors on unused locals. */, + "noUnusedParameters": true /* Report errors on unused parameters. */, + "noImplicitReturns": true /* Report error when not all code paths in function return a value. */, + "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */, + "forceConsistentCasingInFileNames": true, + + /* Debugging Options */ + "traceResolution": false /* Report module resolution log messages. */, + "listEmittedFiles": false /* Print names of generated files part of the compilation. */, + "listFiles": false /* Print names of files part of the compilation. */, + "pretty": true /* Stylize errors and messages using color and context. */, + + // Due to broken types in indirect dependencies + "skipLibCheck": true, + + /* Experimental Options */ + // "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */, + // "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */, + + "lib": ["es2020", "dom"], + "types": ["node", "mocha"], + "typeRoots": ["node_modules/@types", "src/types"] + }, + "include": ["src"], + "exclude": ["src/**/*.spec.ts", "src/test_utils"], + "compileOnSave": false, + "ts-node": { + "files": true + } +} From 9cc32c1032cfa4a9d75e461884bd3d45d28548a4 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Wed, 2 Nov 2022 22:25:47 +1100 Subject: [PATCH 03/11] tests: fix karma --- package-lock.json | 201 +++++++++++++++++- packages/byte-utils/package.json | 4 +- packages/core/src/lib/crypto.ts | 24 --- packages/dns-discovery/.eslintrc.cjs | 6 + packages/dns-discovery/.prettierignore | 4 + packages/enr/.eslintrc.cjs | 6 + packages/enr/.mocharc.json | 11 + packages/enr/.prettierignore | 4 + packages/enr/karma.conf.cjs | 45 ++++ packages/enr/package.json | 12 +- packages/enr/src/crypto.ts | 61 ++++++ packages/enr/src/enr.spec.ts | 13 +- packages/enr/src/enr.ts | 16 +- packages/enr/src/index.ts | 10 +- packages/enr/src/keypair/index.ts | 8 +- packages/enr/src/keypair/secp256k1.ts | 4 +- .../enr/src/multiaddr_from_fields.spec.ts | 2 +- packages/enr/src/multiaddrs_codec.spec.ts | 2 +- packages/enr/src/multiaddrs_codec.ts | 2 +- packages/enr/src/v4.ts | 7 +- packages/enr/src/waku2_codec.spec.ts | 2 +- packages/enr/tsconfig.karma.json | 6 + 22 files changed, 388 insertions(+), 62 deletions(-) create mode 100644 packages/dns-discovery/.eslintrc.cjs create mode 100644 packages/dns-discovery/.prettierignore create mode 100644 packages/enr/.eslintrc.cjs create mode 100644 packages/enr/.mocharc.json create mode 100644 packages/enr/.prettierignore create mode 100644 packages/enr/karma.conf.cjs create mode 100644 packages/enr/src/crypto.ts create mode 100644 packages/enr/tsconfig.karma.json diff --git a/package-lock.json b/package-lock.json index 75ea293c1a..77cd735401 100644 --- a/package-lock.json +++ b/package-lock.json @@ -182,9 +182,9 @@ } }, "node_modules/@babel/parser": { - "version": "7.20.0", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.20.0.tgz", - "integrity": "sha512-G9VgAhEaICnz8iiJeGJQyVl6J2nTjbW0xeisva0PK6XcKsga7BIaqm4ZF8Rg1Wbaqmy6znspNqhPaPkyukujzg==", + "version": "7.20.1", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.20.1.tgz", + "integrity": "sha512-hp0AYxaZJhxULfM1zyp7Wgr+pSUKBcP3M+PHnSzWGdXOzg/kHWIgiUWARvubhUKGOEw3xqY4x+lyZ9ytBVcELw==", "dev": true, "bin": { "parser": "bin/babel-parser.js" @@ -5272,6 +5272,10 @@ "integrity": "sha512-sL/cEvJWAnClXw0wHk85/2L0G6Sj8UB0Ctc1TEMbKSsmpRosqhwj9gWgFRZSrBr2f9tiXISwNhCPmlfqUqyb9Q==", "dev": true }, + "node_modules/@waku/byte-utils": { + "resolved": "packages/byte-utils", + "link": true + }, "node_modules/@waku/core": { "resolved": "packages/core", "link": true @@ -22353,6 +22357,64 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "packages/byte-utils": { + "name": "@waku/byte-utils", + "version": "0.0.1", + "license": "MIT OR Apache-2.0", + "dependencies": { + "uint8arrays": "^4.0.2" + }, + "devDependencies": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3" + }, + "engines": { + "node": ">=16" + } + }, + "packages/byte-utils/node_modules/multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/byte-utils/node_modules/uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "dependencies": { + "multiformats": "^10.0.0" + }, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, "packages/core": { "name": "@waku/core", "version": "0.0.1", @@ -22525,6 +22587,7 @@ } }, "packages/dns-discovery": { + "name": "@waku/dns-discovery", "version": "0.0.1", "license": "MIT OR Apache-2.0", "devDependencies": { @@ -22558,8 +22621,15 @@ } }, "packages/enr": { + "name": "@waku/enr", "version": "0.0.1", "license": "MIT OR Apache-2.0", + "dependencies": { + "@libp2p/crypto": "^1.0.4", + "@multiformats/multiaddr": "^11.0.6", + "@noble/secp256k1": "^1.7.0", + "@waku/byte-utils": "*" + }, "devDependencies": { "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", @@ -22572,6 +22642,7 @@ "@semantic-release/release-notes-generator": "^10.0.3", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "chai": "^4.3.6", "cspell": "^5.14.0", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", @@ -22584,12 +22655,51 @@ "rollup": "^2.75.0", "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", + "ts-loader": "^9.4.1", "typescript": "^4.6.3" }, "engines": { "node": ">=16" } }, + "packages/enr/node_modules/@multiformats/multiaddr": { + "version": "11.0.6", + "resolved": "https://registry.npmjs.org/@multiformats/multiaddr/-/multiaddr-11.0.6.tgz", + "integrity": "sha512-5TvEdCc5uFqcwGA+IwSw49swyHtUbwjhjwF3WQcV9vkzTv1C8oEWhoD2QcsiomDRk8rdqqRyDH6wlZExvLnxjw==", + "dependencies": { + "@chainsafe/is-ip": "^1.0.0", + "dns-over-http-resolver": "^2.1.0", + "err-code": "^3.0.1", + "multiformats": "^10.0.0", + "uint8arrays": "^4.0.2", + "varint": "^6.0.0" + }, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/enr/node_modules/multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/enr/node_modules/uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "dependencies": { + "multiformats": "^10.0.0" + }, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, "packages/interfaces": { "name": "@waku/interfaces", "version": "0.0.1", @@ -22839,9 +22949,9 @@ } }, "@babel/parser": { - "version": "7.20.0", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.20.0.tgz", - "integrity": "sha512-G9VgAhEaICnz8iiJeGJQyVl6J2nTjbW0xeisva0PK6XcKsga7BIaqm4ZF8Rg1Wbaqmy6znspNqhPaPkyukujzg==", + "version": "7.20.1", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.20.1.tgz", + "integrity": "sha512-hp0AYxaZJhxULfM1zyp7Wgr+pSUKBcP3M+PHnSzWGdXOzg/kHWIgiUWARvubhUKGOEw3xqY4x+lyZ9ytBVcELw==", "dev": true }, "@chainsafe/is-ip": { @@ -26909,6 +27019,51 @@ "integrity": "sha512-sL/cEvJWAnClXw0wHk85/2L0G6Sj8UB0Ctc1TEMbKSsmpRosqhwj9gWgFRZSrBr2f9tiXISwNhCPmlfqUqyb9Q==", "dev": true }, + "@waku/byte-utils": { + "version": "file:packages/byte-utils", + "requires": { + "@rollup/plugin-commonjs": "^22.0.0", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-node-resolve": "^13.3.0", + "@semantic-release/changelog": "^6.0.1", + "@semantic-release/commit-analyzer": "^9.0.2", + "@semantic-release/git": "^10.0.1", + "@semantic-release/github": "^8.0.6", + "@semantic-release/npm": "^9.0.1", + "@semantic-release/release-notes-generator": "^10.0.3", + "@typescript-eslint/eslint-plugin": "^5.8.1", + "@typescript-eslint/parser": "^5.8.1", + "cspell": "^5.14.0", + "eslint": "^8.6.0", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-functional": "^4.0.2", + "eslint-plugin-import": "^2.25.3", + "eslint-plugin-prettier": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.1.1", + "rollup": "^2.75.0", + "semantic-release": "^19.0.5", + "semantic-release-monorepo": "^7.0.5", + "typescript": "^4.6.3", + "uint8arrays": "^4.0.2" + }, + "dependencies": { + "multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==" + }, + "uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "requires": { + "multiformats": "^10.0.0" + } + } + } + }, "@waku/core": { "version": "file:packages/core", "requires": { @@ -27090,6 +27245,9 @@ "@waku/enr": { "version": "file:packages/enr", "requires": { + "@libp2p/crypto": "^1.0.4", + "@multiformats/multiaddr": "^11.0.6", + "@noble/secp256k1": "^1.7.0", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -27101,6 +27259,8 @@ "@semantic-release/release-notes-generator": "^10.0.3", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "@waku/byte-utils": "*", + "chai": "^4.3.6", "cspell": "^5.14.0", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", @@ -27113,7 +27273,36 @@ "rollup": "^2.75.0", "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", + "ts-loader": "^9.4.1", "typescript": "^4.6.3" + }, + "dependencies": { + "@multiformats/multiaddr": { + "version": "11.0.6", + "resolved": "https://registry.npmjs.org/@multiformats/multiaddr/-/multiaddr-11.0.6.tgz", + "integrity": "sha512-5TvEdCc5uFqcwGA+IwSw49swyHtUbwjhjwF3WQcV9vkzTv1C8oEWhoD2QcsiomDRk8rdqqRyDH6wlZExvLnxjw==", + "requires": { + "@chainsafe/is-ip": "^1.0.0", + "dns-over-http-resolver": "^2.1.0", + "err-code": "^3.0.1", + "multiformats": "^10.0.0", + "uint8arrays": "^4.0.2", + "varint": "^6.0.0" + } + }, + "multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==" + }, + "uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "requires": { + "multiformats": "^10.0.0" + } + } } }, "@waku/interfaces": { diff --git a/packages/byte-utils/package.json b/packages/byte-utils/package.json index a832ebe6d0..7b3acaec8b 100644 --- a/packages/byte-utils/package.json +++ b/packages/byte-utils/package.json @@ -50,7 +50,9 @@ "engines": { "node": ">=16" }, - "dependencies": {}, + "dependencies": { + "uint8arrays": "^4.0.2" + }, "devDependencies": { "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", diff --git a/packages/core/src/lib/crypto.ts b/packages/core/src/lib/crypto.ts index 321574606d..095b41e9a7 100644 --- a/packages/core/src/lib/crypto.ts +++ b/packages/core/src/lib/crypto.ts @@ -74,27 +74,3 @@ export async function sign( export function keccak256(input: Uint8Array): Uint8Array { return new Uint8Array(sha3.keccak256.arrayBuffer(input)); } - -export function compressPublicKey(publicKey: Uint8Array): Uint8Array { - if (publicKey.length === 64) { - publicKey = concat([new Uint8Array([4]), publicKey], 65); - } - const point = secp.Point.fromHex(publicKey); - return point.toRawBytes(true); -} - -/** - * Verify an ECDSA signature. - */ -export function verifySignature( - signature: Uint8Array, - message: Uint8Array | string, - publicKey: Uint8Array -): boolean { - try { - const _signature = secp.Signature.fromCompact(signature.slice(0, 64)); - return secp.verify(_signature, message, publicKey); - } catch { - return false; - } -} diff --git a/packages/dns-discovery/.eslintrc.cjs b/packages/dns-discovery/.eslintrc.cjs new file mode 100644 index 0000000000..324f1f526d --- /dev/null +++ b/packages/dns-discovery/.eslintrc.cjs @@ -0,0 +1,6 @@ +module.exports = { + parserOptions: { + tsconfigRootDir: __dirname, + project: "./tsconfig.dev.json", + }, +}; diff --git a/packages/dns-discovery/.prettierignore b/packages/dns-discovery/.prettierignore new file mode 100644 index 0000000000..fecb37a393 --- /dev/null +++ b/packages/dns-discovery/.prettierignore @@ -0,0 +1,4 @@ +build +bundle +dist +node_modules diff --git a/packages/enr/.eslintrc.cjs b/packages/enr/.eslintrc.cjs new file mode 100644 index 0000000000..324f1f526d --- /dev/null +++ b/packages/enr/.eslintrc.cjs @@ -0,0 +1,6 @@ +module.exports = { + parserOptions: { + tsconfigRootDir: __dirname, + project: "./tsconfig.dev.json", + }, +}; diff --git a/packages/enr/.mocharc.json b/packages/enr/.mocharc.json new file mode 100644 index 0000000000..db9dd73531 --- /dev/null +++ b/packages/enr/.mocharc.json @@ -0,0 +1,11 @@ +{ + "extension": ["ts"], + "spec": "src/**/*.spec.ts", + "require": ["ts-node/register", "isomorphic-fetch", "jsdom-global/register"], + "loader": "ts-node/esm", + "node-option": [ + "experimental-specifier-resolution=node", + "loader=ts-node/esm" + ], + "exit": true +} diff --git a/packages/enr/.prettierignore b/packages/enr/.prettierignore new file mode 100644 index 0000000000..fecb37a393 --- /dev/null +++ b/packages/enr/.prettierignore @@ -0,0 +1,4 @@ +build +bundle +dist +node_modules diff --git a/packages/enr/karma.conf.cjs b/packages/enr/karma.conf.cjs new file mode 100644 index 0000000000..8ee5033706 --- /dev/null +++ b/packages/enr/karma.conf.cjs @@ -0,0 +1,45 @@ +process.env.CHROME_BIN = require("puppeteer").executablePath(); +const webpack = require("webpack"); + +module.exports = function (config) { + config.set({ + frameworks: ["webpack", "mocha"], + files: ["src/**/*.ts"], + preprocessors: { + "src/**/*.ts": ["webpack"], + }, + envPreprocessor: ["CI"], + reporters: ["progress"], + browsers: ["ChromeHeadless"], + singleRun: true, + client: { + mocha: { + timeout: 6000, // Default is 2s + }, + }, + webpack: { + mode: "development", + module: { + rules: [{ test: /\.([cm]?ts|tsx)$/, loader: "ts-loader" }], + }, + plugins: [ + new webpack.DefinePlugin({ + "process.env.CI": process.env.CI || false, + }), + new webpack.ProvidePlugin({ + process: "process/browser.js", + }), + ], + resolve: { + extensions: [".ts", ".tsx", ".js"], + extensionAlias: { + ".js": [".js", ".ts"], + ".cjs": [".cjs", ".cts"], + ".mjs": [".mjs", ".mts"], + }, + }, + stats: { warnings: false }, + devtool: "inline-source-map", + }, + }); +}; diff --git a/packages/enr/package.json b/packages/enr/package.json index a6c37c6731..711cc52564 100644 --- a/packages/enr/package.json +++ b/packages/enr/package.json @@ -43,6 +43,9 @@ "check:prettier": "prettier . --list-different", "check:spelling": "cspell \"{README.md,src/**/*.ts}\"", "check:tsc": "tsc -p tsconfig.dev.json", + "test": "run-s test:*", + "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha", + "test:browser": "karma start karma.conf.cjs", "prepublish": "npm run build", "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build", "release": "semantic-release" @@ -50,7 +53,12 @@ "engines": { "node": ">=16" }, - "dependencies": {}, + "dependencies": { + "@libp2p/crypto": "^1.0.4", + "@multiformats/multiaddr": "^11.0.6", + "@noble/secp256k1": "^1.7.0", + "@waku/byte-utils": "*" + }, "devDependencies": { "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", @@ -63,6 +71,7 @@ "@semantic-release/release-notes-generator": "^10.0.3", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "chai": "^4.3.6", "cspell": "^5.14.0", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", @@ -75,6 +84,7 @@ "rollup": "^2.75.0", "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", + "ts-loader": "^9.4.1", "typescript": "^4.6.3" }, "release": { diff --git a/packages/enr/src/crypto.ts b/packages/enr/src/crypto.ts new file mode 100644 index 0000000000..39020a4c1a --- /dev/null +++ b/packages/enr/src/crypto.ts @@ -0,0 +1,61 @@ +import * as secp from "@noble/secp256k1"; +import { concat } from "@waku/byte-utils"; +import sha3 from "js-sha3"; + +export const randomBytes = secp.utils.randomBytes; + +/** + * Return the public key for the given private key, to be used for asymmetric + * encryption. + */ +export const getPublicKey = secp.getPublicKey; + +/** + * ECDSA Sign a message with the given private key. + * + * @param message The message to sign, usually a hash. + * @param privateKey The ECDSA private key to use to sign the message. + * + * @returns The signature and the recovery id concatenated. + */ +export async function sign( + message: Uint8Array, + privateKey: Uint8Array +): Promise { + const [signature, recoveryId] = await secp.sign(message, privateKey, { + recovered: true, + der: false, + }); + return concat( + [signature, new Uint8Array([recoveryId])], + signature.length + 1 + ); +} + +export function keccak256(input: Uint8Array): Uint8Array { + return new Uint8Array(sha3.keccak256.arrayBuffer(input)); +} + +export function compressPublicKey(publicKey: Uint8Array): Uint8Array { + if (publicKey.length === 64) { + publicKey = concat([new Uint8Array([4]), publicKey], 65); + } + const point = secp.Point.fromHex(publicKey); + return point.toRawBytes(true); +} + +/** + * Verify an ECDSA signature. + */ +export function verifySignature( + signature: Uint8Array, + message: Uint8Array | string, + publicKey: Uint8Array +): boolean { + try { + const _signature = secp.Signature.fromCompact(signature.slice(0, 64)); + return secp.verify(_signature, message, publicKey); + } catch { + return false; + } +} diff --git a/packages/enr/src/enr.spec.ts b/packages/enr/src/enr.spec.ts index 0db843eae0..df23ab397f 100644 --- a/packages/enr/src/enr.spec.ts +++ b/packages/enr/src/enr.spec.ts @@ -1,15 +1,14 @@ import { createSecp256k1PeerId } from "@libp2p/peer-id-factory"; import { multiaddr } from "@multiformats/multiaddr"; +import { bytesToHex, hexToBytes, utf8ToBytes } from "@waku/byte-utils"; import { assert, expect } from "chai"; import { equals } from "uint8arrays/equals"; -import { getPublicKey } from "../crypto"; -import { bytesToHex, hexToBytes, utf8ToBytes } from "../utils"; - -import { ERR_INVALID_ID } from "./constants"; -import { ENR } from "./enr"; -import { createKeypairFromPeerId, IKeypair } from "./keypair"; -import { Waku2 } from "./waku2_codec"; +import { ERR_INVALID_ID } from "./constants.js"; +import { getPublicKey } from "./crypto.js"; +import { ENR } from "./enr.js"; +import { createKeypairFromPeerId, IKeypair } from "./keypair/index.js"; +import { Waku2 } from "./waku2_codec.js"; describe("ENR", function () { describe("Txt codec", () => { diff --git a/packages/enr/src/enr.ts b/packages/enr/src/enr.ts index 7718a71b33..439d26e148 100644 --- a/packages/enr/src/enr.ts +++ b/packages/enr/src/enr.ts @@ -5,14 +5,22 @@ import { convertToBytes, convertToString, } from "@multiformats/multiaddr/convert"; +import { + bytesToHex, + bytesToUtf8, + hexToBytes, + utf8ToBytes, +} from "@waku/byte-utils"; import debug from "debug"; import { fromString } from "uint8arrays/from-string"; import { toString } from "uint8arrays/to-string"; -import { compressPublicKey, keccak256, verifySignature } from "../crypto"; -import { bytesToHex, bytesToUtf8, hexToBytes, utf8ToBytes } from "../utils"; - -import { ERR_INVALID_ID, ERR_NO_SIGNATURE, MAX_RECORD_SIZE } from "./constants"; +import { + ERR_INVALID_ID, + ERR_NO_SIGNATURE, + MAX_RECORD_SIZE, +} from "./constants.js"; +import { compressPublicKey, keccak256, verifySignature } from "./crypto.js"; import { createKeypair, createKeypairFromPeerId, diff --git a/packages/enr/src/index.ts b/packages/enr/src/index.ts index 32d56e1f6e..b1b0ba86e3 100644 --- a/packages/enr/src/index.ts +++ b/packages/enr/src/index.ts @@ -1,5 +1,5 @@ -export * from "./constants"; -export * from "./enr"; -export * from "./types"; -export * from "./keypair"; -export * from "./waku2_codec"; +export * from "./constants.js"; +export * from "./enr.js"; +export * from "./types.js"; +export * from "./keypair/index.js"; +export * from "./waku2_codec.js"; diff --git a/packages/enr/src/keypair/index.ts b/packages/enr/src/keypair/index.ts index cc1a0c6e2f..addd1dad34 100644 --- a/packages/enr/src/keypair/index.ts +++ b/packages/enr/src/keypair/index.ts @@ -3,12 +3,12 @@ import { supportedKeys } from "@libp2p/crypto/keys"; import type { PeerId } from "@libp2p/interface-peer-id"; import { peerIdFromKeys } from "@libp2p/peer-id"; -import { Secp256k1Keypair } from "./secp256k1"; -import { IKeypair, KeypairType } from "./types"; +import { Secp256k1Keypair } from "./secp256k1.js"; +import { IKeypair, KeypairType } from "./types.js"; export const ERR_TYPE_NOT_IMPLEMENTED = "Keypair type not implemented"; -export * from "./types"; -export * from "./secp256k1"; +export * from "./types.js"; +export * from "./secp256k1.js"; export function createKeypair( type: KeypairType, diff --git a/packages/enr/src/keypair/secp256k1.ts b/packages/enr/src/keypair/secp256k1.ts index bac7be7967..b658cb5421 100644 --- a/packages/enr/src/keypair/secp256k1.ts +++ b/packages/enr/src/keypair/secp256k1.ts @@ -1,8 +1,8 @@ import * as secp from "@noble/secp256k1"; -import { compressPublicKey, randomBytes } from "../../crypto"; +import { compressPublicKey, randomBytes } from "../crypto.js"; -import { IKeypair, KeypairType } from "./types"; +import { IKeypair, KeypairType } from "./types.js"; export class Secp256k1Keypair implements IKeypair { readonly type: KeypairType; diff --git a/packages/enr/src/multiaddr_from_fields.spec.ts b/packages/enr/src/multiaddr_from_fields.spec.ts index 51250e2d3c..6c08f6003c 100644 --- a/packages/enr/src/multiaddr_from_fields.spec.ts +++ b/packages/enr/src/multiaddr_from_fields.spec.ts @@ -1,7 +1,7 @@ import { convertToBytes } from "@multiformats/multiaddr/convert"; import { expect } from "chai"; -import { multiaddrFromFields } from "./multiaddr_from_fields"; +import { multiaddrFromFields } from "./multiaddr_from_fields.js"; describe("Multiaddr from fields", () => { it("tcp ip4 address", function () { diff --git a/packages/enr/src/multiaddrs_codec.spec.ts b/packages/enr/src/multiaddrs_codec.spec.ts index c430e8f9e7..ed92411a4d 100644 --- a/packages/enr/src/multiaddrs_codec.spec.ts +++ b/packages/enr/src/multiaddrs_codec.spec.ts @@ -1,7 +1,7 @@ import { multiaddr } from "@multiformats/multiaddr"; import { expect } from "chai"; -import { decodeMultiaddrs, encodeMultiaddrs } from "./multiaddrs_codec"; +import { decodeMultiaddrs, encodeMultiaddrs } from "./multiaddrs_codec.js"; describe("ENR multiaddrs codec", function () { it("Sample", async () => { diff --git a/packages/enr/src/multiaddrs_codec.ts b/packages/enr/src/multiaddrs_codec.ts index 3bd489b0da..76ed1d26a0 100644 --- a/packages/enr/src/multiaddrs_codec.ts +++ b/packages/enr/src/multiaddrs_codec.ts @@ -1,7 +1,7 @@ import { multiaddr } from "@multiformats/multiaddr"; import type { Multiaddr } from "@multiformats/multiaddr"; -import { MULTIADDR_LENGTH_SIZE } from "./constants"; +import { MULTIADDR_LENGTH_SIZE } from "./constants.js"; export function decodeMultiaddrs(bytes: Uint8Array): Multiaddr[] { const multiaddrs = []; diff --git a/packages/enr/src/v4.ts b/packages/enr/src/v4.ts index 296347a849..5a1a1fe0ec 100644 --- a/packages/enr/src/v4.ts +++ b/packages/enr/src/v4.ts @@ -1,9 +1,8 @@ import * as secp from "@noble/secp256k1"; +import { bytesToHex } from "@waku/byte-utils"; -import { keccak256 } from "../crypto"; -import { bytesToHex } from "../utils"; - -import { NodeId } from "./types"; +import { keccak256 } from "./crypto.js"; +import { NodeId } from "./types.js"; export async function sign( privKey: Uint8Array, diff --git a/packages/enr/src/waku2_codec.spec.ts b/packages/enr/src/waku2_codec.spec.ts index 7d65d10793..1dfc2b7cb2 100644 --- a/packages/enr/src/waku2_codec.spec.ts +++ b/packages/enr/src/waku2_codec.spec.ts @@ -1,6 +1,6 @@ import { expect } from "chai"; -import { decodeWaku2, encodeWaku2, Waku2 } from "./waku2_codec"; +import { decodeWaku2, encodeWaku2, Waku2 } from "./waku2_codec.js"; const waku2FieldEncodings = { relay: 1, diff --git a/packages/enr/tsconfig.karma.json b/packages/enr/tsconfig.karma.json new file mode 100644 index 0000000000..c540c783ff --- /dev/null +++ b/packages/enr/tsconfig.karma.json @@ -0,0 +1,6 @@ +{ + "extends": "./tsconfig.dev", + "compilerOptions": { + "noEmit": false + } +} From 25dfe9d96901dc0b39b264fdff9f54fb8ec4f8d0 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 14:11:42 +1100 Subject: [PATCH 04/11] chore: get dns-discovery to compile (almost) --- package-lock.json | 124 +++++++++++++++++- packages/core/package.json | 11 -- packages/core/rollup.config.js | 2 - packages/dns-discovery/karma.conf.cjs | 45 +++++++ packages/dns-discovery/package.json | 16 ++- packages/dns-discovery/src/dns.spec.ts | 2 +- packages/dns-discovery/src/dns.ts | 9 +- packages/dns-discovery/src/dns_over_https.ts | 5 +- packages/dns-discovery/src/enrtree.spec.ts | 2 +- packages/dns-discovery/src/enrtree.ts | 7 +- .../dns-discovery/src/fetch_nodes.spec.ts | 5 +- packages/dns-discovery/src/fetch_nodes.ts | 5 +- packages/dns-discovery/src/index.spec.ts | 2 +- packages/dns-discovery/src/index.ts | 7 +- .../src/multiaddr_to_peer_info.ts | 17 +++ packages/dns-discovery/src/random_subset.ts | 30 +++++ packages/dns-discovery/tsconfig.karma.json | 6 + packages/enr/package.json | 5 + packages/enr/rollup.config.js | 1 + 19 files changed, 255 insertions(+), 46 deletions(-) create mode 100644 packages/dns-discovery/karma.conf.cjs create mode 100644 packages/dns-discovery/src/multiaddr_to_peer_info.ts create mode 100644 packages/dns-discovery/src/random_subset.ts create mode 100644 packages/dns-discovery/tsconfig.karma.json diff --git a/package-lock.json b/package-lock.json index 77cd735401..1afd6fc1c0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22438,8 +22438,6 @@ "@noble/secp256k1": "^1.3.4", "@waku/interfaces": "*", "debug": "^4.3.4", - "dns-query": "^0.11.2", - "hi-base32": "^0.5.1", "it-all": "^1.0.6", "it-length-prefixed": "^8.0.2", "it-pipe": "^2.0.4", @@ -22452,7 +22450,6 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@libp2p/peer-id-factory": "^1.0.15", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -22590,7 +22587,21 @@ "name": "@waku/dns-discovery", "version": "0.0.1", "license": "MIT OR Apache-2.0", + "dependencies": { + "@libp2p/interface-peer-discovery": "^1.0.0", + "@libp2p/interface-peer-info": "^1.0.1", + "@libp2p/interfaces": "^3.0.2", + "@libp2p/peer-id": "^1.1.10", + "@waku/byte-utils": "*", + "@waku/enr": "*", + "debug": "^4.3.4", + "dns-query": "^0.11.2", + "hi-base32": "^0.5.1", + "uint8arrays": "^3.0.0" + }, "devDependencies": { + "@libp2p/peer-id-factory": "^1.0.15", + "@multiformats/multiaddr": "^11.0.6", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -22602,6 +22613,7 @@ "@semantic-release/release-notes-generator": "^10.0.3", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "chai": "^4.3.4", "cspell": "^5.14.0", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", @@ -22620,6 +22632,53 @@ "node": ">=16" } }, + "packages/dns-discovery/node_modules/@chainsafe/is-ip": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@chainsafe/is-ip/-/is-ip-2.0.1.tgz", + "integrity": "sha512-nqSJ8u2a1Rv9FYbyI8qpDhTYujaKEyLknNrTejLYoSWmdeg+2WB7R6BZqPZYfrJzDxVi3rl6ZQuoaEvpKRZWgQ==", + "dev": true + }, + "packages/dns-discovery/node_modules/@multiformats/multiaddr": { + "version": "11.0.7", + "resolved": "https://registry.npmjs.org/@multiformats/multiaddr/-/multiaddr-11.0.7.tgz", + "integrity": "sha512-rCqYS3Qz/dm4H/1Lvda11OBZf1tH8rst69GWK9jDy8AY+3n+NBBdErA/SRtdcRx6hPtQ8lAB5UhHlzIVbViv1Q==", + "dev": true, + "dependencies": { + "@chainsafe/is-ip": "^2.0.1", + "dns-over-http-resolver": "^2.1.0", + "err-code": "^3.0.1", + "multiformats": "^10.0.0", + "uint8arrays": "^4.0.2", + "varint": "^6.0.0" + }, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/dns-discovery/node_modules/@multiformats/multiaddr/node_modules/uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "dev": true, + "dependencies": { + "multiformats": "^10.0.0" + }, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/dns-discovery/node_modules/multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", + "dev": true, + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, "packages/enr": { "name": "@waku/enr", "version": "0.0.1", @@ -22631,6 +22690,7 @@ "@waku/byte-utils": "*" }, "devDependencies": { + "@libp2p/peer-id-factory": "^1.0.15", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -27080,7 +27140,6 @@ "@libp2p/interfaces": "^3.0.2", "@libp2p/mplex": "^5.1.1", "@libp2p/peer-id": "^1.1.10", - "@libp2p/peer-id-factory": "^1.0.15", "@libp2p/websockets": "^3.0.3", "@multiformats/multiaddr": "^11.0.6", "@noble/secp256k1": "^1.3.4", @@ -27107,7 +27166,6 @@ "chai": "^4.3.4", "cspell": "^5.14.0", "debug": "^4.3.4", - "dns-query": "^0.11.2", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-eslint-comments": "^3.2.0", @@ -27116,7 +27174,6 @@ "eslint-plugin-prettier": "^4.0.0", "fast-check": "^2.14.0", "gh-pages": "^3.2.3", - "hi-base32": "^0.5.1", "ignore-loader": "^0.1.2", "isomorphic-fetch": "^3.0.0", "it-all": "^1.0.6", @@ -27216,6 +27273,12 @@ "@waku/dns-discovery": { "version": "file:packages/dns-discovery", "requires": { + "@libp2p/interface-peer-discovery": "^1.0.0", + "@libp2p/interface-peer-info": "^1.0.1", + "@libp2p/interfaces": "^3.0.2", + "@libp2p/peer-id": "^1.1.10", + "@libp2p/peer-id-factory": "^1.0.15", + "@multiformats/multiaddr": "^11.0.6", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -27227,25 +27290,72 @@ "@semantic-release/release-notes-generator": "^10.0.3", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "@waku/byte-utils": "*", + "@waku/enr": "*", + "chai": "^4.3.4", "cspell": "^5.14.0", + "debug": "^4.3.4", + "dns-query": "^0.11.2", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-eslint-comments": "^3.2.0", "eslint-plugin-functional": "^4.0.2", "eslint-plugin-import": "^2.25.3", "eslint-plugin-prettier": "^4.0.0", + "hi-base32": "^0.5.1", "npm-run-all": "^4.1.5", "prettier": "^2.1.1", "rollup": "^2.75.0", "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", - "typescript": "^4.6.3" + "typescript": "^4.6.3", + "uint8arrays": "^3.0.0" + }, + "dependencies": { + "@chainsafe/is-ip": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@chainsafe/is-ip/-/is-ip-2.0.1.tgz", + "integrity": "sha512-nqSJ8u2a1Rv9FYbyI8qpDhTYujaKEyLknNrTejLYoSWmdeg+2WB7R6BZqPZYfrJzDxVi3rl6ZQuoaEvpKRZWgQ==", + "dev": true + }, + "@multiformats/multiaddr": { + "version": "11.0.7", + "resolved": "https://registry.npmjs.org/@multiformats/multiaddr/-/multiaddr-11.0.7.tgz", + "integrity": "sha512-rCqYS3Qz/dm4H/1Lvda11OBZf1tH8rst69GWK9jDy8AY+3n+NBBdErA/SRtdcRx6hPtQ8lAB5UhHlzIVbViv1Q==", + "dev": true, + "requires": { + "@chainsafe/is-ip": "^2.0.1", + "dns-over-http-resolver": "^2.1.0", + "err-code": "^3.0.1", + "multiformats": "^10.0.0", + "uint8arrays": "^4.0.2", + "varint": "^6.0.0" + }, + "dependencies": { + "uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "dev": true, + "requires": { + "multiformats": "^10.0.0" + } + } + } + }, + "multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", + "dev": true + } } }, "@waku/enr": { "version": "file:packages/enr", "requires": { "@libp2p/crypto": "^1.0.4", + "@libp2p/peer-id-factory": "^1.0.15", "@multiformats/multiaddr": "^11.0.6", "@noble/secp256k1": "^1.7.0", "@rollup/plugin-commonjs": "^22.0.0", diff --git a/packages/core/package.json b/packages/core/package.json index 9661e6b6f0..4031a118ef 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -9,14 +9,6 @@ "types": "./dist/index.d.ts", "import": "./dist/index.js" }, - "./lib/enr": { - "types": "./dist/lib/enr/index.d.ts", - "import": "./dist/lib/enr/index.js" - }, - "./lib/peer_discovery_dns": { - "types": "./dist/lib/peer_discovery_dns/index.d.ts", - "import": "./dist/lib/peer_discovery_dns/index.js" - }, "./lib/peer_discovery_static_list": { "types": "./dist/lib/peer_discovery_static_list.d.ts", "import": "./dist/lib/peer_discovery_static_list.js" @@ -124,8 +116,6 @@ "@noble/secp256k1": "^1.3.4", "@waku/interfaces": "*", "debug": "^4.3.4", - "dns-query": "^0.11.2", - "hi-base32": "^0.5.1", "it-all": "^1.0.6", "it-length-prefixed": "^8.0.2", "it-pipe": "^2.0.4", @@ -138,7 +128,6 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@libp2p/peer-id-factory": "^1.0.15", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", diff --git a/packages/core/rollup.config.js b/packages/core/rollup.config.js index 4b2cd71a2d..75fca0e86e 100644 --- a/packages/core/rollup.config.js +++ b/packages/core/rollup.config.js @@ -5,8 +5,6 @@ import json from "@rollup/plugin-json"; export default { input: { index: "dist/index.js", - "lib/enr": "dist/lib/enr/index.js", - "lib/peer_discovery_dns": "dist/lib/peer_discovery_dns/index.js", "lib/peer_discovery_static_list": "dist/lib/peer_discovery_static_list.js", "lib/predefined_bootstrap_nodes": "dist/lib/predefined_bootstrap_nodes.js", "lib/utils": "dist/lib/utils.js", diff --git a/packages/dns-discovery/karma.conf.cjs b/packages/dns-discovery/karma.conf.cjs new file mode 100644 index 0000000000..8ee5033706 --- /dev/null +++ b/packages/dns-discovery/karma.conf.cjs @@ -0,0 +1,45 @@ +process.env.CHROME_BIN = require("puppeteer").executablePath(); +const webpack = require("webpack"); + +module.exports = function (config) { + config.set({ + frameworks: ["webpack", "mocha"], + files: ["src/**/*.ts"], + preprocessors: { + "src/**/*.ts": ["webpack"], + }, + envPreprocessor: ["CI"], + reporters: ["progress"], + browsers: ["ChromeHeadless"], + singleRun: true, + client: { + mocha: { + timeout: 6000, // Default is 2s + }, + }, + webpack: { + mode: "development", + module: { + rules: [{ test: /\.([cm]?ts|tsx)$/, loader: "ts-loader" }], + }, + plugins: [ + new webpack.DefinePlugin({ + "process.env.CI": process.env.CI || false, + }), + new webpack.ProvidePlugin({ + process: "process/browser.js", + }), + ], + resolve: { + extensions: [".ts", ".tsx", ".js"], + extensionAlias: { + ".js": [".js", ".ts"], + ".cjs": [".cjs", ".cts"], + ".mjs": [".mjs", ".mts"], + }, + }, + stats: { warnings: false }, + devtool: "inline-source-map", + }, + }); +}; diff --git a/packages/dns-discovery/package.json b/packages/dns-discovery/package.json index 27edee5abd..41e6c74cda 100644 --- a/packages/dns-discovery/package.json +++ b/packages/dns-discovery/package.json @@ -50,8 +50,22 @@ "engines": { "node": ">=16" }, - "dependencies": {}, + "dependencies": { + "@waku/enr": "*", + "@waku/byte-utils": "*", + "hi-base32": "^0.5.1", + "debug": "^4.3.4", + "dns-query": "^0.11.2", + "uint8arrays": "^3.0.0", + "@libp2p/interface-peer-discovery": "^1.0.0", + "@libp2p/interface-peer-info": "^1.0.1", + "@libp2p/interfaces": "^3.0.2", + "@libp2p/peer-id": "^1.1.10" + }, "devDependencies": { + "@multiformats/multiaddr": "^11.0.6", + "@libp2p/peer-id-factory": "^1.0.15", + "chai": "^4.3.4", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", diff --git a/packages/dns-discovery/src/dns.spec.ts b/packages/dns-discovery/src/dns.spec.ts index 2c22b50194..7182e884f6 100644 --- a/packages/dns-discovery/src/dns.spec.ts +++ b/packages/dns-discovery/src/dns.spec.ts @@ -1,6 +1,6 @@ import { expect } from "chai"; -import { DnsClient, DnsNodeDiscovery } from "./dns"; +import { DnsClient, DnsNodeDiscovery } from "./dns.js"; import testData from "./testdata.json" assert { type: "json" }; const mockData = testData.dns; diff --git a/packages/dns-discovery/src/dns.ts b/packages/dns-discovery/src/dns.ts index 3354e77cc4..c6d3d039c9 100644 --- a/packages/dns-discovery/src/dns.ts +++ b/packages/dns-discovery/src/dns.ts @@ -1,13 +1,12 @@ +import { ENR } from "@waku/enr"; import debug from "debug"; -import { ENR } from "../enr"; - -import { DnsOverHttps } from "./dns_over_https"; -import { ENRTree } from "./enrtree"; +import { DnsOverHttps } from "./dns_over_https.js"; +import { ENRTree } from "./enrtree.js"; import { fetchNodesUntilCapabilitiesFulfilled, yieldNodesUntilCapabilitiesFulfilled, -} from "./fetch_nodes"; +} from "./fetch_nodes.js"; const log = debug("waku:discovery:dns"); diff --git a/packages/dns-discovery/src/dns_over_https.ts b/packages/dns-discovery/src/dns_over_https.ts index 8aae6781dd..642465aeee 100644 --- a/packages/dns-discovery/src/dns_over_https.ts +++ b/packages/dns-discovery/src/dns_over_https.ts @@ -1,9 +1,8 @@ +import { bytesToUtf8 } from "@waku/byte-utils"; import debug from "debug"; import { Endpoint, query, toEndpoint } from "dns-query"; -import { bytesToUtf8 } from "../utils"; - -import { DnsClient } from "./dns"; +import { DnsClient } from "./dns.js"; const log = debug("waku:dns-over-https"); diff --git a/packages/dns-discovery/src/enrtree.spec.ts b/packages/dns-discovery/src/enrtree.spec.ts index 55b8062d2d..df3f02ec0f 100644 --- a/packages/dns-discovery/src/enrtree.spec.ts +++ b/packages/dns-discovery/src/enrtree.spec.ts @@ -1,6 +1,6 @@ import { expect } from "chai"; -import { ENRTree } from "./enrtree"; +import { ENRTree } from "./enrtree.js"; import testData from "./testdata.json" assert { type: "json" }; const dns = testData.dns; diff --git a/packages/dns-discovery/src/enrtree.ts b/packages/dns-discovery/src/enrtree.ts index 670934e7fd..c13af9bfe6 100644 --- a/packages/dns-discovery/src/enrtree.ts +++ b/packages/dns-discovery/src/enrtree.ts @@ -1,10 +1,9 @@ +import { utf8ToBytes } from "@waku/byte-utils"; +import { ENR } from "@waku/enr"; +import { keccak256, verifySignature } from "@waku/enr/crypto"; import base32 from "hi-base32"; import { fromString } from "uint8arrays/from-string"; -import { keccak256, verifySignature } from "../crypto"; -import { ENR } from "../enr"; -import { utf8ToBytes } from "../utils"; - export type ENRRootValues = { eRoot: string; lRoot: string; diff --git a/packages/dns-discovery/src/fetch_nodes.spec.ts b/packages/dns-discovery/src/fetch_nodes.spec.ts index 01db0c1993..9c136d0d59 100644 --- a/packages/dns-discovery/src/fetch_nodes.spec.ts +++ b/packages/dns-discovery/src/fetch_nodes.spec.ts @@ -1,10 +1,9 @@ import { createSecp256k1PeerId } from "@libp2p/peer-id-factory"; import { multiaddr } from "@multiformats/multiaddr"; +import { ENR, Waku2 } from "@waku/enr"; import { expect } from "chai"; -import { ENR, Waku2 } from "../enr"; - -import { fetchNodesUntilCapabilitiesFulfilled } from "./fetch_nodes"; +import { fetchNodesUntilCapabilitiesFulfilled } from "./fetch_nodes.js"; async function createEnr(waku2: Waku2): Promise { const peerId = await createSecp256k1PeerId(); diff --git a/packages/dns-discovery/src/fetch_nodes.ts b/packages/dns-discovery/src/fetch_nodes.ts index 768eae325e..38fc41b78e 100644 --- a/packages/dns-discovery/src/fetch_nodes.ts +++ b/packages/dns-discovery/src/fetch_nodes.ts @@ -1,8 +1,7 @@ +import { ENR, Waku2 } from "@waku/enr"; import debug from "debug"; -import { ENR, Waku2 } from "../enr"; - -import { NodeCapabilityCount } from "./dns"; +import { NodeCapabilityCount } from "./dns.js"; const log = debug("waku:discovery:fetch_nodes"); diff --git a/packages/dns-discovery/src/index.spec.ts b/packages/dns-discovery/src/index.spec.ts index 175f529dd9..f237a3cbe8 100644 --- a/packages/dns-discovery/src/index.spec.ts +++ b/packages/dns-discovery/src/index.spec.ts @@ -1,6 +1,6 @@ import { expect } from "chai"; -import { getPseudoRandomSubset } from "../random_subset"; +import { getPseudoRandomSubset } from "./random_subset.js"; describe("Discovery", () => { it("returns all values when wanted number matches available values", function () { diff --git a/packages/dns-discovery/src/index.ts b/packages/dns-discovery/src/index.ts index 2df5e00662..243197b723 100644 --- a/packages/dns-discovery/src/index.ts +++ b/packages/dns-discovery/src/index.ts @@ -5,12 +5,11 @@ import type { import { symbol } from "@libp2p/interface-peer-discovery"; import type { PeerInfo } from "@libp2p/interface-peer-info"; import { CustomEvent, EventEmitter } from "@libp2p/interfaces/events"; +import { ENR } from "@waku/enr"; import debug from "debug"; -import { ENR } from "../enr"; -import { multiaddrsToPeerInfo } from "../multiaddr_to_peer_info"; - -import { DnsNodeDiscovery, NodeCapabilityCount } from "./dns"; +import { DnsNodeDiscovery, NodeCapabilityCount } from "./dns.js"; +import { multiaddrsToPeerInfo } from "./multiaddr_to_peer_info.js"; const log = debug("waku:peer-discovery-dns"); diff --git a/packages/dns-discovery/src/multiaddr_to_peer_info.ts b/packages/dns-discovery/src/multiaddr_to_peer_info.ts new file mode 100644 index 0000000000..65524c4439 --- /dev/null +++ b/packages/dns-discovery/src/multiaddr_to_peer_info.ts @@ -0,0 +1,17 @@ +import { PeerInfo } from "@libp2p/interface-peer-info"; +import { peerIdFromString } from "@libp2p/peer-id"; +import { Multiaddr } from "@multiformats/multiaddr"; + +export function multiaddrsToPeerInfo(mas: Multiaddr[]): PeerInfo[] { + return mas + .map((ma) => { + const peerIdStr = ma.getPeerId(); + const protocols: string[] = []; + return { + id: peerIdStr ? peerIdFromString(peerIdStr) : null, + multiaddrs: [ma.decapsulateCode(421)], + protocols, + }; + }) + .filter((peerInfo): peerInfo is PeerInfo => peerInfo.id !== null); +} diff --git a/packages/dns-discovery/src/random_subset.ts b/packages/dns-discovery/src/random_subset.ts new file mode 100644 index 0000000000..20d0ca83ce --- /dev/null +++ b/packages/dns-discovery/src/random_subset.ts @@ -0,0 +1,30 @@ +/** + * Return pseudo random subset of the input. + */ +export function getPseudoRandomSubset( + values: T[], + wantedNumber: number +): T[] { + if (values.length <= wantedNumber || values.length <= 1) { + return values; + } + + return shuffle(values).slice(0, wantedNumber); +} + +function shuffle(arr: T[]): T[] { + if (arr.length <= 1) { + return arr; + } + const randInt = (): number => { + return Math.floor(Math.random() * Math.floor(arr.length)); + }; + + for (let i = 0; i < arr.length; i++) { + const j = randInt(); + const tmp = arr[i]; + arr[i] = arr[j]; + arr[j] = tmp; + } + return arr; +} diff --git a/packages/dns-discovery/tsconfig.karma.json b/packages/dns-discovery/tsconfig.karma.json new file mode 100644 index 0000000000..c540c783ff --- /dev/null +++ b/packages/dns-discovery/tsconfig.karma.json @@ -0,0 +1,6 @@ +{ + "extends": "./tsconfig.dev", + "compilerOptions": { + "noEmit": false + } +} diff --git a/packages/enr/package.json b/packages/enr/package.json index 711cc52564..1c3e3fc2ad 100644 --- a/packages/enr/package.json +++ b/packages/enr/package.json @@ -8,6 +8,10 @@ ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" + }, + "./crypto": { + "types": "./dist/crypto.d.ts", + "import": "./dist/crypto.js" } }, "type": "module", @@ -60,6 +64,7 @@ "@waku/byte-utils": "*" }, "devDependencies": { + "@libp2p/peer-id-factory": "^1.0.15", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", diff --git a/packages/enr/rollup.config.js b/packages/enr/rollup.config.js index d22d3d231e..99f3643c0c 100644 --- a/packages/enr/rollup.config.js +++ b/packages/enr/rollup.config.js @@ -5,6 +5,7 @@ import { nodeResolve } from "@rollup/plugin-node-resolve"; export default { input: { index: "dist/index.js", + crypto: "dist/crypto.js", }, output: { dir: "bundle", From 21e5e41b0a9513711c612c0fd9297ec243c4f2e3 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 14:17:51 +1100 Subject: [PATCH 05/11] chore: build core package --- packages/core/package.json | 5 +---- packages/core/rollup.config.js | 1 - packages/core/src/index.ts | 4 ---- packages/core/src/lib/crypto.ts | 2 +- packages/core/src/lib/waku_message/ecies.ts | 2 +- packages/core/src/lib/waku_message/version_1.ts | 2 +- 6 files changed, 4 insertions(+), 12 deletions(-) diff --git a/packages/core/package.json b/packages/core/package.json index 4031a118ef..edac1035b0 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -17,10 +17,6 @@ "types": "./dist/lib/predefined_bootstrap_nodes.d.ts", "import": "./dist/lib/predefined_bootstrap_nodes.js" }, - "./lib/utils": { - "types": "./dist/lib/utils.d.ts", - "import": "./dist/lib/utils.js" - }, "./lib/wait_for_remote_peer": { "types": "./dist/lib/wait_for_remote_peer.d.ts", "import": "./dist/lib/wait_for_remote_peer.js" @@ -98,6 +94,7 @@ "node": ">=16" }, "dependencies": { + "@waku/byte-utils": "*", "@chainsafe/libp2p-gossipsub": "^4.1.1", "@chainsafe/libp2p-noise": "^8.0.1", "@ethersproject/rlp": "^5.5.0", diff --git a/packages/core/rollup.config.js b/packages/core/rollup.config.js index 75fca0e86e..ce780d1a01 100644 --- a/packages/core/rollup.config.js +++ b/packages/core/rollup.config.js @@ -7,7 +7,6 @@ export default { index: "dist/index.js", "lib/peer_discovery_static_list": "dist/lib/peer_discovery_static_list.js", "lib/predefined_bootstrap_nodes": "dist/lib/predefined_bootstrap_nodes.js", - "lib/utils": "dist/lib/utils.js", "lib/wait_for_remote_peer": "dist/lib/wait_for_remote_peer.js", "lib/waku_message/version_0": "dist/lib/waku_message/version_0.js", "lib/waku_message/version_1": "dist/lib/waku_message/version_1.js", diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index cef0c3a427..d115a25ce1 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -6,10 +6,6 @@ export { getPublicKey, } from "./lib/crypto"; -export * as enr from "./lib/enr"; - -export * as utils from "./lib/utils"; - export * as proto_message from "./proto/message"; export * as proto_topic_only_message from "./proto/topic_only_message"; diff --git a/packages/core/src/lib/crypto.ts b/packages/core/src/lib/crypto.ts index 095b41e9a7..70507bc777 100644 --- a/packages/core/src/lib/crypto.ts +++ b/packages/core/src/lib/crypto.ts @@ -1,9 +1,9 @@ import nodeCrypto from "crypto"; import * as secp from "@noble/secp256k1"; +import { concat } from "@waku/byte-utils"; import sha3 from "js-sha3"; -import { concat } from "./utils"; import { Asymmetric, Symmetric } from "./waku_message/constants"; declare const self: Record | undefined; diff --git a/packages/core/src/lib/waku_message/ecies.ts b/packages/core/src/lib/waku_message/ecies.ts index eed121cc31..8b783f66b2 100644 --- a/packages/core/src/lib/waku_message/ecies.ts +++ b/packages/core/src/lib/waku_message/ecies.ts @@ -1,7 +1,7 @@ import * as secp from "@noble/secp256k1"; +import { concat, hexToBytes } from "@waku/byte-utils"; import { getSubtle, randomBytes, sha256 } from "../crypto"; -import { concat, hexToBytes } from "../utils"; /** * HKDF as implemented in go-ethereum. */ diff --git a/packages/core/src/lib/waku_message/version_1.ts b/packages/core/src/lib/waku_message/version_1.ts index 3b6d46a8e3..4dc426d157 100644 --- a/packages/core/src/lib/waku_message/version_1.ts +++ b/packages/core/src/lib/waku_message/version_1.ts @@ -1,10 +1,10 @@ import * as secp from "@noble/secp256k1"; +import { concat, hexToBytes } from "@waku/byte-utils"; import type { Decoder, Encoder, Message, ProtoMessage } from "@waku/interfaces"; import debug from "debug"; import * as proto from "../../proto/message"; import { keccak256, randomBytes, sign } from "../crypto"; -import { concat, hexToBytes } from "../utils"; import { Symmetric } from "./constants"; import * as ecies from "./ecies"; From 81c855314dbe0ced2b743fad97a7143efe267bb6 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 14:42:01 +1100 Subject: [PATCH 06/11] chore: move dependencies from core to enr --- package-lock.json | 120 +++++++++++++------------- packages/core/package.json | 3 +- packages/dns-discovery/package.json | 9 +- packages/dns-discovery/src/enrtree.ts | 2 +- packages/enr/package.json | 11 ++- 5 files changed, 79 insertions(+), 66 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1afd6fc1c0..31a354e205 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,10 @@ { - "name": "root", + "name": "@waku/root", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "root", + "name": "@waku/root", "workspaces": [ "packages/*" ], @@ -22422,7 +22422,6 @@ "dependencies": { "@chainsafe/libp2p-gossipsub": "^4.1.1", "@chainsafe/libp2p-noise": "^8.0.1", - "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", "@libp2p/interface-connection": "3.0.1", "@libp2p/interface-peer-discovery": "^1.0.0", @@ -22436,6 +22435,7 @@ "@libp2p/websockets": "^3.0.3", "@multiformats/multiaddr": "^11.0.6", "@noble/secp256k1": "^1.3.4", + "@waku/byte-utils": "*", "@waku/interfaces": "*", "debug": "^4.3.4", "it-all": "^1.0.6", @@ -22446,7 +22446,7 @@ "p-event": "^5.0.1", "protons-runtime": "^3.1.0", "uint8arraylist": "^2.3.2", - "uint8arrays": "^3.0.0", + "uint8arrays": "^4.0.2", "uuid": "^8.3.2" }, "devDependencies": { @@ -22524,7 +22524,16 @@ "npm": ">=7.0.0" } }, - "packages/core/node_modules/@multiformats/multiaddr/node_modules/uint8arrays": { + "packages/core/node_modules/multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", + "engines": { + "node": ">=16.0.0", + "npm": ">=7.0.0" + } + }, + "packages/core/node_modules/uint8arrays": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", @@ -22536,15 +22545,6 @@ "npm": ">=7.0.0" } }, - "packages/core/node_modules/multiformats": { - "version": "10.0.2", - "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", - "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", - "engines": { - "node": ">=16.0.0", - "npm": ">=7.0.0" - } - }, "packages/create": { "name": "@waku/create", "version": "0.0.1", @@ -22597,7 +22597,7 @@ "debug": "^4.3.4", "dns-query": "^0.11.2", "hi-base32": "^0.5.1", - "uint8arrays": "^3.0.0" + "uint8arrays": "^4.0.2" }, "devDependencies": { "@libp2p/peer-id-factory": "^1.0.15", @@ -22656,24 +22656,22 @@ "npm": ">=7.0.0" } }, - "packages/dns-discovery/node_modules/@multiformats/multiaddr/node_modules/uint8arrays": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", - "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", - "dev": true, - "dependencies": { - "multiformats": "^10.0.0" - }, + "packages/dns-discovery/node_modules/multiformats": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", "engines": { "node": ">=16.0.0", "npm": ">=7.0.0" } }, - "packages/dns-discovery/node_modules/multiformats": { - "version": "10.0.2", - "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", - "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", - "dev": true, + "packages/dns-discovery/node_modules/uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "dependencies": { + "multiformats": "^10.0.0" + }, "engines": { "node": ">=16.0.0", "npm": ">=7.0.0" @@ -22684,10 +22682,14 @@ "version": "0.0.1", "license": "MIT OR Apache-2.0", "dependencies": { + "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", + "@libp2p/interface-peer-id": "^1.0.2", + "@libp2p/peer-id": "^1.1.10", "@multiformats/multiaddr": "^11.0.6", - "@noble/secp256k1": "^1.7.0", - "@waku/byte-utils": "*" + "@noble/secp256k1": "^1.3.4", + "@waku/byte-utils": "*", + "js-sha3": "^0.8.0" }, "devDependencies": { "@libp2p/peer-id-factory": "^1.0.15", @@ -22716,7 +22718,8 @@ "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", "ts-loader": "^9.4.1", - "typescript": "^4.6.3" + "typescript": "^4.6.3", + "uint8arrays": "^4.0.2" }, "engines": { "node": ">=16" @@ -27129,7 +27132,6 @@ "requires": { "@chainsafe/libp2p-gossipsub": "^4.1.1", "@chainsafe/libp2p-noise": "^8.0.1", - "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", "@libp2p/interface-connection": "3.0.1", "@libp2p/interface-peer-discovery": "^1.0.0", @@ -27161,6 +27163,7 @@ "@types/uuid": "^8.3.0", "@typescript-eslint/eslint-plugin": "^5.8.1", "@typescript-eslint/parser": "^5.8.1", + "@waku/byte-utils": "*", "@waku/interfaces": "*", "app-root-path": "^3.0.0", "chai": "^4.3.4", @@ -27205,7 +27208,7 @@ "ts-node": "^10.9.1", "typescript": "^4.6.3", "uint8arraylist": "^2.3.2", - "uint8arrays": "^3.0.0", + "uint8arrays": "^4.0.2", "uuid": "^8.3.2" }, "dependencies": { @@ -27220,22 +27223,20 @@ "multiformats": "^10.0.0", "uint8arrays": "^4.0.2", "varint": "^6.0.0" - }, - "dependencies": { - "uint8arrays": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", - "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", - "requires": { - "multiformats": "^10.0.0" - } - } } }, "multiformats": { "version": "10.0.2", "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==" + }, + "uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "requires": { + "multiformats": "^10.0.0" + } } } }, @@ -27309,7 +27310,7 @@ "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", "typescript": "^4.6.3", - "uint8arrays": "^3.0.0" + "uint8arrays": "^4.0.2" }, "dependencies": { "@chainsafe/is-ip": { @@ -27330,34 +27331,33 @@ "multiformats": "^10.0.0", "uint8arrays": "^4.0.2", "varint": "^6.0.0" - }, - "dependencies": { - "uint8arrays": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", - "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", - "dev": true, - "requires": { - "multiformats": "^10.0.0" - } - } } }, "multiformats": { "version": "10.0.2", "resolved": "https://registry.npmjs.org/multiformats/-/multiformats-10.0.2.tgz", - "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==", - "dev": true + "integrity": "sha512-nJEHLFOYhO4L+aNApHhCnWqa31FyqAHv9Q77AhmwU3KsM2f1j7tuJpCk5ByZ33smzycNCpSG5klNIejIyfFx2A==" + }, + "uint8arrays": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/uint8arrays/-/uint8arrays-4.0.2.tgz", + "integrity": "sha512-8CWXXZdOvVrIL4SeY/Gnp+idxxiGK4XFkP4FY26Sx/fpTz/b6vv4BVWELMDzQweSyyhdcuAcU14H6izzB6k1Cw==", + "requires": { + "multiformats": "^10.0.0" + } } } }, "@waku/enr": { "version": "file:packages/enr", "requires": { + "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", + "@libp2p/interface-peer-id": "^1.0.2", + "@libp2p/peer-id": "^1.1.10", "@libp2p/peer-id-factory": "^1.0.15", "@multiformats/multiaddr": "^11.0.6", - "@noble/secp256k1": "^1.7.0", + "@noble/secp256k1": "^1.3.4", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", "@rollup/plugin-node-resolve": "^13.3.0", @@ -27378,13 +27378,15 @@ "eslint-plugin-functional": "^4.0.2", "eslint-plugin-import": "^2.25.3", "eslint-plugin-prettier": "^4.0.0", + "js-sha3": "^0.8.0", "npm-run-all": "^4.1.5", "prettier": "^2.1.1", "rollup": "^2.75.0", "semantic-release": "^19.0.5", "semantic-release-monorepo": "^7.0.5", "ts-loader": "^9.4.1", - "typescript": "^4.6.3" + "typescript": "^4.6.3", + "uint8arrays": "^4.0.2" }, "dependencies": { "@multiformats/multiaddr": { diff --git a/packages/core/package.json b/packages/core/package.json index edac1035b0..bfc6ffbcdf 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -97,7 +97,6 @@ "@waku/byte-utils": "*", "@chainsafe/libp2p-gossipsub": "^4.1.1", "@chainsafe/libp2p-noise": "^8.0.1", - "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", "@libp2p/interface-connection": "3.0.1", "@libp2p/interface-peer-discovery": "^1.0.0", @@ -121,7 +120,7 @@ "p-event": "^5.0.1", "protons-runtime": "^3.1.0", "uint8arraylist": "^2.3.2", - "uint8arrays": "^3.0.0", + "uint8arrays": "^4.0.2", "uuid": "^8.3.2" }, "devDependencies": { diff --git a/packages/dns-discovery/package.json b/packages/dns-discovery/package.json index 41e6c74cda..9b35af0419 100644 --- a/packages/dns-discovery/package.json +++ b/packages/dns-discovery/package.json @@ -10,6 +10,13 @@ "import": "./dist/index.js" } }, + "typesVersions": { + "*": { + "*": [ + "dist/*" + ] + } + }, "type": "module", "author": "Waku Team", "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/dns-discovery#readme", @@ -56,7 +63,7 @@ "hi-base32": "^0.5.1", "debug": "^4.3.4", "dns-query": "^0.11.2", - "uint8arrays": "^3.0.0", + "uint8arrays": "^4.0.2", "@libp2p/interface-peer-discovery": "^1.0.0", "@libp2p/interface-peer-info": "^1.0.1", "@libp2p/interfaces": "^3.0.2", diff --git a/packages/dns-discovery/src/enrtree.ts b/packages/dns-discovery/src/enrtree.ts index c13af9bfe6..a1fdbe9fc1 100644 --- a/packages/dns-discovery/src/enrtree.ts +++ b/packages/dns-discovery/src/enrtree.ts @@ -1,6 +1,6 @@ import { utf8ToBytes } from "@waku/byte-utils"; import { ENR } from "@waku/enr"; -import { keccak256, verifySignature } from "@waku/enr/crypto"; +import { keccak256, verifySignature } from "@waku/enr/crypt"; import base32 from "hi-base32"; import { fromString } from "uint8arrays/from-string"; diff --git a/packages/enr/package.json b/packages/enr/package.json index 1c3e3fc2ad..a45aee339e 100644 --- a/packages/enr/package.json +++ b/packages/enr/package.json @@ -9,7 +9,7 @@ "types": "./dist/index.d.ts", "import": "./dist/index.js" }, - "./crypto": { + "./crypt": { "types": "./dist/crypto.d.ts", "import": "./dist/crypto.js" } @@ -58,12 +58,17 @@ "node": ">=16" }, "dependencies": { + "@ethersproject/rlp": "^5.5.0", "@libp2p/crypto": "^1.0.4", + "@libp2p/interface-peer-id": "^1.0.2", + "@libp2p/peer-id": "^1.1.10", "@multiformats/multiaddr": "^11.0.6", - "@noble/secp256k1": "^1.7.0", - "@waku/byte-utils": "*" + "@noble/secp256k1": "^1.3.4", + "@waku/byte-utils": "*", + "js-sha3": "^0.8.0" }, "devDependencies": { + "uint8arrays": "^4.0.2", "@libp2p/peer-id-factory": "^1.0.15", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-json": "^4.1.0", From d78a40f2734578fbf32ac7828875dc57e60d4cc5 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 21:37:55 +1100 Subject: [PATCH 07/11] chore: fix dns-discovery build --- packages/dns-discovery/package.json | 4 +--- packages/dns-discovery/src/enrtree.ts | 2 +- packages/enr/package.json | 8 +------- packages/enr/rollup.config.js | 1 - packages/enr/src/index.ts | 1 + 5 files changed, 4 insertions(+), 12 deletions(-) diff --git a/packages/dns-discovery/package.json b/packages/dns-discovery/package.json index 9b35af0419..10a3fd0f05 100644 --- a/packages/dns-discovery/package.json +++ b/packages/dns-discovery/package.json @@ -186,9 +186,7 @@ "files": [ "dist", "bundle", - "src/*.ts", - "src/lib/**/*.ts", - "src/proto/**/*.ts", + "src/**/*.ts", "!**/*.spec.*", "!**/*.json", "CHANGELOG.md", diff --git a/packages/dns-discovery/src/enrtree.ts b/packages/dns-discovery/src/enrtree.ts index a1fdbe9fc1..a2b1347b91 100644 --- a/packages/dns-discovery/src/enrtree.ts +++ b/packages/dns-discovery/src/enrtree.ts @@ -1,6 +1,6 @@ import { utf8ToBytes } from "@waku/byte-utils"; import { ENR } from "@waku/enr"; -import { keccak256, verifySignature } from "@waku/enr/crypt"; +import { keccak256, verifySignature } from "@waku/enr"; import base32 from "hi-base32"; import { fromString } from "uint8arrays/from-string"; diff --git a/packages/enr/package.json b/packages/enr/package.json index a45aee339e..cda56c7cd2 100644 --- a/packages/enr/package.json +++ b/packages/enr/package.json @@ -8,10 +8,6 @@ ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" - }, - "./crypt": { - "types": "./dist/crypto.d.ts", - "import": "./dist/crypto.js" } }, "type": "module", @@ -185,9 +181,7 @@ "files": [ "dist", "bundle", - "src/*.ts", - "src/lib/**/*.ts", - "src/proto/**/*.ts", + "src/**/*.ts", "!**/*.spec.*", "!**/*.json", "CHANGELOG.md", diff --git a/packages/enr/rollup.config.js b/packages/enr/rollup.config.js index 99f3643c0c..d22d3d231e 100644 --- a/packages/enr/rollup.config.js +++ b/packages/enr/rollup.config.js @@ -5,7 +5,6 @@ import { nodeResolve } from "@rollup/plugin-node-resolve"; export default { input: { index: "dist/index.js", - crypto: "dist/crypto.js", }, output: { dir: "bundle", diff --git a/packages/enr/src/index.ts b/packages/enr/src/index.ts index b1b0ba86e3..aca5cf3955 100644 --- a/packages/enr/src/index.ts +++ b/packages/enr/src/index.ts @@ -3,3 +3,4 @@ export * from "./enr.js"; export * from "./types.js"; export * from "./keypair/index.js"; export * from "./waku2_codec.js"; +export * from "./crypto.js"; From e901e7f69d5f74c90f4b8e7c3c81a5a8ccb98db3 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 21:48:04 +1100 Subject: [PATCH 08/11] chore: fix tests build --- packages/tests/package.json | 3 ++- packages/tests/src/nwaku.ts | 4 +--- packages/tests/tests/store.node.spec.ts | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/tests/package.json b/packages/tests/package.json index 296fb881e8..5acce960eb 100644 --- a/packages/tests/package.json +++ b/packages/tests/package.json @@ -57,7 +57,8 @@ "dependencies": { "@waku/core": "*", "@waku/create": "*", - "@waku/interfaces": "*" + "@waku/interfaces": "*", + "@waku/byte-utils": "*" }, "devDependencies": { "@typescript-eslint/eslint-plugin": "^5.8.1", diff --git a/packages/tests/src/nwaku.ts b/packages/tests/src/nwaku.ts index 15ef495690..036196446e 100644 --- a/packages/tests/src/nwaku.ts +++ b/packages/tests/src/nwaku.ts @@ -3,8 +3,8 @@ import { ChildProcess, spawn } from "child_process"; import type { PeerId } from "@libp2p/interface-peer-id"; import { peerIdFromString } from "@libp2p/peer-id"; import { Multiaddr, multiaddr } from "@multiformats/multiaddr"; +import { bytesToHex, hexToBytes } from "@waku/byte-utils"; import { DefaultPubSubTopic } from "@waku/core"; -import { utils } from "@waku/core"; import appRoot from "app-root-path"; import debug from "debug"; import portfinder from "portfinder"; @@ -13,8 +13,6 @@ import { existsAsync, mkdirAsync, openAsync } from "./async_fs"; import { delay } from "./delay"; import waitForLine from "./log_file"; -const { bytesToHex, hexToBytes } = utils; - const log = debug("waku:nwaku"); const WAKU_SERVICE_NODE_DIR = diff --git a/packages/tests/tests/store.node.spec.ts b/packages/tests/tests/store.node.spec.ts index fb779059b2..b63392b911 100644 --- a/packages/tests/tests/store.node.spec.ts +++ b/packages/tests/tests/store.node.spec.ts @@ -1,10 +1,10 @@ +import { bytesToUtf8, utf8ToBytes } from "@waku/byte-utils"; import { generatePrivateKey, generateSymmetricKey, getPublicKey, } from "@waku/core"; import { PageDirection } from "@waku/core"; -import { bytesToUtf8, utf8ToBytes } from "@waku/core/lib/utils"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { DecoderV0, EncoderV0 } from "@waku/core/lib/waku_message/version_0"; import { From 55192a2774c207f9fe01b5bae764fbcfc9886efd Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 22:40:42 +1100 Subject: [PATCH 09/11] chore: fix tests test + karma tests --- packages/core/karma.conf.cjs | 26 ++++++-------------- packages/core/tsconfig.karma.json | 6 ----- packages/dns-discovery/tsconfig.karma.json | 6 ----- packages/enr/tsconfig.karma.json | 6 ----- packages/tests/package.json | 1 + packages/tests/tests/enr.node.spec.ts | 2 +- packages/tests/tests/filter.node.spec.ts | 2 +- packages/tests/tests/light_push.node.spec.ts | 2 +- packages/tests/tests/relay.node.spec.ts | 2 +- packages/tests/tests/waku.node.spec.ts | 2 +- packages/tests/tsconfig.karma.json | 6 ----- 11 files changed, 14 insertions(+), 47 deletions(-) delete mode 100644 packages/core/tsconfig.karma.json delete mode 100644 packages/dns-discovery/tsconfig.karma.json delete mode 100644 packages/enr/tsconfig.karma.json delete mode 100644 packages/tests/tsconfig.karma.json diff --git a/packages/core/karma.conf.cjs b/packages/core/karma.conf.cjs index febf1611b4..20d52e751f 100644 --- a/packages/core/karma.conf.cjs +++ b/packages/core/karma.conf.cjs @@ -18,24 +18,9 @@ module.exports = function (config) { }, }, webpack: { - mode: "production", + mode: "development", module: { - rules: [ - { - test: /\.(js|tsx?)$/, - use: [ - { - loader: "ts-loader", - options: { configFile: "tsconfig.karma.json" }, - }, - ], - exclude: /(node_modules)|(node\.spec\.ts)/, - }, - { - test: /node\.spec\.ts$/, - use: "ignore-loader", - }, - ], + rules: [{ test: /\.([cm]?ts|tsx)$/, loader: "ts-loader" }], }, plugins: [ new webpack.DefinePlugin({ @@ -46,7 +31,12 @@ module.exports = function (config) { }), ], resolve: { - extensions: [".ts", ".js"], + extensions: [".ts", ".tsx", ".js"], + extensionAlias: { + ".js": [".js", ".ts"], + ".cjs": [".cjs", ".cts"], + ".mjs": [".mjs", ".mts"], + }, }, stats: { warnings: false }, devtool: "inline-source-map", diff --git a/packages/core/tsconfig.karma.json b/packages/core/tsconfig.karma.json deleted file mode 100644 index c540c783ff..0000000000 --- a/packages/core/tsconfig.karma.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "extends": "./tsconfig.dev", - "compilerOptions": { - "noEmit": false - } -} diff --git a/packages/dns-discovery/tsconfig.karma.json b/packages/dns-discovery/tsconfig.karma.json deleted file mode 100644 index c540c783ff..0000000000 --- a/packages/dns-discovery/tsconfig.karma.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "extends": "./tsconfig.dev", - "compilerOptions": { - "noEmit": false - } -} diff --git a/packages/enr/tsconfig.karma.json b/packages/enr/tsconfig.karma.json deleted file mode 100644 index c540c783ff..0000000000 --- a/packages/enr/tsconfig.karma.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "extends": "./tsconfig.dev", - "compilerOptions": { - "noEmit": false - } -} diff --git a/packages/tests/package.json b/packages/tests/package.json index 5acce960eb..1adbe1806a 100644 --- a/packages/tests/package.json +++ b/packages/tests/package.json @@ -56,6 +56,7 @@ }, "dependencies": { "@waku/core": "*", + "@waku/enr": "*", "@waku/create": "*", "@waku/interfaces": "*", "@waku/byte-utils": "*" diff --git a/packages/tests/tests/enr.node.spec.ts b/packages/tests/tests/enr.node.spec.ts index 3bfabbe2e3..1f84370f32 100644 --- a/packages/tests/tests/enr.node.spec.ts +++ b/packages/tests/tests/enr.node.spec.ts @@ -1,6 +1,6 @@ -import { ENR } from "@waku/core/lib/enr"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { createPrivacyNode } from "@waku/create"; +import { ENR } from "@waku/enr"; import type { WakuPrivacy } from "@waku/interfaces"; import { Protocols } from "@waku/interfaces"; import { expect } from "chai"; diff --git a/packages/tests/tests/filter.node.spec.ts b/packages/tests/tests/filter.node.spec.ts index 561e58d8b8..b5298d59de 100644 --- a/packages/tests/tests/filter.node.spec.ts +++ b/packages/tests/tests/filter.node.spec.ts @@ -1,4 +1,4 @@ -import { bytesToUtf8, utf8ToBytes } from "@waku/core/lib/utils"; +import { bytesToUtf8, utf8ToBytes } from "@waku/byte-utils"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { DecoderV0, EncoderV0 } from "@waku/core/lib/waku_message/version_0"; import { createFullNode } from "@waku/create"; diff --git a/packages/tests/tests/light_push.node.spec.ts b/packages/tests/tests/light_push.node.spec.ts index f937e54a22..ed098ca9f6 100644 --- a/packages/tests/tests/light_push.node.spec.ts +++ b/packages/tests/tests/light_push.node.spec.ts @@ -1,4 +1,4 @@ -import { bytesToUtf8, utf8ToBytes } from "@waku/core/lib/utils"; +import { bytesToUtf8, utf8ToBytes } from "@waku/byte-utils"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { EncoderV0 } from "@waku/core/lib/waku_message/version_0"; import { createFullNode } from "@waku/create"; diff --git a/packages/tests/tests/relay.node.spec.ts b/packages/tests/tests/relay.node.spec.ts index cef9e21c88..604439a503 100644 --- a/packages/tests/tests/relay.node.spec.ts +++ b/packages/tests/tests/relay.node.spec.ts @@ -1,11 +1,11 @@ import { PeerId } from "@libp2p/interface-peer-id"; +import { bytesToUtf8, utf8ToBytes } from "@waku/byte-utils"; import { DefaultPubSubTopic, generatePrivateKey, generateSymmetricKey, getPublicKey, } from "@waku/core"; -import { bytesToUtf8, utf8ToBytes } from "@waku/core/lib/utils"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { DecoderV0, diff --git a/packages/tests/tests/waku.node.spec.ts b/packages/tests/tests/waku.node.spec.ts index 8999460ffb..07c4e69010 100644 --- a/packages/tests/tests/waku.node.spec.ts +++ b/packages/tests/tests/waku.node.spec.ts @@ -1,7 +1,7 @@ import type { PeerId } from "@libp2p/interface-peer-id"; +import { bytesToUtf8, utf8ToBytes } from "@waku/byte-utils"; import { generateSymmetricKey } from "@waku/core"; import { PeerDiscoveryStaticPeers } from "@waku/core/lib/peer_discovery_static_list"; -import { bytesToUtf8, utf8ToBytes } from "@waku/core/lib/utils"; import { waitForRemotePeer } from "@waku/core/lib/wait_for_remote_peer"; import { SymDecoder, SymEncoder } from "@waku/core/lib/waku_message/version_1"; import { createLightNode, createPrivacyNode } from "@waku/create"; diff --git a/packages/tests/tsconfig.karma.json b/packages/tests/tsconfig.karma.json deleted file mode 100644 index c540c783ff..0000000000 --- a/packages/tests/tsconfig.karma.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "extends": "./tsconfig.dev", - "compilerOptions": { - "noEmit": false - } -} From 16cca33a59f0dbe9954f2deb626496385ec5fb78 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 23:04:33 +1100 Subject: [PATCH 10/11] chore: fix size-limit --- .size-limit.cjs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.size-limit.cjs b/.size-limit.cjs index 9d4a1b12c8..080fd8b46e 100644 --- a/.size-limit.cjs +++ b/.size-limit.cjs @@ -25,7 +25,7 @@ module.exports = [ }, { name: "DNS discovery", - path: "packages/core/bundle/lib/peer_discovery_dns.js", + path: "packages/dns-discovery/bundle/index.js", import: "{ PeerDiscoveryDns }", }, { From 1a77aca0a4de7c67fbe05a3ef44fa2ef5ac7b457 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 3 Nov 2022 23:06:41 +1100 Subject: [PATCH 11/11] doc: add new packages to config --- typedoc.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/typedoc.json b/typedoc.json index c381a4fcb7..55192a4c00 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,13 @@ { "entryPointStrategy": "packages", - "entryPoints": ["packages/core", "packages/interfaces", "packages/create"], + "entryPoints": [ + "packages/byte-utils", + "packages/core", + "packages/create", + "packages/dns-discovery", + "packages/enr", + "packages/interfaces" + ], "out": "docs", "exclude": ["**/*.spec.ts"], "excludeInternal": true,