The web3-eth-personal package allows you to interact with the Ethereum node's accounts.
Note
Many of these functions send sensitive information, like password. Never call these functions over a unsecured Websocket or HTTP provider, as your password will be sent in plain text!
import Web3 from 'web3';
import {Personal} from 'web3-eth-personal';
// "Web3.givenProvider" will be set if in an Ethereum supported browser.
const personal = new Personal(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);
// or using the web3 umbrella package
const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);
// -> web3.eth.personalnewAccount =========
web3.eth.personal.newAccount(password, [callback])Create a new account on the node that Web3 is connected to with its provider. The RPC method used is personal_newAccount. It differs from web3.eth.accounts.create() <accounts-create> where the key pair is created only on client and it's up to the developer to manage it.
Note
Never call this function over a unsecured Websocket or HTTP provider, as your password will be send in plain text!
password-String: The password to encrypt this account with.
Promise<string> - The address of the newly created account.
web3.eth.personal.newAccount('!@superpassword')
.then(console.log);
> '0x1234567891011121314151617181920212223456'web3.eth.personal.sign(dataToSign, address, password [, callback])Signs data using a specific account. This data is before UTF-8 HEX decoded and enveloped as follows: "\x19Ethereum Signed Message:\n" + message.length + message.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
String- Data to sign. If String it will be converted usingweb3.utils.utf8ToHex <utils-utf8tohex>.String- Address to sign data with.String- The password of the account to sign data with.Function- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<string> - The signature.
web3.eth.personal.sign("Hello world", "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!")
.then(console.log);
> "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"
// the below is the same
web3.eth.personal.sign(web3.utils.utf8ToHex("Hello world"), "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!")
.then(console.log);
> "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"web3.eth.personal.ecRecover(dataThatWasSigned, signature [, callback])Recovers the account that signed the data.
String- Data that was signed. If String it will be converted usingweb3.utils.utf8ToHex <utils-utf8tohex>.String- The signature.Function- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<string> - The account.
web3.eth.personal.ecRecover("Hello world", "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400").then(console.log);
> "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"web3.eth.personal.signTransaction(transaction, password [, callback])Signs a transaction. This account needs to be unlocked.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
Object- The transaction data to signweb3.eth.sendTransaction() <eth-sendtransaction>for more.String- The password of thefromaccount, to sign the transaction with.Function- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<Object> - The RLP encoded transaction. The raw property can be used to send the transaction using web3.eth.sendSignedTransaction <eth-sendsignedtransaction>.
web3.eth.signTransaction({
from: "0xEB014f8c8B418Db6b45774c326A0E64C78914dC0",
gasPrice: "20000000000",
gas: "21000",
to: '0x3535353535353535353535353535353535353535',
value: "1000000000000000000",
data: ""
}, 'MyPassword!').then(console.log);
> {
raw: '0xf86c808504a817c800825208943535353535353535353535353535353535353535880de0b6b3a76400008025a04f4c17305743700648bc4f6cd3038ec6f6af0df73e31757007b7f59df7bee88da07e1941b264348e80c78c4027afc65a87b0a5e43e86742b8ca0823584c6788fd0',
tx: {
nonce: '0x0',
gasPrice: '0x4a817c800',
gas: '0x5208',
to: '0x3535353535353535353535353535353535353535',
value: '0xde0b6b3a7640000',
input: '0x',
v: '0x25',
r: '0x4f4c17305743700648bc4f6cd3038ec6f6af0df73e31757007b7f59df7bee88d',
s: '0x7e1941b264348e80c78c4027afc65a87b0a5e43e86742b8ca0823584c6788fd0',
hash: '0xda3be87732110de6c1354c83770aae630ede9ac308d9f7b399ecfba23d923384'
}
}web3.eth.personal.sendTransaction(transactionOptions, password [, callback])This method sends a transaction over the management API.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
Object- The transaction optionsString- The passphrase for the current accountFunction- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<string> - The transaction hash.
web3.eth.sendTransaction({
from: "0xEB014f8c8B418Db6b45774c326A0E64C78914dC0",
gasPrice: "20000000000",
gas: "21000",
to: '0x3535353535353535353535353535353535353535',
value: "1000000000000000000",
data: ""
}, 'MyPassword!').then(console.log);
> '0xda3be87732110de6c1354c83770aae630ede9ac308d9f7b399ecfba23d923384'web3.eth.personal.unlockAccount(address, password, unlockDuraction [, callback])Unlocks the given account.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
address-String: The account address.password-String- The password of the account.unlockDuration-Number- The duration for the account to remain unlocked.Function- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<boolean> - True if the account got unlocked successful otherwise false.
web3.eth.personal.unlockAccount("0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!", 600)
.then(console.log('Account unlocked!'));
> "Account unlocked!"web3.eth.personal.lockAccount(address [, callback])Locks the given account.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
address-String: The account address.Function- (optional) Optional callback, returns an error object as first parameter and the result as second.
Promise<boolean>
web3.eth.personal.lockAccount("0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe")
.then(console.log('Account locked!'));
> "Account locked!"web3.eth.personal.getAccounts([callback])Returns a list of accounts the node controls by using the provider and calling the RPC method personal_listAccounts. Using web3.eth.accounts.create() <accounts-create> will not add accounts into this list. For that use web3.eth.personal.newAccount() <personal-newaccount>.
The results are the same as web3.eth.getAccounts() <eth-getaccounts> except that calls the RPC method eth_accounts.
Promise<Array> - An array of addresses controlled by node.
web3.eth.personal.getAccounts()
.then(console.log);
> ["0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "0xDCc6960376d6C6dEa93647383FfB245CfCed97Cf"]web3.eth.personal.importRawKey(privateKey, password)Imports the given private key into the key store, encrypting it with the passphrase.
Returns the address of the new account.
Note
Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
privateKey-String- An unencrypted private key (hex string).password-String- The password of the account.
Promise<string> - The address of the account.
web3.eth.personal.importRawKey("cd3376bb711cb332ee3fb2ca04c6a8b9f70c316fcdf7a1f44ef4c7999483295e", "password1234")
.then(console.log);
> "0x8f337bf484b2fc75e4b0436645dcc226ee2ac531"