-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mark v1.17.1 in the changelog and release notes. (#1805)
* Mark v1.17.1 in the changelog and release notes. * Add notes about the release to the release changelog. * Add more details about the security advisory. * Fix typo: backedn * Add a suggestion to back up stuff if going from badgerdb. * Fix more typos and tweak a bit of wording on the db backend steps. Change any uses of 'fastsync' to 'fastnode'. * Update release changelog with config defaults backport.
- Loading branch information
1 parent
8527b7a
commit 7b16570
Showing
2 changed files
with
74 additions
and
89 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,87 @@ | ||
| ## [v1.17.0](https://github.com/provenance-io/provenance/releases/tag/v1.17.0) - 2023-11-13 | ||
| ## [v1.17.1](https://github.com/provenance-io/provenance/releases/tag/v1.17.1) - 2024-01-11 | ||
|
|
||
| _Release v1.17.0 brings expanded support for token exchange with the new Exchange and Hold modules._ | ||
| Users should upgrade to v1.17.1 at their earliest convenience. | ||
|
|
||
| ### Overview | ||
| Release v1.17.1 addresses [CWA-2023-004](https://github.com/CosmWasm/advisories/blob/main/CWAs/CWA-2023-004.md) and also adds some command-line functionality and configuration recommendations. | ||
|
|
||
| With the release of 1.17.0 the Provenance Blockchain protocol is enhanced with 'in place hold' capabilities that remove the requirement for a 3rd party escrow solution. Additional improvements for cross zone markers and on chain TVL are also included. | ||
| ### [~~High~~ Low] Security Advisory CWA-2023-004 | ||
|
|
||
| ### Hold/Exchange | ||
| Provenance 1.17.1 contains a dependency update for the CosmWasm VM to resolve a [security issue](https://github.com/CosmWasm/advisories/blob/main/CWAs/CWA-2023-004.md) which could result in non-determinism and a halt of the network. This advisory has been reclassified from **HIGH** to **LOW** risk due to the configuration of the Provenance Blockchain Network. | ||
|
|
||
| The hold capability is implemented through a private module api that integrates with the bank module to reduce spendable balances on accounts. Building on top of these holds is the new Exchange module which offers low level primitives for buy and sell order books that leverage these holds. Developers of exchange contracts or applications are encouraged to migrate from smart contracts that holds assets internally to these new exchange apis that provide more efficient execution and reduce counter-party risk for their users. | ||
| The Provenance Blockchain network does not permit the permission-less upload of smart contract code, resulting in a Low risk exposure for this advisory. The Provenance Blockchain Foundation advises against accepting any further smart contract code proposals until after the deployment of the 1.17.1 patch. This is to provide the network with an opportunity to mitigate potential risks effectively. Updating to the 1.17.1 release is recommended at your earliest convenience. | ||
|
|
||
| ### IBC/Markers | ||
| ### New Configuration Recommendations | ||
|
|
||
| A new set of capabilities for restricted markers sent over IBC has been added that synchronizes transfer authority and marker configuration on a destination network using metadata attached to ICS-20 IBC transfers. This is the first step of several planned enhancements for multi-zone tokens on the Provenance Network of blockchains. | ||
| Provenance has a few new recommendations regarding node configuration. | ||
|
|
||
| Additionally a new attribute has been added to markers that allows a creator to notionally define the associated value of each token in USD. This allows for a better on-chain experience for monitoring TVL compared to the existing approach that uses an off-chain service to provide this metadata. The new exchange module will further attach transaction settlement prices to markers in an effort to keep this information current and relevant with each settlement. | ||
| #### Goleveldb | ||
|
|
||
| Provenance now recommends that nodes use `goleveldb` as their db backend. Support for `cleveldb` and `badgerdb` will be removed in a future upgrade. It is better to do this migration outside of an upgrade. Nodes currently using those database backends should migrate to `goleveldb` at your leisure prior to that upgrade. If your node is using `cleveldb`, a warning will be issued when your node starts. | ||
|
|
||
| To migrate to `goleveldb` from `cleveldb`: | ||
|
|
||
| 1. Stop your node. | ||
| 2. Back up your `data` and `config` directories. | ||
| 3. Update your `config.toml` to have `db_backend = "goleveldb"`. | ||
| 4. Update your `app.toml` to have either `app-db-backend = ""` or `app-db-backend = "goleveldb"`. | ||
| 5. Restart your node. | ||
|
|
||
| In some cases, that process might not work and your node will fail to restart. If that happens, restore your `data` and `config` directories and follow the same steps below. | ||
|
|
||
| To migrate to `goleveldb` from `badgerdb` (or if the above steps failed): | ||
|
|
||
| 1. Stop your node. | ||
| 2. Back up your `data` and `config` directories. | ||
| 3. Use the [dbmigrate](https://github.com/provenance-io/provenance/releases/download/v1.17.0/dbmigrate-linux-amd64-v1.17.0.zip) utility to migrate your node's database to `goleveldb`. This can take 3 hours or more to complete and should not be interrupted. | ||
| 4. Restart your node. | ||
|
|
||
| #### IAVL-Fastnode | ||
|
|
||
| Provenance also recommends that nodes enable iavl-fastnode. In a future upgrade, nodes will be required to use iavl-fastnode, and it is better to do this migration outside of an upgrade. If your node's `app.toml` has `iavl-disable-fastnode = true`, you should migrate your store at your leisure prior to the next upgrade. If your node has iavl-fastnode disabled, a warning will be issued when your node starts. | ||
|
|
||
| It might take 3 hours or more for the migration to finish. Do not stop or restart your node during this process. Your node will be unavailable during this process. | ||
|
|
||
| To migrate to iavl-fastnode, follow these steps: | ||
|
|
||
| 1. Stop your node. | ||
| 2. Back up your data directory. | ||
| 3. Update your node's `app.toml` to have `iavl-disable-fastnode = false`. | ||
| 4. Restart your node. | ||
|
|
||
| #### Pruning Interval | ||
|
|
||
| Provenance recommends, too, that validators use a pruning interval of at most `10`. This can help prevent missed blocks. This is configured in `app.toml`. If you have a `pruning` value of `"default"`, `"nothing"`, or `"everything"`, you are okay. If you have a `pruning` value of `"custom"` and a `pruning-interval` of `1000` or more, a warning will be issued when your node starts. | ||
|
|
||
| #### Indexer | ||
|
|
||
| Lastly, Provenance recommends that validators do not enable tx indexing. This should also help prevent missed blocks. This is configured in `config.toml` in the `indexer` field of the `tx_index` section (aka `tx_index.indexer`). If you have an indexer defined, a warning will be issued when your node starts. | ||
|
|
||
| --- | ||
|
|
||
| ### Features | ||
|
|
||
| * Create the `x/exchange` module which facilitates the buying and selling of assets [#1658](https://github.com/provenance-io/provenance/issues/1658), [#1699](https://github.com/provenance-io/provenance/issues/1699), [#1700](https://github.com/provenance-io/provenance/issues/1700). | ||
| Assets and funds remain in their owner's account (with a hold on them) until the order is settled (or cancelled). | ||
| Market's are created to manage order matching and define fees. | ||
| The chain will receive a portion of the fees a market collects. | ||
| * Allow marker's transfer authority to prevent transfer of restricted coin with deny list on send [#1518](https://github.com/provenance-io/provenance/issues/1518). | ||
| * Add net asset value to markers [#1328](https://github.com/provenance-io/provenance/issues/1328). | ||
| * Add ICQHost and Oracle module to allow cross chain oracle queries [#1497](https://github.com/provenance-io/provenance/issues/1497). | ||
| * New `GetByAddr` metadata query [#1443](https://github.com/provenance-io/provenance/issues/1443). | ||
| * Add Trigger module queries to stargate whitelist for smart contracts [#1636](https://github.com/provenance-io/provenance/issues/1636). | ||
| * Added the saffron upgrade handlers [PR 1648](https://github.com/provenance-io/provenance/pull/1648). | ||
| * Add the ICQ, Oracle, IBC Hooks, Hold, and Exchange modules. | ||
| * Run module migrations. | ||
| * Set IBC Hooks params [PR 1659](https://github.com/provenance-io/provenance/pull/1659). | ||
| * Remove inactive validators. | ||
| * Migrate marker max supplies to BigInt [#1292](https://github.com/provenance-io/provenance/issues/1292). | ||
| * Add initial marker NAVs [PR 1712](https://github.com/provenance-io/provenance/pull/1712). | ||
| * Create denom metadata for IBC markers [#1728](https://github.com/provenance-io/provenance/issues/1728). | ||
| * Create the `x/hold` module which facilitates locking funds in an owners account [#1607](https://github.com/provenance-io/provenance/issues/1607). | ||
| Funds with a hold on them cannot be transferred until the hold is removed. | ||
| Management of holds is internal, but there are queries for looking up holds on accounts. | ||
| Holds are also reflected in the `x/bank` module's `SpendableBalances` query. | ||
| * Add new MaxSupply param to marker module and deprecate MaxTotalSupply [#1292](https://github.com/provenance-io/provenance/issues/1292). | ||
| * Add hidden docgen command to output documentation in different formats [#1468](https://github.com/provenance-io/provenance/issues/1468). | ||
| * Add ics20 marker creation for receiving marker via ibc sends [#1127](https://github.com/provenance-io/provenance/issues/1127). | ||
| * Add CLI commands for the exchange module endpoints and queries [#1701](https://github.com/provenance-io/provenance/issues/1701). | ||
| * Create CLI commands for adding a market to a genesis file [#1757](https://github.com/provenance-io/provenance/issues/1757). | ||
| * Add CLI command to generate autocomplete shell scripts [#1762](https://github.com/provenance-io/provenance/pull/1762). | ||
|
|
||
| ### Improvements | ||
|
|
||
| * Add IBC-Hooks module for Axelar GMP support [PR 1659](https://github.com/provenance-io/provenance/pull/1659). | ||
| * Update ibcnet ports so they don't conflict with host machine [#1622](https://github.com/provenance-io/provenance/issues/1622). | ||
| * Replace custom ibc-go v6.1.1 fork with official module [#1616](https://github.com/provenance-io/provenance/issues/1616). | ||
| * Migrate `msgfees` gov proposals to v1 [#1328](https://github.com/provenance-io/provenance/issues/1328). | ||
| * Updated metadata queries to optionally include the request and id info [#1443](https://github.com/provenance-io/provenance/issues/1443). | ||
| The request is now omitted by default, but will be included if `include_request` is `true`. | ||
| The id info is still included by default, but will be excluded if `exclude_id_info` is `true`. | ||
| * Removed the quicksilver upgrade handlers [PR 1648](https://github.com/provenance-io/provenance/pull/1648). | ||
| * Bump cometbft to v0.34.29 (from v0.34.28) [PR 1649](https://github.com/provenance-io/provenance/pull/1649). | ||
| * Add genesis/init for Marker module send deny list addresses [#1660](https://github.com/provenance-io/provenance/issues/1660). | ||
| * Add automatic changelog entries for dependabot [#1674](https://github.com/provenance-io/provenance/issues/1674). | ||
| * Ensure IBC marker has matching supply [#1706](https://github.com/provenance-io/provenance/issues/1706). | ||
| * Add publishing of docker arm64 container builds [#1634](https://github.com/provenance-io/provenance/issues/1634). | ||
| * Add additional logging to trigger module [#1718](https://github.com/provenance-io/provenance/issues/1718). | ||
| * When the exchange module settles orders, update the marker net-asset-values [#1736](https://github.com/provenance-io/provenance/pull/1736). | ||
| * Add the EventTriggerDetected and EventTriggerExecuted events [#1717](https://github.com/provenance-io/provenance/issues/1717). | ||
| * Add StoreLoader wrapper to check configuration settings [#1792](https://github.com/provenance-io/provenance/pull/1792). | ||
| * Create a default market in `make run`, `localnet`, `devnet` and the `provenanced testnet` command [#1757](https://github.com/provenance-io/provenance/issues/1757). | ||
| * Updated documentation for each module to work with docusaurus [PR 1763](https://github.com/provenance-io/provenance/pull/1763) | ||
| * Set the default `iavl-disable-fastnode` value to `false` and the default `tx_index.indexer` value to `"null"` [#1807](https://github.com/provenance-io/provenance/pull/1807). | ||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * Fix ibcnet relayer creating multiple connections on restart [#1620](https://github.com/provenance-io/provenance/issues/1620). | ||
| * Fix for incorrect resource-id type casting on contract specification [#1647](https://github.com/provenance-io/provenance/issues/1647). | ||
| * Allow restricted coins to be quarantined [#1626](https://github.com/provenance-io/provenance/issues/1626). | ||
| * Prevent marker forced transfers from module accounts [#1626](https://github.com/provenance-io/provenance/issues/1626). | ||
| * Change config load order so custom.toml can override other config [#1262](https://github.com/provenance-io/provenance/issues/1262). | ||
| * Fixed denom metadata source chain-id retrieval for new ibc markers [#1726](https://github.com/provenance-io/provenance/issues/1726). | ||
|
|
||
| ### Client Breaking | ||
|
|
||
| * Metadata query responses no longer include the request by default [#1443](https://github.com/provenance-io/provenance/issues/1443). | ||
| They are still available by setting the `include_request` flag in the requests. | ||
| * The `provenanced query metadata get` command has been changed to use the new `GetByAddr` query [#1443](https://github.com/provenance-io/provenance/issues/1443). | ||
| The command can now take in multiple ids. | ||
| The output of this command reflects the `GetByAddrResponse` instead of specific type queries. | ||
| The command no longer has any `--include-<thing>` flags since they don't pertain to the `GetByAddr` query. | ||
| The specific queries (e.g. `provenanced query metadata scope`) are still available with all appropriate flags. | ||
| * Deprecate marker proposal transaction [#1797](https://github.com/provenance-io/provenance/issues/1797). | ||
|
|
||
| ### Dependencies | ||
|
|
||
| - Bump `google.golang.org/grpc` from 1.56.1 to 1.59.0 ([#1624](https://github.com/provenance-io/provenance/pull/1624), [#1635](https://github.com/provenance-io/provenance/pull/1635), [#1672](https://github.com/provenance-io/provenance/pull/1672), [#1685](https://github.com/provenance-io/provenance/pull/1685), [#1689](https://github.com/provenance-io/provenance/pull/1689), [#1710](https://github.com/provenance-io/provenance/pull/1710)) | ||
| - Bump `crazy-max/ghaction-import-gpg` from 5 to 6 ([#1677](https://github.com/provenance-io/provenance/pull/1677)) | ||
| - Bump `golang.org/x/text` from 0.12.0 to 0.13.0 ([#1667](https://github.com/provenance-io/provenance/pull/1667)) | ||
| - Bump `actions/checkout` from 3 to 4 ([#1668](https://github.com/provenance-io/provenance/pull/1668)) | ||
| - Bump `bufbuild/buf-breaking-action` from 1.1.2 to 1.1.3 ([#1663](https://github.com/provenance-io/provenance/pull/1663)) | ||
| - Bump `cosmossdk.io/math` from 1.0.1 to 1.1.2 ([#1656](https://github.com/provenance-io/provenance/pull/1656)) | ||
| - Bump `github.com/google/uuid` from 1.3.0 to 1.3.1 ([#1657](https://github.com/provenance-io/provenance/pull/1657)) | ||
| - Bump `golangci/golangci-lint-action` from 3.6.0 to 3.7.0 ([#1651](https://github.com/provenance-io/provenance/pull/1651)) | ||
| - Bump `bufbuild/buf-setup-action` from 1.21.0 to 1.27.1 ([#1610](https://github.com/provenance-io/provenance/pull/1610), [#1613](https://github.com/provenance-io/provenance/pull/1613), [#1631](https://github.com/provenance-io/provenance/pull/1631), [#1632](https://github.com/provenance-io/provenance/pull/1632), [#1642](https://github.com/provenance-io/provenance/pull/1642), [#1645](https://github.com/provenance-io/provenance/pull/1645), [#1650](https://github.com/provenance-io/provenance/pull/1650), [#1694](https://github.com/provenance-io/provenance/pull/1694), [#1711](https://github.com/provenance-io/provenance/pull/1711)) | ||
| - Bump `cometbft to v0.34.29 `(from v0.34.28) ([#1649](https://github.com/provenance-io/provenance/pull/1649)) | ||
| - Bump `golang.org/x/text` from 0.11.0 to 0.12.0 ([#1644](https://github.com/provenance-io/provenance/pull/1644)) | ||
| - Bump `github.com/rs/zerolog` from 1.29.1 to 1.31.0 ([#1639](https://github.com/provenance-io/provenance/pull/1639), [#1691](https://github.com/provenance-io/provenance/pull/1691)) | ||
| - Bump `github.com/cosmos/ibc-go/v6` from 6.1.1 to 6.2.0 ([#1629](https://github.com/provenance-io/provenance/pull/1629)) | ||
| - Bump `cosmossdk.io/errors` from 1.0.0-beta.7 to 1.0.0 ([#1628](https://github.com/provenance-io/provenance/pull/1628)) | ||
| - Bump `google.golang.org/protobuf` from 1.30.0 to 1.31.0 ([#1611](https://github.com/provenance-io/provenance/pull/1611)) | ||
| - Bump `docker/setup-buildx-action` from 2 to 3 ([#1681](https://github.com/provenance-io/provenance/pull/1681)) | ||
| - Bump `docker/login-action` from 2 to 3 ([#1680](https://github.com/provenance-io/provenance/pull/1680)) | ||
| - Bump `docker/build-push-action` from 4 to 5 ([#1679](https://github.com/provenance-io/provenance/pull/1679)) | ||
| - Bump `github.com/spf13/viper` from 1.16.0 to 1.17.0 ([#1695](https://github.com/provenance-io/provenance/pull/1695)) | ||
| - Bump `github.com/otiai10/copy` from 1.12.0 to 1.14.0 ([#1693](https://github.com/provenance-io/provenance/pull/1693)) | ||
| - Bump `stefanzweifel/git-auto-commit-action` from 4 to 5 ([#1696](https://github.com/provenance-io/provenance/pull/1696)) | ||
| - Bump `golang.org/x/net` from 0.15.0 to 0.17.0 ([#1704](https://github.com/provenance-io/provenance/pull/1704)) | ||
| - Bump `bufbuild/buf-lint-action` from 1.0.3 to 1.1.0 ([#1705](https://github.com/provenance-io/provenance/pull/1705)) | ||
| - Bump `github.com/spf13/cobra` from 1.7.0 to 1.8.0 ([#1733](https://github.com/provenance-io/provenance/pull/1733)) | ||
| - Bump `github.com/CosmWasm/wasmvm` from 1.2.4 to 1.2.6 ([#1799](https://github.com/provenance-io/provenance/issues/1799)) | ||
| - Bump `github.com/CosmWasm/wasmd` from v0.30.0-pio-5 to v0.30.0-pio-6 ([#1799](https://github.com/provenance-io/provenance/issues/1799)) | ||
|
|
||
| ### Full Commit History | ||
|
|
||
| * https://github.com/provenance-io/provenance/compare/v1.16.0...v1.17.0 | ||
| * https://github.com/provenance-io/provenance/compare/v1.17.0...v1.17.1 | ||
|
|