chore: v4.2 Release Notes (#1902)

* chore: v4.2 changelog * release notes * Apply suggestions from code review Co-authored-by: Adam Moser <[email protected]> * release notes update * release notes update --------- Co-authored-by: Adam Moser <[email protected]>
umee-network · Mar 15, 2023 · 04399b6 · 04399b6
1 parent e1b579b
commit 04399b6
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,9 +46,26 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
-## Features
+## [v4.2.0](https://github.com/umee-network/umee/releases/tag/v4.2.0) - 2023-03-15
+
+### Features
 
 - [1867](https://github.com/umee-network/umee/pull/1867) Allow `/denom` option on registered tokens query to get only a single token by `base_denom`.
+- [1568](https://github.com/umee-network/umee/pull/1568) IBC ICS20 transfer quota. New Cosmos SDK module and IBC ICS20 middleware to limit IBC token outflows.
+- [1764](https://github.com/umee-network/umee/pull/1764) New `util.Panic` helper function.
+- [1725](https://github.com/umee-network/umee/pull/1725) historacle: average prices.
+
+### Improvements
+
+- [1744](https://github.com/umee-network/umee/pull/1744) docs: testing guidelines.
+- [1771](https://github.com/umee-network/umee/pull/1771) CI: add experimental e2e tests on docker image.
+- [1788](https://github.com/umee-network/umee/pull/1788) deprecated use of `sdkerrors`.
+- [1835](https://github.com/umee-network/umee/pull/1835) CI: use experimental for default CI tests.
+- [1864](https://github.com/umee-network/umee/pull/1864) testing: mock gen integration.
+
+### Fixes
+
+- [1767](https://github.com/umee-network/umee/pull/1767) Oracle: Fix `GetTickerPrice()` and `GetCandlePrice()`.
 
 ## [v4.1.0](https://github.com/umee-network/umee/releases/tag/v4.1.0) - 2023-02-15
 
@@ -58,11 +75,14 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Fixes
 
-- [1812](https://github.com/umee-network/umee/pull/1812) MaxCollateralShare now works during partial oracle outages when certain conditions are safe.
+- [1707](https://github.com/umee-network/umee/pull/1707) Oracle: Enforce voting threshold param in oracle endblocker.
 - [1736](https://github.com/umee-network/umee/pull/1736) Blacklisted tokens no longer add themselves back to the oracle accept list.
 - [1807](https://github.com/umee-network/umee/pull/1807) Fixes BNB ibc denom in 4.1 migration
+- [1812](https://github.com/umee-network/umee/pull/1812) MaxCollateralShare now works during partial oracle outages when certain conditions are safe.
 - [1821](https://github.com/umee-network/umee/pull/1821) Allow safe leverage operations during partial oracle outages.
 - [1845](https://github.com/umee-network/umee/pull/1845) Fix validator power calculation during oracle ballot counting.
+- [1851](https://github.com/umee-network/umee/pull/1851) Oracle: ballot sorting.
+- [1852](https://github.com/umee-network/umee/pull/1852) Oracle: power vote calculation.
 
 ## [v4.0.1](https://github.com/umee-network/umee/releases/tag/v4.0.1) - 2023-02-10
 
@@ -80,7 +100,9 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Fixes
 
 - [1680](https://github.com/umee-network/umee/pull/1680) Add amino support for MsgMaxWithdraw.
+- [1694](https://github.com/umee-network/umee/pull/1694) `leverage.MaxBorrow` return zero instead of failing when there is no more to borrow.
 - [1710](https://github.com/umee-network/umee/pull/1710) Skip blacklisted tokens in MaxBorrow and MaxWithdraw queries.
+- [1717](https://github.com/umee-network/umee/pull/1717) Oracle: Add blockNum to median and median deviation queries.
 
 ### Features
 

diff --git a/README.md b/README.md
@@ -52,6 +52,7 @@ Building from source will automatically link the `libwasmvm.x86_64.so` created a
 |    v3.3.x    |    ✓    |      ✗       |  v0.46.6+  | v5.1.x | v1.3.x+ |    v2.0.2    |   umee/v3 v1.5.3-umee-3    |
 |    v4.0.x    |    ✓    |      ✗       |  v0.46.6+  | v5.1.x | v1.3.x+ |    v2.0.3    |   umee/v4 v1.5.3-umee-4    |
 |    v4.1.x    |    ✓    |      ✗       |  v0.46.7+  | v5.2.x | v1.3.x+ |    v2.1.0    |   umee/v4 v1.5.3-umee-4    |
+|    v4.2.x    |    ✓    |      ✗       | v0.46.10+  | v5.2.x | v1.3.x+ |    v2.1.0    |   umee/v4 v1.5.3-umee-4    |
 
 ## Active Networks
 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -8,25 +8,31 @@ Release Procedure is defined in the [CONTRIBUTING](CONTRIBUTING.md#release-proce
 
 ## v4.2.0
 
-- new option is available in `app.toml`: `iavl-lazy-loading` (in general settings). When setting to `true`, lazy loading of iavl store will be enabled and improve start up time of archive nodes.
+The main highlight of this release is new `x/uibc` module which introduces IBC Quota functionality.
+We are using it to limit daily (quota resets every 24 hours) IBC outflows in USD value based on our Avg price oracle update. Our current daily quota is 1M USD of total outflows and 600k USD of per token outflows. We only track the `x/leverage` registered tokens.
+Example IBC outflows reaching the daily quota:
 
-## v4.1.0
-
-This release contains several fixes designed to make lending and borrowing more resilient during price outages. Short summary of changes is available in the [Changelog](./CHANGELOG.md)
+- 600k USD worth of ATOM (this is the max of a single token we can send per day), 400k USD worth of UMEE.
+- 300k USD worth of ATOM, 200k USD worth of STATOM, 250k USD worth of UMEE and 250k USD worth JUNO.
 
-- [Price Feeder V2.1.0](https://github.com/umee-network/umee/releases/tag/price-feeder/v2.1.0) is recommended for use with this release. Upgrading price feeder can be done immediately by any validators who have not already switched. It does not need to be simultaneously with the chain upgrade.
+Other highlights:
 
-**Please Note:**
+- Oracle: Avg prices. We compute average price based on ~16h rolling window.
+- New option is available in `app.toml`: `iavl-lazy-loading` (in general settings). When setting to `true`, lazy loading of iavl store will be enabled and improve start up time of archive nodes.
+- Migration from Tendermint to [CometBFT](https://github.com/cometbft/cometbft).
 
-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).
+See [CHANGELOG](https://github.com/umee-network/umee/blob/v4.2.0/CHANGELOG.md) for a full list of changes.
 
-If you build on system different than Linux amd64, then you need to download appropriate version of libwasmvm (eg from [CosmWasm/wasmvm Releases](https://github.com/CosmWasm/wasmvm/releases)) or build it from source (you will need Rust toolchain).
+### Validators
 
-Otherwise you have to download `libwasmvm`. Please check [Supported Platforms](https://github.com/CosmWasm/wasmvm/tree/main/#supported-platforms). Example:
+Given recent spam transactions in Umee, we request all validators set a `minimum-gas-prices` setting (in app `config/app.toml` file, general settings). We recommend `0.1uumee` which is equal the current Keplr _average_ setting:
 
-```bash
-wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -P /lib/
 ```
+minimum-gas-prices = "0.1uumee"
+```
+
+In next release we will be enforcing the minimum setting.
+
 ### Upgrade instructions
 
 - Note: Skip this step if you build binary from source and are able to properly link libwasmvm.
@@ -36,6 +42,8 @@ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwa
 $ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/libwasmvm.$(uname -m).so -O /lib/libwasmvm.$(uname -m).so
 ```
 
+- Download latest binary or build from source.
+- Run the binary to make sure it works for you: `umeed --version`
 - Wait for software upgrade proposal to pass and trigger the chain upgrade.
 - Swap binaries.
 - Restart the chain.
@@ -49,3 +57,21 @@ NOTE: BEFORE the upgrade, make sure the binary is working and libwasmvm is in yo
 #### Docker
 
 Docker images are available in [ghcr.io umee-network](https://github.com/umee-network/umee/pkgs/container/umeed) repository.
+
+## v4.1.0
+
+This release contains several fixes designed to make lending and borrowing more resilient during price outages. Short summary of changes is available in the [Changelog](./CHANGELOG.md)
+
+- [Price Feeder V2.1.0](https://github.com/umee-network/umee/releases/tag/price-feeder/v2.1.0) is recommended for use with this release. Upgrading price feeder can be done immediately by any validators who have not already switched. It does not need to be simultaneously with the chain upgrade.
+
+**Please Note:**
+
+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).
+
+If you build on system different than Linux amd64, then you need to download appropriate version of libwasmvm (eg from [CosmWasm/wasmvm Releases](https://github.com/CosmWasm/wasmvm/releases)) or build it from source (you will need Rust toolchain).
+
+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/
+```