A few inconsistencies in JSDoc formatting have been fixed throughout
the project. Many issues remain; these were just the few things that
were easy to fix with a regular expression.
The changes include:
* Using lower-case for primitive types, but capitalizing non-primitive
types
* Separating the parameter identifier and the description with a dash
* Omitting a dash between the return type and the return description
* Ensuring the parameter type is first and the identifier is second (in
a few places it was backwards)
* Using square brackets to denote when a parameter is optional, rather
than putting "(optional)" in the parameter description
* Including a type and identifier with every parameter
* Fixing inconsistent spacing, except where it's used for alignment
* Remove incorrectly formatted `@deprecated` tags that reference non-
existent properties
* Remove lone comment block without accompanying function
Additionally, one parameter was renamed for clarity.
* Use over the whole stringified error object which doesn't show the actual error message that is set as the
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
* Feedback commit
The code for checking whether a transaction was dropped or not was
refactored in #8398, but in the process an off-by-one error was
introduced.
The old version of `_checkIfTxWasDropped` would query for an updated
transaction count from the network, and would consider the pending
transaction to be dropped if the count was above the nonce. However,
the version introduced in #8398 considers the transaction to be dropped
if the count is above *or equal to* the nonce.
The pending transaction nonce is expected to be equal to the
transaction count, because the nonce starts at zero. The transaction
count is equal to the expected next nonce.
The variable name has been updated to make this more clear
(`networkNextNonce` is how the `nonce-tracker` refers to this value).
`parseInt` is now called with an explicit radix of `16` as well, to
ensure both nonce strings are always parsed as hex. In all cases I am
aware of, these nonce strings were prefixed by `0x`, meaning that
`parseInt` would default to a radix of `16`, so this likely doesn't
constitute a functional change.
Fixes#8688
This reverts commit 466ece4588, which has
the message:
"Revert "Merge pull request #7599 from MetaMask/Version-v7.7.0" (#7648)"
This effectively re-introduces the changes from the "LoginPerSite" PR.
* 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
* tests - create tests for pending middlewares
* transactions - add r,s,v values to the txMeta to match the JSON rpc response
* network - add new middleware for eth_getTransactionByHash that the checks pending tx's for a response value
* transactions/pending - use getTransactionReceipt for checking if tx is in a block
* meta - file rename
* transactions/pending - check nonce against the network and mark as dropped if not included in a block
* transactions/pending - unifiy "dropped" txs
* transactions/pending - test - fix for new expected behavior
* fix comment
* transactions/pending - clean up dropped event
* fix spelling
Co-Authored-By: frankiebee <frankie.diamond@gmail.com>
* nit fix
* test/tx-pending - clarify test description
* 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
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
```
Erik Marks
Mark Stacey
Brad Decker
Whymarrh Whitby
Thomas Huang
Frankie
Dan Finlay
brunobar79
kumavis
Dan
Dan Finlay
Daijiro Wachi