feat(spike): taker fee

[czarcas7ic]

Closes: #XXX

What is the purpose of the change

This feature adds taker fee logic to poolmanager when making a swap. It is important to note that all swap logic messages are routed through poolmanager. This means that if you call a swap method directly in GAMM or CL (and not via the message), taker fees will not be charged.

There are two txfees module accounts that taker fees accrue and get swapped in: An account for staking rewards and an account for community pool.

If the taker fee is in osmo:

• the parameterized community pool percent goes directly to the community pool
• the parameterized staking rewards percent goes to the txfees staking rewards module account, and is sent to the actual staking rewards module account at epoch.

If the taker fee is non osmo but a whitelisted quote asset:

• the parameterized community pool percent goes directly to the community pool
• the parameterized staking rewards percent goes to the txfees staking rewards module account, is swapped to OSMO at epoch, then sent to the actual staking rewards module account.

If the taker fee is non osmo and non whitelisted quote asset:

• the parameterized community pool percent goes to the txfees community pool module account and is swapped to the parameterized asset (defaults to USDC) at epoch, then is sent to the actual community pool module account
• the parameterized staking rewards percent goes to the txfees staking rewards module account, is swapped to OSMO at epoch, then sent to the actual staking rewards module account.

hooks.go, taker_fee.go, and router.go will be the ones to pay the most attention to.

Pre v19 Release:

• Add all missing tests for hooks.go
• Add all missing tests for taker_fee.go
• Add all missing tests for upgrades.go
• Add an E2E test for this. The CL test indirectly tested this properly, so we really just need a test that checks the module accounts and ensures the epoch swaps and distributes properly
• In upgrade handler, set default taker fee to 0
• Backport v18 upgrade handler to main

Post v19 Release:

• Make issue to remove whitelisted quote denoms in CL module in v20
• Have skip change the takerFee to non zero in their test suite so they can confirm the number changes

Testing and Verifying

TBD

Documentation and Release Note

• Does this pull request introduce a new feature or user-facing behavior changes?
• Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

• Specification (x/{module}/README.md)
• Osmosis documentation site
• Code comments?
• N/A

[czarcas7ic]

devbot help

[devbot-wizard]

Hi! I'm DevBot, a bot that helps with common tasks in the development process. Commands:

• devbot fix: Fix basic errors in the PR. (e.g. imports, changelog conflicts, go mod conflicts)
• devbot merge base: Merge the base branch into the PR branch.
• devbot add changelog [misc/feat/bug/api/sec] [message]: Add a changelog entry to the PR. (e.g. devbot add changelog feat Added a new feature)
  • If message is blank, defaults to PR title.
• devbot re-pr: Re-PR the PR, useful for external contributors where we have no edit perms.

[czarcas7ic]

devbot add changelog feat

[ValarDragon]

I'd like to come back to this later, where I feel like we can make some more general method to get these guarantees

[ValarDragon]

I think we should be setting the precise param we want in the upgrade handler, and not have so many denoms in defaults

[ValarDragon]

(For testnets) we may want it s.t. if this list is blank, it allows anything.

That can be done in a mainnet non-breaking way, so can be done later.

[ValarDragon]

I propose we get pool-manager side in a state were proud of as one PR, and then txfees as second

[AlpinYukseloglu]

Core logic LGTM, nice work. Approving to get this base PR in, understanding that there are potential changes that will need to be done in follow up PRs as discussed on call