pallet-migrations Initial Implementation

pallets/migrations/src/lib.rs

@@ -14,11 +14,12 @@
 // You should have received a copy of the GNU General Public License
 // along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
 
-//! # Migrations
+//! # Migration Pallet
 
 #![cfg_attr(not(feature = "std"), no_std)]
 
 use frame_support::pallet;
+pub mod migrations;
 
 #[pallet]
 pub mod pallet {
@@ -31,13 +32,19 @@ pub mod pallet {
 
 	#[derive(Copy, Clone, PartialEq, Eq, Encode, Decode, RuntimeDebug)]
 	/// A Migration that must happen on-chain upon a runtime-upgrade
-	pub struct Migration {
+	pub trait Migration {
 		// TODO: this would involve some metadata about the migration as well as a means of calling
 		// the actual migration function
+
+		fn friendly_name() -> str;
 	}
 
 	/// Our list of migrations. Any ordering considerations can be specified here (?).
-	// const MIGRATIONS: // TODO: this would be a constant vec (or similar) of individual migrations
+	static MIGRATIONS: [Migration] = [
+		MM_001_AuthorMappingAddDeposit,
+		MM_002_StakingFixTotalBalance,
+		MM_003_StakingTransitionBoundedSet,
+	];
 
 	/// Configuration trait of this pallet.
 	#[pallet::config]

pallets/migrations/src/migrations.rs

@@ -0,0 +1,43 @@
+// Copyright 2019-2020 PureStake Inc.
+// This file is part of Moonbeam.
+
+// Moonbeam is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Moonbeam is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
+
+//! # Migrations
+
+use crate::*;
+
+/// This module acts as a registry where each migration is defined. Each migration should implement
+/// the "Migration" trait declared in this crate.
+
+struct MM_001_AuthorMappingAddDeposit;
+impl Migration for MM_001_AuthorMappingAddDeposit {
+	fn friendly_name() -> str {
+		"AuthorMappingAddDeposit"
+	}
+}
+
+struct MM_002_StakingFixTotalBalance;
+impl Migration for StakingFixTotalBalance {
+	fn friendly_name() -> str {
+		"StakingFixTotalBalance"
+	}
+}
+
+struct MM_003_StakingTransitionBoundedSet; // TODO: better name
+impl Migration for MM_003_StakingTransitionBoundedSet {
+	fn friendly_name() -> str {
+		"StakingTransitionBoundedSet"
+	}
+}