From 7d42f62f90c45d32574b11209e98610f5840ad5c Mon Sep 17 00:00:00 2001 From: Alexander Bezobchuk Date: Tue, 13 Aug 2019 16:00:28 -0400 Subject: [PATCH] Merge PR #4902: Changelog Flow Updates --- .clog.yaml | 16 ---- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .pending/breaking/_All-REST-responses- | 2 - .pending/breaking/modules/_4665-gov-refactor | 3 - .pending/breaking/rest/_Remove-version-and- | 2 - .pending/breaking/rest/_The-balance-field-i | 1 - .pending/bugfixes/_4868-Context-CacheC | 2 - .pending/bugfixes/_4891-Disable-queryi | 1 - .pending/bugfixes/_Return-height-in-re | 1 - .pending/bugfixes/_Sort-state-JSON-dur | 1 - .pending/bugfixes/abci/_4639-checktx-verify | 1 - .pending/bugfixes/cli/_4763-fix-flag-min-s | 1 - .pending/bugfixes/cli/_4870-Disable-the-wi | 1 - .pending/bugfixes/keys/Fix-ledger-custom-co | 1 - .pending/bugfixes/keys/_4338-fix-multisig-o | 1 - .../bugfixes/modules/_4795-restrict-txs-m | 2 - .../bugfixes/modules/_fix-defaultunbondin | 1 - .../bugfixes/modules/_prevent-community-s | 1 - .pending/bugfixes/rest/_4858-Do-not-return- | 3 - .../bugfixes/simulation/_Fix-non-determinism | 2 - .pending/bugfixes/store/_Fix-IAVL-Store-to-p | 2 - .../bugfixes/tendermint/_4879-Don-t-terminat | 1 - .pending/features/_4843-Add-RegisterEv | 2 - .pending/features/store/4724-Multistore-supp | 4 - .pending/improvements/_4775-Refactor-CI-co | 1 - .pending/improvements/_Upgrade-IAVL-to-v0- | 1 - .../improvements/keys/_4611-store-keys-in- | 1 - .../improvements/modules/4762-Deprecate-remov | 1 - .../improvements/modules/_4751-update-genutil | 1 - .../improvements/modules/_4760-update-auth | 1 - .../improvements/modules/_4814-Add-security-c | 1 - .../improvements/rest/3867-Allow-querying- | 1 - .pending/improvements/sdk/4566-sim-export | 2 - .../improvements/sdk/4640-extend-DiffKVSt | 2 - .../improvements/sdk/4717-refactor-slashi | 1 - .../improvements/sdk/4758-update-genaccou | 1 - .../simulation/4824-PrintAllInvaria | 1 - .../simulation/_4490-add-init-heigh | 1 - .../simulation/_4670-JSON-sim-stats | 2 - .../improvements/store/_4792-panic-non-regi | 1 - .../tendermint/_Upgrade-Tendermint- | 1 - .../improvements/types/4821-types-errors-pa | 2 - CHANGELOG.md | 96 +++++++++++++++++-- CONTRIBUTING.md | 88 +++++++++-------- contrib/devtools/Makefile | 18 ++-- scripts/linkify_changelog.py | 15 +++ 46 files changed, 158 insertions(+), 135 deletions(-) delete mode 100644 .clog.yaml delete mode 100644 .pending/breaking/_All-REST-responses- delete mode 100644 .pending/breaking/modules/_4665-gov-refactor delete mode 100644 .pending/breaking/rest/_Remove-version-and- delete mode 100644 .pending/breaking/rest/_The-balance-field-i delete mode 100644 .pending/bugfixes/_4868-Context-CacheC delete mode 100644 .pending/bugfixes/_4891-Disable-queryi delete mode 100644 .pending/bugfixes/_Return-height-in-re delete mode 100644 .pending/bugfixes/_Sort-state-JSON-dur delete mode 100644 .pending/bugfixes/abci/_4639-checktx-verify delete mode 100644 .pending/bugfixes/cli/_4763-fix-flag-min-s delete mode 100644 .pending/bugfixes/cli/_4870-Disable-the-wi delete mode 100644 .pending/bugfixes/keys/Fix-ledger-custom-co delete mode 100644 .pending/bugfixes/keys/_4338-fix-multisig-o delete mode 100644 .pending/bugfixes/modules/_4795-restrict-txs-m delete mode 100644 .pending/bugfixes/modules/_fix-defaultunbondin delete mode 100644 .pending/bugfixes/modules/_prevent-community-s delete mode 100644 .pending/bugfixes/rest/_4858-Do-not-return- delete mode 100644 .pending/bugfixes/simulation/_Fix-non-determinism delete mode 100644 .pending/bugfixes/store/_Fix-IAVL-Store-to-p delete mode 100644 .pending/bugfixes/tendermint/_4879-Don-t-terminat delete mode 100644 .pending/features/_4843-Add-RegisterEv delete mode 100644 .pending/features/store/4724-Multistore-supp delete mode 100644 .pending/improvements/_4775-Refactor-CI-co delete mode 100644 .pending/improvements/_Upgrade-IAVL-to-v0- delete mode 100644 .pending/improvements/keys/_4611-store-keys-in- delete mode 100644 .pending/improvements/modules/4762-Deprecate-remov delete mode 100644 .pending/improvements/modules/_4751-update-genutil delete mode 100644 .pending/improvements/modules/_4760-update-auth delete mode 100644 .pending/improvements/modules/_4814-Add-security-c delete mode 100644 .pending/improvements/rest/3867-Allow-querying- delete mode 100644 .pending/improvements/sdk/4566-sim-export delete mode 100644 .pending/improvements/sdk/4640-extend-DiffKVSt delete mode 100644 .pending/improvements/sdk/4717-refactor-slashi delete mode 100644 .pending/improvements/sdk/4758-update-genaccou delete mode 100644 .pending/improvements/simulation/4824-PrintAllInvaria delete mode 100644 .pending/improvements/simulation/_4490-add-init-heigh delete mode 100644 .pending/improvements/simulation/_4670-JSON-sim-stats delete mode 100644 .pending/improvements/store/_4792-panic-non-regi delete mode 100644 .pending/improvements/tendermint/_Upgrade-Tendermint- delete mode 100644 .pending/improvements/types/4821-types-errors-pa create mode 100644 scripts/linkify_changelog.py diff --git a/.clog.yaml b/.clog.yaml deleted file mode 100644 index d2777fae6..000000000 --- a/.clog.yaml +++ /dev/null @@ -1,16 +0,0 @@ -sections: - breaking: Breaking Changes - features: Features - improvements: Improvements - bugfixes: Bugfixes - -tags: - - keys - - store - - abci - - rest - - cli - - modules - - simulation - - types - - tendermint diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4abd843fa..b7ffdc2b3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,7 +9,7 @@ v If a checkbox is n/a - please still include it but + a little note why - [ ] Linked to github-issue with discussion and accepted design OR link to spec that describes this work. - [ ] Wrote tests - [ ] Updated relevant documentation (`docs/`) -- [ ] Added a relevant changelog entry: `clog add [section] [-t ] [-m ]` +- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [ ] Re-reviewed `Files changed` in the github PR explorer ______ diff --git a/.pending/breaking/_All-REST-responses- b/.pending/breaking/_All-REST-responses- deleted file mode 100644 index 9b61f0f08..000000000 --- a/.pending/breaking/_All-REST-responses- +++ /dev/null @@ -1,2 +0,0 @@ -All REST responses now wrap the original resource/result. The response -will contain two fields: height and result. diff --git a/.pending/breaking/modules/_4665-gov-refactor b/.pending/breaking/modules/_4665-gov-refactor deleted file mode 100644 index a2e6fa548..000000000 --- a/.pending/breaking/modules/_4665-gov-refactor +++ /dev/null @@ -1,3 +0,0 @@ -#4665 Refactored `x/gov` module structure and dev-UX: - - Prepare for module spec integration - - Update gov keys to use big endian encoding instead of little endian \ No newline at end of file diff --git a/.pending/breaking/rest/_Remove-version-and- b/.pending/breaking/rest/_Remove-version-and- deleted file mode 100644 index 9a3847aca..000000000 --- a/.pending/breaking/rest/_Remove-version-and- +++ /dev/null @@ -1,2 +0,0 @@ -[\#4837](https://github.com/cosmos/cosmos-sdk/pull/4837) Remove /version and /node_version -endpoints in favor of refactoring /node_info to also include application version info. diff --git a/.pending/breaking/rest/_The-balance-field-i b/.pending/breaking/rest/_The-balance-field-i deleted file mode 100644 index 163828427..000000000 --- a/.pending/breaking/rest/_The-balance-field-i +++ /dev/null @@ -1 +0,0 @@ -#4783 The balance field in the DelegationResponse type is now sdk.Coin instead of sdk.Int diff --git a/.pending/bugfixes/_4868-Context-CacheC b/.pending/bugfixes/_4868-Context-CacheC deleted file mode 100644 index 84b0f6340..000000000 --- a/.pending/bugfixes/_4868-Context-CacheC +++ /dev/null @@ -1,2 +0,0 @@ -#4868 Context#CacheContext now sets a new EventManager. This prevents unwanted events -from being emitted. diff --git a/.pending/bugfixes/_4891-Disable-queryi b/.pending/bugfixes/_4891-Disable-queryi deleted file mode 100644 index 2878ce82b..000000000 --- a/.pending/bugfixes/_4891-Disable-queryi +++ /dev/null @@ -1 +0,0 @@ -#4891 Disable querying with proofs enabled when the query height <= 1. diff --git a/.pending/bugfixes/_Return-height-in-re b/.pending/bugfixes/_Return-height-in-re deleted file mode 100644 index f4c332a69..000000000 --- a/.pending/bugfixes/_Return-height-in-re +++ /dev/null @@ -1 +0,0 @@ -Return height in responses when querying against BaseApp \ No newline at end of file diff --git a/.pending/bugfixes/_Sort-state-JSON-dur b/.pending/bugfixes/_Sort-state-JSON-dur deleted file mode 100644 index 690493921..000000000 --- a/.pending/bugfixes/_Sort-state-JSON-dur +++ /dev/null @@ -1 +0,0 @@ -Sort state JSON during export and initialization diff --git a/.pending/bugfixes/abci/_4639-checktx-verify b/.pending/bugfixes/abci/_4639-checktx-verify deleted file mode 100644 index 8441c5cfb..000000000 --- a/.pending/bugfixes/abci/_4639-checktx-verify +++ /dev/null @@ -1 +0,0 @@ -#4639 Fix `CheckTx` by verifying the message route diff --git a/.pending/bugfixes/cli/_4763-fix-flag-min-s b/.pending/bugfixes/cli/_4763-fix-flag-min-s deleted file mode 100644 index 9822f2185..000000000 --- a/.pending/bugfixes/cli/_4763-fix-flag-min-s +++ /dev/null @@ -1 +0,0 @@ -#4763 fix flag `--min-self-delegation` for staking `EditValidator` \ No newline at end of file diff --git a/.pending/bugfixes/cli/_4870-Disable-the-wi b/.pending/bugfixes/cli/_4870-Disable-the-wi deleted file mode 100644 index bd911069d..000000000 --- a/.pending/bugfixes/cli/_4870-Disable-the-wi +++ /dev/null @@ -1 +0,0 @@ -#4870 Disable the `withdraw-all-rewards` command when `--generate-only` is supplied diff --git a/.pending/bugfixes/keys/Fix-ledger-custom-co b/.pending/bugfixes/keys/Fix-ledger-custom-co deleted file mode 100644 index 2a1b5b02e..000000000 --- a/.pending/bugfixes/keys/Fix-ledger-custom-co +++ /dev/null @@ -1 +0,0 @@ -Fix ledger custom coin type support bug \ No newline at end of file diff --git a/.pending/bugfixes/keys/_4338-fix-multisig-o b/.pending/bugfixes/keys/_4338-fix-multisig-o deleted file mode 100644 index 5f4175139..000000000 --- a/.pending/bugfixes/keys/_4338-fix-multisig-o +++ /dev/null @@ -1 +0,0 @@ -#4338 fix multisig key output for CLI \ No newline at end of file diff --git a/.pending/bugfixes/modules/_4795-restrict-txs-m b/.pending/bugfixes/modules/_4795-restrict-txs-m deleted file mode 100644 index 5286c7d01..000000000 --- a/.pending/bugfixes/modules/_4795-restrict-txs-m +++ /dev/null @@ -1,2 +0,0 @@ -#4795 restrict module accounts from receiving transactions. -Allowing this would cause an invariant on the module account coins. diff --git a/.pending/bugfixes/modules/_fix-defaultunbondin b/.pending/bugfixes/modules/_fix-defaultunbondin deleted file mode 100644 index cd4c7ee97..000000000 --- a/.pending/bugfixes/modules/_fix-defaultunbondin +++ /dev/null @@ -1 +0,0 @@ -#4823 Update the `DefaultUnbondingTime` from 3 days to 3 weeks to be inline with documentation. diff --git a/.pending/bugfixes/modules/_prevent-community-s b/.pending/bugfixes/modules/_prevent-community-s deleted file mode 100644 index e25abd9a7..000000000 --- a/.pending/bugfixes/modules/_prevent-community-s +++ /dev/null @@ -1 +0,0 @@ -#4831 Prevent community spend proposal from transferring funds to a module account diff --git a/.pending/bugfixes/rest/_4858-Do-not-return- b/.pending/bugfixes/rest/_4858-Do-not-return- deleted file mode 100644 index 5459f7510..000000000 --- a/.pending/bugfixes/rest/_4858-Do-not-return- +++ /dev/null @@ -1,3 +0,0 @@ -#4858 Do not return an error in BroadcastTxCommit when the tx broadcasting -was successful. This allows the proper REST response to be returned for a -failed tx during `block` broadcasting mode. diff --git a/.pending/bugfixes/simulation/_Fix-non-determinism b/.pending/bugfixes/simulation/_Fix-non-determinism deleted file mode 100644 index 7a1b606ff..000000000 --- a/.pending/bugfixes/simulation/_Fix-non-determinism +++ /dev/null @@ -1,2 +0,0 @@ -[\#4861](https://github.com/cosmos/cosmos-sdk/pull/4861) Fix non-determinism simulation -by using CLI flags as input and updating Makefile target. \ No newline at end of file diff --git a/.pending/bugfixes/store/_Fix-IAVL-Store-to-p b/.pending/bugfixes/store/_Fix-IAVL-Store-to-p deleted file mode 100644 index 27c704e6f..000000000 --- a/.pending/bugfixes/store/_Fix-IAVL-Store-to-p +++ /dev/null @@ -1,2 +0,0 @@ -[\#4880](https://github.com/cosmos/cosmos-sdk/pull/4880) Fix error check in -IAVL `Store#DeleteVersion`. diff --git a/.pending/bugfixes/tendermint/_4879-Don-t-terminat b/.pending/bugfixes/tendermint/_4879-Don-t-terminat deleted file mode 100644 index 6c92b1f2e..000000000 --- a/.pending/bugfixes/tendermint/_4879-Don-t-terminat +++ /dev/null @@ -1 +0,0 @@ -#4879 Don't terminate the process immediately after startup when run in standalone mode. diff --git a/.pending/features/_4843-Add-RegisterEv b/.pending/features/_4843-Add-RegisterEv deleted file mode 100644 index 17ad66e6a..000000000 --- a/.pending/features/_4843-Add-RegisterEv +++ /dev/null @@ -1,2 +0,0 @@ -#4843 Add RegisterEvidences function in the codec package to register -Tendermint evidence types with a given codec. diff --git a/.pending/features/store/4724-Multistore-supp b/.pending/features/store/4724-Multistore-supp deleted file mode 100644 index b1fa458f9..000000000 --- a/.pending/features/store/4724-Multistore-supp +++ /dev/null @@ -1,4 +0,0 @@ -#4724 Multistore supports substore migrations upon load. -New `rootmulti.Store.LoadLatestVersionAndUpgrade` method -Baseapp supports `StoreLoader` to enable various upgrade strategies -No longer panics if the store to load contains substores that we didn't explicitly mount. diff --git a/.pending/improvements/_4775-Refactor-CI-co b/.pending/improvements/_4775-Refactor-CI-co deleted file mode 100644 index 650e919d9..000000000 --- a/.pending/improvements/_4775-Refactor-CI-co +++ /dev/null @@ -1 +0,0 @@ -#4775 Refactor CI config \ No newline at end of file diff --git a/.pending/improvements/_Upgrade-IAVL-to-v0- b/.pending/improvements/_Upgrade-IAVL-to-v0- deleted file mode 100644 index d77a50c2b..000000000 --- a/.pending/improvements/_Upgrade-IAVL-to-v0- +++ /dev/null @@ -1 +0,0 @@ -Upgrade IAVL to v0.12.4 \ No newline at end of file diff --git a/.pending/improvements/keys/_4611-store-keys-in- b/.pending/improvements/keys/_4611-store-keys-in- deleted file mode 100644 index e319e241a..000000000 --- a/.pending/improvements/keys/_4611-store-keys-in- +++ /dev/null @@ -1 +0,0 @@ -#4611 store keys in simapp now use a map instead of using individual literal keys diff --git a/.pending/improvements/modules/4762-Deprecate-remov b/.pending/improvements/modules/4762-Deprecate-remov deleted file mode 100644 index 463b32db2..000000000 --- a/.pending/improvements/modules/4762-Deprecate-remov +++ /dev/null @@ -1 +0,0 @@ -# 4762 Deprecate remove and add permissions in ModuleAccount. \ No newline at end of file diff --git a/.pending/improvements/modules/_4751-update-genutil b/.pending/improvements/modules/_4751-update-genutil deleted file mode 100644 index d1bbd4f15..000000000 --- a/.pending/improvements/modules/_4751-update-genutil +++ /dev/null @@ -1 +0,0 @@ -#4751 update `x/genutils` to match module spec diff --git a/.pending/improvements/modules/_4760-update-auth b/.pending/improvements/modules/_4760-update-auth deleted file mode 100644 index f200d78a6..000000000 --- a/.pending/improvements/modules/_4760-update-auth +++ /dev/null @@ -1 +0,0 @@ -#4760 update `x/auth` to match module spec diff --git a/.pending/improvements/modules/_4814-Add-security-c b/.pending/improvements/modules/_4814-Add-security-c deleted file mode 100644 index f661bc64f..000000000 --- a/.pending/improvements/modules/_4814-Add-security-c +++ /dev/null @@ -1 +0,0 @@ -#4814 Add security contact to Validator description \ No newline at end of file diff --git a/.pending/improvements/rest/3867-Allow-querying- b/.pending/improvements/rest/3867-Allow-querying- deleted file mode 100644 index 2681ec8b5..000000000 --- a/.pending/improvements/rest/3867-Allow-querying- +++ /dev/null @@ -1 +0,0 @@ -# 3867 Allow querying for genesis transaction when height query param is set to zero. diff --git a/.pending/improvements/sdk/4566-sim-export b/.pending/improvements/sdk/4566-sim-export deleted file mode 100644 index 6dfd5d421..000000000 --- a/.pending/improvements/sdk/4566-sim-export +++ /dev/null @@ -1,2 +0,0 @@ -#4566 Export simulation's parameters and app state to JSON in order to reproduce bugs -and invariants. \ No newline at end of file diff --git a/.pending/improvements/sdk/4640-extend-DiffKVSt b/.pending/improvements/sdk/4640-extend-DiffKVSt deleted file mode 100644 index 821dd5c40..000000000 --- a/.pending/improvements/sdk/4640-extend-DiffKVSt +++ /dev/null @@ -1,2 +0,0 @@ -#4640 improve import/export simulation errors by extending `DiffKVStores` -to return an array of `KVPairs` that are then compared to check for inconsistencies. \ No newline at end of file diff --git a/.pending/improvements/sdk/4717-refactor-slashi b/.pending/improvements/sdk/4717-refactor-slashi deleted file mode 100644 index 24a2359d6..000000000 --- a/.pending/improvements/sdk/4717-refactor-slashi +++ /dev/null @@ -1 +0,0 @@ -#4717 refactor `x/slashing` to match the new module spec \ No newline at end of file diff --git a/.pending/improvements/sdk/4758-update-genaccou b/.pending/improvements/sdk/4758-update-genaccou deleted file mode 100644 index e9a3e8cf7..000000000 --- a/.pending/improvements/sdk/4758-update-genaccou +++ /dev/null @@ -1 +0,0 @@ -#4758 update `x/genaccounts` to match module spec \ No newline at end of file diff --git a/.pending/improvements/simulation/4824-PrintAllInvaria b/.pending/improvements/simulation/4824-PrintAllInvaria deleted file mode 100644 index fd23692f9..000000000 --- a/.pending/improvements/simulation/4824-PrintAllInvaria +++ /dev/null @@ -1 +0,0 @@ -# 4824 PrintAllInvariants flag will print all failed invariants \ No newline at end of file diff --git a/.pending/improvements/simulation/_4490-add-init-heigh b/.pending/improvements/simulation/_4490-add-init-heigh deleted file mode 100644 index df6b069c5..000000000 --- a/.pending/improvements/simulation/_4490-add-init-heigh +++ /dev/null @@ -1 +0,0 @@ -# 4490 add `InitialBlockHeight` flag to resume a simulation from a given block \ No newline at end of file diff --git a/.pending/improvements/simulation/_4670-JSON-sim-stats b/.pending/improvements/simulation/_4670-JSON-sim-stats deleted file mode 100644 index 4358d2526..000000000 --- a/.pending/improvements/simulation/_4670-JSON-sim-stats +++ /dev/null @@ -1,2 +0,0 @@ -#4670 Update simulation statistics to JSON format - - Support exporting the simulation stats to a given JSON file diff --git a/.pending/improvements/store/_4792-panic-non-regi b/.pending/improvements/store/_4792-panic-non-regi deleted file mode 100644 index 1a83162fa..000000000 --- a/.pending/improvements/store/_4792-panic-non-regi +++ /dev/null @@ -1 +0,0 @@ -#4792 panic on non-registered store \ No newline at end of file diff --git a/.pending/improvements/tendermint/_Upgrade-Tendermint- b/.pending/improvements/tendermint/_Upgrade-Tendermint- deleted file mode 100644 index 653e4d26a..000000000 --- a/.pending/improvements/tendermint/_Upgrade-Tendermint- +++ /dev/null @@ -1 +0,0 @@ -Upgrade Tendermint to v0.32.2 \ No newline at end of file diff --git a/.pending/improvements/types/4821-types-errors-pa b/.pending/improvements/types/4821-types-errors-pa deleted file mode 100644 index e8afa72f5..000000000 --- a/.pending/improvements/types/4821-types-errors-pa +++ /dev/null @@ -1,2 +0,0 @@ -#4821 types/errors package added with support for stacktraces -Meant as a more feature-rich replacement for sdk.Errors in the mid-term diff --git a/CHANGELOG.md b/CHANGELOG.md index dba749d3d..1c29204e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,74 @@ + + # Changelog -## 0.36.0 +## [Unreleased] + +### Breaking Changes + +* (modules) [\#4665](https://github.com/cosmos/cosmos-sdk/issues/4665) Refactored `x/gov` module structure and dev-UX: + * Prepare for module spec integration + * Update gov keys to use big endian encoding instead of little endian +* (rest) [\#4783](https://github.com/cosmos/cosmos-sdk/issues/4783) The balance field in the DelegationResponse type is now sdk.Coin instead of sdk.Int + +### Features + +* (store) [\#4724](https://github.com/cosmos/cosmos-sdk/issues/4724) Multistore supports substore migrations upon load. New `rootmulti.Store.LoadLatestVersionAndUpgrade` method in +`Baseapp` supports `StoreLoader` to enable various upgrade strategies. It no +longer panics if the store to load contains substores that we didn't explicitly mount. + +### Improvements + +* (modules) [\#4762](https://github.com/cosmos/cosmos-sdk/issues/4762) Deprecate remove and add permissions in ModuleAccount. +* (modules) [\#4760](https://github.com/cosmos/cosmos-sdk/issues/4760) update `x/auth` to match module spec. +* (modules) [\#4814](https://github.com/cosmos/cosmos-sdk/issues/4814) Add security contact to Validator description. +* (sdk) [\#4566](https://github.com/cosmos/cosmos-sdk/issues/4566) Export simulation's parameters and app state to JSON in order to reproduce bugs and invariants. +* (sdk) [\#4640](https://github.com/cosmos/cosmos-sdk/issues/4640) improve import/export simulation errors by extending `DiffKVStores` to return an array of `KVPairs` that are then compared to check for inconsistencies. +* (sdk) [\#4717](https://github.com/cosmos/cosmos-sdk/issues/4717) refactor `x/slashing` to match the new module spec +* (sdk) [\#4758](https://github.com/cosmos/cosmos-sdk/issues/4758) update `x/genaccounts` to match module spec +* (simulation) [\#4824](https://github.com/cosmos/cosmos-sdk/issues/4824) PrintAllInvariants flag will print all failed invariants +* (simulation) [\#4490](https://github.com/cosmos/cosmos-sdk/issues/4490) add `InitialBlockHeight` flag to resume a simulation from a given block + * Support exporting the simulation stats to a given JSON file +* (store) [\#4792](https://github.com/cosmos/cosmos-sdk/issues/4792) panic on non-registered store +* (types) [\#4821](https://github.com/cosmos/cosmos-sdk/issues/4821) types/errors package added with support for stacktraces. It is meant as a more feature-rich replacement for sdk.Errors in the mid-term. + +### Bug Fixes + +* (cli) [\#4763](https://github.com/cosmos/cosmos-sdk/issues/4763) Fix flag `--min-self-delegation` for staking `EditValidator` +* (keys) Fix ledger custom coin type support bug + +## [v0.36.0] - 2019-08-13 ### Breaking Changes @@ -162,12 +230,19 @@ Replace complex Context construct with a simpler immutible struct. Only breaking change is not to support `Value` and `GetValue` as first class calls. We do embed ctx.Context() as a raw context.Context instead to be used as you see fit. - + Migration guide: - - `ctx = ctx.WithValue(contextKeyBadProposal, false)` -> - `ctx = ctx.WithContext(context.WithValue(ctx.Context(), contextKeyBadProposal, false))` - + + ```go + ctx = ctx.WithValue(contextKeyBadProposal, false) + ``` + + Now becomes: + + ```go + ctx = ctx.WithContext(context.WithValue(ctx.Context(), contextKeyBadProposal, false)) + ``` + A bit more verbose, but also allows `context.WithTimeout()`, etc and only used in one function in this repo, in test code. * [\#3685](https://github.com/cosmos/cosmos-sdk/issues/3685) Add `SetAddressVerifier` and `GetAddressVerifier` to `sdk.Config` to allow SDK users to configure custom address format verification logic (to override the default limitation of 20-byte addresses). @@ -222,8 +297,8 @@ methods. * [\#4654](https://github.com/cosmos/cosmos-sdk/issues/4654) validator slash event stored by period and height * [\#4681](https://github.com/cosmos/cosmos-sdk/issues/4681) panic on invalid amount on `MintCoins` and `BurnCoins` - - skip minting if inflation is set to zero -* Sort state JSON during export and initialization + * skip minting if inflation is set to zero +* Sort state JSON during export and initialization ## 0.35.0 @@ -2468,3 +2543,8 @@ BUG FIXES: ##### September 22, 2016 * Basecoin compiles again + + + +[Unreleased]: https://github.com/cosmos/cosmos-sdk/compare/v0.36.0...HEAD +[v0.36.0]: https://github.com/cosmos/cosmos-sdk/releases/tag/v0.36.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4adfbf931..287518a07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,19 @@ # Contributing -- [ADR](#adr) -- [Pull Requests](#pull-requests) - - [Process for reviewing PRs](#process-for-reviewing-prs) - - [Updating Documentation](#updating-documentation) -- [Forking](#forking) -- [Dependencies](#dependencies) -- [Testing](#testing) -- [Branching Model and Release](#branching-model-and-release) - - [PR Targeting](#pr-targeting) - - [Development Procedure](#development-procedure) - - [Pull Merge Procedure](#pull-merge-procedure) - - [Release Procedure](#release-procedure) - - [Point Release Procedure](#point-release-procedure) +- [Contributing](#contributing) + - [Architecture Decision Records (ADR)](#architecture-decision-records-adr) + - [Pull Requests](#pull-requests) + - [Process for reviewing PRs](#process-for-reviewing-prs) + - [Updating Documentation](#updating-documentation) + - [Forking](#forking) + - [Dependencies](#dependencies) + - [Testing](#testing) + - [Branching Model and Release](#branching-model-and-release) + - [PR Targeting](#pr-targeting) + - [Development Procedure](#development-procedure) + - [Pull Merge Procedure](#pull-merge-procedure) + - [Release Procedure](#release-procedure) + - [Point Release Procedure](#point-release-procedure) Thank you for considering making contributions to Cosmos-SDK and related repositories! @@ -21,24 +22,27 @@ Contributing to this repo can mean many things such as participated in discussion or proposing code changes. To ensure a smooth workflow for all contributors, the general procedure for contributing has been established: -1. either [open](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or - [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you'd like to help with, -2. participate in thoughtful discussion on that issue, -3. if you would then like to contribute code: - 1. if a the issue is a proposal, ensure that the proposal has been accepted, - 2. ensure that nobody else has already begun working on this issue, if they have - make sure to contact them to collaborate, - 3. if nobody has been assigned the issue and you would like to work on it +1. Either [open](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or + [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you'd like to help with +2. Participate in thoughtful discussion on that issue +3. If you would like to contribute: + 1. If a the issue is a proposal, ensure that the proposal has been accepted + 2. Ensure that nobody else has already begun working on this issue, if they have + make sure to contact them to collaborate + 3. If nobody has been assigned the issue and you would like to work on it make a comment on the issue to inform the community of your intentions - to begin work, - 4. follow standard github best practices: fork the repo, branch from the - top of `master`, make some commits, and submit a PR to `master`, - for core developers working within the cosmos-sdk repo, - to ensure a clear ownership of branches, branches must be named with the convention `yourname/{issue-}feature-name`. - 5. include `WIP:` in the PR-title to and submit your PR early, even if it's - incomplete, this indicates to the community you're working on something and - allows them to provide comments early in the development process. When the code - is complete it can be marked as ready-for-review by replacing `WIP:` with - `R4R:` in the PR-title. + to begin work + 4. Follow standard Github best practices: fork the repo, branch from the + HEAD of `master`, make some commits, and submit a PR to `master` + - For core developers working within the cosmos-sdk repo, to ensure a clear + ownership of branches, branches must be named with the convention + `{moniker}/{issue#}-branch-name` + 5. Be sure to submit the PR in `Draft` mode submit your PR early, even if + it's incomplete as this indicates to the community you're working on + something and allows them to provide comments early in the development process + 6. When the code is complete it can be marked `Ready for Review` + 7. Be sure to include a relevant change log entry in the `Unreleased` section + of `CHANGELOG.md` (see file for log format) Note that for very small or blatantly obvious problems (such as typos) it is not required to an open issue to submit a PR, but be aware that for more complex @@ -196,16 +200,20 @@ only pull requests targeted directly against master. ### Release Procedure -- start on `master` -- create the release candidate branch `rc/v*` (going forward known as **RC**) and ensure it's protected against pushing from anyone except the release manager/coordinator. **no PRs targeting this branch should be merged unless exceptional circumstances arise** -- on the `RC` branch, use `clog` to prepare the `CHANGELOG.md` and kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). -- if errors are found during the simulation testing or if any last minute changes -need to be introduced, create a new `RC` branch (making sure to increment the `rcN`) -based off of the current `RC` branch and commit any fixes or changes - - the above requires that any commits introduced must also be merged back into `master` -- after simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch -- merge the release branch to `master` to incorporate the `CHANGELOG.md` updates -- delete the `RC` branches +- Start on `master` +- Create the release candidate branch `rc/v*` (going forward known as **RC**) + and ensure it's protected against pushing from anyone except the release + manager/coordinator + - **no PRs targeting this branch should be merged unless exceptional circumstances arise** +- On the `RC` branch, prepare a new version section in the `CHANGELOG.md` + - All links must be link-ified: `$ python ./scripts/linkify_changelog.py CHANGELOG.md` +- Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks) +- If errors are found during the simulation testing, commit the fixes to `master` + and create a new `RC` branch (making sure to increment the `rcN`) +- After simulation has successfully completed, create the release branch + (`release/vX.XX.X`) from the `RC` branch +- Create a PR to `master` to incorporate the `CHANGELOG.md` updates +- Delete the `RC` branches ### Point Release Procedure diff --git a/contrib/devtools/Makefile b/contrib/devtools/Makefile index 4c663053f..5ce0d94df 100644 --- a/contrib/devtools/Makefile +++ b/contrib/devtools/Makefile @@ -42,15 +42,14 @@ mkfile_dir := $(shell cd $(shell dirname $(mkfile_path)); pwd) TOOLS_DESTDIR ?= $(GOPATH)/bin -GOLANGCI_LINT = $(TOOLS_DESTDIR)/golangci-lint -STATIK = $(TOOLS_DESTDIR)/statik -GOIMPORTS = $(TOOLS_DESTDIR)/goimports -CLOG = $(TOOLS_DESTDIR)/clog -RUNSIM = $(TOOLS_DESTDIR)/runsim +GOLANGCI_LINT = $(TOOLS_DESTDIR)/golangci-lint +STATIK = $(TOOLS_DESTDIR)/statik +GOIMPORTS = $(TOOLS_DESTDIR)/goimports +RUNSIM = $(TOOLS_DESTDIR)/runsim all: tools -tools: statik clog runsim goimports golangci-lint +tools: statik runsim goimports golangci-lint golangci-lint: $(GOLANGCI_LINT) $(GOLANGCI_LINT): $(mkfile_dir)/install-golangci-lint.sh @@ -66,18 +65,13 @@ $(GOIMPORTS): @echo "Get goimports@v0.0.0-20190628034336-212fb13d595e" @go get golang.org/x/tools/cmd/goimports@v0.0.0-20190628034336-212fb13d595e -clog: $(CLOG) -$(CLOG): - @echo "Get clog" - @go get github.com/cosmos/tools/cmd/clog - runsim: $(RUNSIM) $(RUNSIM): @echo "Get runsim" @go get github.com/cosmos/tools/cmd/runsim tools-clean: - rm -f $(STATIK) $(GOIMPORTS) $(CLOG) $(GOLANGCI_LINT) $(RUNSIM) + rm -f $(STATIK) $(GOIMPORTS) $(GOLANGCI_LINT) $(RUNSIM) rm -f tools-stamp .PHONY: all tools tools-clean diff --git a/scripts/linkify_changelog.py b/scripts/linkify_changelog.py new file mode 100644 index 000000000..cea22ec6c --- /dev/null +++ b/scripts/linkify_changelog.py @@ -0,0 +1,15 @@ +import fileinput +import re + +# This script goes through the provided file, and replaces any " \#", +# with the valid mark down formatted link to it. e.g. +# " [\#number](https://github.com/cosmos/cosmos-sdk/issues/) +# Note that if the number is for a PR, github will auto-redirect you when you click the link. +# It is safe to run the script multiple times in succession. +# +# Example: +# +# $ python ./scripts/linkify_changelog.py CHANGELOG.md +for line in fileinput.input(inplace=1): + line = re.sub(r"\s\\#([0-9]+)", r" [\\#\1](https://github.com/cosmos/cosmos-sdk/issues/\1)", line.rstrip()) + print(line) \ No newline at end of file