web3-eth-personal - npm Package Compare versions

Comparing version 4.0.9-dev.2c60685.0 to 4.0.9-dev.2ef694c.0

lib/commonjs/personal.d.ts

 import { Web3Context } from 'web3-core';
 import { Address, EthPersonalAPI, HexString, Transaction } from 'web3-types';
 /**
- * Eth Personal allows you to interact with the Ethereum node’s accounts.
- */
+* Eth Personal allows you to interact with the Ethereum node’s accounts.
+* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
+* ```ts
+*
+*import { Web3 } from 'web3';
+*  const web3 = new Web3('http://127.0.0.1:7545');
+*
+*  console.log(await web3.eth.personal.getAccounts());
+*
+* ```
+* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
+*
+* ```ts
+* import {Personal} from 'web3-eth-personal';
+*
+* const personal = new Personal('http://127.0.0.1:7545');
+* console.log(await personal.getAccounts());
+* ```
+*/
 export declare class Personal extends Web3Context<EthPersonalAPI> {
@@ -67,2 +84,3 @@ /**
      * );
+     * ```
      */
@@ -168,3 +186,3 @@ lockAccount(address: Address): Promise<boolean>;
      * ```ts
-     * const sig = await personal .sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
+     * const sig = await personal.sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
      * console.log(sig)
@@ -171,0 +189,0 @@ * > 0x5d21d01b3198ac34d0585a9d76c4d1c8123e5e06746c8962318a1c08ffb207596e6fce4a6f377b7c0fc98c5f646cd73438c80e8a1a95cbec55a84c2889dca0301b

lib/commonjs/personal.js

@@ -55,4 +55,21 @@ "use strict";
 /**
- * Eth Personal allows you to interact with the Ethereum node’s accounts.
- */
+* Eth Personal allows you to interact with the Ethereum node’s accounts.
+* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
+* ```ts
+*
+*import { Web3 } from 'web3';
+*  const web3 = new Web3('http://127.0.0.1:7545');
+*
+*  console.log(await web3.eth.personal.getAccounts());
+*
+* ```
+* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
+*
+* ```ts
+* import {Personal} from 'web3-eth-personal';
+*
+* const personal = new Personal('http://127.0.0.1:7545');
+* console.log(await personal.getAccounts());
+* ```
+*/
 class Personal extends web3_core_1.Web3Context {
@@ -131,2 +148,3 @@ /**
      * );
+     * ```
      */
@@ -248,3 +266,3 @@ lockAccount(address) {
      * ```ts
-     * const sig = await personal .sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
+     * const sig = await personal.sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
      * console.log(sig)
@@ -251,0 +269,0 @@ * > 0x5d21d01b3198ac34d0585a9d76c4d1c8123e5e06746c8962318a1c08ffb207596e6fce4a6f377b7c0fc98c5f646cd73438c80e8a1a95cbec55a84c2889dca0301b

lib/esm/personal.js

@@ -29,4 +29,21 @@ /*
 /**
- * Eth Personal allows you to interact with the Ethereum node’s accounts.
- */
+* Eth Personal allows you to interact with the Ethereum node’s accounts.
+* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
+* ```ts
+*
+*import { Web3 } from 'web3';
+*  const web3 = new Web3('http://127.0.0.1:7545');
+*
+*  console.log(await web3.eth.personal.getAccounts());
+*
+* ```
+* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
+*
+* ```ts
+* import {Personal} from 'web3-eth-personal';
+*
+* const personal = new Personal('http://127.0.0.1:7545');
+* console.log(await personal.getAccounts());
+* ```
+*/
 export class Personal extends Web3Context {
@@ -105,2 +122,3 @@ /**
      * );
+     * ```
      */
@@ -222,3 +240,3 @@ lockAccount(address) {
      * ```ts
-     * const sig = await personal .sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
+     * const sig = await personal.sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
      * console.log(sig)
@@ -225,0 +243,0 @@ * > 0x5d21d01b3198ac34d0585a9d76c4d1c8123e5e06746c8962318a1c08ffb207596e6fce4a6f377b7c0fc98c5f646cd73438c80e8a1a95cbec55a84c2889dca0301b

lib/types/personal.d.ts

 import { Web3Context } from 'web3-core';
 import { Address, EthPersonalAPI, HexString, Transaction } from 'web3-types';
 /**
- * Eth Personal allows you to interact with the Ethereum node’s accounts.
- */
+* Eth Personal allows you to interact with the Ethereum node’s accounts.
+* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
+* ```ts
+*
+*import { Web3 } from 'web3';
+*  const web3 = new Web3('http://127.0.0.1:7545');
+*
+*  console.log(await web3.eth.personal.getAccounts());
+*
+* ```
+* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
+*
+* ```ts
+* import {Personal} from 'web3-eth-personal';
+*
+* const personal = new Personal('http://127.0.0.1:7545');
+* console.log(await personal.getAccounts());
+* ```
+*/
 export declare class Personal extends Web3Context<EthPersonalAPI> {
@@ -67,2 +84,3 @@ /**
      * );
+     * ```
      */
@@ -168,3 +186,3 @@ lockAccount(address: Address): Promise<boolean>;
      * ```ts
-     * const sig = await personal .sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
+     * const sig = await personal.sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
      * console.log(sig)
@@ -171,0 +189,0 @@ * > 0x5d21d01b3198ac34d0585a9d76c4d1c8123e5e06746c8962318a1c08ffb207596e6fce4a6f377b7c0fc98c5f646cd73438c80e8a1a95cbec55a84c2889dca0301b

package.json

 {
 	"name": "web3-eth-personal",
-	"version": "4.0.9-dev.2c60685.0+2c60685",
+	"version": "4.0.9-dev.2ef694c.0+2ef694c",
 	"description": "Web3 module to interact with the Ethereum blockchain accounts stored in the node.",
@@ -33,3 +33,3 @@ "main": "./lib/commonjs/index.js",
 		"build:check": "node -e \"require('./lib')\"",
-		"lint": "eslint --ext .js,.ts .",
+		"lint": "eslint --cache --cache-strategy content --ext .ts .",
 		"lint:fix": "eslint --fix --ext .js,.ts .",
@@ -46,8 +46,8 @@ "format": "prettier --write '**/*'",
 	"dependencies": {
-		"web3-core": "4.3.2-dev.2c60685.0+2c60685",
-		"web3-eth": "4.3.2-dev.2c60685.0+2c60685",
-		"web3-rpc-methods": "1.1.4-dev.2c60685.0+2c60685",
-		"web3-types": "1.3.2-dev.2c60685.0+2c60685",
-		"web3-utils": "4.0.8-dev.2c60685.0+2c60685",
-		"web3-validator": "2.0.4-dev.2c60685.0+2c60685"
+		"web3-core": "4.5.1-dev.2ef694c.0+2ef694c",
+		"web3-eth": "4.8.3-dev.2ef694c.0+2ef694c",
+		"web3-rpc-methods": "1.3.1-dev.2ef694c.0+2ef694c",
+		"web3-types": "1.7.1-dev.2ef694c.0+2ef694c",
+		"web3-utils": "4.3.2-dev.2ef694c.0+2ef694c",
+		"web3-validator": "2.0.7-dev.2ef694c.0+2ef694c"
 	},
@@ -62,10 +62,10 @@ "devDependencies": {
 		"eslint-plugin-import": "^2.26.0",
-		"jest": "^28.1.3",
+		"jest": "^29.7.0",
 		"jest-extended": "^3.0.1",
 		"prettier": "^2.7.1",
-		"ts-jest": "^28.0.7",
+		"ts-jest": "^29.1.1",
 		"typescript": "^4.7.4",
-		"web3-providers-ws": "4.0.8-dev.2c60685.0+2c60685"
+		"web3-providers-ws": "4.0.9-dev.2ef694c.0+2ef694c"
 	},
-	"gitHead": "2c6068571268a41a5de530f9052f1de1faaafd24"
+	"gitHead": "2ef694cc5b40cf44f4ec46c60e183970d2f5c18e"
 }

src/personal.ts

@@ -24,4 +24,21 @@ /*
 /**
- * Eth Personal allows you to interact with the Ethereum node’s accounts.
- */
+* Eth Personal allows you to interact with the Ethereum node’s accounts.
+* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
+* ```ts
+* 
+*import { Web3 } from 'web3';
+*  const web3 = new Web3('http://127.0.0.1:7545');
+*
+*  console.log(await web3.eth.personal.getAccounts());
+* 
+* ```
+* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
+*
+* ```ts
+* import {Personal} from 'web3-eth-personal';
+* 
+* const personal = new Personal('http://127.0.0.1:7545');
+* console.log(await personal.getAccounts());
+* ```
+*/
 export class Personal extends Web3Context<EthPersonalAPI> {
@@ -96,2 +113,3 @@ /**
 	 * );
+	 * ```
 	 */
@@ -206,3 +224,3 @@ public async lockAccount(address: Address) {
 	 * ```ts
-	 * const sig = await personal .sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
+	 * const sig = await personal.sign("Hello world", "0x0D4Aa485ECbC499c70860fEb7e5AaeAf5fd8172E", "123456")
 	 * console.log(sig)
@@ -209,0 +227,0 @@ * > 0x5d21d01b3198ac34d0585a9d76c4d1c8123e5e06746c8962318a1c08ffb207596e6fce4a6f377b7c0fc98c5f646cd73438c80e8a1a95cbec55a84c2889dca0301b

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

88286

increased by3.6%

Lines of code

1600

increased by5.96%

Dependency changes

• Updatedweb3-core@4.5.1-dev.2ef694c.0+2ef694c

• Updatedweb3-eth@4.8.3-dev.2ef694c.0+2ef694c

• Updatedweb3-rpc-methods@1.3.1-dev.2ef694c.0+2ef694c

• Updatedweb3-types@1.7.1-dev.2ef694c.0+2ef694c

• Updatedweb3-utils@4.3.2-dev.2ef694c.0+2ef694c

• Updatedweb3-validator@2.0.7-dev.2ef694c.0+2ef694c