Cumulus parachains-v9.0.0 Release runtime checklist #1189

github-actions · 2022-04-20T15:47:31Z

The release of binary / runtime being now split, this is the first checklist for the binary part of the release.
You may also want to have a look at the client checklist.

Runtime Release Checklist

These checks should be performed on the codebase.

Verify spec_version has been incremented since the
last release for any native runtimes from any existing use on public
(non-private/test) networks.
Verify previously completed migrations are
removed for any public (non-private/test) networks.
- No migrations added in the last release that would need to be removed.
Verify pallet and extrinsic ordering as well as SignedExtensions have stayed
the same. Bump transaction_version if not.
Verify new extrinsics have been correctly whitelisted/blacklisted for
proxy filters.
- No new extrinsics.
Verify benchmarks have been updated for any modified
runtime logic.
- Verify the weights are up-to-date.
Verify that the various pieces of XCM config are sane.

The following checks can be performed after we have forked off to the release-
candidate branch or started an additional release candidate branch (rc-2, rc-3, etc)

Verify new migrations complete successfully, and the
runtime state is correctly updated for any public (non-private/test)
networks.
Run integration tests.
Run manual tests.
Push runtime upgrade to Westmint and verify network stability.

All Releases

Check that a draft release has been created at
https://github.com/paritytech/cumulus/releases with relevant release
notes.
Check that build artifacts have been added to the
draft-release.

Notes

Build Artifacts

Add any necessary assets to the release. They should include:

Source code
Wasm binaries of any runtimes

Release notes

The release notes should list:

The priority of the release (i.e., how quickly users should upgrade) - this is
based on the max priority of any client changes.
Which native runtimes and their versions are included
The proposal hashes of the runtimes as built with
srtool
Any changes in this release that are still awaiting audit

The release notes may also list:

Free text at the beginning of the notes mentioning anything important
regarding this release
Notable changes separated into sections.

Spec Version

A runtime upgrade must bump the spec number. This may follow a pattern with the
client release (e.g. runtime v12 corresponds to v0.8.12, even if the current
runtime is not v11).

Runtime version bump between RCs

The clients need to be aware of runtime changes. However, we do not want to bump the
spec_version for every single release candidate. Instead, we can bump the impl field of the version
to signal the change to the client.

Old Migrations Removed

Previous on_runtime_upgrade functions from old upgrades should be removed.

New Migrations

Ensure that any migrations that are required due to storage or logic changes
are included in the on_runtime_upgrade function of the appropriate pallets.

Extrinsic Ordering & Storage

Offline signing libraries depend on a consistent ordering of call indices and
functions. Compare the metadata of the current and new runtimes and ensure that
the module index, call index tuples map to the same set of functions. It also checks if there have been any changes in storage. In case of a breaking change, increase transaction_version.

To verify the order has not changed, manually start the following Github Action. It takes around a minute to run and will produce the report as artifact you need to manually check.

To run it, in the Run Workflow dropdown:

Use workflow from: to ignore, leave master as default
The WebSocket url of the reference node:
- Statemine: wss://kusama-statemine-rpc.paritytech.net
- Westmint: wss://westmint-rpc.polkadot.io
A url to a Linux binary for the node containing the runtime to test: Paste the URL of the latest release-candidate binary from the draft-release on Github. The binary has to previously be uploaded to S3 (Github url link to the binary is constantly changing)
- https://releases.parity.io/cumulus/statemine-v6.0.0-rc1/polkadot-collator
The name of the chain under test. Usually, you would pass a local chain:
- Statemine: statemine-local
- Westmint: westmint-local
Click Run workflow

When the workflow is done, click on it and download the zip artifact, inside you'll find an output.txt file. The things to look for in the output are lines like:

[Identity] idx 28 -> 25 (calls 15) - indicates the index for Identity has changed
[+] Society, Recovery - indicates the new version includes 2 additional modules/pallets.
If no indices have changed, every modules line should look something like [Identity] idx 25 (calls 15)

Note: Adding new functions to the runtime does not constitute a breaking change
as long as the indexes did not change.

Note: Extrinsic function signatures changes (adding/removing & ordering arguments) are not caught by the job, so those changes should be reviewed "manually"

Proxy Filtering

The runtime contains proxy filters that map proxy types to allowable calls. If
the new runtime contains any new calls, verify that the proxy filters are up to
date to include them.

Benchmarks

Until #631 is done, running the benchmarks is a manual process:

Connect to the bechmarking machine
Make sure no one else is using the machine with htop check
Pull in the branch of Cumulus that has the version of Statemine you want to release
Recompile cargo build --profile production --locked --features runtime-benchmarks
From the root directory run nohup ./scripts/benchmarks.sh & (it will take quite a few hours)
Checkout in your local machine to the branch of cumulus that has the version of Statemine you want to release
scp from the host to your local machine the weights for Statemine, Westmint and Statemint you'll find in:
- /polkadot-parachains/statemine/src/weights
- /polkadot-parachains/westmint/src/weights
- /polkadot-parachains/statemint/src/weights
Commit the changes in your local and create a PR

The text was updated successfully, but these errors were encountered:

gilescope · 2022-04-21T16:09:39Z

Talked in the group and there seem to be no migrations this time around.

gilescope · 2022-04-21T16:10:53Z

There were no migrations for v800 so there's no old migrations to remove.

NachoPal · 2022-04-22T14:16:47Z

My findings about the Proxy Filters:

A new extrinsic was added: set_accept_ownership in the Uniques pallet.

When checking if I had to whitelist it I found out that many other dispatchables were never whitelisted:

ASSETS pallet

refund
touch
transfer_approved
force_cancel_approval
cancel_approval
approve_transfer
force_asset_status
force_clear_metadata
force_set_metadata
transfer
force_create

