-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
Accounts.js
284 lines (251 loc) · 7.78 KB
/
Accounts.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file Accounts.js
* @author Samuel Furter <samuel@ethereum.org>, Fabian Vogelsteller <fabian@ethereum.org>
* @date 2017
*/
import isFunction from 'lodash/isFunction';
import isObject from 'lodash/isObject';
import Hash from 'eth-lib/lib/hash';
import RLP from 'eth-lib/lib/rlp';
import Bytes from 'eth-lib/lib/bytes';
import {encodeSignature, recover} from 'eth-lib/lib/account'; // TODO: Remove this dependency
import {AbstractWeb3Module} from 'web3-core';
import Account from './models/Account';
import Wallet from './models/Wallet';
// TODO: Rename Accounts module to Wallet and move the Wallet class to the eth module.
export default class Accounts extends AbstractWeb3Module {
/**
* @param {Web3EthereumProvider|HttpProvider|WebsocketProvider|IpcProvider|String} provider
* @param {Object} formatters
* @param {Utils} utils
* @param {MethodFactory} methodFactory
* @param {Object} options
* @param {Net.Socket} net
*
* @constructor
*/
constructor(provider, utils, formatters, methodFactory, options, net) {
super(provider, options, methodFactory, net);
this.utils = utils;
this.formatters = formatters;
this._transactionSigner = options.transactionSigner;
this.defaultKeyName = 'web3js_wallet';
this.accounts = {};
this.accountsIndex = 0;
this.wallet = new Wallet(utils, this);
}
/**
* Getter for the transactionSigner property
*
* @property transactionSigner
*
* @returns {TransactionSigner}
*/
get transactionSigner() {
return this._transactionSigner;
}
/**
* TODO: Remove setter
*
* Setter for the transactionSigner property
*
* @property transactionSigner
*
* @param {TransactionSigner} transactionSigner
*/
set transactionSigner(transactionSigner) {
if (transactionSigner.type && transactionSigner.type === 'TransactionSigner') {
throw new Error('Invalid TransactionSigner given!');
}
this._transactionSigner = transactionSigner;
}
/**
* Creates an account with a given entropy
*
* @method create
*
* @param {String} entropy
*
* @returns {Account}
*/
create(entropy) {
return Account.from(entropy, this);
}
/**
* Creates an Account object from a privateKey
*
* @method privateKeyToAccount
*
* @param {String} privateKey
*
* @returns {Account}
*/
privateKeyToAccount(privateKey) {
return Account.fromPrivateKey(privateKey, this);
}
/**
* Hashes a given message
*
* @method hashMessage
*
* @param {String} data
*
* @returns {String}
*/
hashMessage(data) {
if (this.utils.isHexStrict(data)) {
data = this.utils.hexToBytes(data);
}
const messageBuffer = Buffer.from(data);
const preambleBuffer = Buffer.from(`\u0019Ethereum Signed Message:\n${data.length}`);
const ethMessage = Buffer.concat([preambleBuffer, messageBuffer]);
return Hash.keccak256s(ethMessage);
}
/**
* TODO: Add deprecation message and extend the signTransaction method in the eth module
*
* Signs a transaction object with the given privateKey
*
* @method signTransaction
*
* @param {Object} tx
* @param {String} privateKey
* @param {Function} callback
*
* @callback callback callback(error, result)
* @returns {Promise<Object>}
*/
async signTransaction(tx, privateKey, callback) {
try {
const account = Account.fromPrivateKey(privateKey, this);
if (!tx.chainId) {
tx.chainId = await this.getChainId();
}
if (!tx.gasPrice) {
tx.gasPrice = await this.getGasPrice();
}
if (!tx.nonce && tx.nonce !== 0) {
tx.nonce = await this.getTransactionCount(account.address);
}
const signedTransaction = await this.transactionSigner.sign(
this.formatters.inputCallFormatter(tx, this),
account.privateKey
);
if (isFunction(callback)) {
callback(false, signedTransaction);
}
return signedTransaction;
} catch (error) {
if (isFunction(callback)) {
callback(error, null);
return;
}
throw error;
}
}
/**
* Recovers transaction
*
* @method recoverTransaction
*
* @param {String} rawTx
*
* @returns {String}
*/
recoverTransaction(rawTx) {
const values = RLP.decode(rawTx);
const signature = encodeSignature(values.slice(6, 9));
const recovery = Bytes.toNumber(values[6]);
const extraData = recovery < 35 ? [] : [Bytes.fromNumber((recovery - 35) >> 1), '0x', '0x'];
const signingData = values.slice(0, 6).concat(extraData);
const signingDataHex = RLP.encode(signingData);
return recover(Hash.keccak256(signingDataHex), signature);
}
/**
* Signs a string with the given privateKey
*
* @method sign
*
* @param {String} data
* @param {String} privateKey
*
* @returns {Object}
*/
sign(data, privateKey) {
if (this.utils.isHexStrict(data)) {
data = this.utils.hexToBytes(data);
}
return Account.fromPrivateKey(privateKey, this).sign(data);
}
/**
* Recovers the Ethereum address which was used to sign the given data.
*
* @method recover
*
* @param {String|Object} message
* @param {String} signature
* @param {Boolean} preFixed
*
* @returns {String}
*/
recover(message, signature, preFixed) {
if (isObject(message)) {
return this.recover(message.messageHash, encodeSignature([message.v, message.r, message.s]), true);
}
if (!preFixed) {
message = this.hashMessage(message);
}
if (arguments.length >= 4) {
// v, r, s
return this.recover(
arguments[0],
encodeSignature([arguments[1], arguments[2], arguments[3]]),
!!arguments[4]
);
}
return recover(message, signature);
}
/**
* Decrypts account
*
* Note: Taken from https://github.com/ethereumjs/ethereumjs-wallet
*
* @method decrypt
*
* @param {Object|String} v3Keystore
* @param {String} password
* @param {Boolean} nonStrict
*
* @returns {Account}
*/
decrypt(v3Keystore, password, nonStrict) {
return Account.fromV3Keystore(v3Keystore, password, nonStrict, this);
}
/**
* Encrypts the account
*
* @method encrypt
*
* @param {String} privateKey
* @param {String} password
* @param {Object} options
*
* @returns {Object}
*/
encrypt(privateKey, password, options) {
return Account.fromPrivateKey(privateKey, this).toV3Keystore(password, options);
}
}