Make Staking pallet using a proper Time module. by gui1117 · Pull Request #4662 · paritytech/substrate

gui1117 · 2020-01-17T13:28:35Z

(EDITED)

the staking modules make use of Time trait to get the time in millisecond, however this a wrong usage of such traits which doesn't specifies what is moment.

To solve this this PR introduce a new trait named UnixTime implemented by timestamp and used by staking.

As said by Kian it would be great to have more docs on the Time trait itself and usage it is suppose to have. But I struggle to define any documentation for this trait.

The migration is implemented in such a way that the active era start at the moment of the migration.
This is needed because even if the wrong usage of Time correctly returned a moment in millisecond there is no guarantee that this moment is since unix_epoch.

On Kusama however the old Time was indeed the millisecond since unix epoch thus we could improve kusama migration.

frame/support/src/traits.rs

bkchr · 2020-02-03T08:44:40Z

Any update on this?

gui1117 · 2020-02-03T09:31:43Z

OK I made an alternative implementation, otherwise I can do now_millis but I feel like this way the moment of now is a bit more configurable.

bkchr · 2020-02-03T09:49:48Z

frame/support/src/traits.rs

+	fn year() -> Self::Moment;
+
+	/// Return current moment.
 	fn now() -> Self::Moment;


Now you are mixing some time related functionality (year()) with a moment that can be anything.

I still think we should keep this Time trait simple and say that now() will return a moment that increases between blocks, but without specifying what it is. It could also be the moment from the genesis of the chain.

I would add another trait UnixTime that clearly says that now() returns the Duration from the unix epoch. I would directly return core::time::Duration. This already brings all the functions for converting between the different time formats.

The timestamp module would implement both of these traits and return the same value for both now() calls, but as different types. Staking would require that Time implements UnixTime.

yes, I completely agree

frame/staking/src/lib.rs

frame/staking/src/migration.rs

gnunicorn · 2020-02-18T14:51:16Z

please update to latest master.

frame/staking/src/mock.rs

kianenigma · 2020-03-09T07:55:09Z

I think it should be explained in the timestamp module when another module (i.e. staking in this case) should use Time impl and and when UnixTime.

Co-Authored-By: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

bkchr · 2020-03-09T09:56:12Z

I think it should be explained in the timestamp module when another module (i.e. staking in this case) should use Time impl and and when UnixTime.

Why? It depends on what the module requires on constraints and not what the timestamp module provides.

You could just have the requirement of time increasing which could be anything, even just the block number.

Or like staking you really need UNIX time.

gui1117 · 2020-03-09T09:57:25Z

I think it should be explained in the timestamp module when another module (i.e. staking in this case) should use Time impl and and when UnixTime.

to be honest I struggle to know what are the guarantee of Time, maybe that it can only increase.

bkchr · 2020-03-09T16:20:05Z

frame/staking/src/lib.rs

+	/// Deprecated Time.
+	///
+	/// Deprecated associated type wrongly used to query Time in millisecond.
+	type DeprecatedTime: Time;


Why do we need this?

the main use it to be able to decode the old structure ActiveInfo<MomentOf<T>>.
But indeed I can just decode the EraIndex and not start field as I don't use it.

