update TxFee README to include new auto fee swaps (#1340)

x/txfees/README.md

@@ -7,29 +7,31 @@ Currently the only supported metadata & spot price calculator is using a GAMM po
 
 ## State Changes
 
-* Adds a whitelist of tokens that can be used as fees on the chain.
-  * Any token not on this list cannot be provided as a tx fee.
-* Adds a new SDK message for creating governance proposals for adding new TxFee denoms.
+- Adds a whitelist of tokens that can be used as fees on the chain.
+  - Any token not on this list cannot be provided as a tx fee.
+  - Any fee that is paid with a token that is on this list but is not the base denom will be collected in a separate module account to be batched and swapped into the base denom at the end of each epoch.
+- Adds a new SDK message for creating governance proposals for adding new TxFee denoms.
 
 ## Local Mempool Filters Added
 
-* If you specify a min-tx-fee in the $BASEDENOM then
-  * Your node will allow any tx w/ tx fee in the whitelist of fees, and a sufficient osmo-equivalent price to enter your mempool
-  * The osmo-equivalent price for determining sufficiency is rechecked after every block. (During the mempools RecheckTx)
-    * TODO: further consider if we want to take this tradeoff. Allows someone who manipulates price for one block to flush txs using that asset as fee from most of the networks' mempools.
-    * The simple alternative is only check fee equivalency at a txs entry into the mempool, which allows someone to manipulate price down to have many txs enter the chain at low cost.
-    * Another alternative is to use TWAP instead of Spot Price once it is available on-chain
-    * The former concern isn't very worrisome as long as some nodes have 0 min tx fees.
-* A separate min-gas-fee can be set on every node for arbitrage txs. Methods of detecting an arb tx atm
-  * does start token of a swap = final token of swap (definitionally correct)
-  * does it have multiple swap messages, with different tx ins. If so, we assume its an arb.
-    * This has false positives, but is intended to avoid the obvious solution of splitting an arb into multiple messages.
-  * We record all denoms seen across all swaps, and see if any duplicates. (TODO)
-  * Contains both JoinPool and ExitPool messages in one tx.
-    * Has some false positives.
-  * These false positives seem like they primarily will get hit during batching of many distinct operations, not really in one atomic action.
-* A max wanted gas per any tx can be set to filter out attack txes.
-* If tx wanted gas > than predefined threshold of 1M, then separate 'min-gas-price-for-high-gas-tx' option used to calculate min gas price.
+- If you specify a min-tx-fee in the $BASEDENOM then
+  - Your node will allow any tx w/ tx fee in the whitelist of fees, and a sufficient osmo-equivalent price to enter your mempool
+    - Txs with valid non-basedenom tx fees will be routed to a separate module account. At the end of each epoch, these fees will be swapped into the basedenom token and transferred to the primary tx fee module account to be distributed to validators/delegators.
+  - The osmo-equivalent price for determining sufficiency is rechecked after every block. (During the mempools RecheckTx)
+    - TODO: further consider if we want to take this tradeoff. Allows someone who manipulates price for one block to flush txs using that asset as fee from most of the networks' mempools.
+    - The simple alternative is only check fee equivalency at a txs entry into the mempool, which allows someone to manipulate price down to have many txs enter the chain at low cost.
+    - Another alternative is to use TWAP instead of Spot Price once it is available on-chain
+    - The former concern isn't very worrisome as long as some nodes have 0 min tx fees.
+- A separate min-gas-fee can be set on every node for arbitrage txs. Methods of detecting an arb tx atm
+  - does start token of a swap = final token of swap (definitionally correct)
+  - does it have multiple swap messages, with different tx ins. If so, we assume its an arb.
+    - This has false positives, but is intended to avoid the obvious solution of splitting an arb into multiple messages.
+  - We record all denoms seen across all swaps, and see if any duplicates. (TODO)
+  - Contains both JoinPool and ExitPool messages in one tx.
+    - Has some false positives.
+  - These false positives seem like they primarily will get hit during batching of many distinct operations, not really in one atomic action.
+- A max wanted gas per any tx can be set to filter out attack txes.
+- If tx wanted gas > than predefined threshold of 1M, then separate 'min-gas-price-for-high-gas-tx' option used to calculate min gas price.
 
 ## New SDK messages
 
@@ -49,6 +51,6 @@ TODO: Describe
 
 ## Future directions
 
-* Want to add in a system to add in general "tx fee credits" for different on-chain usages
-  * e.g. making 0 fee txs under certain usecases
-* If other chains would like to use this, we should brainstorm mechanisms for extending the metadata proto fields
+- Want to add in a system to add in general "tx fee credits" for different on-chain usages
+  - e.g. making 0 fee txs under certain usecases
+- If other chains would like to use this, we should brainstorm mechanisms for extending the metadata proto fields