BREAKING - Try-runtime: Use proper error types #13993

Szegoo · 2023-04-24T15:15:51Z

Updates the return types of:

try_state to DispatchResult
pre_upgrade to Result<_, DispatchError>
post_upgrade to DispatchResult
try_on_runtime_upgrade to Result<Weight, DispatchError>

TODO:

Check for places where some existing error variants can be used.

This PR introduces a new type inside sp_runtime called TryRuntimeError. This new type is essentially just an alias to the DispatchError type. This only improves the readability of the code.

All of the hooks that now have a different error type should no longer use assert! or similar. The reason for this is that we don't want the code in these macros to panic, instead in case of an error we want to return the TryRuntimeError type.
Since TryRuntimeError is an alias for DispatchError it allows us to use some existing error variants, but in case there isn't an existing variant that could convey the error message &'static str should be used which will get converted to TryRuntimeError during compile time.

Polkadot companion: paritytech/polkadot#7146
Cumulus companion: paritytech/cumulus#2615

kusama address: DfqY6XQUSETTszBQ1juocTcG9iiDoXhvq1CoVadBSUqTGJS

Closes: #13736

Szegoo · 2023-04-27T13:49:11Z

@kianenigma @liamaharon PTAL.

liamaharon

LGTM. Just some errors on cargo c --features try-runtime still to fix it looks like.

frame/staking/src/migrations.rs

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

Szegoo · 2023-05-23T17:40:18Z

@liamaharon Thanks for the tip!

@mordamax I would also like to use my Kusama address here also. Is the tip-bot working with opengov now?

mordamax · 2023-05-23T17:43:01Z

@Szegoo yes, it should work now. I fixed len for Lookup and we deployed today. I guess we need to re-tip you in the other PR again )

mordamax · 2023-05-23T17:48:24Z

/tip medium

substrate-tip-bot · 2023-05-23T17:48:27Z