UNIQUES pallet

set_accept_ownership
force_asset_status
cancel_approval
approve_transfer
redeposit
transfer
force_create

I can not find a clear pattern to tell which ones should be included in the ProxyType. Probably there is business/security logic behind.

NachoPal · 2022-04-25T19:28:26Z

Tests results:

Statemine

--------------------------------------------------------------
Assets Common Good Parachain
--------------------------------------------------------------
- Assets
                - Create -> ✅
		- Force Create (from Relay Chain) -> ✅

- Uniques
                - Create -> ✅
		- Force Create (from Relay Chain) -> ✅

----------------------------------------------------------------
DMP -> Relay Chain to Assets Common Good Parachain
----------------------------------------------------------------
- XcmPallet
		- Limited Teleport Asset (KSM) -> ✅
		- Limited Reserve Transfer Assets (KSM) -> ✅
		- Send (Root - Transact) -> ✅
		- Send (No Root - Transact) -> ✅ (expected ❌ [Bad Origin])

----------------------------------------------------------------
HRMP -> Community Parachain <> Assets Common Good Parachain
----------------------------------------------------------------
- Opening Bidirectional Channels
		- InitOpenChannel | (Community → Assets) -> ✅
		- Accept & initOpenChannel | (Assets → Community) -> ✅
		- AcceptOpenChannel | Community -> ✅

- PolkadotXcm
		- LimitedReserveTransferAssets (Asset) | Assets → Community -> ✅
		- LimitedReserveTransferAssets (KSM) | Assets → Community ->  ✅

----------------------------------------------------------------
UMP -> Assets Common Good Parachain to Relay Chain
----------------------------------------------------------------
- PolkadotXcm
		- Limited Teleport Asset (KSM) -> ✅ 
		- Limited Reserve Transfer Assets (KSM) -> ✅ (expected ❌ [Barrier])
		- Send -> ✅ (expected ❌ [Bad Origin])

----------------------------------------------------------------
RELEASE SPECIFIC
----------------------------------------------------------------
None

Statemint

--------------------------------------------------------------
Assets Common Good Parachain
--------------------------------------------------------------
- Assets
		- Create -> ✅
		- Force Create (from Relay Chain) -> ✅

- Uniques
		- Create -> ✅
		- Force Create (from Relay Chain) -> ✅

----------------------------------------------------------------
DMP -> Relay Chain to Assets Common Good Parachain
----------------------------------------------------------------
- XcmPallet
		- Limited Teleport Asset (DOT) -> ✅ 
		- Limited Reserve Transfer Assets (DOT) -> ✅ 
		- Send (Root-Transact) -> ✅
		- Send (No Root - Transact) -> ✅ (expected ❌ [BadOrigin])

----------------------------------------------------------------
HRMP -> Community Parachain <> Assets Common Good Parachain
----------------------------------------------------------------
- Opening Bidirectional Channels
		- InitOpenChannel | (Community → Assets) -> ✅
		- Accept & initOpenChannel | (Assets → Community) -> ✅
		- AcceptOpenChannel | Community -> ✅

- PolkadotXcm
		- LimitedReserveTransferAssets (Asset) | Assets → Community -> ✅
		- LimitedReserveTransferAssets (KSM) | Assets → Community ->  ✅

----------------------------------------------------------------
UMP -> Assets Common Good Parachain to Relay Chain
----------------------------------------------------------------
- PolkadotXcm
		- Limited Teleport Asset (DOT) -> ✅
		- Limited Reserve Transfer Assets (DOT) -> ✅ (expected ❌ [Barrier])
		- Send -> ✅ (expected ❌ [BadOrigin])

----------------------------------------------------------------
RELEASE SPECIFIC
----------------------------------------------------------------
None

chevdor · 2022-04-25T20:12:56Z

ref https://github.com/paritytech/cumulus/releases/tag/parachains-v9.0.0

chevdor changed the title ~~Cumulus parachains-v9.0.0 Release checklist~~ Cumulus parachains-v9.0.0 Release runtime checklist Apr 22, 2022

chevdor mentioned this issue Apr 22, 2022

Cumulus polkadot-v0.9.19 collator binary Release checklist #1201

Closed

6 tasks

gilescope mentioned this issue Apr 22, 2022

Should a NonTransfer proxy be able to set_accept_ownership of an asset? #1206

Open

chevdor closed this as completed Apr 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cumulus parachains-v9.0.0 Release runtime checklist #1189

Cumulus parachains-v9.0.0 Release runtime checklist #1189

github-actions bot commented Apr 20, 2022 •

edited by chevdor

gilescope commented Apr 21, 2022

gilescope commented Apr 21, 2022

NachoPal commented Apr 22, 2022

NachoPal commented Apr 25, 2022 •

edited

chevdor commented Apr 25, 2022

Cumulus parachains-v9.0.0 Release runtime checklist #1189

Cumulus parachains-v9.0.0 Release runtime checklist #1189

Comments

github-actions bot commented Apr 20, 2022 • edited by chevdor

Runtime Release Checklist

All Releases

Notes

Build Artifacts

Release notes

Spec Version

Runtime version bump between RCs

Old Migrations Removed

New Migrations

Extrinsic Ordering & Storage

Proxy Filtering

Benchmarks

gilescope commented Apr 21, 2022

gilescope commented Apr 21, 2022

NachoPal commented Apr 22, 2022

NachoPal commented Apr 25, 2022 • edited

Statemine

Statemint

chevdor commented Apr 25, 2022

github-actions bot commented Apr 20, 2022 •

edited by chevdor

NachoPal commented Apr 25, 2022 •

edited