`tx-pause` and `safe-mode` pallets integration - Shibuya #1382

sylvaincormier · 2024-11-07T14:37:14Z

Date: Thu Nov 7 08:10:27 2024 -0500

Integrate SafeMode pallet into Shibuya runtime
- Added pallet_tx_pause to runtime configuration.
- Added `pallet_safe_mode` to runtime configuration.
- Updated genesis configuration to include `safe_mode`.
- Configured `SafeModeWhitelistedCalls` to define calls that bypass SafeMode restrictions.
- Added parameter types for SafeMode configuration, including enter and extend durations, deposit amounts, and release delay.
- Updated `construct_runtime!` macro to include SafeMode pallet at index

Pull Request Summary

Check list

added or updated unit tests
updated Astar official documentation
added OnRuntimeUpgrade hook for precompile revert code registration
added benchmarks & weights for any modified runtime logics.

Date: Thu Nov 7 08:10:27 2024 -0500 Integrate SafeMode pallet into Shibuya runtime - Added pallet_tx_pause to runtime configuration. - Added `pallet_safe_mode` to runtime configuration. - Updated genesis configuration to include `safe_mode`. - Configured `SafeModeWhitelistedCalls` to define calls that bypass SafeMode restrictions. - Added parameter types for SafeMode configuration, including enter and extend durations, deposit amounts, and release delay. - Updated `construct_runtime!` macro to include SafeMode pallet at index

ipapandinas

This first version is promising—good job! I've left comments on the config parameters and the master branch rebase.

Additionally, from my analysis of these pallets, it appears you forgot to extend the BaseCallFilter type in the frame_system config to include whitelisted calls. You can define a new type alias, SafeModeTxPauseFilter, and use it as follows:

type SafeModeTxPauseFilter = InsideBoth<SafeModeWhitelistedCalls, TxPauseWhitelistedCalls>;

type BaseCallFilter = InsideBoth<BaseFilter, SafeModeTxPauseFilter>;

ipapandinas · 2024-11-07T14:50:26Z

bin/collator/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "astar-collator"
-version = "5.45.0"
+version = "5.44.0"


make sure to have the latest master branch rebased, otherwise it reverts existing work

ipapandinas · 2024-11-07T14:55:01Z

runtime/shibuya/Cargo.toml

