aboutsummaryrefslogtreecommitdiffstats
path: root/app/scripts/controllers/transactions/README.md
diff options
context:
space:
mode:
authorDan Finlay <dan@danfinlay.com>2018-04-24 00:43:18 +0800
committerDan Finlay <dan@danfinlay.com>2018-04-24 00:43:18 +0800
commit621e9334bc7009f7ccd7c1536df00ff6f8240bd3 (patch)
treeda1a7bbab44f29b36ac0f94883989c57cca38ff0 /app/scripts/controllers/transactions/README.md
parente862a5091e271e8065e9da3c25540612f98a8d2a (diff)
downloadtangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar.gz
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar.bz2
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar.lz
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar.xz
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.tar.zst
tangerine-wallet-browser-621e9334bc7009f7ccd7c1536df00ff6f8240bd3.zip
Cleaned up some typos and JSDocs in Transactions
Nonce tracker is not fully documented yet. Have not yet touched: - tx-state-manager - tx-state-history-helper - util - tx-gas-utils - pending-tx-tracker
Diffstat (limited to 'app/scripts/controllers/transactions/README.md')
-rw-r--r--app/scripts/controllers/transactions/README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/app/scripts/controllers/transactions/README.md b/app/scripts/controllers/transactions/README.md
index ea38b5ae6..b414762dc 100644
--- a/app/scripts/controllers/transactions/README.md
+++ b/app/scripts/controllers/transactions/README.md
@@ -1,7 +1,7 @@
# Transaction Controller
Transaction Controller is an aggregate of sub-controllers and trackers
-composing them in a way to be exposed to the metamask controller
+exposed to the MetaMask controller.
- txStateManager
responsible for the state of a transaction and
@@ -14,11 +14,11 @@ composing them in a way to be exposed to the metamask controller
- nonceTracker
calculating nonces
-## flow digram of processing a transaction
+## Flow diagram of processing a transaction
![transaction-flow](../../../../docs/transaction-flow.png)
-## txMeta's && txParams
+## txMeta's & txParams
A txMeta is the "meta" object it has all the random bits of info we need about a transaction on it. txParams are sacred every thing on txParams gets signed so it must
be a valid key and be hex prefixed except for the network number. Extra stuff must go on the txMeta!
@@ -59,8 +59,8 @@ txMeta = {
"value": "0x3b9aca00"
},
...], // I've removed most of history for this
- "gasPriceSpecified": false, //weather or not the user/dapp has specified gasPrice
- "gasLimitSpecified": false, //weather or not the user/dapp has specified gas
+ "gasPriceSpecified": false, //whether or not the user/dapp has specified gasPrice
+ "gasLimitSpecified": false, //whether or not the user/dapp has specified gas
"estimatedGas": "5208",
"origin": "MetaMask", //debug
"nonceDetails": {