@lukso/eip191-signer.js - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

CHANGELOG.md

 # Changelog
 
+## [0.2.2](https://github.com/lukso-network/tools-eip191-signer/compare/v0.2.1...v0.2.2) (2023-01-31)
+
+
+### Documentation
+
+* update links in docs ([80eac41](https://github.com/lukso-network/tools-eip191-signer/commit/80eac4160b0e26dd868b8edb302b7655c265953b))
+
 ## [0.2.1](https://github.com/lukso-network/tools-eip191-signer/compare/v0.2.0...v0.2.1) (2022-10-28)
 
-
 ### Features
 
-* add eslint import rules ([36f6981](https://github.com/lukso-network/tools-eip191-signer/commit/36f698192a9abfba398fe4defdfe66ef0d2cc884))
+- add eslint import rules ([36f6981](https://github.com/lukso-network/tools-eip191-signer/commit/36f698192a9abfba398fe4defdfe66ef0d2cc884))
 
-
 ### Bug Fixes
 
-* update README ([f26910e](https://github.com/lukso-network/tools-eip191-signer/commit/f26910e2015d188dd22a28c942a6692fbda1b71c))
+- update README ([f26910e](https://github.com/lukso-network/tools-eip191-signer/commit/f26910e2015d188dd22a28c942a6692fbda1b71c))
 
 ## [0.2.0](https://github.com/lukso-network/tools-eip191-signer/compare/v0.1.0...v0.2.0) (2022-10-26)
 
-
 ### Bug Fixes
 
-* change package name ([cb2c3ef](https://github.com/lukso-network/tools-eip191-signer/commit/cb2c3efe95cd6728d76fefd3090720fb8f78b1b6))
-* improve test ([83a0781](https://github.com/lukso-network/tools-eip191-signer/commit/83a0781a9f2e3bc454f15525d4ea63abc26c19d8))
-* refactor code and add test ([e2b6fdb](https://github.com/lukso-network/tools-eip191-signer/commit/e2b6fdb57f7eb08d944dea1540199598e7356a8c))
-* update docs and variable name for clarity ([64ff1ce](https://github.com/lukso-network/tools-eip191-signer/commit/64ff1ce1dcc6e6065d25540241bfc4abf3d51df6))
+- improve test ([83a0781](https://github.com/lukso-network/tools-eip191-signer/commit/83a0781a9f2e3bc454f15525d4ea63abc26c19d8))
+- refactor code and add test ([e2b6fdb](https://github.com/lukso-network/tools-eip191-signer/commit/e2b6fdb57f7eb08d944dea1540199598e7356a8c))
+- update docs and variable name for clarity ([64ff1ce](https://github.com/lukso-network/tools-eip191-signer/commit/64ff1ce1dcc6e6065d25540241bfc4abf3d51df6))
 
-
 ### Miscellaneous Chores
 
-* release 0.2.0 ([6697005](https://github.com/lukso-network/tools-eip191-signer/commit/6697005d10f40ccf341898d3f05839f6b1899151))
+- release 0.2.0 ([6697005](https://github.com/lukso-network/tools-eip191-signer/commit/6697005d10f40ccf341898d3f05839f6b1899151))
 
-## [0.1.0](https://github.com/lukso-network/tools-lsp6-signer/compare/v0.0.2-development...v0.1.0) (2022-10-07)
+### Breaking Changes
 
+- change package name ([cb2c3ef](https://github.com/lukso-network/tools-eip191-signer/commit/cb2c3efe95cd6728d76fefd3090720fb8f78b1b6))
 
+## [0.1.0](https://github.com/lukso-network/tools-eip191-signer/compare/v0.0.2-development...v0.1.0) (2022-10-07)
+
 ### Bug Fixes
 
-* adapt code to prefix '\x19Execute Relay Call:\n' ([dcb8674](https://github.com/lukso-network/tools-lsp6-signer/commit/dcb86741974f3437b13ae2fdd95d13118ca290be))
+- adapt code to prefix '\x19Execute Relay Call:\n' ([dcb8674](https://github.com/lukso-network/tools-eip191-signer/commit/dcb86741974f3437b13ae2fdd95d13118ca290be))
 
-
 ### Miscellaneous Chores
 
-* release 0.1.0 ([2bd42a6](https://github.com/lukso-network/tools-lsp6-signer/commit/2bd42a6ec50f978c5855b7fb9a4e46440d99466d))
+- release 0.1.0 ([2bd42a6](https://github.com/lukso-network/tools-eip191-signer/commit/2bd42a6ec50f978c5855b7fb9a4e46440d99466d))
 
-## [0.0.2-development](https://github.com/lukso-network/tools-lsp6-signer/compare/v0.0.1-development...v0.0.2-development) (2022-09-30)
+## [0.0.2-development](https://github.com/lukso-network/tools-eip191-signer/compare/v0.0.1-development...v0.0.2-development) (2022-09-30)
 
-
 ### Features
 
-* add package to specify contributors ([33404a4](https://github.com/lukso-network/tools-lsp6-signer/commit/33404a4348410d550c6324f847ab7d4da05fc353))
+- add package to specify contributors ([33404a4](https://github.com/lukso-network/tools-eip191-signer/commit/33404a4348410d550c6324f847ab7d4da05fc353))
 
-
 ### Bug Fixes
 
-* change the branch to open PR against to main ([25c9f60](https://github.com/lukso-network/tools-lsp6-signer/commit/25c9f60535da22d5065c0ee5a8a9b0c3541d7682))
-* change the default branch for the release workflow to main ([d99b7d5](https://github.com/lukso-network/tools-lsp6-signer/commit/d99b7d5383629ec75634222ac4ec09a701a57b8c))
+- change the branch to open PR against to main ([25c9f60](https://github.com/lukso-network/tools-eip191-signer/commit/25c9f60535da22d5065c0ee5a8a9b0c3541d7682))
+- change the default branch for the release workflow to main ([d99b7d5](https://github.com/lukso-network/tools-eip191-signer/commit/d99b7d5383629ec75634222ac4ec09a701a57b8c))
 
 ## 0.0.1-development (2022-09-26)
 
-
 ### Bug Fixes
 
-* add checkout step to the release workflow ([ad0d037](https://github.com/lukso-network/tools-lsp6-signer/commit/ad0d0372ee306279ceb6a8a21e3c120d3163a29d))
-* set bump-patch-for-minor-pre-major for the release ([9cd1f67](https://github.com/lukso-network/tools-lsp6-signer/commit/9cd1f67eb55fef1cb98a8444ade3379c5fe4d2c7))
+- add checkout step to the release workflow ([ad0d037](https://github.com/lukso-network/tools-eip191-signer/commit/ad0d0372ee306279ceb6a8a21e3c120d3163a29d))
+- set bump-patch-for-minor-pre-major for the release ([9cd1f67](https://github.com/lukso-network/tools-eip191-signer/commit/9cd1f67eb55fef1cb98a8444ade3379c5fe4d2c7))
 
-
 ### Miscellaneous Chores
 
-* release 0.0.1-development ([5305ad1](https://github.com/lukso-network/tools-lsp6-signer/commit/5305ad1c9cd8569a12852759c51709b60c848fda))
+- release 0.0.1-development ([5305ad1](https://github.com/lukso-network/tools-eip191-signer/commit/5305ad1c9cd8569a12852759c51709b60c848fda))

package.json

 {
   "name": "@lukso/eip191-signer.js",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Helper Library to allows to sign any EIP191 data",
@@ -24,5 +24,9 @@ "main": "build/main/src/index.js",
     "type": "git",
-    "url": "git+https://github.com/lukso-network/tools-lsp6-signer.git"
+    "url": "git+https://github.com/lukso-network/tools-eip191-signer.git"
   },
-  "keywords": [],
+  "keywords": [
+    "web3",
+    "lukso",
+    "eip191"
+  ],
   "author": {
@@ -40,5 +44,5 @@ "name": "Magali Morin",
   "bugs": {
-    "url": "https://github.com/lukso-network/tools-lsp6-signer/issues"
+    "url": "https://github.com/lukso-network/tools-eip191-signer/issues"
   },
-  "homepage": "https://github.com/lukso-network/tools-lsp6-signer#readme",
+  "homepage": "https://github.com/lukso-network/tools-eip191-signer#readme",
   "devDependencies": {
@@ -45,0 +49,0 @@ "@types/jest": "^29.0.3",

README.md

@@ -1,2 +0,2 @@
-# eip191-signer.js · [![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@lukso/lsp6-signer.js.svg?style=flat)](https://www.npmjs.com/package/@lukso/eip191-signer.js) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/lukso-network/tools-lsp6-signer/pulls)
+# eip191-signer.js · [![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@lukso/eip191-signer.js.svg?style=flat)](https://www.npmjs.com/package/@lukso/eip191-signer.js) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/lukso-network/tools-eip191-signer/pulls)
 
@@ -12,9 +12,9 @@ <p align="center">
 
-The `@lukso/lsp6-signer.js` package is used to sign an LSP6 Execute Relay Call transaction.
+The `@lukso/eip191-signer.js` package is used to sign messages according to the [EIP191 standard](https://eips.ethereum.org/EIPS/eip-191).
 
-This library will add the `\x19Execute Relay Call:\n` prefix to a message and sign it.
+If you want to sign with the version **0x45**, then use the function **signEthereumSignedMessage**.
 
-The `LSP6 ExcuteRelayCall` prefix is used instead of the standard Ethereum transaction prefix to sign messages so that an [`executeRelayCall`](https://docs.lukso.tech/standards/smart-contracts/lsp6-key-manager#executerelaycall) transaction cannot be inadvertently signed when signing an Ethereum signed message.
+If you want to sign with the version **0x00**, then use the function **signDataWithIntendedValidator**.
 
-- [GitHub Repository](https://github.com/lukso-network/tools-lsp6-signer)
+- [GitHub Repository](https://github.com/lukso-network/tools-eip191-signer)
 - [NPM Package](https://www.npmjs.com/package/@lukso/eip191-signer.js)
@@ -42,4 +42,6 @@
 
-Hashes the given message. The message will be enveloped as follows: `'\x19' + '\x45' + 'thereum Signed Message:\n' + messageBytes.length + message` and hashed using keccak256.
+Hashes the given message with the version 0x45.
 
+The message will be enveloped as follows: `'\x19' + '\x45' + 'thereum Signed Message:\n' + messageBytes.length + message` and hashed using keccak256.
+
 ## hashDataWithIntendedValidator
@@ -51,4 +53,6 @@
 
-Hashes the given message. The message will be enveloped as follows: `'\x19' + '\x00' + validatorAddress + message` and hashed using keccak256.
+Hashes the given message with the version 0x00.
 
+The message will be enveloped as follows: `'\x19' + '\x00' + validatorAddress + message` and hashed using keccak256.
+
 ## signEthereumSignedMessage
@@ -60,4 +64,6 @@
 
-Signs a message. The message passed as parameter will be wrapped as follows: `'\x19' + '\x45' + 'thereum Signed Message:\n' + messageBytes.length + message`.
+This method is for signing a message with the version 0x45.
 
+The message passed as parameter will be wrapped as follows: `'\x19' + '\x45' + 'thereum Signed Message:\n' + messageBytes.length + message`.
+
 ## signDataWithIntendedValidator
@@ -73,4 +79,6 @@
 
-Signs a message. The message passed as parameter will be wrapped as follows: `'\x19' + '\x00' + validatorAddress + message`.
+This method is for signing a message with the version 0x00.
 
+The message passed as parameter will be wrapped as follows: `'\x19' + '\x00' + validatorAddress + message`.
+
 ## recover
@@ -100,6 +108,6 @@
     <tr>
-      <td align="center"><a href="https://github.com/magalimorin18"><img src="https://avatars.githubusercontent.com/u/51906903?v=4?s=50" width="50px;" alt="Magali Morin"/><br /><sub><b>Magali Morin</b></sub></a><br /><a href="https://github.com/Fabian Vogelsteller/tools-lsp6-signer/commits?author=magalimorin18" title="Code">💻</a> <a href="https://github.com/Fabian Vogelsteller/tools-lsp6-signer/commits?author=magalimorin18" title="Tests">⚠️</a></td>
-      <td align="center"><a href="https://lukso.network/"><img src="https://avatars.githubusercontent.com/u/232662?v=4?s=50" width="50px;" alt="Fabian Vogelsteller"/><br /><sub><b>Fabian Vogelsteller</b></sub></a><br /><a href="#ideas-frozeman" title="Ideas, Planning, & Feedback">🤔</a></td>
-      <td align="center"><a href="https://github.com/CallumGrindle"><img src="https://avatars.githubusercontent.com/u/54543428?v=4?s=50" width="50px;" alt="Callum Grindle"/><br /><sub><b>Callum Grindle</b></sub></a><br /><a href="https://github.com/Fabian Vogelsteller/tools-lsp6-signer/pulls?q=is%3Apr+reviewed-by%3ACallumGrindle" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-CallumGrindle" title="Mentoring">🧑‍🏫</a></td>
-      <td align="center"><a href="http://www.hugomasclet.com/"><img src="https://avatars.githubusercontent.com/u/477945?v=4?s=50" width="50px;" alt="Hugo Masclet"/><br /><sub><b>Hugo Masclet</b></sub></a><br /><a href="https://github.com/Fabian Vogelsteller/tools-lsp6-signer/pulls?q=is%3Apr+reviewed-by%3AHugoo" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-Hugoo" title="Mentoring">🧑‍🏫</a></td>
+      <td align="center"><a href="https://github.com/magalimorin18"><img src="https://avatars.githubusercontent.com/u/51906903?v=4?s=50" width="50px;" alt="Magali Morin"/><br /><sub><b>Magali Morin</b></sub></a><br /><a href="https://github.com/lukso-network/tools-eip191-signer/commits?author=magalimorin18" title="Code">💻</a> <a href="https://github.com/lukso-network/tools-eip191-signer/commits?author=magalimorin18" title="Tests">⚠️</a></td>
+      <td align="center"><a href="https://github.com/frozeman"><img src="https://avatars.githubusercontent.com/u/232662?v=4?s=50" width="50px;" alt="Fabian Vogelsteller"/><br /><sub><b>Fabian Vogelsteller</b></sub></a><br /><a href="#ideas-frozeman" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center"><a href="https://github.com/CallumGrindle"><img src="https://avatars.githubusercontent.com/u/54543428?v=4?s=50" width="50px;" alt="Callum Grindle"/><br /><sub><b>Callum Grindle</b></sub></a><br /><a href="https://github.com/lukso-network/tools-eip191-signer/pulls?q=is%3Apr+reviewed-by%3ACallumGrindle" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-CallumGrindle" title="Mentoring">🧑‍🏫</a></td>
+      <td align="center"><a href="https://github.com/Hugoo"><img src="https://avatars.githubusercontent.com/u/477945?v=4?s=50" width="50px;" alt="Hugo Masclet"/><br /><sub><b>Hugo Masclet</b></sub></a><br /><a href="https://github.com/lukso-network/tools-eip191-signer/pulls?q=is%3Apr+reviewed-by%3AHugoo" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-Hugoo" title="Mentoring">🧑‍🏫</a></td>
     </tr>
@@ -106,0 +114,0 @@ </tbody>

No alert changes

Improved metrics

Total package byte prevSize

75649

increased by0.42%

Number of lines in readme file

115

increased by7.48%

No dependency changes