@@ -153,6 +154,8 @@ substrate-wasm-builder = { workspace = true, optional = true }
 [features]
 default = ["std"]
 std = [
+	"pallet-tx-pause/std",


You can add them to runtime-benchmarks & try-runtime features below too

ipapandinas · 2024-11-07T15:00:15Z

runtime/shibuya/src/lib.rs

@@ -1522,7 +1526,13 @@ parameter_types! {
 impl pallet_migrations::Config for Runtime {
    type RuntimeEvent = RuntimeEvent;
    #[cfg(not(feature = "runtime-benchmarks"))]
-    type Migrations = ();
+    type Migrations = (


Those migrations have already been executed on Shibuya, and will be deleted once you have rebased the master branch

ipapandinas · 2024-11-07T15:00:49Z

runtime/shibuya/src/lib.rs

@@ -1655,7 +1667,7 @@ pub type Executive = frame_executive::Executive<
 pub type Migrations = (Unreleased, Permanent);

 /// Unreleased migrations. Add new ones here:
-pub type Unreleased = ();
+pub type Unreleased = (cumulus_pallet_xcmp_queue::migration::v5::MigrateV4ToV5<Runtime>,);


same here, it has already been applied

ipapandinas · 2024-11-07T15:19:42Z

runtime/shibuya/src/lib.rs

@@ -1608,6 +1618,8 @@ construct_runtime!(
        CollectiveProxy: pallet_collective_proxy = 109,

        MultiBlockMigrations: pallet_migrations = 120,
+        TxPause: pallet_tx_pause = 200,


A small gap is ok, we can go with SafeMode first:

SafeMode: pallet_safe_mode = 130, TxPause: pallet_tx_pause = 131,

ipapandinas · 2024-11-07T15:32:00Z

runtime/shibuya/src/lib.rs

+    type PauseOrigin = EnsureRoot<AccountId>; // Authority required to pause transactions.
+    type UnpauseOrigin = EnsureRoot<AccountId>; // Authority required to unpause transactions.
+    type WhitelistedCalls = ();
+    type MaxNameLen = ConstU32<32>; // Maximum length of name, adjust as needed.


"256" is probably better here: type MaxNameLen = ConstU32<256>

ipapandinas · 2024-11-07T15:35:02Z

runtime/shibuya/src/lib.rs

+    type RuntimeEvent = RuntimeEvent;
+    type PauseOrigin = EnsureRoot<AccountId>; // Authority required to pause transactions.
+    type UnpauseOrigin = EnsureRoot<AccountId>; // Authority required to unpause transactions.
+    type WhitelistedCalls = ();


In the similar way you did for the pallet_safe_mode, can you create a TxPauseWhitelistedCalls type?

An example (but you can check if other pallets can be whitelisted):

/// Calls that can bypass the tx-pause pallet. /// We always allow system calls and timestamp since it is required for block production pub struct TxPauseWhitelistedCalls; impl Contains<pallet_tx_pause::RuntimeCallNameOf<Runtime>> for TxPauseWhitelistedCalls { fn contains(full_name: &pallet_tx_pause::RuntimeCallNameOf<Runtime>) -> bool { matches!(full_name.0.as_slice(), b"Sudo" | b"System" | b"Timestamp" | b"TxPause") } }

ipapandinas · 2024-11-07T15:37:01Z

runtime/shiden/src/lib.rs

@@ -1194,7 +1194,13 @@ parameter_types! {
 impl pallet_migrations::Config for Runtime {
    type RuntimeEvent = RuntimeEvent;
    #[cfg(not(feature = "runtime-benchmarks"))]
-    type Migrations = ();
+    type Migrations = (


Same as above

ipapandinas · 2024-11-07T15:37:09Z

runtime/shiden/src/lib.rs

@@ -1333,7 +1339,11 @@ parameter_types! {
 pub type Migrations = (Unreleased, Permanent);

 /// Unreleased migrations. Add new ones here:
-pub type Unreleased = ();
+pub type Unreleased = (


Same as above

ipapandinas · 2024-11-07T15:41:24Z

runtime/shibuya/src/lib.rs

+impl Contains<RuntimeCall> for SafeModeWhitelistedCalls {
+    fn contains(call: &RuntimeCall) -> bool {
+        match call {
+            RuntimeCall::System(_) | RuntimeCall::SafeMode(_) | RuntimeCall::TxPause(_) => true,


You can add Sudo too

- Added `SafeModeTxPauseFilter` combining SafeMode and TxPause whitelisted calls. - Updated `BaseCallFilter` to include the combined filter for comprehensive runtime restrictions. - Reordered pallet indices in `construct_runtime!` for SafeMode and TxPause (SafeMode now precedes TxPause). - Implemented `TxPauseWhitelistedCalls` to allow specific calls to bypass TxPause restrictions (e.g., Sudo, System, Timestamp). - Updated `SafeModeWhitelistedCalls` to include `Sudo`. - Extended `MaxNameLen` from 32 to 256 in TxPause configuration. Addresses comments on runtime configurations and ensures correct integration of SafeMode and TxPause functionalities.

sylvaincormier · 2024-11-08T13:49:53Z

@ipapandinas, thank you for taking the time to provide such thorough feedback and detailed examples! I've addressed all the points you raised:

Updated BaseCallFilter to incorporate both SafeModeWhitelistedCalls and TxPauseWhitelistedCalls.
Created TxPauseWhitelistedCalls to ensure critical calls like Sudo, System, Timestamp, and TxPause are whitelisted.
Extended SafeModeWhitelistedCalls to include Sudo.
Reordered the SafeMode and TxPause pallets as suggested.
Increased MaxNameLen to 256.

I also rebased onto the latest master as you recommended. Let me know if there's anything else you need me to adjust. I appreciate your guidance throughout this process!

…igration setup - Added `pallet-tx-pause` and `pallet-safe-mode` to runtime-benchmarks and try-runtime features in `Cargo.toml`. - Imported `EnsureWithSuccess` and `EitherOfDiverse` to enhance the configuration of emergency authorities. - Removed outdated lazy migrations for `pallet_dapp_staking` and `vesting_mbm` as they have already been executed. - Cleared `Unreleased` and `Permanent` migrations, indicating their completion. - Introduced `TxPauseWhitelistedCalls` struct for better granularity in whitelisted calls during transaction pause operations.

ipapandinas · 2024-11-12T14:27:49Z

@sylvaincormier Thank you for your work on this contribution! For now, we’ll close this pull request, but we appreciate your effort and may revisit these ideas in the future. Thanks again for your understanding!

sylvaincormier · 2024-11-13T11:08:12Z

Hi Ipapandinas.
I was not done!
I just finished this:
Author: Silvereau [email protected]
Date: Wed Nov 13 06:02:18 2024 -0500

feat(runtime): add EmergencyAuthority origin types

Define origin types for emergency operations:
- MoreThanHalfCouncil for council majority actions
- EmergencyAuthority combining council and technical committee control
- EmergencyAuthorityWithSuccess for time-sensitive operations

These types enable proper governance control over emergency features.

ipapandinas requested changes Nov 7, 2024

View reviewed changes

ipapandinas added shibuya related to shibuya runtime This PR/Issue is related to the topic “runtime”. labels Nov 7, 2024

ipapandinas linked an issue Nov 7, 2024 that may be closed by this pull request

Integrate tx-pause and safe-mode pallets #1364

Closed

5 tasks

ipapandinas changed the title ~~1364-integrate-tx-pause-safe-mode~~ tx-pause and safe-mode pallets integration - Shibuya Nov 7, 2024

ipapandinas closed this Nov 12, 2024

ipapandinas removed a link to an issue Nov 12, 2024

Integrate tx-pause and safe-mode pallets #1364

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`tx-pause` and `safe-mode` pallets integration - Shibuya #1382

`tx-pause` and `safe-mode` pallets integration - Shibuya #1382

sylvaincormier commented Nov 7, 2024 •

edited

Loading

ipapandinas left a comment

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

ipapandinas Nov 7, 2024

sylvaincormier commented Nov 8, 2024

ipapandinas commented Nov 12, 2024

sylvaincormier commented Nov 13, 2024 •

edited

Loading

tx-pause and safe-mode pallets integration - Shibuya #1382

tx-pause and safe-mode pallets integration - Shibuya #1382

Conversation

sylvaincormier commented Nov 7, 2024 • edited Loading

ipapandinas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sylvaincormier commented Nov 8, 2024

ipapandinas commented Nov 12, 2024

sylvaincormier commented Nov 13, 2024 • edited Loading

`tx-pause` and `safe-mode` pallets integration - Shibuya #1382

`tx-pause` and `safe-mode` pallets integration - Shibuya #1382

sylvaincormier commented Nov 7, 2024 •

edited

Loading

sylvaincormier commented Nov 13, 2024 •

edited

Loading