From 003f1306d3a3bb6f35335f63964910f06f5bbc20 Mon Sep 17 00:00:00 2001
From: Mark Stacey <markjstacey@gmail.com>
Date: Thu, 15 Oct 2020 13:09:13 -0230
Subject: [PATCH] Split the account tracker doc comments (#9574)

The account tracker had one doc comment above the constructor that
partially served to document the constructor, but mostly contained a
type definition for the class itself. It has been split into two
blocks; one for the class, one for the constructor. The constructor doc
comment has also been expanded to document all constructor options.
---
 app/scripts/lib/account-tracker.js | 37 +++++++++++++++++-------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/app/scripts/lib/account-tracker.js b/app/scripts/lib/account-tracker.js
index 599baa86c..bb5563606 100644
--- a/app/scripts/lib/account-tracker.js
+++ b/app/scripts/lib/account-tracker.js
@@ -24,25 +24,30 @@ import {
 } from '../controllers/network/contract-addresses'
 import { bnToHex } from './util'
 
+/**
+ * This module is responsible for tracking any number of accounts and caching their current balances & transaction
+ * counts.
+ *
+ * It also tracks transaction hashes, and checks their inclusion status on each new block.
+ *
+ * @typedef {Object} AccountTracker
+ * @property {Object} store The stored object containing all accounts to track, as well as the current block's gas limit.
+ * @property {Object} store.accounts The accounts currently stored in this AccountTracker
+ * @property {string} store.currentBlockGasLimit A hex string indicating the gas limit of the current block
+ * @property {Object} _provider A provider needed to create the EthQuery instance used within this AccountTracker.
+ * @property {EthQuery} _query An EthQuery instance used to access account information from the blockchain
+ * @property {BlockTracker} _blockTracker A BlockTracker instance. Needed to ensure that accounts and their info updates
+ * when a new block is created.
+ * @property {Object} _currentBlockNumber Reference to a property on the _blockTracker: the number (i.e. an id) of the the current block
+ *
+ */
 export default class AccountTracker {
 
   /**
-   * This module is responsible for tracking any number of accounts and caching their current balances & transaction
-   * counts.
-   *
-   * It also tracks transaction hashes, and checks their inclusion status on each new block.
-   *
-   * @typedef {Object} AccountTracker
-   * @param {Object} opts - Initialize various properties of the class.
-   * @property {Object} store The stored object containing all accounts to track, as well as the current block's gas limit.
-   * @property {Object} store.accounts The accounts currently stored in this AccountTracker
-   * @property {string} store.currentBlockGasLimit A hex string indicating the gas limit of the current block
-   * @property {Object} _provider A provider needed to create the EthQuery instance used within this AccountTracker.
-   * @property {EthQuery} _query An EthQuery instance used to access account information from the blockchain
-   * @property {BlockTracker} _blockTracker A BlockTracker instance. Needed to ensure that accounts and their info updates
-   * when a new block is created.
-   * @property {Object} _currentBlockNumber Reference to a property on the _blockTracker: the number (i.e. an id) of the the current block
-   *
+   * @param {Object} opts - Options for initializing the controller
+   * @param {Object} opts.provider - An EIP-1193 provider instance that uses the current global network
+   * @param {Object} opts.blockTracker - A block tracker, which emits events for each new block
+   * @param {Function} opts.getCurrentChainId - A function that returns the `chainId` for the current global network
    */
   constructor (opts = {}) {
     const initState = {