chore: add docs for new CL logic #4918
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
C:docs
czarcas7ic
added
the
V:state/compatible/no_backport
czarcas7ic
requested review from
mattverse,
stackman27 and
p0mvn
as code owners
p0mvn
approved these changes
Apr 15, 2023
x/concentrated-liquidity/README.md
Outdated
|
|
||
| ### Locked and Unlocked Balancer to Concentrated | ||
|
|
||
| The locked<>locked and unlocked<>unlocked migration is just a subset of the above-described migration. The Lockup module account that was holding the original GAMM shares sends them back to the user, deleting the GAMM lock in the process. These shares are used to claim the underlying two assets from the GAMM pool, which are then immediately put into a full range Concentrated Liquidity position in the canonical Concentrated Liquidity pool. |
There was a problem hiding this comment.
Not sure I'm getting the subset part. Above what migration? 2 were described
There was a problem hiding this comment.
Clarified here e105eac
x/concentrated-liquidity/README.md
Outdated
|
|
||
| ### Balancer to Concentrated with No Lock | ||
|
|
||
| This is an even smaller subset of the above described migration. The GAMM shares are claimed for the underlying two assets, which are then immediately put into a full range concentrated liquidity position in the canonical concentrated liquidity pool. No locks are involved in this migration. |
There was a problem hiding this comment.
I think I get what you mean by subset now but it really confused me above. Consider changing
There was a problem hiding this comment.
Clarified here e105eac
x/concentrated-liquidity/README.md
Outdated
|
|
||
| ### Locked and Unlocked Balancer to Concentrated | ||
|
|
||
| The locked<>locked and unlocked<>unlocked migration is just a subset of the above-described migration. The Lockup module account that was holding the original GAMM shares sends them back to the user, deleting the GAMM lock in the process. These shares are used to claim the underlying two assets from the GAMM pool, which are then immediately put into a full range Concentrated Liquidity position in the canonical Concentrated Liquidity pool. |
There was a problem hiding this comment.
To be clear, consider specifying that this is all happening within the same message
Co-authored-by: Roman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #XXX
What is the purpose of the change
We added superfluid capabilities to full range concentrated liquidity positions. This required tweaking some logic in both lockup and superfluid (as well as CL itself).
This PR adds notes to all three module READMEs to document the respective changes.
Documentation and Release Note
Unreleasedsection inCHANGELOG.md? (yes / no)x/<module>/spec/) / Osmosis docs repo / not documented)