Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: x/mint docs and clean up, excluding mint keeper #1857

Merged
merged 32 commits into from
Jun 30, 2022
Merged

chore: x/mint docs and clean up, excluding mint keeper #1857

merged 32 commits into from
Jun 30, 2022

Conversation

p0mvn
Copy link
Member

@p0mvn p0mvn commented Jun 23, 2022 •
edited
Loading

Subset of: #1839

What is the purpose of the change

Audit docs and refactor for the mint module:

  • proto
    • renamed LastHalvenEpoch to LastReductionEpoch
  • x/mint
  • types
    • Added validation and tests for minter
  • spec
    • Removed code snippets to avoid these going out of sync. Also, docs should be able to convey the meaning seamlessly without diving deep into implementation details.
    • Instead, provided links to the codebase where applicable.
  • simulation
    • Removed simulation as it is not being used. We can reintroduce when needed.
  • client
  • keeper
    • Will be submitted in a separate PR together with a test for 365 epochs as this PR is getting too big

Testing and Verifying

This change is a trivial rework / code cleanup without any test coverage.

Documentation and Release Note

  • Does this pull request introduce 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? not applicable

@github-actions github-actions bot added C:x/gamm Changes, features and bugs related to the gamm module. C:x/mint C:x/pool-incentives C:x/superfluid labels Jun 23, 2022
@github-actions github-actions bot added the C:docs Improvements or additions to documentation label Jun 23, 2022
@github-actions github-actions bot added C:app-wiring Changes to the app folder Type:build labels Jun 24, 2022
@github-actions github-actions bot added the C:CLI label Jun 24, 2022
@p0mvn p0mvn changed the title chore: mint module docs and clean up chore: mint module docs and clean up, excluding mint keeper Jun 24, 2022
@github-actions github-actions bot removed C:x/superfluid C:x/gamm Changes, features and bugs related to the gamm module. labels Jun 25, 2022
@p0mvn p0mvn marked this pull request as ready for review June 25, 2022 01:01
@p0mvn p0mvn requested a review from a team June 25, 2022 01:01
ValarDragon
ValarDragon reviewed Jun 25, 2022
View reviewed changes
Makefile Show resolved Hide resolved
ValarDragon
ValarDragon reviewed Jun 25, 2022
View reviewed changes
x/mint/module.go Outdated Show resolved Hide resolved
mattverse
mattverse approved these changes Jun 30, 2022
View reviewed changes
Copy link
Member

@mattverse mattverse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some minor comments that would be good to be fixed before merging!

Otherwise 🌮 !

proto/osmosis/mint/v1beta1/genesis.proto Outdated Show resolved Hide resolved
proto/osmosis/mint/v1beta1/mint.proto Outdated Show resolved Hide resolved
x/mint/types/hooks.go Outdated Show resolved Hide resolved
x/mint/simulation/genesis_test.go Show resolved Hide resolved
x/mint/simulation/genesis.go Outdated Show resolved Hide resolved
x/mint/simulation/genesis.go Outdated Show resolved Hide resolved
x/mint/types/minter.go Show resolved Hide resolved
alexanderbez
alexanderbez approved these changes Jun 30, 2022
View reviewed changes
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like @mattverse provided some good feedback here. LGTM pending changes 👍

ValarDragon
ValarDragon approved these changes Jun 30, 2022
View reviewed changes
Copy link
Member

@ValarDragon ValarDragon left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I'll probably do another pass over all simulator work as part of my simulator refactor, so not worried about that tbh.

I'm good with hitting merge after make proto-all