I updated code as such, (also fixing that StorageVersion wasn't set)

bkchr · 2020-03-24T10:59:45Z

What is your plan with this @thiolliere ?

gui1117 · 2020-03-25T12:12:59Z

frame/staking/src/lib.rs

 impl Default for Releases {
 	fn default() -> Self {
-		Releases::V2_0_0
+		Releases::V3_0_0


I'm not sure what to think about this default, because if we add staking in a running chain (so without executing GenesisConfig) then we must insert the storage version in the runtime upgrade.
I think a staking module without any storage version must be considered invalid now.

otherwise if a chain introduce staking module without inserting the storage version then the storage version depends on when it has been inserted, and storage version could be V2 or V3 there is no way to know it.

gui1117 · 2020-03-25T12:14:55Z

What is your plan with this @thiolliere ?

OK as the strategy for now is only to support Kusama I updated the runtime_upgrade code.
And merged master.

The PR is now ready for review

frame/timestamp/src/lib.rs

bkchr · 2020-03-26T08:38:30Z

Please merge master.

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

kianenigma · 2020-03-26T11:24:51Z

Needed a polkadot companion PR :(

gui1117 · 2020-03-26T11:57:24Z

sorry done here paritytech/polkadot#941

gui1117 requested a review from kianenigma as a code owner January 17, 2020 13:28

gui1117 added the A0-please_review Pull request needs code review. label Jan 17, 2020

bkchr reviewed Jan 17, 2020

View reviewed changes

frame/support/src/traits.rs Outdated Show resolved Hide resolved

gui1117 added A4-gotissues and removed A0-please_review Pull request needs code review. labels Jan 20, 2020

gui1117 force-pushed the gui-time-doc branch from 8f973d2 to f6ed7f1 Compare February 3, 2020 09:29

bkchr suggested changes Feb 3, 2020

View reviewed changes

gui1117 added A3-in_progress Pull request is in progress. No review needed at this stage. and removed A4-gotissues labels Feb 3, 2020

paritytech-ci added the B2-breaksapi label Feb 4, 2020

gui1117 commented Feb 4, 2020

View reviewed changes

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

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

gui1117 added A0-please_review Pull request needs code review. B1-runtimenoteworthy and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Feb 4, 2020

gui1117 changed the title ~~Write documentation for Time trait~~ Make Staking pallet using a proper Time module. Feb 4, 2020

gui1117 added A3-in_progress Pull request is in progress. No review needed at this stage. and removed A0-please_review Pull request needs code review. labels Mar 6, 2020

add new trait, still migration to make

b00aab3

gui1117 force-pushed the gui-time-doc branch from 1e07876 to b00aab3 Compare March 6, 2020 14:44

gui1117 added A1-onice and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Mar 6, 2020

kianenigma reviewed Mar 9, 2020

View reviewed changes

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

kianenigma reviewed Mar 9, 2020

View reviewed changes

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

Apply suggestions from code review

92d0535

Co-Authored-By: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

fix test

0ae4f62

gui1117 added A0-please_review Pull request needs code review. and removed A1-onice labels Mar 9, 2020

bkchr reviewed Mar 9, 2020

View reviewed changes

no longer require DeprecatedTime

458fb77

gui1117 added A3-in_progress Pull request is in progress. No review needed at this stage. and removed A0-please_review Pull request needs code review. labels Mar 18, 2020

gui1117 added 5 commits March 25, 2020 11:52

Merge remote-tracking branch 'origin/master' into HEAD

62c8d18

add test

cdd3a72

fix version

6a0fcfd

upgrade only from kusama

41e288b

add test

596e043

gui1117 commented Mar 25, 2020

View reviewed changes

fix test

343ded0

gui1117 added A0-please_review Pull request needs code review. and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Mar 25, 2020

bkchr approved these changes Mar 26, 2020

View reviewed changes

frame/timestamp/src/lib.rs Outdated Show resolved Hide resolved

gui1117 and others added 2 commits March 26, 2020 10:18

Update frame/timestamp/src/lib.rs

0a2b8ab

Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>

Merge remote-tracking branch 'origin/master' into gui-time-doc

58dc268

bkchr merged commit 43c716b into master Mar 26, 2020

bkchr deleted the gui-time-doc branch March 26, 2020 10:04

aurexav mentioned this pull request Apr 10, 2020

Switch to UnixTime darwinia-network/darwinia-common#51

Closed

apopiak added the D1-runtime-migration label Jun 22, 2020

This was referenced Jun 22, 2020

Runtime migrations tracking issue hicommonwealth/edgeware-node#164

Closed

Improve Migration Support paritytech/polkadot-sdk#353

Open

Conversation

gui1117 commented Jan 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bkchr commented Feb 3, 2020

Uh oh!

gui1117 commented Feb 3, 2020

Uh oh!

bkchr Feb 3, 2020

Choose a reason for hiding this comment

Uh oh!

gui1117 Feb 3, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gnunicorn commented Feb 18, 2020

Uh oh!

Uh oh!

Uh oh!

kianenigma commented Mar 9, 2020

Uh oh!

bkchr commented Mar 9, 2020

Uh oh!

gui1117 commented Mar 9, 2020

Uh oh!

bkchr Mar 9, 2020

Choose a reason for hiding this comment

Uh oh!

gui1117 Mar 9, 2020

Choose a reason for hiding this comment

Uh oh!

bkchr commented Mar 24, 2020

Uh oh!

gui1117 Mar 25, 2020

Choose a reason for hiding this comment

Uh oh!

gui1117 commented Mar 25, 2020

Uh oh!

Uh oh!

bkchr commented Mar 26, 2020

Uh oh!

kianenigma commented Mar 26, 2020

Uh oh!

gui1117 commented Mar 26, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gui1117 commented Jan 17, 2020 •

edited

Loading