@ethereumjs/rlp - npm Package Compare versions

Comparing version 4.0.1 to 5.0.0-rc.1

package.json

 {
   "name": "@ethereumjs/rlp",
-  "version": "4.0.1",
+  "version": "5.0.0-rc.1",
   "description": "Recursive Length Prefix Encoding Module",
@@ -27,4 +27,11 @@ "keywords": [
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "bin": {
@@ -41,3 +48,4 @@ "rlp": "bin/rlp"
     "clean": "../../config/cli/clean-package.sh",
-    "coverage": "../../config/cli/coverage.sh",
+    "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov",
+    "examples": "ts-node ../../scripts/examples-runner.ts -- rlp",
     "lint": "../../config/cli/lint.sh",
@@ -47,11 +55,10 @@ "lint:diff": "../../config/cli/lint-diff.sh",
     "prepublishOnly": "../../config/cli/prepublish.sh",
-    "tape": "tape -r ts-node/register",
     "test": "npm run test:node && npm run test:browser",
-    "test:browser": "karma start karma.conf.js",
-    "test:node": "npm run tape -- test/*.spec.ts",
+    "test:browser": "npx vitest run --browser.name=chrome --browser.headless",
+    "test:node": "npx vitest run",
     "tsc": "../../config/cli/ts-compile.sh"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   }
 }

README.md

@@ -9,4 +9,7 @@ # @ethereumjs/rlp
 
-[Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp) encoding for Node.js and the browser.
+Note: this README has been updated containing the changes from our next breaking release round [UNRELEASED] targeted for Summer 2023. See the README files from the [maintenance-v6](https://github.com/ethereumjs/ethereumjs-monorepo/tree/maintenance-v6/) branch for documentation matching our latest releases.
 
+| [Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp) encoding for Node.js and the browser. |
+| ----------------------------------------------------------------------------------------------------------------------------------------- |
+
 ## Installation
@@ -34,2 +37,8 @@
 
+## Browser
+
+With the breaking release round in Summer 2023 we have added hybrid ESM/CJS builds for all our libraries (see section below) and have eliminated many of the caveats which had previously prevented a frictionless browser usage.
+
+It is now easily possible to run a browser build of one of the EthereumJS libraries within a modern browser using the provided ESM build. For a setup example see [./examples/browser.html](./examples/browser.html).
+
 ## API
@@ -58,2 +67,8 @@
 
+### Buffer -> Uint8Arrayy
+
+With the breaking releases from Summer 2023 we have removed all Node.js specific `Buffer` usages from our libraries and replace these with [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) representations, which are available both in Node.js and the browser (`Buffer` is a subclass of `Uint8Array`).
+
+We have converted existing Buffer conversion methods to Uint8Array conversion methods in the [@ethereumjs/util](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/util) `bytes` module, see the respective README section for guidance.
+
 ### BigInt Support
@@ -77,18 +92,2 @@
 
-## Tests
-
-Tests use mocha.
-
-To run tests and linting: `npm test`
-
-To auto-fix linting problems run: `npm run lint:fix`
-
-## Code Coverage
-
-Install dev dependencies: `npm install`
-
-Run coverage: `npm run coverage`
-
-The results will be at: `coverage/lcov-report/index.html`
-
 ## EthereumJS
@@ -95,0 +94,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

123355

increased by139.25%

Number of package files

17

increased by88.89%

Lines of code

847

increased by52.06%

Is type module

Yes

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

107

decreased by-0.93%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes