Skip to content

Commit

Permalink
docs: 4.1 branch release notes (#1868)
Browse files Browse the repository at this point in the history
* docs: 4.1 release notes (backport)

* word
  • Loading branch information
toteki authored Feb 22, 2023
1 parent a2ae569 commit 7179ad9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 34 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

# Changelog

## [Unreleased]
## [v4.1.0](https://github.com/umee-network/umee/releases/tag/v4.1.0) - 2023-02-22

### Features

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Building from source will automatically link the `libwasmvm.x86_64.so` created a
| 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 |
| 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 |

## Active Networks

Expand Down
43 changes: 10 additions & 33 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,24 @@

Release Procedure is defined in the [CONTRIBUTING](CONTRIBUTING.md#release-procedure) document.

## v3.3.0
## v4.1.0

- 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
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)

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.
- [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.

Additional highlights:

- 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

Please see the [CHANGELOG](https://github.com/umee-network/umee/blob/v3.3.0/CHANGELOG.md) for an exhaustive list of changes.

### Github Release

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.
**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 Relases](https://github.com/CosmWasm/wasmvm/releases)) or build it from source (you will need Rust toolchain).
If you build on system other 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/
```

### Update instructions
### Upgrade instructions

- Note: Skip this step if you build binary from source and are able to properly link libwasmvm.
- Download `libwasmvm`:
Expand All @@ -46,25 +33,15 @@ $ wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.1.1/internal/api/lib
```

- Wait for software upgrade proposal to pass and trigger the chain upgrade.
- Run latest Peggo (v1.4.0) - **updated**
- Run latest Price Feeder (v2.0.2) - **updated**
- Swap binaries.
- Restart the chain.

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
```
- Ensure latest Peggo (v1.4.0) is running
- Ensure latest Price Feeder (v2.1.0) is running

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`.
NOTE: BEFORE the upgrade, make sure the binary is working and libwasmvm is in your system. You can test it by running `./umeed-v4.1.0 --version`.

#### Docker

Docker images are available in [ghcr.io umee-network](https://github.com/umee-network/umee/pkgs/container/umeed) repository.
Docker images are available in [ghcr.io umee-network](https://github.com/umee-network/umee/pkgs/container/umeed) repository.

0 comments on commit 7179ad9

Please sign in to comment.