Transaction confirmation workflow improvements

jest.config.js

@@ -9,7 +9,6 @@ const config = {
     transform: {
         '^.+\\.js$': '<rootDir>/../../jest.preprocessor.js'
     },
-    transformIgnorePatterns: ['node_modules/(?!(underscore-es)/)'],
     bail: true
 };
 

packages/web3-core-method/README.md

@@ -10,97 +10,6 @@ The Method module abstracts the JSON-RPC method and is used within most [web3.js
 npm install web3-core-method
 ```
 
-## Exported classes
-
- ``` js
- MethodModuleFactory
- AbstractMethod 
- AbstractMethodFactory
-
- /**
- * Methods
- */
-
- // Network
- GetProtocolVersionMethod 
- VersionMethod 
- ListeningMethod 
- PeerCountMethod 
-
- // Node
- GetNodeInfoMethod
- GetCoinbaseMethod
- IsMiningMethod 
- GetHashrateMethod
- IsSyncingMethod
- GetGasPriceMethod
- SubmitWorkMethod
- GetWorkMethod
-
- // Account
- GetAccountsMethod
- GetBalanceMethod
- GetTransactionCountMethod
- RequestAccountsMethod
-
- // Block
- GetBlockNumberMethod
- GetBlockMethod 
- GetUncleMethod 
- GetBlockTransactionCountMethod
- GetBlockUncleCountMethod
-
- // Transaction
- GetTransactionMethod
- GetTransactionFromBlockMethod
- GetTransactionReceipt
- SendRawTransactionMethod
- SignTransactionMethod
- SendTransactionMethod
-
- // Global
- GetCodeMethod
- SignMethod
- CallMethod
- GetStorageAtMethod
- EstimateGasMethod
- GetPastLogsMethod
-
- // Personal
- EcRecoverMethod
- ImportRawKeyMethod
- ListAccountsMethod
- LockAccountMethod
- NewAccountMethod
- PersonalSendTransactionMethod
- PersonalSignMethod
- PersonalSignTransactionMethod
- UnlockAccountMethod
-
- // SHH
- AddPrivateKeyMethod
- AddSymKeyMethod
- DeleteKeyPairMethod
- DeleteMessageFilterMethod
- DeleteSymKeyMethod
- GenerateSymKeyFromPasswordMethod
- GetFilterMessagesMethod
- GetInfoMethod
- GetPrivateKeyMethod
- GetPublicKeyMethod
- GetSymKeyMethod
- HasKeyPairMethod
- HasSymKeyMethod
- MarkTrustedPeerMethod
- NewKeyPairMethod
- NewMessageFilterMethod
- NewSymKeyMethod
- PostMethod
- SetMaxMessageSizeMethod
- SetMinPoWMethod
- ShhVersionMethod
-```
-
 ## Types 
 
 All the typescript typings are placed in the types folder. 

packages/web3-core-method/jest.config.js

@@ -6,8 +6,5 @@ module.exports = jestConfig({
     'AbstractWeb3Module': 'web3-core',
     'Utils': 'web3-utils',
     'formatters': 'web3-core-helpers',
-    'PromiEvent': 'web3-core-promievent',
-    'Subscription': 'web3-core-subscriptions',
-    'SubscriptionsFactory': 'web3-core-subscriptions',
     'AbstractSubscription': 'web3-core-subscriptions'
 });

packages/web3-core-promievent/src/PromiEvent.js → packages/web3-core-method/lib/PromiEvent.js

@@ -16,14 +16,13 @@
 */
 /**
  * @file PromiEvent.js
- * @author Samuel Furter <samuel@ethereum.org>
+ * @author Fabian Vogelsteller <fabian@ethereum.org>, Samuel Furter <samuel@ethereum.org>
  * @date 2018
  */
 
 import EventEmitter from 'eventemitter3';
 
-// TODO: Remove this module and use the EventEmitter or Promise separately. This kind of object could be implemented in
-// TODO: the AbstractSendMethod. I think the better way would be a API with just Observable and Promise objects.
+// TODO: add handleSuccess() and handleError() method instead of having them in the send method class
 export default class PromiEvent {
     /**
      * @constructor

packages/web3-core-method/lib/factories/AbstractMethodFactory.js

@@ -20,20 +20,19 @@
  * @date 2018
  */
 
-import SendRawTransactionMethod from '../../src/methods/transaction/SendRawTransactionMethod';
-import GetTransactionCountMethod from '../../src/methods/account/GetTransactionCountMethod';
-import ChainIdMethod from '../../src/methods/network/ChainIdMethod';
+import {NewHeadsSubscription} from 'web3-core-subscriptions';
+import GetBlockByNumberMethod from '../../src/methods/block/GetBlockByNumberMethod';
+import GetTransactionReceiptMethod from '../../src/methods/transaction/GetTransactionReceiptMethod';
+import TransactionObserver from '../../src/observers/TransactionObserver';
 
 export default class AbstractMethodFactory {
     /**
-     * @param {MethodModuleFactory} methodModuleFactory
      * @param {Utils} utils
      * @param {Object} formatters
      *
      * @constructor
      */
-    constructor(methodModuleFactory, utils, formatters) {
-        this.methodModuleFactory = methodModuleFactory;
+    constructor(utils, formatters) {
         this.utils = utils;
         this.formatters = formatters;
         this._methods = null;
@@ -79,41 +78,41 @@ export default class AbstractMethodFactory {
     }
 
     /**
-     * TODO: Find a cleaner way for the dependency resolution here.
-     *
      * Returns an MethodModel
      *
      * @param {String} name
+     * @param {AbstractWeb3Module} moduleInstance
      *
      * @returns {AbstractMethod}
      */
-    createMethod(name) {
+    createMethod(name, moduleInstance) {
         const method = this.methods[name];
 
-        /* eslint-disable new-cap */
-        switch (method.Type) {
-            case 'CALL':
-                return new method(this.utils, this.formatters);
-            case 'SEND':
-                if (method.name === 'SendTransactionMethod') {
-                    const transactionConfirmationWorkflow = this.methodModuleFactory.createTransactionConfirmationWorkflow();
+        if (method.Type === 'observed-transaction-method') {
+            let timeout = moduleInstance.transactionBlockTimeout;
+            const providerName = moduleInstance.currentProvider.constructor.name;
 
-                    return new method(
-                        this.utils,
-                        this.formatters,
-                        transactionConfirmationWorkflow,
-                        new SendRawTransactionMethod(this.utils, this.formatters, transactionConfirmationWorkflow),
-                        new ChainIdMethod(this.utils, this.formatters),
-                        new GetTransactionCountMethod(this.utils, this.formatters)
-                    );
-                }
+            if (providerName === 'HttpProvider' || providerName === 'CustomProvider') {
+                timeout = moduleInstance.transactionPollingTimeout;
+            }
 
-                return new method(
-                    this.utils,
-                    this.formatters,
-                    this.methodModuleFactory.createTransactionConfirmationWorkflow()
-                );
+            // eslint-disable-next-line new-cap
+            return new method(
+                this.utils,
+                this.formatters,
+                moduleInstance,
+                new TransactionObserver(
+                    moduleInstance.currentProvider,
+                    timeout,
+                    moduleInstance.transactionConfirmationBlocks,
+                    new GetTransactionReceiptMethod(this.utils, this.formatters, moduleInstance),
+                    new GetBlockByNumberMethod(this.utils, this.formatters, moduleInstance),
+                    new NewHeadsSubscription(this.utils, this.formatters, moduleInstance)
+                )
+            );
         }
-        /* eslint-enable new-cap */
+
+        // eslint-disable-next-line new-cap
+        return new method(this.utils, this.formatters, moduleInstance);
     }
 }

packages/web3-core-method/lib/methods/AbstractMethod.js

@@ -23,21 +23,21 @@
 import isFunction from 'lodash/isFunction';
 import isString from 'lodash/isString';
 import cloneDeep from 'lodash/cloneDeep';
-import {PromiEvent} from 'web3-core-promievent';
 
 export default class AbstractMethod {
     /**
      * @param {String} rpcMethod
      * @param {Number} parametersAmount
      * @param {Utils} utils
      * @param {Object} formatters
+     * @param {AbstractWeb3Module} moduleInstance
      *
      * @constructor
      */
-    constructor(rpcMethod, parametersAmount, utils, formatters) {
+    constructor(rpcMethod, parametersAmount, utils, formatters, moduleInstance) {
         this.utils = utils;
         this.formatters = formatters;
-        this.promiEvent = new PromiEvent();
+        this.moduleInstance = moduleInstance;
         this._arguments = {
             parameters: []
         };
@@ -68,15 +68,42 @@ export default class AbstractMethod {
     }
 
     /**
-     * Checks which command should be executed
+     * Sends a JSON-RPC call request
      *
      * @method execute
      *
-     * @param {AbstractWeb3Module} moduleInstance
-     *
-     * @returns {Promise<Object|String>|PromiEvent|String}
+     * @callback callback callback(error, result)
+     * @returns {Promise<Object|String>}
      */
-    execute(moduleInstance) {}
+    async execute() {
+        this.beforeExecution(this.moduleInstance);
+
+        if (this.parameters.length !== this.parametersAmount) {
+            throw new Error(
+                `Invalid Arguments length: expected: ${this.parametersAmount}, given: ${this.parameters.length}`
+            );
+        }
+
+        try {
+            let response = await this.moduleInstance.currentProvider.send(this.rpcMethod, this.parameters);
+
+            if (response) {
+                response = this.afterExecution(response);
+            }
+
+            if (this.callback) {
+                this.callback(false, response);
+            }
+
+            return response;
+        } catch (error) {
+            if (this.callback) {
+                this.callback(error, null);
+            }
+
+            throw error;
+        }
+    }
 
     /**
      * Setter for the rpcMethod property
@@ -189,6 +216,12 @@ export default class AbstractMethod {
             callback,
             parameters
         };
+
+        if (this.parameters.length !== this.parametersAmount) {
+            throw new Error(
+                `Invalid Arguments length: expected: ${this.parametersAmount}, given: ${this.parameters.length}`
+            );
+        }
     }
 
     /**
@@ -212,6 +245,6 @@ export default class AbstractMethod {
      * @returns {Boolean}
      */
     isHash(parameter) {
-        return isString(parameter) && parameter.indexOf('0x') === 0;
+        return isString(parameter) && parameter.startsWith('0x');
     }
 }