Add migration SetRetentionPeriodIfZero to ensure RetentionPeriod is non-zero for live solochain

Author: bkontur

pallets/transaction-storage/src/lib.rs

@@ -27,6 +27,7 @@
 mod benchmarking;
 pub mod weights;
 
+pub mod migrations;
 #[cfg(test)]
 mod mock;
 #[cfg(test)]
@@ -37,7 +38,10 @@ use core::fmt::Debug;
 use polkadot_sdk_frame::{
 	deps::{sp_core::sp_std::prelude::*, *},
 	prelude::*,
-	traits::fungible::{Balanced, Credit, Inspect, Mutate, MutateHold},
+	traits::{
+		fungible::{Balanced, Credit, Inspect, Mutate, MutateHold},
+		parameter_types,
+	},
 };
 use sp_transaction_storage_proof::{
 	encode_index, num_chunks, random_chunk, ChunkIndex, InherentError, TransactionStorageProof,
@@ -57,6 +61,9 @@ const LOG_TARGET: &str = "runtime::transaction-storage";
 
 /// Default retention period for data (in blocks).
 pub const DEFAULT_RETENTION_PERIOD: u32 = 100800;
+parameter_types! {
+	pub const DefaultRetentionPeriod: u32 = DEFAULT_RETENTION_PERIOD;
+}
 
 // TODO: https://github.com/paritytech/polkadot-bulletin-chain/issues/139 - Clarify purpose of allocator limits and decide whether to remove or use these constants.
 /// Maximum bytes that can be stored in one transaction.

pallets/transaction-storage/src/migrations.rs

@@ -0,0 +1,48 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use crate::{Config, RetentionPeriod, LOG_TARGET};
+use core::marker::PhantomData;
+use polkadot_sdk_frame::{
+	prelude::{BlockNumberFor, Weight},
+	traits::{Get, OnRuntimeUpgrade, Zero},
+};
+
+/// Runtime migration that sets the `RetentionPeriod` storage item to a
+/// non-zero `NewValue` value **only if it is currently zero**.
+///
+/// Idempotent migration: safe to run multiple times
+pub struct SetRetentionPeriodIfZero<T, NewValue>(PhantomData<(T, NewValue)>);
+impl<T: Config, NewValue: Get<BlockNumberFor<T>>> OnRuntimeUpgrade
+	for SetRetentionPeriodIfZero<T, NewValue>
+{
+	fn on_runtime_upgrade() -> Weight {
+		let mut weight = T::DbWeight::get().reads(1);
+
+		// If zero, let's reset.
+		if RetentionPeriod::<T>::get().is_zero() {
+			RetentionPeriod::<T>::set(NewValue::get());
+			weight.saturating_accrue(T::DbWeight::get().writes(1));
+
+			tracing::warn!(
+				target: LOG_TARGET,
+				"[SetRetentionPeriodIfZero] RetentionPeriod was zero; set to {:?}",
+				NewValue::get()
+			);
+		}
+
+		weight
+	}
+}

runtime/src/lib.rs

@@ -647,7 +647,12 @@ pub mod migrations {
 	pub type Unreleased = ();
 
 	/// Migrations/checks that do not need to be versioned and can run on every update.
-	pub type Permanent = ();
+	pub type Permanent = (
+		pallet_transaction_storage::migrations::SetRetentionPeriodIfZero<
+			crate::Runtime,
+			pallet_transaction_storage::DefaultRetentionPeriod,
+		>,
+	);
 
 	/// All single block migrations that will run on the next runtime upgrade.
 	pub type SingleBlockMigrations = (Unreleased, Permanent);

runtimes/bulletin-polkadot/src/lib.rs

@@ -724,7 +724,12 @@ pub mod migrations {
 	pub type Unreleased = ();
 
 	/// Migrations/checks that do not need to be versioned and can run on every update.
-	pub type Permanent = ();
+	pub type Permanent = (
+		pallet_transaction_storage::migrations::SetRetentionPeriodIfZero<
+			crate::Runtime,
+			pallet_transaction_storage::DefaultRetentionPeriod,
+		>,
+	);
 
 	/// All single block migrations that will run on the next runtime upgrade.
 	pub type SingleBlockMigrations = (Unreleased, Permanent);

runtimes/bulletin-westend/src/lib.rs

@@ -140,7 +140,13 @@ pub mod migrations {
 	);
 
 	/// Migrations/checks that do not need to be versioned and can run on every update.
-	pub type Permanent = (pallet_xcm::migration::MigrateToLatestXcmVersion<Runtime>,);
+	pub type Permanent = (
+		pallet_xcm::migration::MigrateToLatestXcmVersion<Runtime>,
+		pallet_transaction_storage::migrations::SetRetentionPeriodIfZero<
+			Runtime,
+			pallet_transaction_storage::DefaultRetentionPeriod,
+		>,
+	);
 
 	/// All single block migrations that will run on the next runtime upgrade.
 	pub type SingleBlockMigrations = (Unreleased, Permanent);