migration: Add LP Gateway migration for outbound messages #1946
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| use cfg_types::domain_address::Domain; | ||
| use frame_support::{ | ||
| pallet_prelude::ValueQuery, | ||
| storage::{child::MultiRemovalResults, generator::StorageValue, unhashed}, | ||
| storage_alias, | ||
| traits::{Get, OnRuntimeUpgrade}, | ||
| Blake2_128Concat, StorageMap, | ||
| }; | ||
| use pallet_liquidity_pools_gateway::{pallet::Pallet as LPGateway, Config}; | ||
| use pallet_order_book::weights::Weight; | ||
| use sp_runtime::{DispatchError, TryRuntimeError}; | ||
| use sp_std::vec::Vec; | ||
|
|
||
| #[storage_alias] | ||
| pub type OutboundMessageNonceStore<T: Config> = | ||
| StorageValue<pallet_liquidity_pools_gateway::Pallet<T>, u64, ValueQuery>; | ||
|
|
||
| #[storage_alias] | ||
| pub type OutboundMessageQueue<T: Config + frame_system::Config> = StorageMap< | ||
| pallet_liquidity_pools_gateway::Pallet<T>, | ||
| Blake2_128Concat, | ||
| u64, | ||
| ( | ||
| Domain, | ||
| <T as frame_system::Config>::AccountId, | ||
| pallet_liquidity_pools::Message, | ||
| ), | ||
| >; | ||
|
|
||
| #[storage_alias] | ||
| pub type FailedOutboundMessages<T: Config + frame_system::Config> = StorageMap< | ||
| pallet_liquidity_pools_gateway::Pallet<T>, | ||
| Blake2_128Concat, | ||
| u64, | ||
| ( | ||
| Domain, | ||
| <T as frame_system::Config>::AccountId, | ||
| pallet_liquidity_pools::Message, | ||
| DispatchError, | ||
| ), | ||
| >; | ||
|
|
||
| pub struct Migration<T>(sp_std::marker::PhantomData<T>); | ||
|
|
||
| impl<T> OnRuntimeUpgrade for Migration<T> | ||
| where | ||
| T: Config + frame_system::Config, | ||
| { | ||
| fn on_runtime_upgrade() -> Weight { | ||
| let mut weight = Self::clear_storage( | ||
| OutboundMessageNonceStore::<T>::storage_prefix(), | ||
| "OutboundMessageNonceStore", | ||
| ); | ||
|
There was a problem hiding this comment. An alternative, and my preference, would be just utilizing |
||
|
|
||
| for (nonce, entry) in OutboundMessageQueue::<T>::iter() { | ||
| log::warn!("Found outbound message:\nnonce:{nonce}\nentry:{entry:?}"); | ||
| weight = weight.saturating_add(<T as frame_system::Config>::DbWeight::get().reads(1)); | ||
| } | ||
|
|
||
| for (nonce, entry) in FailedOutboundMessages::<T>::iter() { | ||
| log::warn!("Found failed outbound message:\nnonce:{nonce}\nentry:{entry:?}"); | ||
| weight = weight.saturating_add(<T as frame_system::Config>::DbWeight::get().reads(1)); | ||
| } | ||
|
|
||
| weight | ||
| } | ||
|
|
||
| #[cfg(feature = "try-runtime")] | ||
| fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError> { | ||
| // Extra check to confirm that the storage alias is correct. | ||
| assert!( | ||
| OutboundMessageNonceStore::<T>::get() > 0, | ||
| "OutboundMessageNonce should be > 0" | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| OutboundMessageQueue::<T>::iter_keys().count(), | ||
| 0, | ||
| "OutboundMessageQueue should be empty!" | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| FailedOutboundMessages::<T>::iter_keys().count(), | ||
| 0, | ||
| "FailedOutboundMessages should be empty!" | ||
| ); | ||
|
|
||
| Ok(Vec::new()) | ||
| } | ||
|
|
||
| #[cfg(feature = "try-runtime")] | ||
| fn post_upgrade(_: Vec<u8>) -> Result<(), TryRuntimeError> { | ||
| assert_eq!( | ||
|
There was a problem hiding this comment. @lemunozm this is the assert that fails when running Not sure where that panic comes from tho, that's a different story. There was a problem hiding this comment. What's the error it tells you? There was a problem hiding this comment. Yes, with the latest version that's what I get in the There was a problem hiding this comment. Mmm.. I think the assert should pass IIUC this 🤔 There was a problem hiding this comment. The previous message was failing correctly because "there is" entry if you read. But if you check the value it should be the default one, 0 |
||
| OutboundMessageNonceStore::<T>::get(), | ||
| 0, | ||
| "OutboundMessageNonceStore should be 0!" | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| OutboundMessageQueue::<T>::iter_keys().count(), | ||
| 0, | ||
| "OutboundMessageQueue should be empty!" | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| FailedOutboundMessages::<T>::iter_keys().count(), | ||
| 0, | ||
| "FailedOutboundMessages should be empty!" | ||
| ); | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| impl<T: Config + frame_system::Config> Migration<T> { | ||
| fn clear_storage(prefix: &[u8], storage_name: &str) -> Weight { | ||
| let res = unhashed::clear_prefix(prefix, None, None); | ||
|
|
||
| match res.maybe_cursor { | ||
| None => log::info!("{storage_name} was cleared"), | ||
| Some(_) => log::error!("{storage_name} was not completely cleared"), | ||
| }; | ||
|
|
||
| <T as frame_system::Config>::DbWeight::get() | ||
| .reads_writes(res.loops.into(), res.unique.into()) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This only represents the
b"OutboundMessageNonceStore"but is missing the pallet prefix. The solution is to always use the final storage key for clearing.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I thought the
storage_aliastakes care of that.