docs: v3.3.0 Release Notes (#1646)

* docs: v3.3.0 Release Notes * Apply suggestions from code review Co-authored-by: Adam Moser <63419657+toteki@users.noreply.github.com> * update price-feeder * release notes update * add note about iavl-disable-fastnode config * update release notes * update release notes * changelog * typo Co-authored-by: Adam Moser <63419657+toteki@users.noreply.github.com>
umee-network · Dec 21, 2022 · 709ed34 · 709ed34
1 parent 4550d89
commit 709ed34
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,16 +46,24 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+## [v3.3.0](https://github.com/umee-network/umee/releases/tag/v3.3.0) - 2022-12-20
+
 ### Features
 
 - [1642](https://github.com/umee-network/umee/pull/1642) Added QueryMaxWithdraw and MsgMaxWithdraw
 - [1633](https://github.com/umee-network/umee/pull/1633) MarketSummary query now displays symbol price instead of base price for readability.
 
+### Improvements
+
+- [1659](https://github.com/umee-network/umee/pull/1659) Update to Cosmos SDK 0.46.7 and related dependencies (#1659)
+
 ### Fixes
 
+- [1640](https://github.com/umee-network/umee/pull/1640) Migrate legacy x/leverage gov handler proposals to the new `MsgGovUpdateRegistry` messages.
 - [1650](https://github.com/umee-network/umee/pull/1650) Fixes bug with reserves in ExportGenesis
 - [1642](https://github.com/umee-network/umee/pull/1642) Added missing CLI for QueryBadDebts
 - [1633](https://github.com/umee-network/umee/pull/1633) Increases price calculation precision for high exponent assets.
+- [1645](https://github.com/umee-network/umee/pull/1645) Fix: docker build & release
 
 ## [v3.2.0](https://github.com/umee-network/umee/releases/tag/v3.2.0) - 2022-11-25
 

diff --git a/README.md b/README.md
@@ -46,7 +46,9 @@ Building from source will automatically link the `libwasmvm.x86_64.so` created a
 |    v1.x.x    |    ✓    |      ✗       |  v0.45.x   | v2.0.x | v0.2.x  |     N/A      | umee/v1 module/v1.4.x-umee |
 |    v2.x.x    |    ✗    |      ✓       |  v0.45.x   | v2.3.x | v0.2.x  |    v0.2.x    |   umee/v2 module/v1.4.x    |
 |   v3.0-1.x   |    ✓    |      ✗       |  v0.46.x   | v5.0.x | v1.3.x+ |    v1.0.x    | umee/v3 module/v1.5.x-umee |
-|    v3.2.x    |    ✓    |      ✗       |  v0.46.6+  | v5.0.x | v1.3.x+ |    v2.0.x    |   umee/v3 v1.5.3-umee-3    |
+|  v3.1.0-cw1  |    ✗    |      ✓       |  v0.46.x   | v5.0.x | v1.3.x+ |    v2.0.x    | umee/v3 module/v1.5.x-umee |
+|    v3.2.x    |    ✓    |      ✗       |  v0.46.6+  | v5.1.x | v1.3.x+ |    v2.0.x    |   umee/v3 v1.5.3-umee-3    |
+|    v3.3.x    |    ✓    |      ✗       |  v0.46.6+  | v5.1.x | v1.3.x+ |   v2.0.1+    |   umee/v3 v1.5.3-umee-3    |
 
 ## Active Networks
 
@@ -92,8 +94,11 @@ export DAEMON_RESTART_AFTER_UPGRADE=true
 export DAEMON_ALLOW_DOWNLOAD_BINARIES=true
 export DAEMON_PREUPGRADE_MAX_RETRIES=3
 ```
-- If you didn't build binary from source in the machine, you have to download the respective `libwasmvm` into your machine.  
+
+- If you didn't build binary from source in the machine, you have to download the respective `libwasmvm` into your machine.
+
 ```bash
 $ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -O /lib/libwasmvm.$(uname -m).so
 ```
+
 - To use `cosmovisor` for starting `umeed` process, instead of calling `umeed start`, use `cosmovisor run start [umeed flags]`
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -6,50 +6,61 @@
 
 Release Procedure is defined in the [CONTRIBUTING](CONTRIBUTING.md#release-procedure) document.
 
-## v3.2.0
+## v3.3.0
 
-This is a state machine breaking release. Coordinated update is required.
+- For the mainnet, this release includes update from v3.1.x → v3.3.x. Please also look at the [`v3.2` Release Notes](https://github.com/umee-network/umee/blob/v3.2.0/RELEASE_NOTES.md), notably the **Gravity Bridge Slashing**.
+- For the Canon-2 testnet, this release includes update from v3.2.x → v3.3.x
 
-Highlights:
+v3.2.0 was not released on mainnet due to a bug in x/leverage gov messages migration to the new format which utilizes x/gov/v1 authorization system. The bug caused legacy token registry updates to break x/gov proposal queries. In v3.3 we fix that bug.
 
-- IBC update to v5.1
-- `QueryLiquidationTargets` RPC is now available when the node is run with `--enable-liquidator-query`. The LIQUIDATOR build flag has been removed. NOTE: this query should not be enabled for nodes with public API. The query involves intensive computation and can impact node stability when used by an attacker.
-- Introduced experimental features, available when build with `experimental` flag. This flag must not be used on mainnet.
+Additional highlights:
 
-Please see the [CHANGELOG](https://github.com/umee-network/umee/blob/v3.2.0/CHANGELOG.md) for an exhaustive list of changes.
+- Added `QueryMaxWithdraw` and `MsgMaxWithdraw` to allow user easily withdraw previously supplied tokens from the module back to the user balance.
+- Updated Cosmos SDK to v0.46.7
 
-### Gravity Bridge
-
-This is the final step for enabling Gravity Bridge. We enable slashing.
-Validators must run Peggo and must process claims to not be slashed.
+Please see the [CHANGELOG](https://github.com/umee-network/umee/blob/v3.3.0/CHANGELOG.md) for an exhaustive list of changes.
 
 ### Github Release
 
-New experimental features which are part of the linked binary changed the build process. Umeed doesn't support static CGO build (with `CGO_ENABLED=1`). Github Actions only support build using Linux on amd64, we can not make a cross platform build using Github Actions. So our Github release only contains source code archive and amd64 Linux binary.
+Sinice `v3.2.0` new experimental features (disabled by default) are part of the linked binary. That changed the build process. Umeed officially doesn't support static CGO build (with `CGO_ENABLED=1`) any more. Github Actions only support build using Linux on amd64 -- we can not make a cross platform build using Github Actions (possible solution is to do it through Qemu emulator). So our Github release only contains source code archive and amd64 Linux binary.
+
+To run the provided binary, you **have to have `libwasmvm.x86_64.so v1.1.1`** in your system lib directory.
 
-Moreover to run the provided binary, you need to have `libwasmvm.x86_64.so v1.1.1` in your system lib directory.
+Building from source will automatically link the `libwasmvm.x86_64.so` created as a part of the build process (you must build on the same host as you run the binary, or copy the `libwasmvm.x86_64.so` your lib directory).
 
-Building from source will automatically link the `libwasmvm.x86_64.so` created as a part of the build process (you must build on same host as you run the binary, or copy the `libwasmvm.x86_64.so` your lib directory).
+If you build on system different than Linux amd64, then you need to download appropriate version of libwasmvm (eg from [CosmWasm/wasmvm Relases](https://github.com/CosmWasm/wasmvm/releases)) or build it from source (you will need Rust toolchain).
 
-Please check [Supported Platforms](https://github.com/CosmWasm/wasmvm/tree/v1.1.1/#supported-platforms) for `libwasmvm`
+Otherwise you have to download `libwasmvm`. Please check [Supported Platforms](https://github.com/CosmWasm/wasmvm/tree/main/#supported-platforms). Example:
+
+```bash
+wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -P /lib/
+```
 
 ### Update instructions
 
-- Note: Skip this step if you build binary from source
-  - Download `libwasmvm`
+- Note: Skip this step if you build binary from source and are able to properly link libwasmvm.
+  - Download `libwasmvm`:
+
 ```bash
 $ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -O /lib/libwasmvm.$(uname -m).so
 ```
+
 - Wait for software upgrade proposal to pass and trigger the chain upgrade.
-- Run latest Peggo (v1.3.0) - **updated**
-- Run latest Price Feeder (v2.0.0) - **updated**
+- Run latest Peggo (v1.4.0) - **updated**
+- Run latest Price Feeder (v2.0.2) - **updated**
 - Swap binaries.
 - Restart the chain.
 
-You can use Cosmovisor → see [instructions](https://github.com/umee-network/umee/#cosmovisor).
-- If you use Cosmovisor, and you didn't build binary from source in the validator machine, you have to download the respective `libwasmvm` into your machine.  
-```bash
-$ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -O /lib/libwasmvm.$(uname -m).so
+There is a new option available in `app.toml` (in Base Configuration). Set `iavl-disable-fastnode` to `true` if you want to disable fastnode cache and reduce RAM usage (default is `false`).
+
+```
+# IAVLDisableFastNode enables or disables the fast node feature of IAVL.
+# Default is false.
+iavl-disable-fastnode = false
 ```
 
-NOTE: As described in the previous section, you need to have `libwasmvm.x86_64.so` correctly linked to the binary. BEFORE the upgrade, make sure the binary is working. You can test it by running `./umeed-v3.2.0 --version`.
+You can use Cosmovisor → see [instructions](https://github.com/umee-network/umee/#cosmovisor).
+
+- If you use Cosmovisor, and you didn't build binary from source in the validator machine, you have to download the respective `libwasmvm` into your machine. See the previous section for more details.
+
+NOTE: BEFORE the upgrade, make sure the binary is working and libwasmvm is in your system. You can test it by running `./umeed-v3.3.0 --version`.