From 27b874f2c48fd1cb9dc0984646cb739173ddaf2c Mon Sep 17 00:00:00 2001
From: kumavis <kumavis@users.noreply.github.com>
Date: Thu, 15 Jun 2017 14:08:07 -0700
Subject: transactions controller - add comments

---
 app/scripts/controllers/transactions.js | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'app/scripts/controllers/transactions.js')

diff --git a/app/scripts/controllers/transactions.js b/app/scripts/controllers/transactions.js
index 41f651458..aa168b736 100644
--- a/app/scripts/controllers/transactions.js
+++ b/app/scripts/controllers/transactions.js
@@ -26,6 +26,7 @@ module.exports = class TransactionController extends EventEmitter {
     this.txProviderUtils = new TxProviderUtil(this.query)
     this.blockTracker.on('block', this.checkForTxInBlock.bind(this))
     this.blockTracker.on('block', this.resubmitPendingTxs.bind(this))
+    // provider-engine only exploses the 'block' event, not 'latest' for 'sync'
     this.provider._blockTracker.on('sync', this.queryPendingTxs.bind(this))
     this.signEthTx = opts.signTransaction
     this.nonceLock = Semaphore(1)
@@ -371,10 +372,12 @@ module.exports = class TransactionController extends EventEmitter {
   }
 
   queryPendingTxs ({oldBlock, newBlock}) {
+    // check pending transactions on start
     if (!oldBlock) {
       this._checkPendingTxs()
       return
     }
+    // if we synced by more than one block, check for missed pending transactions
     const diff = Number.parseInt(newBlock.number) - Number.parseInt(oldBlock.number)
     if (diff > 1) this._checkPendingTxs()
   }
@@ -453,6 +456,8 @@ module.exports = class TransactionController extends EventEmitter {
     this.txProviderUtils.publishTransaction(rawTx, cb)
   }
 
+  // checks the network for signed txs and
+  // if confirmed sets the tx status as 'confirmed'
   _checkPendingTxs () {
     var signedTxList = this.getFilteredTxList({status: 'submitted'})
     if (!signedTxList.length) return
-- 
cgit