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.

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

docs: improve proto vesting docs about time attributes #15474

Merged
merged 3 commits into from
Mar 20, 2023

Conversation

robert-zaremba
Copy link
Collaborator

Description

Added a little bit more comments to note about the meaning / type of the numeric time values.

When I'm creating the vesting accounts, I always have to double check it, and end up looking at the code.

@robert-zaremba robert-zaremba added T:Docs Changes and features related to documentation. backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release labels Mar 20, 2023
@robert-zaremba robert-zaremba requested a review from a team as a code owner March 20, 2023 15:00
@github-prbot github-prbot requested review from a team, julienrbrt and atheeshp and removed request for a team March 20, 2023 15:03
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm!

@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 20, 2023
@mergify mergify bot merged commit 5612bb8 into main Mar 20, 2023
@mergify mergify bot deleted the robert/proto-vesting-docs branch March 20, 2023 16:40
julienrbrt added a commit that referenced this pull request Mar 20, 2023
…) (#15481)

Co-authored-by: Julien Robert <julien@rbrt.fr>
julienrbrt added a commit that referenced this pull request Mar 20, 2023
…) (#15480)

Co-authored-by: Julien Robert <julien@rbrt.fr>
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Jun 9, 2023
* fix: create snapshot dir for rocksdb backend (backport cosmos#15054) (cosmos#15065)

Co-authored-by: yihuang <huang@crypto.com>

* chore: Add check for uneven stores' height (backport cosmos#14410) (cosmos#15115)

Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* refactor!: remove store v2alpha1 (cosmos#15152)

* build: use cometbft in v0.46 (cosmos#15090)

* chore: bump cometbft to v0.34.27 final (cosmos#15206)

* fix: Change proposer address cast for `sdk_block` conversion (backport cosmos#15243) (cosmos#15245)

Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: revert double close fix (cosmos#15255)

* chore: prepare v0.46.11 release (cosmos#15259)

* feat: add extend cb to avoid unmarshal state twice for sim test (backport: cosmos#15305) (cosmos#15321)

* feat: add extend cb with genesisState for sim test (backport: cosmos#15305) (cosmos#15349)

* fix: add extra check in vesting (backport cosmos#15373) (cosmos#15383)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* docs: update cosmwasm link (cosmos#15441)

* fix: remove extra `;` in service.proto (cosmos#15443)

* fix: flaky group genesis sim (backport cosmos#15447) (cosmos#15461)

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* feat: add delegator to withdraw address (backport cosmos#15462) (cosmos#15473)

Co-authored-by: Marko <marbar3778@yahoo.com>

* docs: improve proto vesting docs about time attributes (backport cosmos#15474) (cosmos#15481)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add query `groups` in `x/group` (backport cosmos#14879) (cosmos#15476)

Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix: Makefile rocksdb (backport cosmos#15422) (cosmos#15525)

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)

Co-authored-by: Daniel Wedul <github@wedul.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

* fix: remove unnecessary cms typecasting (backport cosmos#14054) (cosmos#15669)

Co-authored-by: Javier Su <javier.su.weijie@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore: prepare v0.46.12 release notes (cosmos#15685)

* fix: upstream error on empty version (backport cosmos#13355) (cosmos#15717)

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: More flexibility for `CacheMultiStoreWithVersion` (backport cosmos#15683) (cosmos#15775)

Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add moduleStateCb to allow access moduleState in sim test (backport cosmos#15903) (cosmos#15925)

Co-authored-by: mmsqe <tqd0800210105@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): bump cometbft to v0.34.28 (cosmos#15973)

* chore(gov): improve proposal conversion error message (backport cosmos#15979) (cosmos#15981)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* feat!: bootstrap comet cmd for local state sync  (backport cosmos#16061) (cosmos#16080)

Co-authored-by: Marko <marbar3778@yahoo.com>

* chore(auth/vesting): fix typo in `create-period-vesting-account` cmd example (backport cosmos#16085) (cosmos#16087)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add local snapshots management commands (backport cosmos#16067) (cosmos#16103)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: snapshot commands panic if snapshot don't exists (backport cosmos#16138) (cosmos#16140)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: save restored snapshot locally (backport cosmos#16060) (cosmos#16262)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* chore: update sidebar v0.46 (cosmos#16304)

* chore: add baseapp circuit breaker setter (cosmos#16289)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: allow any address in `ValidatePromptAddress` (backport cosmos#16312) (cosmos#16314)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(group): add group event tally result (backport cosmos#16191) (cosmos#16306)

Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: Revert "fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)" (cosmos#16331)

* chore: prepare v0.46.13 (cosmos#16249)

* chore: small snapshot commands & docs improvement (backport cosmos#16404) (cosmos#16409)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* Add the quarantine and sanction stores to the import-export sim test.

* refactor: avoid breaking change due to cosmos#16415 included in v0.50 (backport cosmos#16430) (cosmos#16432)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Facundo Medica <facundomedica@gmail.com>

* chore: prepare v0.46.13 (2/2) (cosmos#16443)

* fix: patch barberry (cosmos#16466)

* Better gov prop error handling.

* Fix the group sims random genesis so it can't pick the same account twice for the group policies since that address is the primary key for the table. Also, output the genesis state after it's randomized just like all the other modules do.

* Add changelog entries.

* Regen the swagger docs.

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Javier Su <javier.su.weijie@gmail.com>
Co-authored-by: mmsqe <tqd0800210105@gmail.com>
Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com>
Co-authored-by: Facundo Medica <facundomedica@gmail.com>
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Jun 9, 2023
* fix: create snapshot dir for rocksdb backend (backport cosmos#15054) (cosmos#15065)

Co-authored-by: yihuang <huang@crypto.com>

* chore: Add check for uneven stores' height (backport cosmos#14410) (cosmos#15115)

Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* refactor!: remove store v2alpha1 (cosmos#15152)

* build: use cometbft in v0.46 (cosmos#15090)

* chore: bump cometbft to v0.34.27 final (cosmos#15206)

* fix: Change proposer address cast for `sdk_block` conversion (backport cosmos#15243) (cosmos#15245)

Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: revert double close fix (cosmos#15255)

* chore: prepare v0.46.11 release (cosmos#15259)

* feat: add extend cb to avoid unmarshal state twice for sim test (backport: cosmos#15305) (cosmos#15321)

* feat: add extend cb with genesisState for sim test (backport: cosmos#15305) (cosmos#15349)

* fix: add extra check in vesting (backport cosmos#15373) (cosmos#15383)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* docs: update cosmwasm link (cosmos#15441)

* fix: remove extra `;` in service.proto (cosmos#15443)

* fix: flaky group genesis sim (backport cosmos#15447) (cosmos#15461)

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* feat: add delegator to withdraw address (backport cosmos#15462) (cosmos#15473)

Co-authored-by: Marko <marbar3778@yahoo.com>

* docs: improve proto vesting docs about time attributes (backport cosmos#15474) (cosmos#15481)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add query `groups` in `x/group` (backport cosmos#14879) (cosmos#15476)

Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix: Makefile rocksdb (backport cosmos#15422) (cosmos#15525)

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)

Co-authored-by: Daniel Wedul <github@wedul.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

* fix: remove unnecessary cms typecasting (backport cosmos#14054) (cosmos#15669)

Co-authored-by: Javier Su <javier.su.weijie@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore: prepare v0.46.12 release notes (cosmos#15685)

* fix: upstream error on empty version (backport cosmos#13355) (cosmos#15717)

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: More flexibility for `CacheMultiStoreWithVersion` (backport cosmos#15683) (cosmos#15775)

Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add moduleStateCb to allow access moduleState in sim test (backport cosmos#15903) (cosmos#15925)

Co-authored-by: mmsqe <tqd0800210105@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): bump cometbft to v0.34.28 (cosmos#15973)

* chore(gov): improve proposal conversion error message (backport cosmos#15979) (cosmos#15981)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* feat!: bootstrap comet cmd for local state sync  (backport cosmos#16061) (cosmos#16080)

Co-authored-by: Marko <marbar3778@yahoo.com>

* chore(auth/vesting): fix typo in `create-period-vesting-account` cmd example (backport cosmos#16085) (cosmos#16087)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add local snapshots management commands (backport cosmos#16067) (cosmos#16103)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: snapshot commands panic if snapshot don't exists (backport cosmos#16138) (cosmos#16140)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: save restored snapshot locally (backport cosmos#16060) (cosmos#16262)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* chore: update sidebar v0.46 (cosmos#16304)

* chore: add baseapp circuit breaker setter (cosmos#16289)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: allow any address in `ValidatePromptAddress` (backport cosmos#16312) (cosmos#16314)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(group): add group event tally result (backport cosmos#16191) (cosmos#16306)

Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: Revert "fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)" (cosmos#16331)

* chore: prepare v0.46.13 (cosmos#16249)

* chore: small snapshot commands & docs improvement (backport cosmos#16404) (cosmos#16409)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* Add the quarantine and sanction stores to the import-export sim test.

* refactor: avoid breaking change due to cosmos#16415 included in v0.50 (backport cosmos#16430) (cosmos#16432)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Facundo Medica <facundomedica@gmail.com>

* chore: prepare v0.46.13 (2/2) (cosmos#16443)

* fix: patch barberry (cosmos#16466)

* Better gov prop error handling.

* Fix the group sims random genesis so it can't pick the same account twice for the group policies since that address is the primary key for the table. Also, output the genesis state after it's randomized just like all the other modules do.

* Add changelog entries.

* Regen the swagger docs.

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Javier Su <javier.su.weijie@gmail.com>
Co-authored-by: mmsqe <tqd0800210105@gmail.com>
Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com>
Co-authored-by: Facundo Medica <facundomedica@gmail.com>
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Jun 9, 2023
* fix: create snapshot dir for rocksdb backend (backport cosmos#15054) (cosmos#15065)



* chore: Add check for uneven stores' height (backport cosmos#14410) (cosmos#15115)




* refactor!: remove store v2alpha1 (cosmos#15152)

* build: use cometbft in v0.46 (cosmos#15090)

* chore: bump cometbft to v0.34.27 final (cosmos#15206)

* fix: Change proposer address cast for `sdk_block` conversion (backport cosmos#15243) (cosmos#15245)




* fix: revert double close fix (cosmos#15255)

* chore: prepare v0.46.11 release (cosmos#15259)

* feat: add extend cb to avoid unmarshal state twice for sim test (backport: cosmos#15305) (cosmos#15321)

* feat: add extend cb with genesisState for sim test (backport: cosmos#15305) (cosmos#15349)

* fix: add extra check in vesting (backport cosmos#15373) (cosmos#15383)



* docs: update cosmwasm link (cosmos#15441)

* fix: remove extra `;` in service.proto (cosmos#15443)

* fix: flaky group genesis sim (backport cosmos#15447) (cosmos#15461)



* feat: add delegator to withdraw address (backport cosmos#15462) (cosmos#15473)



* docs: improve proto vesting docs about time attributes (backport cosmos#15474) (cosmos#15481)



* feat: add query `groups` in `x/group` (backport cosmos#14879) (cosmos#15476)




* fix: Makefile rocksdb (backport cosmos#15422) (cosmos#15525)



* fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)




* fix: remove unnecessary cms typecasting (backport cosmos#14054) (cosmos#15669)




* chore: prepare v0.46.12 release notes (cosmos#15685)

* fix: upstream error on empty version (backport cosmos#13355) (cosmos#15717)




* feat: More flexibility for `CacheMultiStoreWithVersion` (backport cosmos#15683) (cosmos#15775)




* feat: add moduleStateCb to allow access moduleState in sim test (backport cosmos#15903) (cosmos#15925)




* build(deps): bump cometbft to v0.34.28 (cosmos#15973)

* chore(gov): improve proposal conversion error message (backport cosmos#15979) (cosmos#15981)




* feat!: bootstrap comet cmd for local state sync  (backport cosmos#16061) (cosmos#16080)



* chore(auth/vesting): fix typo in `create-period-vesting-account` cmd example (backport cosmos#16085) (cosmos#16087)



* feat: add local snapshots management commands (backport cosmos#16067) (cosmos#16103)





* fix: snapshot commands panic if snapshot don't exists (backport cosmos#16138) (cosmos#16140)





* feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205)




* feat: save restored snapshot locally (backport cosmos#16060) (cosmos#16262)




* chore: update sidebar v0.46 (cosmos#16304)

* chore: add baseapp circuit breaker setter (cosmos#16289)



* fix: allow any address in `ValidatePromptAddress` (backport cosmos#16312) (cosmos#16314)



* feat(group): add group event tally result (backport cosmos#16191) (cosmos#16306)





* fix: Revert "fix(x/gov): Return ErrInvalidProposalContent in SubmitProposal when legacy handler returns an error. (backport cosmos#13051) (cosmos#15667)" (cosmos#16331)

* chore: prepare v0.46.13 (cosmos#16249)

* chore: small snapshot commands & docs improvement (backport cosmos#16404) (cosmos#16409)



* Add the quarantine and sanction stores to the import-export sim test.

* refactor: avoid breaking change due to cosmos#16415 included in v0.50 (backport cosmos#16430) (cosmos#16432)




* chore: prepare v0.46.13 (2/2) (cosmos#16443)

* fix: patch barberry (cosmos#16466)

* Better gov prop error handling.

* Fix the group sims random genesis so it can't pick the same account twice for the group policies since that address is the primary key for the table. Also, output the genesis state after it's randomized just like all the other modules do.

* Add changelog entries.

* Regen the swagger docs.

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Maksym Hontar <99190705+max-hontar@users.noreply.github.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Javier Su <javier.su.weijie@gmail.com>
Co-authored-by: mmsqe <tqd0800210105@gmail.com>
Co-authored-by: Jeancarlo Barrios <JeancarloBarrios@users.noreply.github.com>
Co-authored-by: Facundo Medica <facundomedica@gmail.com>
JeancarloBarrios pushed a commit to agoric-labs/cosmos-sdk that referenced this pull request Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release C:CLI C:orm C:x/auth C:x/tx T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants