From 74c6de7d23c979c091028d8bd599f389e2090bc1 Mon Sep 17 00:00:00 2001
From: Dan Finlay <dan@danfinlay.com>
Date: Thu, 7 Sep 2017 12:45:00 -0700
Subject: [PATCH] Add constructor comment

---
 app/scripts/lib/pending-balance-calculator.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/app/scripts/lib/pending-balance-calculator.js b/app/scripts/lib/pending-balance-calculator.js
index e4ff1e050..d5e2e4c17 100644
--- a/app/scripts/lib/pending-balance-calculator.js
+++ b/app/scripts/lib/pending-balance-calculator.js
@@ -4,6 +4,11 @@ const normalize = require('eth-sig-util').normalize
 
 class PendingBalanceCalculator {
 
+  // Must be initialized with two functions:
+  // getBalance => Returns a promise of a BN of the current balance in Wei
+  // getPendingTransactions => Returns an array of TxMeta Objects,
+  // which have txParams properties, which include value, gasPrice, and gas,
+  // all in a base=16 hex format.
   constructor ({ getBalance, getPendingTransactions }) {
     this.getPendingTransactions = getPendingTransactions
     this.getNetworkBalance = getBalance