Skip to content

Commit

Permalink
docs: v3.1 Release Notes (#1426)
Browse files Browse the repository at this point in the history
## Description

Release notes for v3.1

---

### Author Checklist

_All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues._

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] added appropriate labels to the PR
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/umee-network/umee/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

_All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items._

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
  • Loading branch information
robert-zaremba authored Oct 22, 2022
1 parent 224e916 commit ff503f4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 76 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Ref: https://keepachangelog.com/en/1.0.0/

## [Unreleased]

## [v3.1.0](https://github.com/umee-network/umee/releases/tag/v3.0.0) - 2022-10-22

### Features

- [1513](https://github.com/umee-network/umee/pull/1513) New query service exposing chain information via new RPC route. See [cosmos-sdk/11582](https://github.com/cosmos/cosmos-sdk/issues/11582).
Expand All @@ -58,6 +60,13 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Fixes

- [1471](https://github.com/umee-network/umee/pull/1471) Fix slash window progress query.
- [1501](https://github.com/umee-network/umee/pull/1501) Cosmos SDK patch release.

## [v3.0.3](https://github.com/umee-network/umee/releases/tag/v3.0.3) - 2022-10-21

### Fixes

- [1511](https://github.com/umee-network/umee/pull/1511) Cosmos SDK patch release for Umee v3.0.3.

## [v3.0.2](https://github.com/umee-network/umee/releases/tag/v3.0.2) - 2022-09-29

Expand Down
91 changes: 15 additions & 76 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,89 +6,28 @@

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

## [Unreleased]
## v3.1.0

## v3.0.2
This is a state machine breaking release. Coordinated update is required.

Gravity Bridge update. In v3.0.0 we enabled Gravity Bridge, but there was an error in the way how the
`ValsetUpdate` attestation is handled, causing the chain to halt in EndBlocker.
The bug didn't involved any security issue and the bridge is safe.
Updates:

Update instructions:
- New `leverage/MsgSupplyCollateral` message which combines functionality of both supply and collaterization.
- New chain `/cosmos/base/node/v1beta1/config` query gRPC endpoint was integrated providing chain information such us `bond_denom`, `gas_prices`... See [cosmos-sdk/11582](https://github.com/cosmos/cosmos-sdk/issues/11582) for more details.

- stop the chain
- swap the binary
- restart (no additional coordination is required)

## v3.0.1

Fix v3.0.0 `Block.Header.LastResultsHash` problem.
During inspections we found that `tx.GasUsage` didn't match across some nodes, causing chain halt:

```
ERR prevote step: ProposalBlock is invalid err="wrong Block.Header.LastResultsHash. Expected EDEE3056AA71C73EC8B7089AAA5414D1298EF78ADC4D510498DB834E499E42C2, got 5ADF2EA7E0B31BA21E802071E1A9E4C4803259FE3AFFF17AAA53F93DA1D6264F" height=3216273 module=consensus round=68
```

## v3.0.0

v3.0.0 improves upon the _umeemania_ testnet release (v2.0.x) which introduced our **lending** and **oracle** functionality.

### Highlights since v1.x

- `x/leverage` module, which allows anyone to:
- supply liquidity (and earn interest)
- collateralize the supplied assets to enable borrowing
- borrow (and pay interest)
- participate in governance of `x/leverage` [parameters](https://github.com/umee-network/umee/blob/main/proto/umee/leverage/v1/leverage.proto) file.
- `x/oracle` module - a decentralized price oracle for the `x/leverage` module, as well as any app built in the Umee blockchain. UMEE holders set `x/oracle` [parameters](https://github.com/umee-network/umee/blob/main/proto/umee/oracle/v1/oracle.proto) by governance.
- Cosmos v0.46 upgrade, which features:
- [`x/group`](https://tutorials.cosmos.network/tutorials/7-understand-sdk-modules/3-group.html) module
- [`x/nft`](https://github.com/cosmos/cosmos-sdk/tree/v0.46.1/x/nft/spec) module
- [Transaction Tips](https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/RELEASE_NOTES.md#transaction-tips-and-sign_mode_direct_aux)
- [SIGN_MODE_DIRECT_AUX](https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/RELEASE_NOTES.md#transaction-tips-and-sign_mode_direct_aux)
- transaction prioritization
- IBC v5.0
- Minimum validator commission rate is set to 5% per [prop 16](https://www.mintscan.io/umee/proposals/16). Validators with smaller commission rate will be automatically updated.

#### x/leverage settings

The leverage module is by default compiled without support for the `liquidation_targets` query.

Validators should NOT enable this query on their nodes - it is inefficient due to iterating over all borrower accounts, and can delay time-sensitive consensus operations when a sufficient number of addresses must be checked.

To run a node capable of supporting a liquidator, enable the query at compile time using `LIQUIDATOR=true make install`.
Please see the [CHANGELOG](https://github.com/umee-network/umee/blob/v3.1.0/CHANGELOG.md) for an exhaustive list of changes.

### Gravity Bridge

In `v1.1.x` (current mainnet) we disabled Gravity Bridge (GB) module due to Ethereum PoS migration (_the merge_).
This release is the first step to re-enable GB. We start by enabling validators update and evidence messages (`MsgValsetConfirm` and `MsgValsetUpdatedClaim`), but the bridge messages: batch creation, claims (both ways: Ethereum->Cosmos and Cosmos->Ethereum) remain disabled.

Validators are expected to run Peggo and update the valiator set in Gravity smart contract.

See [Gravity Bridge](https://github.com/umee-network/Gravity-Bridge/blob/module/v1.5.3-umee-1/module/RELEASE_NOTES.md) Release Notes.

### Update notes

Each validator MUST:

- Run Peggo (Gravity Bridge Orchestrator) v1.0.x
- Run [Price Feeder](https://github.com/umee-network/umee/tree/main/price-feeder) v1.0.x
- Update `app.toml` file by setting `minimum-gas-prices = "0uumee"`:

```toml
# The minimum gas prices a validator is willing to accept for processing a
# transaction. A transaction's fees must meet the minimum of any denomination
# specified in this config (e.g. 0.25token1;0.0001token2).
minimum-gas-prices = "0uumee"
```

- Update `config.toml` file by setting `mempool.version="v1"`. Ideally you should do it before the upgrade time, then at the upgrade switch binaries and start with the upgraded config:
This is the second step for enabling Gravity Bridge.
We enable all messages. Peggo was updated to handle the bridge pause.

```toml
[mempool]
version = "v1"
```
### Update instructions

Instructions: [umeeversity/validator](https://umeeversity.umee.cc/validators/mainnet-validator.html)
- Wait for software upgrade proposal to pass and trigger the chain upgrade.
- Run latest Peggo (v1.2.1)
- Run latest Price Feeder (v1.0.0)
- Swap binaries.
- Restart the chain.

Failure to run Peggo and Price Feeder results in being slashed, as do certain types of misbehavior such as consistently submitting incorrect prices.
Validators are required to run Peggo in order to sync the Gravity Bridge messages.

0 comments on commit ff503f4

Please sign in to comment.