1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
// This file is part of Astar.

// Copyright (C) Stake Technologies Pte.Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later

// Astar 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.

// Astar 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 Astar. If not, see <http://www.gnu.org/licenses/>.

use super::*;
use frame_support::{
    pallet_prelude::*,
    traits::{Get, UncheckedOnRuntimeUpgrade},
};
use sp_std::{marker::PhantomData, vec::Vec};

/// Exports for versioned migration `type`s for this pallet.
pub mod versioned {
    use super::*;

    /// Migration storage V3 to V4 wrapped in a [`frame_support::migrations::VersionedMigration`], ensuring
    /// the migration is only performed when on-chain version is 3.
    pub type V3ToV4<T> = frame_support::migrations::VersionedMigration<
        3,
        4,
        unchecked_migration::UncheckedMigrationXcmVersion<{ xcm::v5::VERSION }, T>,
        Pallet<T>,
        <T as frame_system::Config>::DbWeight,
    >;

    /// Migration storage V4 to V5 which removes `AssetHubMigrationStep`.
    pub type V4ToV5<T> = frame_support::migrations::VersionedMigration<
        4,
        5,
        unchecked_migration::UncheckedMigrationRemoveAssetHubStep<T>,
        Pallet<T>,
        <T as frame_system::Config>::DbWeight,
    >;
}

mod unchecked_migration {
    use super::*;
    use xcm::IntoVersion;

    /// Migration for XCM versioned locations, generic over XCM version.
    pub struct UncheckedMigrationXcmVersion<const XCM_VERSION: u32, T: Config>(PhantomData<T>);
    impl<const XCM_VERSION: u32, T: Config> UncheckedOnRuntimeUpgrade
        for UncheckedMigrationXcmVersion<XCM_VERSION, T>
    {
        fn on_runtime_upgrade() -> Weight {
            let mut consumed_weight = Weight::zero();

            // 1st map
            AssetIdToLocation::<T>::translate::<xcm::VersionedLocation, _>(
                |asset_id, multi_location| {
                    consumed_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));

                    multi_location
                        .into_version(XCM_VERSION)
                        .map_err(|_| {
                            log::error!(
                            "Failed to convert AssetIdToLocation value for asset Id: {asset_id:?}",
                        );
                        })
                        .ok()
                },
            );

            // 2nd map
            let location_to_id_entries: Vec<_> = AssetLocationToId::<T>::drain().collect();
            for (multi_location, asset_id) in location_to_id_entries {
                consumed_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));

                if let Ok(new_location) = multi_location.into_version(XCM_VERSION) {
                    AssetLocationToId::<T>::insert(new_location, asset_id);
                } else {
                    log::error!(
                        "Failed to convert AssetLocationToId value for asset Id: {asset_id:?}",
                    );
                }
            }

            // 3rd map
            let location_to_price_entries: Vec<_> =
                AssetLocationUnitsPerSecond::<T>::drain().collect();
            for (multi_location, price) in location_to_price_entries {
                consumed_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));

                if let Ok(new_location) = multi_location.into_version(XCM_VERSION) {
                    AssetLocationUnitsPerSecond::<T>::insert(new_location, price);
                } else {
                    log::error!("Failed to convert AssetLocationUnitsPerSecond value failed!");
                }
            }

            consumed_weight
        }

        #[cfg(feature = "try-runtime")]
        fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
            let mut count = AssetIdToLocation::<T>::iter().collect::<Vec<_>>().len();
            count += AssetLocationToId::<T>::iter().collect::<Vec<_>>().len();
            count += AssetLocationUnitsPerSecond::<T>::iter()
                .collect::<Vec<_>>()
                .len();

            Ok((count as u32).encode())
        }

        #[cfg(feature = "try-runtime")]
        fn post_upgrade(state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
            let old_count: u32 = Decode::decode(&mut state.as_ref())
                .map_err(|_| "Cannot decode data from pre_upgrade")?;

            let mut count = AssetIdToLocation::<T>::iter().collect::<Vec<_>>().len();
            count += AssetLocationToId::<T>::iter().collect::<Vec<_>>().len();
            count += AssetLocationUnitsPerSecond::<T>::iter()
                .collect::<Vec<_>>()
                .len();

            assert_eq!(old_count, count as u32);
            Ok(())
        }
    }

    /// Migration that clears the old `AssetHubMigrationStep` storage key.
    pub struct UncheckedMigrationRemoveAssetHubStep<T: Config>(PhantomData<T>);
    impl<T: Config> UncheckedOnRuntimeUpgrade for UncheckedMigrationRemoveAssetHubStep<T> {
        fn on_runtime_upgrade() -> Weight {
            use sp_core::hexdisplay::HexDisplay;

            let key = frame_support::storage::storage_prefix(
                <Pallet<T>>::name().as_bytes(),
                b"AssetHubMigrationStep",
            );
            frame_support::storage::unhashed::kill(&key);

            log::info!(
                "Deleted AssetHubMigrationStep key: 0x{}",
                HexDisplay::from(&key)
            );

            T::DbWeight::get().writes(1)
        }

        #[cfg(feature = "try-runtime")]
        fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::DispatchError> {
            let key = frame_support::storage::storage_prefix(
                <Pallet<T>>::name().as_bytes(),
                b"AssetHubMigrationStep",
            );

            Ok(key.to_vec())
        }

        #[cfg(feature = "try-runtime")]
        fn post_upgrade(state: Vec<u8>) -> Result<(), sp_runtime::DispatchError> {
            use sp_io::storage::exists;

            let key = state;

            // Ensure the value was deleted.
            assert!(
                !exists(&key),
                "AssetHubMigrationStep should be removed after migration"
            );

            Ok(())
        }
    }
}