Skip to content

Commit

Permalink
docs: v5.0 release notes (#2073)
Browse files Browse the repository at this point in the history
* docs: v5.0 release notes

* release notes updates
  • Loading branch information
robert-zaremba authored May 31, 2023
1 parent 702866e commit ab74be0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 95 deletions.
16 changes: 14 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,33 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Features

- [1952](https://github.com/umee-network/umee/pull/1952) Add `x/incentive` module
- [1952](https://github.com/umee-network/umee/pull/1952) Add `x/incentive` module.
- [2015](https://github.com/umee-network/umee/pull/2015), [2050](https://github.com/umee-network/umee/pull/2050) Add `x/ugov` module.

## [v5.0.0](https://github.com/umee-network/umee/releases/tag/v5.0.0-rc1) - 2023-05-31

### Features

- [1888](https://github.com/umee-network/umee/pull/1888) Created `/sdkclient` and `/client` (umee client) packages to easy the E2E tests and external tools. Essentially, you can import that client and broadcast transactions easily.
- [1993](https://github.com/umee-network/umee/pull/1993) Updated our Cosmos SDK fork to 0.46.12 and included an option to disable colored logs.
- [2071](https://github.com/umee-network/umee/pull/2071) Update GB and enable Valset Burn mechanism.
- [1547](https://github.com/umee-network/umee/pull/1547), [1997](https://github.com/umee-network/umee/pull/1997), [2058](https://github.com/umee-network/umee/pull/2058), [2063](https://github.com/umee-network/umee/pull/2063) Cosmwasm integration.

### Improvements

- [1989](https://github.com/umee-network/umee/pull/1989) Leverage: fix the duplicate symbol denoms issue on adding new tokens to registry.
- [1989](https://github.com/umee-network/umee/pull/1989) Updated go version from 1.19 to 1.20
- [2001](https://github.com/umee-network/umee/pull/2001) Refactoring CLI integration test suite.
- [2009](https://github.com/umee-network/umee/pull/2009) Use DavidAnson/markdownlint action for Markdown linting.
- [2010](https://github.com/umee-network/umee/pull/2010) New `util/store` generic functions to load all values from a store.
- [2021](https://github.com/umee-network/umee/pull/2021) `quota/keeper` unit test refactor.
- [2021](https://github.com/umee-network/umee/pull/2021) `uibc/quota/keeper` unit test refactor.
- [2024](https://github.com/umee-network/umee/pull/2024) New upgrade registration methods.
- [2037](https://github.com/umee-network/umee/pull/2037) Speedup e2e by removing docker cache.
- [2038](https://github.com/umee-network/umee/pull/2038) Unify util tsdk and store packages.

### Fixes

- [1982](https://github.com/umee-network/umee/pull/1982) Fix the build version (`umeed version`).
- [2052](https://github.com/umee-network/umee/pull/2052) Allow liquidation threshold == collateral weight in token validation.
- [2072](https://github.com/umee-network/umee/pull/2072) Fix an int64 overflow when computing module liquidity for high-exponent assets.

Expand Down
97 changes: 4 additions & 93 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,22 @@

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

## v4.5.0
## v5.0.0

Highlights:

- Updated to the latest Cosmos SDK v0.46.12
- Cosmwasm integration.
- Gravity Bridge phase-3: shutdown of the transfers. In this release we introduce valset burn mechanism,
which will block the Ethereum smart contract for processing any further transactions, as well
as sending transfers back to Ethereum. This follows the plan approved through in the
[prop-67](https://www.mintscan.io/umee/proposals/67).
NOTE: All validators must continue to use Peggo to not get slashed.
- Updated to the latest Cosmos SDK v0.46.12

<!-- TODO: See [CHANGELOG](https://github.com/umee-network/umee/blob/v4.4.0/CHANGELOG.md) for a full list of changes. -->
See [CHANGELOG](https://github.com/umee-network/umee/blob/v5.0.0-rc1/CHANGELOG.md)

### Validators

We changed our GitHub release configuration, and now provide binaries in `.tar.gz` tarball.

#### libwasmvm update

Related to CosmWasm security patch, the binary requires `libwasmvm v1.2.3`. When you build the binary from source on the server machine you probably don't need any change. However when you download a binary from GitHub, or from other source, make sure you update the `/usr/lib/libwasmvm.<cpu_arch>.so`. For example:

- copy from `$GOPATH/pkg/mod/github.com/!cosm!wasm/wasmvm@v1.2.3/internal/api/libwasmvm.$(uname -m).so`
- or download from github `wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.2.3/internal/api/libwasmvm.$(uname -m).so -O /usr/lib/libwasmvm.$(uname -m).so`

You don't need to do anything if you are using our Docker image.

#### Min Gas Prices

Since v4.2 release 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:
Expand All @@ -58,82 +48,3 @@ You can use Cosmovisor → see [instructions](https://github.com/umee-network/um
#### Docker

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

## v4.4.1

Patch release updating `ibc-go` to the most recent patch release.

## v4.4.0

This is a small, intermediate release.

For the Stride onboarding process, we decided to disable the IBC ICS-20 inflow limit of x/leverage registered tokens only. That means, now all tokens will be available for inflow transfers. Outflows quota will still hold: unregistered tokens can be transferred out without any limit and x/leverage registered tokens are limited to the daily quota.

See [CHANGELOG](https://github.com/umee-network/umee/blob/v4.4.0/CHANGELOG.md) for a full list of changes.

## v4.3.0

Highlights:

- Gravity Bridge Shutdown Phase 2. Following [Prop-67](https://www.mintscan.io/umee/proposals/67) we are disabling Umee -> Ethereum token transfers. Ethereum -> Umee transfers are still possible, and we encourage everyone to move the tokens back to Umee. In May we are planning the complete shut down. See more in the [blog post](https://umee.cc/blog/bridgemigration).
- IBC updated to `ibc-go v6.1`. That also triggered our wasmvm dependency update (see `libwasmvm` update in Validators section)
- ICA Host integration.
- IBC ICS20: we will only accept tokens (denoms) which are registered in the x/leverage token registry. You can check the supported tokens by `umeed q leverage registered-tokens` or by visiting [umee/leverage/v1/registered_tokens](https://umee-api.polkachu.com/umee/leverage/v1/registered_tokens).

See [CHANGELOG](https://github.com/umee-network/umee/blob/v4.3.0/CHANGELOG.md) for a full list of changes.

### Validators

#### libwasmvm update

Our dependencies have been updated. Now the binary requires `libwasmvm v1.2.1`. When you build the binary from source on the server machine you probably don't need any change. However when you download a binary from GitHub, or from other source, make sure you update the `/usr/lib/libwasmvm.<cpu_arch>.so`. For example:

- copy from `$GOPATH/pkg/mod/github.com/!cosm!wasm/wasmvm@v1.2.1/internal/api/libwasmvm.$(uname -m).so`
- or download from github `wget https://raw.githubusercontent.com/CosmWasm/wasmvm/v1.2.1/internal/api/libwasmvm.$(uname -m).so -O /usr/lib/libwasmvm.$(uname -m).so`

You don't need to do anything if you are using our Docker image.

#### Min Gas Prices

Same as with v4.2 release. 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:

```
minimum-gas-prices = "0.1uumee"
```

You MUST also set the related parameter when starting Peggo `--cosmos-gas-prices="0.1uumee"`

## v4.2.0

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:

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

Other highlights:

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

See [CHANGELOG](https://github.com/umee-network/umee/blob/v4.2.0/CHANGELOG.md) for a full list of changes.

## 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/
```

0 comments on commit ab74be0

Please sign in to comment.