-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
AbstractWeb3Module.js
321 lines (288 loc) · 8.22 KB
/
AbstractWeb3Module.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/*
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 AbstractWeb3Module.js
* @author Samuel Furter <samuel@ethereum.org>
* @date 2018
*/
import isObject from 'lodash/isObject';
import {
HttpProvider,
WebsocketProvider,
IpcProvider,
BatchRequest,
ProviderDetector,
ProviderResolver
} from 'web3-providers';
import {MethodProxy} from 'web3-core-method';
import {toChecksumAddress} from 'web3-utils';
export default class AbstractWeb3Module {
/**
* @param {AbstractSocketProvider|HttpProvider|String|EthereumProvider} provider
* @param {Object} options
* @param {MethodFactory} methodFactory
* @param {Net.Socket} nodeNet
*
* @constructor
*/
constructor(provider, options = {}, methodFactory = null, nodeNet = null) {
// ProviderDetector and ProviderResolver are created in the constructor for providing a simpler Web3 Module API.
this.providerResolver = new ProviderResolver();
this.givenProvider = ProviderDetector.detect();
this._currentProvider = this.providerResolver.resolve(provider, nodeNet);
this._defaultAccount = options.defaultAccount ? toChecksumAddress(options.defaultAccount) : undefined;
this._defaultBlock = options.defaultBlock || 'latest';
this._transactionBlockTimeout = options.transactionBlockTimeout || 50;
this._transactionConfirmationBlocks = options.transactionConfirmationBlocks || 24;
this._transactionPollingTimeout = options.transactionPollingTimeout || 750;
this._defaultGasPrice = options.defaultGasPrice;
this._defaultGas = options.defaultGas;
this.BatchRequest = () => {
return new BatchRequest(this);
};
if (methodFactory) {
return new MethodProxy(this, methodFactory);
}
}
/**
* Getter for the defaultBlock property
*
* @property defaultBlock
*
* @returns {String|Number}
*/
get defaultBlock() {
return this._defaultBlock;
}
/**
* Setter for the defaultAccount property
*
* @property defaultBlock
*
* @param {String|Number} value
*/
set defaultBlock(value) {
this._defaultBlock = value;
}
/**
* Getter for the transactionBlockTimeout property
*
* @property transactionBlockTimeout
*
* @returns {Number}
*/
get transactionBlockTimeout() {
return this._transactionBlockTimeout;
}
/**
* Setter for the transactionBlockTimeout property
*
* @property transactionBlockTimeout
*
* @param {Number} value
*/
set transactionBlockTimeout(value) {
this._transactionBlockTimeout = value;
}
/**
* Getter for the transactionConfirmationBlocks property
*
* @property transactionConfirmationBlocks
*
* @returns {Number}
*/
get transactionConfirmationBlocks() {
return this._transactionConfirmationBlocks;
}
/**
* Setter for the transactionConfirmationBlocks property
*
* @property transactionConfirmationBlocks
*
* @param {Number} value
*/
set transactionConfirmationBlocks(value) {
this._transactionConfirmationBlocks = value;
}
/**
* Getter for the transactionPollingTimeout property
*
* @property transactionPollingTimeout
*
* @returns {Number}
*/
get transactionPollingTimeout() {
return this._transactionPollingTimeout;
}
/**
* Setter for the transactionPollingTimeout property
*
* @property transactionPollingTimeout
*
* @param {Number} value
*/
set transactionPollingTimeout(value) {
this._transactionPollingTimeout = value;
}
/**
* Getter for the defaultGasPrice property
*
* @property defaultGasPrice
*
* @returns {Number|String}
*/
get defaultGasPrice() {
return this._defaultGasPrice;
}
/**
* Setter for the defaultGasPrice property
*
* @property defaultGasPrice
*
* @param {Number|String} value
*/
set defaultGasPrice(value) {
this._defaultGasPrice = value;
}
/**
* Getter for the defaultGas property
*
* @property defaultGas
*
* @returns {Number|String}
*/
get defaultGas() {
return this._defaultGas;
}
/**
* Setter for the defaultGas property
*
* @property defaultGas
*
* @param {Number|String} value
*/
set defaultGas(value) {
this._defaultGas = value;
}
/**
* Returns a object with factory methods for the Web3 providers.
*
* @property providers
*
* @returns {Object}
*/
static get providers() {
return {
HttpProvider,
WebsocketProvider,
IpcProvider
};
}
/**
* Getter for the defaultAccount property
*
* @property defaultAccount
*
* @returns {null|String}
*/
get defaultAccount() {
return this._defaultAccount;
}
/**
* TODO: Add utils and formatters as dependency or create the core-types module and pass the factory to the
* TODO: AbstractWeb3Module (factory.createAddress())
*
* Sets the defaultAccount of the current object
*
* @property defaultAccount
*
* @param {String} value
*/
set defaultAccount(value) {
this._defaultAccount = toChecksumAddress(value);
}
/**
* Returns the currentProvider
*
* @property currentProvider
*
* @returns {AbstractSocketProvider|HttpProvider|CustomProvider}
*/
get currentProvider() {
return this._currentProvider;
}
/**
* Throws an error because currentProvider is read-only
*
* @property currentProvider
*/
set currentProvider(value) {
throw new Error('The property currentProvider is read-only!');
}
/**
* Sets the currentProvider and provider property
*
* @method setProvider
*
* @param {Web3EthereumProvider|HttpProvider|WebsocketProvider|IpcProvider|String} provider
* @param {Net} net
*
* @returns {Boolean|Error}
*/
setProvider(provider, net) {
if (!this.isSameProvider(provider)) {
const resolvedProvider = this.providerResolver.resolve(provider, net);
this.clearSubscriptions();
this._currentProvider = resolvedProvider;
return true;
}
return false;
}
/**
* Checks if the given provider is the same as the currentProvider
*
* @method isSameProvider
*
* @param {Web3EthereumProvider|HttpProvider|WebsocketProvider|IpcProvider|String} provider
*
* @returns {Boolean}
*/
isSameProvider(provider) {
if (isObject(provider)) {
if (this.currentProvider && this.currentProvider.constructor.name === provider.constructor.name) {
return this.currentProvider.host === provider.host;
}
return false;
}
return this.currentProvider.host === provider;
}
/**
* Clears all subscriptions and listeners
*
* @method clearSubscriptions
*
* @param {String} unsubscribeMethod
*
* @returns {Promise<Boolean|Error>}
*/
clearSubscriptions(unsubscribeMethod) {
if (
typeof this.currentProvider.clearSubscriptions !== 'undefined' &&
this.currentProvider.subscriptions.length > 0
) {
return this.currentProvider.clearSubscriptions(unsubscribeMethod);
}
return Promise.resolve(true);
}
}