GAMM module spec improvements #3654
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
dalmirel
added
the
V:state/compatible/backport
ValarDragon
approved these changes
Dec 14, 2022
ValarDragon
added
A:backport/v13.x
mergify bot
pushed a commit
that referenced
this pull request
Dec 14, 2022
## What is the purpose of the change This PR is created during the Informal Systems audit, after analysis of the existing specification and code inspection Auditing is performed on commit hash: 42d73f1 ## Brief Changelog - GAMM/README.md is expanded with certain details that we found important to know and understand during the creation of the TLA spec for the GAMM module - Diagrams added for easier understanding of code structure of GAMM module base and two types of pool styles (balancer and stableswap) - minor changes in function descriptions to hold the explanation of the actual implementation ## Testing and Verifying *(Please pick one of the following options)* This change is a trivial rework / code cleanup without any test coverage. ## Documentation and Release Note - Does this pull request introduces a new feature or user-facing behavior changes? no - Is a relevant changelog entry added to the `Unreleased` section in `CHANGELOG.md`? no - How is the feature or change documented? specification x/GAMM/README.md (cherry picked from commit a942009)
ValarDragon
pushed a commit
that referenced
this pull request
Dec 14, 2022
## What is the purpose of the change This PR is created during the Informal Systems audit, after analysis of the existing specification and code inspection Auditing is performed on commit hash: 42d73f1 ## Brief Changelog - GAMM/README.md is expanded with certain details that we found important to know and understand during the creation of the TLA spec for the GAMM module - Diagrams added for easier understanding of code structure of GAMM module base and two types of pool styles (balancer and stableswap) - minor changes in function descriptions to hold the explanation of the actual implementation ## Testing and Verifying *(Please pick one of the following options)* This change is a trivial rework / code cleanup without any test coverage. ## Documentation and Release Note - Does this pull request introduces a new feature or user-facing behavior changes? no - Is a relevant changelog entry added to the `Unreleased` section in `CHANGELOG.md`? no - How is the feature or change documented? specification x/GAMM/README.md (cherry picked from commit a942009) Co-authored-by: Mirel Dalčeković <97894739+dalmirel@users.noreply.github.com>
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.
What is the purpose of the change
This PR is created during the Informal Systems audit, after analysis of the existing specification and code inspection
Auditing is performed on commit hash: 42d73f1
Brief Changelog
Testing and Verifying
(Please pick one of the following options)
This change is a trivial rework / code cleanup without any test coverage.
Documentation and Release Note
Unreleasedsection inCHANGELOG.md? no