All transaction status updates were moved into a `setTimeout` callback
and wrapped in a `try...catch` block in #4131, apparently in an attempt
to prevent failures in event subscribers from interrupting the
transaction logic. The `try...catch` block did accomplish that, but by
putting the status update in a `setTimeout` callback the operation was
made asynchronous.
Transaction status updates now happen unpredictably, in some future
event loop from when they're triggered. This creates a race condition,
where the transaction status update may occur before or after
subsequent state changes. This also introduces a risk of accidentally
undoing a change to the transaction state, as the update made to the
transaction inside the `setTimeout` callback uses a reference to
`txMeta` obtained synchronously before the `setTimeout` call. Any
replacement of the `txMeta` between the `setTxStatus` call and the
execution of the timeout would be erased. Luckily the `txMeta` object
is more often than not mutated rather than replaced, which may explain
why we haven't seen this happen yet.
Everything seems to work correctly with the `setTimeout` call removed,
and now the transaction logic is easier to understand.
* Specify type before parameter name
Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.
A couple of `@return` entries have been given types as well.
* Use JSDoc optional syntax rather than Closure syntax
* Use @returns rather than @return
* Use consistent built-in type capitalization
Primitive types are lower-case, and Object is upper-case.
* Separate param/return description with a dash
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Handle transaction ordering in cases where tx ids are off by more than 1 in tx-state-manager
* Add comment to addUnapprovedTransaction explaining calling _determineTransactionCategory after generateTxMeta
* Sort txes by timestamp of creation instead of id
* eslint: Check for unused function arguments
* eslint: Ignore unused '_' in argument list
Also allow any number of '_' e.g., '__' or '___' which is to be used sparingly
* Remove and rename unused arguments
* transactions - use safe-event-emitter over events
* tests - pass a platform object on init with a noop showTransactionNotification
* test - fix for tx-state-history-helper trying to reduce an empty array
* deps - safe-event-emitter
* lint
* Add beginning of test
* Resubmit approved transactions on new block
May fix#4343 and related issues, where an error could leave
transactions stranded in the approved state.
* Remove unused test
* Re-approve transactions when retrying approved
* Add retry approved test
* Include approved in pending tx count
* Fix getPendingTxs()
* Linted
* Only throw hash error in submitted state
* Only check submitted txs for block inclusion
* Fix test expectations
- create a new tx instead of overwriting the tx hash
- add a new state 'dropped' to the txStateManager
- mark duplicate txs as dropped when one gets confirmed in a block
Fixed warnings:
```md
app/scripts/controllers/computed-balances.js
+ 35:27 warning Missing space before function parentheses space-before-function-paren
+ 41:14 warning 'address' is never reassigned. Use 'const' instead prefer-const
+ 61:9 warning 'updater' is never reassigned. Use 'const' instead prefer-const
+ 68:11 warning 'newState' is never reassigned. Use 'const' instead prefer-const
app/scripts/controllers/network.js
+ 104:29 warning Missing space before function parentheses space-before-function-paren
app/scripts/lib/createLoggerMiddleware.js
+ 4:32 warning Missing space before function parentheses space-before-function-paren
+ 15:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/createOriginMiddleware.js
+ 4:32 warning Missing space before function parentheses space-before-function-paren
+ 9:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/createProviderMiddleware.js
+ 5:34 warning Missing space before function parentheses space-before-function-paren
+ 13:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/events-proxy.js
+ 1:50 warning Missing space before function parentheses space-before-function-paren
+ 31:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/nodeify.js
+ 2:22 warning Missing space before function parentheses space-before-function-paren
+ 2:24 warning Missing space before opening brace space-before-blocks
+ 5:18 warning Missing space before function parentheses space-before-function-paren
+ 5:20 warning Missing space before opening brace space-before-blocks
app/scripts/lib/pending-balance-calculator.js
+ 16:19 warning Missing space before function parentheses space-before-function-paren
app/scripts/lib/pending-tx-tracker.js
+ 85:11 warning '||' should be placed at the end of the line operator-linebreak
+ 87:11 warning '||' should be placed at the end of the line operator-linebreak
+ 88:11 warning '||' should be placed at the end of the line operator-linebreak
+ 90:11 warning '||' should be placed at the end of the line operator-linebreak
+ 91:11 warning '||' should be placed at the end of the line operator-linebreak
app/scripts/lib/port-stream.js
+ 3:22 warning Missing space before function parentheses space-before-function-paren
+ 3:24 warning Missing space before opening brace space-before-blocks
app/scripts/lib/tx-gas-utils.js
+ 84:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/tx-state-history-helper.js
+ 12:37 warning Missing space before function parentheses space-before-function-paren
+ 23:30 warning Missing space before function parentheses space-before-function-paren
+ 30:23 warning Missing space before function parentheses space-before-function-paren
+ 35:28 warning Missing space before function parentheses space-before-function-paren
+ 41:2 warning Newline required at end of file but not found eol-last
app/scripts/lib/tx-state-manager.js
+ 94:13 warning 'value' is never reassigned. Use 'const' instead prefer-const
ui/app/reducers.js
+ 45:7 warning 'state' is never reassigned. Use 'const' instead prefer-const
+ 53:7 warning 'stateString' is never reassigned. Use 'const' instead prefer-const
ui/lib/tx-helper.js
+ 27:2 warning Newline required at end of file but not found eol-last
ui/app/components/account-dropdowns.js
+ 163:1 warning More than 2 blank lines not allowed no-multiple-empty-lines
ui/app/components/menu-droppo.js
+ 22:7 warning 'style' is never reassigned. Use 'const' instead prefer-const
ui/app/components/shapeshift-form.js
+ 135:11 warning '&&' should be placed at the end of the line operator-linebreak
ui/app/components/typed-message-renderer.js
+ 35:25 warning Missing space before function parentheses space-before-function-paren
+ 42:2 warning Newline required at end of file but not found eol-last
mascara/server/index.js
+ 11:42 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 12:36 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 13:33 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 14:40 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 20:29 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 21:29 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
+ 26:40 warning Use path.join() or path.resolve() instead of + to create paths no-path-concat
```
Mark Stacey
Whymarrh Whitby
Dan J Miller
Frankie
Akshit Kr Nagpal
Dan Finlay
Alexander Tseung
Csaba Solya
Alexander Tseung
kumavis
kumavis
Jeffrey Tong
Bruno Barbieri
Dan Finlay
Daijiro Wachi