refactor incoming tx controller

[brad-decker]

Rationale

As a means of more deeply understanding what the incoming transaction controller does I set out to document its methods with types and descriptions. In so doing I found a number of cases where I felt like the readability of the controller could be improved. This should be a non-functional refactor. Please take care in reading the changes to the test file to see if I have altered the desired outcomes in any functional way.

This will require a migration as I renamed incomingTxLastFetchedBlocksByNetwork to incomingTxLastFetchedBlockByChainId. Although the value is an object storing values that are blocks, each chainId only has one block. Although I've changed it from network to chainId, this shouldn't result in functional changes except where user's are using custom networks with chainIds that match default chains.

Migration now included, and the case above doesn't exist because we were mapping chainId to provider type before, so custom network with chainId 0x1 would have had its last fetched block stored in the mainnet key

[metamaskbot]

Builds ready [adb61ce]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (593 ± 59 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	45	76	60	8	4
		domContentLoaded	345	787	591	122	58
		load	346	787	593	122	59
		domInteractive	345	786	591	122	58

[metamaskbot]

Builds ready [534a292]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (644 ± 33 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	50	70	61	6	3
		domContentLoaded	449	817	642	68	32
		load	450	819	644	68	33
		domInteractive	448	817	642	68	32

[Gudahtt]

This looks great!

Although I've changed it from network to chainId, this shouldn't result in functional changes except where user's are using custom networks with chainIds that match default chains.

I think even for those users it won't be a functional change, as we were using the chainId and mapping it back to a type (using CHAIN_ID_TO_NETWORK_ID_MAP). So it was effectively grouping by chainId already, even though it was keyed by the network identifier. Unless I missed something.

[brad-decker]

I think even for those users it won't be a functional change, as we were using the chainId and mapping it back to a type (using CHAIN_ID_TO_NETWORK_ID_MAP). So it was effectively grouping by chainId already, even though it was keyed by the network identifier. Unless I missed something.

No, that's correct. This should be an entirely non-functional change.

[metamaskbot]

Builds ready [9b87f73]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (580 ± 45 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	43	80	56	8	4
		domContentLoaded	351	762	578	95	45
		load	358	763	580	94	45
		domInteractive	351	762	577	95	45

[metamaskbot]

Builds ready [fd4f5ee]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (593 ± 35 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	46	106	58	12	6
		domContentLoaded	399	728	592	73	35
		load	400	729	593	73	35
		domInteractive	399	727	592	73	35

[metamaskbot]

Builds ready [dfba6c0]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (594 ± 45 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	45	80	58	9	4
		domContentLoaded	375	713	592	93	45
		load	380	713	594	93	45
		domInteractive	374	712	592	93	45

[Gudahtt]

LGTM!

[brad-decker]

@Gudahtt thanks for review and approval! I'm going to hold this and change my migration number to avoid stealing two migration numbers from @darkwing 😬. going to bump the number up by one and wait for #10593 to land.,

[metamaskbot]

Builds ready [ae29cd0]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (643 ± 35 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	46	72	58	7	3
		domContentLoaded	472	807	641	74	35
		load	473	808	643	74	35
		domInteractive	471	807	641	74	35

[metamaskbot]

Builds ready [a24b030]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (608 ± 29 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	44	74	56	9	4
		domContentLoaded	541	831	607	61	30
		load	542	832	608	61	29
		domInteractive	540	831	606	61	30

[metamaskbot]

Builds ready [fe5944e]

• builds: chrome, firefox, opera
• bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
• build viz: Build System
• code coverage: Report
• storybook: Storybook
• all artifacts

Page Load Metrics (689 ± 56 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	45	111	60	14	7
		domContentLoaded	556	943	687	116	56
		load	558	944	689	116	56
		domInteractive	556	942	687	116	56

[brad-decker]

@Gudahtt could use another look at this, only thing that has changed is the migration number (and test relocation due to my other PR)

[Gudahtt]

LGTM!