From a555a8a374743c4e4be3647110e664dd3d799432 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Wed, 21 Mar 2018 18:24:45 +0000
Subject: Improve subproviders comment

---
 packages/subproviders/src/subproviders/empty_wallet_subprovider.ts      | 2 +-
 packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts | 2 +-
 packages/subproviders/src/subproviders/ganache.ts                       | 2 +-
 packages/subproviders/src/subproviders/injected_web3.ts                 | 2 +-
 packages/subproviders/src/subproviders/nonce_tracker.ts                 | 2 +-
 packages/subproviders/src/subproviders/redundant_rpc.ts                 | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'packages')

diff --git a/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts b/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts
index 38972b6cf..4cf3ece69 100644
--- a/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts
+++ b/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts
@@ -9,7 +9,7 @@ import { Subprovider } from './subprovider';
  * It intercepts the `eth_accounts` JSON RPC requests and never returns any addresses when queried.
  */
 export class EmptyWalletSubprovider extends Subprovider {
-    // This method needs to be here to satisfy the interface but linter wants it to be static.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private handleRequest(payload: Web3.JSONRPCRequestPayload, next: Callback, end: ErrorCallback) {
         switch (payload.method) {
diff --git a/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts b/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts
index 8241e58f2..eff4439b4 100644
--- a/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts
+++ b/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts
@@ -23,7 +23,7 @@ export class FakeGasEstimateSubprovider extends Subprovider {
         super();
         this._constantGasAmount = constantGasAmount;
     }
-    // This method needs to be here to satisfy the interface but linter wants it to be static.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private handleRequest(payload: Web3.JSONRPCRequestPayload, next: Callback, end: ErrorCallback) {
         switch (payload.method) {
diff --git a/packages/subproviders/src/subproviders/ganache.ts b/packages/subproviders/src/subproviders/ganache.ts
index 22ac5e1e2..feb17f8c5 100644
--- a/packages/subproviders/src/subproviders/ganache.ts
+++ b/packages/subproviders/src/subproviders/ganache.ts
@@ -19,7 +19,7 @@ export class GanacheSubprovider extends Subprovider {
         super();
         this._ganacheProvider = Ganache.provider(opts);
     }
-    // This method needs to be here to satisfy the interface but linter wants it to be static.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private handleRequest(payload: Web3.JSONRPCRequestPayload, next: Callback, end: ErrorCallback) {
         this._ganacheProvider.sendAsync(payload, (err: Error | null, result: any) => {
diff --git a/packages/subproviders/src/subproviders/injected_web3.ts b/packages/subproviders/src/subproviders/injected_web3.ts
index 3e3744d5c..73c7e59db 100644
--- a/packages/subproviders/src/subproviders/injected_web3.ts
+++ b/packages/subproviders/src/subproviders/injected_web3.ts
@@ -21,7 +21,7 @@ export class InjectedWeb3Subprovider extends Subprovider {
         super();
         this._injectedWeb3 = new Web3(provider);
     }
-    // This method needs to be here to satisfy the interface but linter wants it to be static.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private handleRequest(payload: Web3.JSONRPCRequestPayload, next: Callback, end: ErrorCallback) {
         switch (payload.method) {
diff --git a/packages/subproviders/src/subproviders/nonce_tracker.ts b/packages/subproviders/src/subproviders/nonce_tracker.ts
index b51ba4ac8..919aa861f 100644
--- a/packages/subproviders/src/subproviders/nonce_tracker.ts
+++ b/packages/subproviders/src/subproviders/nonce_tracker.ts
@@ -46,7 +46,7 @@ export class NonceTrackerSubprovider extends Subprovider {
                 throw new Error(NonceSubproviderErrors.CannotDetermineAddressFromPayload);
         }
     }
-    // Required to implement this public interface which doesn't conform to our linting rule.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private async handleRequest(
         payload: Web3.JSONRPCRequestPayload,
diff --git a/packages/subproviders/src/subproviders/redundant_rpc.ts b/packages/subproviders/src/subproviders/redundant_rpc.ts
index 2b84d223b..55b4128f4 100644
--- a/packages/subproviders/src/subproviders/redundant_rpc.ts
+++ b/packages/subproviders/src/subproviders/redundant_rpc.ts
@@ -45,7 +45,7 @@ export class RedundantRPCSubprovider extends Subprovider {
             });
         });
     }
-    // Required to implement this public interface which doesn't conform to our linting rule.
+    // This method must conform to the web3-provider-engine interface
     // tslint:disable-next-line:prefer-function-over-method underscore-private-and-protected
     private async handleRequest(
         payload: Web3.JSONRPCRequestPayload,
-- 
cgit v1.2.3