Skip to content

Commit

Permalink
chore: v3.2 Release Notes (#1620)
Browse files Browse the repository at this point in the history
## Description

Updates:
+ release notes
+ README
+ notes about Github binary release
+ notes a `libwasmvm.x86_64.so v1.1.1` dependency

---

### 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 committed Nov 25, 2022
1 parent 636bb1a commit 4e4dc13
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
run: echo "TM_VERSION=$(go list -m github.com/tendermint/tendermint | sed 's:.* ::')" >> $GITHUB_ENV

# useful to test builds. However will require to add "push" rule to the "on" section
- name: Build
- name: goreleaser test-build
uses: goreleaser/goreleaser-action@v3
if: github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'Enable:ReleaseBuild')
with:
Expand Down
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,13 @@ Ref: https://keepachangelog.com/en/1.0.0/

## [Unreleased]

## [v3.2.0](https://github.com/umee-network/umee/releases/tag/v3.2.0) - 2022-11-25

Since `umeed v3.2` there is a new runtime dependency: `libwasmvm.x86_64.so v1.1.1` is required.
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).

### Features

- [1555](https://github.com/umee-network/umee/pull/1555) Updates IBC to v5.1.0 that adds adds optional memo field to `FungibleTokenPacketData` and `MsgTransfer`.
- [1577](https://github.com/umee-network/umee/pull/1577) Removes LIQUIDATOR build flag and adds `--enable-liquidator-query` or `-l` runtime flag to `umeed start`. See [README.md](README.md) file for more details.

Expand All @@ -58,7 +64,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

- [1578](https://github.com/umee-network/umee/pull/1578) Reorganize key constructors in x/leverage/types and x/oracle/types.

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

### Features

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,18 @@ Umee will allow a multitude of decentralized debt products.

See [Release procedure](CONTRIBUTING.md#release-procedure) for more information about the release model.

Since `umeed v3.2` there is a new runtime dependency: `libwasmvm.x86_64.so v1.1.1` is required.
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).

### Release Compatibility Matrix

| Umee Version | Mainnet | Experimental | Cosmos SDK | IBC | Peggo | Price Feeder | Gravity Bridge |
| Umee Version | Mainnet | Experimental | Cosmos SDK | IBC | Peggo | Price Feeder | Gravity Bridge |
| :----------: | :-----: | :----------: | :--------: | :----: | :-----: | :----------: | :------------------------: |
| v0.8.x ||| v0.45.x | v2.0.x | v0.2.x | v0.1.x | |
| 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.x.x ||| v0.46.x | v5.0.x | v1.3.x+ | v1.0.x | umee/v3 module/v1.5.x-umee |
| 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 |

## Active Networks

Expand Down Expand Up @@ -71,7 +75,7 @@ $ make install
> Note: `cosmovisor` only works for upgrades in the `umeed`, for off-chain processes updates like `peggo` or `price-feeder`, manual steps are required.
- `cosmovisor` is a small process manager for Cosmos SDK application binaries that monitors the governance module for incoming chain upgrade proposals. If it sees a proposal that gets approved, `cosmovisor` can automatically download
the new binary, stop the current binary, switch from the old binary to the new one, and finally restart the node with the new binary.
the new binary, stop the current binary, switch from the old binary to the new one, and finally restart the node with the new binary.

- Install it with go

Expand Down
20 changes: 17 additions & 3 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,32 @@ This is a state machine breaking release. Coordinated update is required.
Highlights:

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

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

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

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

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 same host as you run the binary, or copy the `libwasmvm.x86_64.so` your lib directory).

### Update instructions

- 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)
- Run latest Peggo (v1.3.0) - **updated**
- Run latest Price Feeder (v2.0.0) - **updated**
- Swap binaries.
- Restart the chain.

You can use Cosmovisor → see [instructions](https://github.com/umee-network/umee/#cosmovisor).

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

0 comments on commit 4e4dc13

Please sign in to comment.