@p0mvn p0mvn mentioned this pull request Jun 30, 2022
Closed
p0mvn and others added 6 commits June 30, 2022 09:49
@p0mvn
Merge branch 'main' into roman/mint-docs
8da5a8a
@p0mvn @mattverse
Update proto/osmosis/mint/v1beta1/genesis.proto
adc46b0 
Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>
@p0mvn @mattverse
Update proto/osmosis/mint/v1beta1/mint.proto
828951b 
Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>
@p0mvn @mattverse
Update x/mint/types/hooks.go
8c873a3 
Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>
@p0mvn
Merge branch 'roman/mint-docs' of github.com:osmosis-labs/osmosis int…
dacd4e0 
…o roman/mint-docs
@p0mvn
make prot-all
536c279
@p0mvn p0mvn merged commit ee48cf5 into main Jun 30, 2022
@p0mvn p0mvn deleted the roman/mint-docs branch June 30, 2022 14:43
@p0mvn p0mvn added the A:backport/v10.x backport patches to v10.x branch label Jul 14, 2022
mergify bot pushed a commit that referenced this pull request Jul 14, 2022
@p0mvn @mergify
chore: x/mint docs and clean up, excluding mint keeper (#1857)
1e7917e 
* chore: mint module docs and clean up

* rename LasteHalvenEpoch to LastReductionEpoch

* lint

* revert proto comments

* spec

* try removing simulation

* client module changes

* client/rest

* more proto fixes

* avoid listing minting params in spec

* Update proto/osmosis/mint/v1beta1/mint.proto

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>

* update comment in hooks.go

* Revert "try removing simulation" w/o Makefile change

This reverts commit 5a06bf1.

* randomize mint gen state simulation

* fix full sim tests

* fix TestAppStateDeterminism

* fix TestAppStateDeterminism

* change expected epochIdentifier to day

* address Dev's comments to hardcode certain parameters

* Update x/mint/types/minter_test.go

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>

* remove unused variable

* Update proto/osmosis/mint/v1beta1/genesis.proto

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* Update proto/osmosis/mint/v1beta1/mint.proto

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* Update x/mint/types/hooks.go

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* make prot-all

* remove unused

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>
(cherry picked from commit ee48cf5)

# Conflicts:
#	go.mod
#	proto/osmosis/superfluid/query.proto
#	x/mint/keeper/genesis.go
#	x/mint/keeper/hooks_test.go
#	x/mint/keeper/keeper.go
#	x/mint/types/genesis.pb.go
#	x/mint/types/params.go
#	x/pool-incentives/keeper/hooks.go
#	x/superfluid/types/query.pb.go
@mergify mergify bot mentioned this pull request Jul 14, 2022
Closed
p0mvn added a commit that referenced this pull request Jul 14, 2022
@p0mvn
chore: x/mint docs and clean up, excluding mint keeper (backport #1857)
6feea69
p0mvn added a commit that referenced this pull request Jul 15, 2022
@p0mvn
chore: x/mint docs and clean up, excluding mint keeper (backport #1857)
0ab359e
@p0mvn p0mvn added A:backport/v10.x backport patches to v10.x branch and removed A:backport/v10.x backport patches to v10.x branch labels Jul 18, 2022
p0mvn added a commit that referenced this pull request Jul 18, 2022
@p0mvn @ValarDragon @mattverse
chore: x/mint docs and clean up, excluding mint keeper (backport #1857)
1033ee6 
* chore: mint module docs and clean up

* rename LasteHalvenEpoch to LastReductionEpoch

* lint

* revert proto comments

* spec

* try removing simulation

* client module changes

* client/rest

* more proto fixes

* avoid listing minting params in spec

* Update proto/osmosis/mint/v1beta1/mint.proto

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>

* update comment in hooks.go

* Revert "try removing simulation" w/o Makefile change

This reverts commit 5a06bf1.

* randomize mint gen state simulation

* fix full sim tests

* fix TestAppStateDeterminism

* fix TestAppStateDeterminism

* change expected epochIdentifier to day

* address Dev's comments to hardcode certain parameters

* Update x/mint/types/minter_test.go

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>

* remove unused variable

* Update proto/osmosis/mint/v1beta1/genesis.proto

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* Update proto/osmosis/mint/v1beta1/mint.proto

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* Update x/mint/types/hooks.go

Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>

* make prot-all

* remove unused

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Co-authored-by: Matt, Park <45252226+mattverse@users.noreply.github.com>
@p0mvn p0mvn mentioned this pull request Jul 18, 2022
Closed
p0mvn added a commit that referenced this pull request Jul 18, 2022
@p0mvn
chore: x/mint docs and clean up, excluding mint keeper (backport #1857)
febf8d8
p0mvn added a commit that referenced this pull request Jul 19, 2022
@p0mvn
chore(changelog): add api breaking changelog entry from #1857
39dbe87
@p0mvn p0mvn mentioned this pull request Jul 19, 2022
Merged
mergify bot pushed a commit that referenced this pull request Jul 20, 2022
@p0mvn
chore(changelog): add api breaking changelog entry from #1857 (#2157)
339c58f 
Closes: #XXX

## What is the purpose of the change

#1857 introduced an API break but a changelog entry wasn't added. This PR follows through with the entry
@github-actions github-actions bot mentioned this pull request Feb 15, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattverse mattverse mattverse approved these changes

@ValarDragon ValarDragon ValarDragon approved these changes

@alexanderbez alexanderbez alexanderbez approved these changes

Assignees
No one assigned
Labels
A:backport/v10.x backport patches to v10.x branch C:app-wiring Changes to the app folder C:CLI C:docs Improvements or additions to documentation C:x/mint C:x/pool-incentives C:x/superfluid T:build
Projects
Osmosis Chain Development
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@p0mvn @ValarDragon @alexanderbez @mattverse