@mordamax Could not submit tip :( Notify someone here.

mordamax · 2023-05-23T18:36:54Z

/tip medium

substrate-tip-bot · 2023-05-23T18:43:07Z

@mordamax Could not submit tip :( Notify someone here.

mordamax · 2023-05-23T19:08:23Z

/tip medium

substrate-tip-bot · 2023-05-23T19:14:38Z

@mordamax Could not submit tip :( Notify someone here.

mordamax · 2023-05-24T14:37:40Z

/tip medium

substrate-tip-bot · 2023-05-24T14:38:21Z

@mordamax A medium tip was successfully submitted for @Szegoo (DfqY6XQUSETTszBQ1juocTcG9iiDoXhvq1CoVadBSUqTGJS on kusama).

https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-rpc.polkadot.io#/referenda

mordamax · 2023-05-24T14:41:26Z

So now looks like all good. I will send tips for previous wasted proposals with 0 len

liamaharon · 2023-05-24T15:03:43Z

Thanks @mordamax !

pgherveou · 2023-05-26T09:59:32Z

Hey @Szegoo did you use a script to rewrite all the changes ?
I am asking as I need to fix some conflict, in one of our pending PR

Szegoo · 2023-05-26T12:39:19Z

@pgherveou I used basic vscode search and replace for pre_upgrade. For the other ones, I used a regex in vscode to search and replace all of them.

You can do something like this:

Search pattern: fn try_on_runtime_upgrade\((.*?)\) -> Result<Weight, &'static str>

Replacement: fn try_on_runtime_upgrade($1) -> Result<Weight, TryRuntimeError>

pgherveou · 2023-05-26T12:42:11Z

Ty ended up doing the same, was not too much trouble

pgherveou · 2023-05-26T12:42:52Z

You also updated all the assert_eq -> ensure right in this pre/post upgrade methods

Szegoo · 2023-05-26T12:43:25Z

You also updated all the assert_eq -> ensure right

Yes, that also needs to be updated.

* Try-state: DispatchResult as return type * try_state for the rest of the pallets * pre_upgrade * post_upgrade * try_runtime_upgrade * fixes * bags-list fix * fix * update test * warning fix * ... * final fixes 🤞 * warning.. * frame-support * warnings * Update frame/staking/src/migrations.rs Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * fix * fix warning * nit fix * merge fixes * small fix * should be good now * missed these ones * introduce TryRuntimeError and TryRuntimeResult * fixes * fix * removed TryRuntimeResult & made some fixes * fix testsg * tests passing * unnecessary imports * Update frame/assets/src/migration.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> --------- Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

Szegoo · 2023-05-28T07:25:28Z

@mordamax From my understanding by looking at this: https://kusama.subsquare.io/referenda/referendum/205 the proposal is approved and executed. But it seems like the tokens didn't get transferred from the treasury 🤔
The same goes for my other tip.

mordamax · 2023-05-29T15:44:11Z

@Szegoo thank you for pinging me back!
@bkchr helped to find a problem and here's paritytech/substrate-tip-bot#74 issue to fix it.
We'll follow-up with both tips again after fix 🙏
cc @rzadp

rzadp · 2023-06-09T08:58:40Z

/tip medium

substrate-tip-bot · 2023-06-09T08:59:23Z

@rzadp A medium (5 KSM) tip was successfully submitted for @Szegoo (DfqY6XQUSETTszBQ1juocTcG9iiDoXhvq1CoVadBSUqTGJS on kusama).

https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-rpc.polkadot.io#/referenda

* Try-state: DispatchResult as return type * try_state for the rest of the pallets * pre_upgrade * post_upgrade * try_runtime_upgrade * fixes * bags-list fix * fix * update test * warning fix * ... * final fixes 🤞 * warning.. * frame-support * warnings * Update frame/staking/src/migrations.rs Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * fix * fix warning * nit fix * merge fixes * small fix * should be good now * missed these ones * introduce TryRuntimeError and TryRuntimeResult * fixes * fix * removed TryRuntimeResult & made some fixes * fix testsg * tests passing * unnecessary imports * Update frame/assets/src/migration.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> --------- Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

Szegoo added 7 commits April 24, 2023 17:14

Try-state: DispatchResult as return type

9e030be

try_state for the rest of the pallets

1b0155e

pre_upgrade

c78308b

post_upgrade

733d461

try_runtime_upgrade

388bf12

fixes

3cd0012

bags-list fix

8776628

Szegoo marked this pull request as ready for review April 27, 2023 13:48

Szegoo requested a review from a team April 27, 2023 13:48

Szegoo requested a review from athei as a code owner April 27, 2023 13:48

liamaharon requested review from kianenigma and liamaharon April 27, 2023 13:52

Szegoo added 8 commits April 27, 2023 15:52

fix

f7aa4d6

update test

fd44013

warning fix

a5693f7

...

f38a40e

final fixes 🤞

113aeac

warning..

65ffe15

frame-support

d0ea89f

warnings

e6a37c7

liamaharon approved these changes Apr 28, 2023

View reviewed changes

frame/staking/src/migrations.rs Outdated Show resolved Hide resolved

Szegoo and others added 3 commits April 28, 2023 11:06

Update frame/staking/src/migrations.rs

49ac4db

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

fix

83b5cdf

fix warning

773f4ad

Szegoo mentioned this pull request Apr 28, 2023

Try-runtime proper return types paritytech/polkadot#7146

Merged

mordamax mentioned this pull request May 29, 2023

Store tip metadata through set_metadata instead of a remark paritytech/substrate-tip-bot#74

Closed

github-actions bot mentioned this pull request Jun 15, 2023

Update substrate/polkadot/cumulus from v0.9.40 to v0.9.43 moonbeam-foundation/moonbeam#2354

Closed

kiltbot mentioned this pull request Jun 21, 2023

1️⃣ [AUTOMATIC] Update Polkadot dependencies from 0.9.42 to 0.9.43 KILTprotocol/kilt-node#531

Closed

kacperzuk-neti mentioned this pull request Jun 23, 2023

Polkadot v0.9.43 liberland/liberland_substrate#295

Merged

15 tasks

ToufeeqP mentioned this pull request Aug 31, 2023

Upgrade to polkadot-v1.0 availproject/avail#195

Merged

dmitrylavrenov mentioned this pull request Oct 29, 2024

Tracking issue to bump substrate related deps to polkadot-v0.9.43 humanode-network/humanode#923

Open

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING - Try-runtime: Use proper error types #13993

BREAKING - Try-runtime: Use proper error types #13993

Szegoo commented Apr 24, 2023 •

edited

Loading

Szegoo commented Apr 27, 2023

liamaharon left a comment •

edited

Loading

Szegoo commented May 23, 2023

mordamax commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 24, 2023

substrate-tip-bot bot commented May 24, 2023

mordamax commented May 24, 2023

liamaharon commented May 24, 2023

pgherveou commented May 26, 2023

Szegoo commented May 26, 2023

pgherveou commented May 26, 2023

pgherveou commented May 26, 2023 •

edited

Loading

Szegoo commented May 26, 2023

Szegoo commented May 28, 2023

mordamax commented May 29, 2023

rzadp commented Jun 9, 2023

substrate-tip-bot bot commented Jun 9, 2023

BREAKING - Try-runtime: Use proper error types #13993

BREAKING - Try-runtime: Use proper error types #13993

Conversation

Szegoo commented Apr 24, 2023 • edited Loading

Szegoo commented Apr 27, 2023

liamaharon left a comment • edited Loading

Choose a reason for hiding this comment

Szegoo commented May 23, 2023

mordamax commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 23, 2023

substrate-tip-bot bot commented May 23, 2023

mordamax commented May 24, 2023

substrate-tip-bot bot commented May 24, 2023

mordamax commented May 24, 2023

liamaharon commented May 24, 2023

pgherveou commented May 26, 2023

Szegoo commented May 26, 2023

pgherveou commented May 26, 2023

pgherveou commented May 26, 2023 • edited Loading

Szegoo commented May 26, 2023

Szegoo commented May 28, 2023

mordamax commented May 29, 2023

rzadp commented Jun 9, 2023

substrate-tip-bot bot commented Jun 9, 2023

Szegoo commented Apr 24, 2023 •

edited

Loading

liamaharon left a comment •

edited

Loading

pgherveou commented May 26, 2023 •

edited

Loading