The rsk3-personal package allows you to interact with the Rsk
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 {Personal} from '@rsksmart/rsk3-personal';
const personal = new Personal('ws://some.local-or-remote.node:8546', null, options);
// -> rsk3.personal
A Rsk3 module does provide several options for configuring the transaction confirmation worklfow or for defining default values. These are the currently available option properties on a Rsk3 module:
defaultAccount
defaultBlock
defaultGas
defaultGasPrice
transactionBlockTimeout
transactionConfirmationBlocks
transactionPollingTimeout
transactionSigner
import {Rsk3} from 'rsk3';
const options = {
defaultAccount: '0x0',
defaultBlock: 'latest',
defaultGas: 1,
defaultGasPrice: 0,
transactionBlockTimeout: 50,
transactionConfirmationBlocks: 24,
transactionPollingTimeout: 480,
transactionSigner: new CustomTransactionSigner()
}
const rsk3 = new Rsk3('http://localhost:8545', null, options);
rsk3.defaultBlock
...
The default block is used for all methods which have a block parameter. You can override it by passing the block parameter if a block is required.
Example:
rsk3.getBalance()rsk3.getCode()rsk3.getTransactionCount()rsk3.getStorageAt()rsk3.call()new rsk3.Contract() -> myContract.methods.myMethod().call()The defaultBlock property can return the following values:
Number: A block number"genesis" - String: The genesis block"latest" - String: The latest block (current head of the
blockchain)"pending" - String: The currently mined block (including pending
transactions)Default is "latest"
rsk3.defaultAccount
...
This default address is used as the default "from" property, if no
"from" property is specified.
String - 20 Bytes: Any Rsk address. You need to have the private
key for that address in your node or keystore. (Default is undefined)
rsk3.defaultGasPrice
...
The default gas price which will be used for a request.
string|number: The current value of the defaultGasPrice property.
rsk3.defaultGas
...
The default gas which will be used for a request.
string|number: The current value of the defaultGas property.
rsk3.transactionBlockTimeout
...
The transactionBlockTimeout will be used over a socket based
connection. This option does define the amount of new blocks it should
wait until the first confirmation happens. This means the PromiEvent
rejects with a timeout error when the timeout got exceeded.
number: The current value of transactionBlockTimeout
rsk3.transactionConfirmationBlocks
...
This defines the number of blocks it requires until a transaction will be handled as confirmed.
number: The current value of transactionConfirmationBlocks
rsk3.transactionPollingTimeout
...
The transactionPollingTimeout will be used over a HTTP connection.
This option does define the amount of polls (each second) it should wait
until the first confirmation happens.
number: The current value of transactionPollingTimeout
rsk3.transactionSigner
...
The transactionSigner property does provide us the possibility to
customize the signing process of the Eth module and the related
sub-modules.
The interface of a TransactionSigner:
interface TransactionSigner {
sign(txObject: Transaction): Promise<SignedTransaction>
}
interface SignedTransaction {
messageHash: string,
v: string,
r: string,
s: string,
rawTransaction: string
}
TransactionSigner: A JavaScript class of type TransactionSigner.
rsk3.setProvider(myProvider)
...
Will change the provider for its module.
Object|String - provider: a valid providerNet - net: (optional) the node.js Net package. This is only
required for the IPC provider.Boolean
Rsk3.providers
...
Contains the current available providers.
Object with the following providers:
Object-HttpProvider: The HTTP provider is deprecated, as it won't work for subscriptions.Object-WebsocketProvider: The Websocket provider is the standard for usage in legacy browsers.Object-IpcProvider: The IPC provider is used node.js dapps when running a local node. Gives the most secure connection.
rsk3.givenProvider
...
When using rsk3.js in an Rsk compatible browser, it will set with
the current native provider by that browser. Will return the given
provider by the (browser) environment, otherwise null.
Object: The given provider set or false.
rsk3.currentProvider
...
Will return the current provider.
Object: The current provider set.
new rsk3.BatchRequest()
...
Class to create and execute batch requests.
none
Object: With the following methods:
add(request): To add a request object to the batch call.execute(): Will execute the batch request.
rsk3.personal.newAccount(password, [callback])
Create a new account on the node that Rsk3 is connected to with its
provider. The RPC method used is personal_newAccount. It differs from
rsk3.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.
rsk3.personal.newAccount('!@superpassword')
.then(console.log);
> '0x1234567891011121314151617181920212223456'
rsk3.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 using
rsk3.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.
rsk3.personal.sign("Hello world", "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!")
.then(console.log);
> "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"
// the below is the same
rsk3.personal.sign(rsk3.utils.utf8ToHex("Hello world"), "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!")
.then(console.log);
> "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"
rsk3.personal.ecRecover(dataThatWasSigned, signature [, callback])
Recovers the account that signed the data.
String - Data that was signed. If String it will be converted
using rsk3.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.
rsk3.personal.ecRecover("Hello world", "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400").then(console.log);
> "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"
rsk3.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 sign
rsk3.sendTransaction() for more.String - The password of the from account, 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
rsk3.sendSignedTransaction
rsk3.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'
}
}
rsk3.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.
rsk3.sendTransaction({
from: "0xEB014f8c8B418Db6b45774c326A0E64C78914dC0",
gasPrice: "20000000000",
gas: "21000",
to: '0x3535353535353535353535353535353535353535',
value: "1000000000000000000",
data: ""
}, 'MyPassword!').then(console.log);
> '0xda3be87732110de6c1354c83770aae630ede9ac308d9f7b399ecfba23d923384'
rsk3.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.
rsk3.personal.unlockAccount("0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "test password!", 600)
.then(console.log('Account unlocked!'));
> "Account unlocked!"
rsk3.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>
rsk3.personal.lockAccount("0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe")
.then(console.log('Account locked!'));
> "Account locked!"
rsk3.personal.getAccounts([callback])
Returns a list of accounts the node controls by using the provider and
calling the RPC method personal_listAccounts. Using
rsk3.accounts.create() will not add accounts into this list. For that use
rsk3.personal.newAccount()
The results are the same as
rsk3.getAccounts()
except that calls the RPC method eth_accounts.
Promise<Array> - An array of addresses controlled by node.
rsk3.personal.getAccounts()
.then(console.log);
> ["0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe", "0xDCc6960376d6C6dEa93647383FfB245CfCed97Cf"]
rsk3.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.
rsk3.personal.importRawKey("cd3376bb711cb332ee3fb2ca04c6a8b9f70c316fcdf7a1f44ef4c7999483295e", "password1234")
.then(console.log);
> "0x8f337bf484b2fc75e4b0436645dcc226ee2ac531"
Go to top