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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
// This file is part of Substrate. // Copyright (C) 2017-2020 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. //! Stuff to do with the runtime's storage. use sp_std::prelude::*; use codec::{FullCodec, FullEncode, Encode, EncodeLike, Decode}; use crate::hash::{Twox128, StorageHasher}; use sp_runtime::generic::{Digest, DigestItem}; pub use sp_runtime::TransactionOutcome; pub mod unhashed; pub mod hashed; pub mod child; #[doc(hidden)] pub mod generator; pub mod migration; /// Execute the supplied function in a new storage transaction. /// /// All changes to storage performed by the supplied function are discarded if the returned /// outcome is `TransactionOutcome::Rollback`. /// /// Transactions can be nested to any depth. Commits happen to the parent transaction. pub fn with_transaction<R>(f: impl FnOnce() -> TransactionOutcome<R>) -> R { use sp_io::storage::{ start_transaction, commit_transaction, rollback_transaction, }; use TransactionOutcome::*; start_transaction(); match f() { Commit(res) => { commit_transaction(); res }, Rollback(res) => { rollback_transaction(); res }, } } /// A trait for working with macro-generated storage values under the substrate storage API. /// /// Details on implementation can be found at /// [`generator::StorageValue`] pub trait StorageValue<T: FullCodec> { /// The type that get/take return. type Query; /// Get the storage key. fn hashed_key() -> [u8; 32]; /// Does the value (explicitly) exist in storage? fn exists() -> bool; /// Load the value from the provided storage instance. fn get() -> Self::Query; /// Try to get the underlying value from the provided storage instance; `Ok` if it exists, /// `Err` if not. fn try_get() -> Result<T, ()>; /// Translate a value from some previous type (`O`) to the current type. /// /// `f: F` is the translation function. /// /// Returns `Err` if the storage item could not be interpreted as the old type, and Ok, along /// with the new value if it could. /// /// NOTE: This operates from and to `Option<_>` types; no effort is made to respect the default /// value of the original type. /// /// # Warning /// /// This function must be used with care, before being updated the storage still contains the /// old type, thus other calls (such as `get`) will fail at decoding it. /// /// # Usage /// /// This would typically be called inside the module implementation of on_runtime_upgrade, while /// ensuring **no usage of this storage are made before the call to `on_runtime_upgrade`**. (More /// precisely prior initialized modules doesn't make use of this storage). fn translate<O: Decode, F: FnOnce(Option<O>) -> Option<T>>(f: F) -> Result<Option<T>, ()>; /// Store a value under this key into the provided storage instance. fn put<Arg: EncodeLike<T>>(val: Arg); /// Store a value under this key into the provided storage instance; this uses the query /// type rather than the underlying value. fn set(val: Self::Query); /// Mutate the value fn mutate<R, F: FnOnce(&mut Self::Query) -> R>(f: F) -> R; /// Mutate the value if closure returns `Ok` fn try_mutate<R, E, F: FnOnce(&mut Self::Query) -> Result<R, E>>(f: F) -> Result<R, E>; /// Clear the storage value. fn kill(); /// Take a value from storage, removing it afterwards. fn take() -> Self::Query; /// Append the given item to the value in the storage. /// /// `T` is required to implement [`StorageAppend`]. /// /// # Warning /// /// If the storage item is not encoded properly, the storage item will be overwritten /// and set to `[item]`. Any default value set for the storage item will be ignored /// on overwrite. fn append<Item, EncodeLikeItem>(item: EncodeLikeItem) where Item: Encode, EncodeLikeItem: EncodeLike<Item>, T: StorageAppend<Item>; /// Read the length of the storage value without decoding the entire value. /// /// `T` is required to implement [`StorageDecodeLength`]. /// /// If the value does not exists or it fails to decode the length, `None` is returned. /// Otherwise `Some(len)` is returned. /// /// # Warning /// /// `None` does not mean that `get()` does not return a value. The default value is completly /// ignored by this function. fn decode_len() -> Option<usize> where T: StorageDecodeLength { T::decode_len(&Self::hashed_key()) } } /// A strongly-typed map in storage. /// /// Details on implementation can be found at /// [`generator::StorageMap`] pub trait StorageMap<K: FullEncode, V: FullCodec> { /// The type that get/take return. type Query; /// Get the storage key used to fetch a value corresponding to a specific key. fn hashed_key_for<KeyArg: EncodeLike<K>>(key: KeyArg) -> Vec<u8>; /// Does the value (explicitly) exist in storage? fn contains_key<KeyArg: EncodeLike<K>>(key: KeyArg) -> bool; /// Load the value associated with the given key from the map. fn get<KeyArg: EncodeLike<K>>(key: KeyArg) -> Self::Query; /// Swap the values of two keys. fn swap<KeyArg1: EncodeLike<K>, KeyArg2: EncodeLike<K>>(key1: KeyArg1, key2: KeyArg2); /// Store a value to be associated with the given key from the map. fn insert<KeyArg: EncodeLike<K>, ValArg: EncodeLike<V>>(key: KeyArg, val: ValArg); /// Remove the value under a key. fn remove<KeyArg: EncodeLike<K>>(key: KeyArg); /// Mutate the value under a key. fn mutate<KeyArg: EncodeLike<K>, R, F: FnOnce(&mut Self::Query) -> R>(key: KeyArg, f: F) -> R; /// Mutate the item, only if an `Ok` value is returned. fn try_mutate<KeyArg: EncodeLike<K>, R, E, F: FnOnce(&mut Self::Query) -> Result<R, E>>( key: KeyArg, f: F, ) -> Result<R, E>; /// Mutate the value under a key. Deletes the item if mutated to a `None`. fn mutate_exists<KeyArg: EncodeLike<K>, R, F: FnOnce(&mut Option<V>) -> R>(key: KeyArg, f: F) -> R; /// Mutate the item, only if an `Ok` value is returned. Deletes the item if mutated to a `None`. fn try_mutate_exists<KeyArg: EncodeLike<K>, R, E, F: FnOnce(&mut Option<V>) -> Result<R, E>>( key: KeyArg, f: F, ) -> Result<R, E>; /// Take the value under a key. fn take<KeyArg: EncodeLike<K>>(key: KeyArg) -> Self::Query; /// Append the given items to the value in the storage. /// /// `V` is required to implement `codec::EncodeAppend`. /// /// # Warning /// /// If the storage item is not encoded properly, the storage will be overwritten /// and set to `[item]`. Any default value set for the storage item will be ignored /// on overwrite. fn append<Item, EncodeLikeItem, EncodeLikeKey>(key: EncodeLikeKey, item: EncodeLikeItem) where EncodeLikeKey: EncodeLike<K>, Item: Encode, EncodeLikeItem: EncodeLike<Item>, V: StorageAppend<Item>; /// Read the length of the storage value without decoding the entire value under the /// given `key`. /// /// `V` is required to implement [`StorageDecodeLength`]. /// /// If the value does not exists or it fails to decode the length, `None` is returned. /// Otherwise `Some(len)` is returned. /// /// # Warning /// /// `None` does not mean that `get()` does not return a value. The default value is completly /// ignored by this function. fn decode_len<KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<usize> where V: StorageDecodeLength, { V::decode_len(&Self::hashed_key_for(key)) } /// Migrate an item with the given `key` from a defunct `OldHasher` to the current hasher. /// /// If the key doesn't exist, then it's a no-op. If it does, then it returns its value. fn migrate_key<OldHasher: StorageHasher, KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<V>; /// Migrate an item with the given `key` from a `blake2_256` hasher to the current hasher. /// /// If the key doesn't exist, then it's a no-op. If it does, then it returns its value. fn migrate_key_from_blake<KeyArg: EncodeLike<K>>(key: KeyArg) -> Option<V> { Self::migrate_key::<crate::hash::Blake2_256, KeyArg>(key) } } /// A strongly-typed map in storage whose keys and values can be iterated over. pub trait IterableStorageMap<K: FullEncode, V: FullCodec>: StorageMap<K, V> { /// The type that iterates over all `(key, value)`. type Iterator: Iterator<Item = (K, V)>; /// Enumerate all elements in the map in no particular order. If you alter the map while doing /// this, you'll get undefined results. fn iter() -> Self::Iterator; /// Remove all elements from the map and iterate through them in no particular order. If you /// add elements to the map while doing this, you'll get undefined results. fn drain() -> Self::Iterator; /// Translate the values of all elements by a function `f`, in the map in no particular order. /// By returning `None` from `f` for an element, you'll remove it from the map. /// /// NOTE: If a value fail to decode because storage is corrupted then it is skipped. fn translate<O: Decode, F: Fn(K, O) -> Option<V>>(f: F); } /// A strongly-typed double map in storage whose secondary keys and values can be iterated over. pub trait IterableStorageDoubleMap< K1: FullCodec, K2: FullCodec, V: FullCodec >: StorageDoubleMap<K1, K2, V> { /// The type that iterates over all `(key2, value)`. type PrefixIterator: Iterator<Item = (K2, V)>; /// The type that iterates over all `(key1, key2, value)`. type Iterator: Iterator<Item = (K1, K2, V)>; /// Enumerate all elements in the map with first key `k1` in no particular order. If you add or /// remove values whose first key is `k1` to the map while doing this, you'll get undefined /// results. fn iter_prefix(k1: impl EncodeLike<K1>) -> Self::PrefixIterator; /// Remove all elements from the map with first key `k1` and iterate through them in no /// particular order. If you add elements with first key `k1` to the map while doing this, /// you'll get undefined results. fn drain_prefix(k1: impl EncodeLike<K1>) -> Self::PrefixIterator; /// Enumerate all elements in the map in no particular order. If you add or remove values to /// the map while doing this, you'll get undefined results. fn iter() -> Self::Iterator; /// Remove all elements from the map and iterate through them in no particular order. If you /// add elements to the map while doing this, you'll get undefined results. fn drain() -> Self::Iterator; /// Translate the values of all elements by a function `f`, in the map in no particular order. /// By returning `None` from `f` for an element, you'll remove it from the map. /// /// NOTE: If a value fail to decode because storage is corrupted then it is skipped. fn translate<O: Decode, F: Fn(K1, K2, O) -> Option<V>>(f: F); } /// An implementation of a map with a two keys. /// /// It provides an important ability to efficiently remove all entries /// that have a common first key. /// /// Details on implementation can be found at /// [`generator::StorageDoubleMap`] pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> { /// The type that get/take returns. type Query; /// Get the storage key used to fetch a value corresponding to a specific key. fn hashed_key_for<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Vec<u8> where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>; /// Does the value (explicitly) exist in storage? fn contains_key<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> bool where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>; /// Load the value associated with the given key from the double map. fn get<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Self::Query where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>; /// Take a value from storage, removing it afterwards. fn take<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Self::Query where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>; /// Swap the values of two key-pairs. fn swap<XKArg1, XKArg2, YKArg1, YKArg2>(x_k1: XKArg1, x_k2: XKArg2, y_k1: YKArg1, y_k2: YKArg2) where XKArg1: EncodeLike<K1>, XKArg2: EncodeLike<K2>, YKArg1: EncodeLike<K1>, YKArg2: EncodeLike<K2>; /// Store a value to be associated with the given keys from the double map. fn insert<KArg1, KArg2, VArg>(k1: KArg1, k2: KArg2, val: VArg) where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, VArg: EncodeLike<V>; /// Remove the value under the given keys. fn remove<KArg1, KArg2>(k1: KArg1, k2: KArg2) where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>; /// Remove all values under the first key. fn remove_prefix<KArg1>(k1: KArg1) where KArg1: ?Sized + EncodeLike<K1>; /// Iterate over values that share the first key. fn iter_prefix_values<KArg1>(k1: KArg1) -> PrefixIterator<V> where KArg1: ?Sized + EncodeLike<K1>; /// Mutate the value under the given keys. fn mutate<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Self::Query) -> R; /// Mutate the value under the given keys when the closure returns `Ok`. fn try_mutate<KArg1, KArg2, R, E, F>(k1: KArg1, k2: KArg2, f: F) -> Result<R, E> where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Self::Query) -> Result<R, E>; /// Mutate the value under the given keys. Deletes the item if mutated to a `None`. fn mutate_exists<KArg1, KArg2, R, F>(k1: KArg1, k2: KArg2, f: F) -> R where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Option<V>) -> R; /// Mutate the item, only if an `Ok` value is returned. Deletes the item if mutated to a `None`. fn try_mutate_exists<KArg1, KArg2, R, E, F>(k1: KArg1, k2: KArg2, f: F) -> Result<R, E> where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, F: FnOnce(&mut Option<V>) -> Result<R, E>; /// Append the given item to the value in the storage. /// /// `V` is required to implement [`StorageAppend`]. /// /// # Warning /// /// If the storage item is not encoded properly, the storage will be overwritten /// and set to `[item]`. Any default value set for the storage item will be ignored /// on overwrite. fn append<Item, EncodeLikeItem, KArg1, KArg2>( k1: KArg1, k2: KArg2, item: EncodeLikeItem, ) where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, Item: Encode, EncodeLikeItem: EncodeLike<Item>, V: StorageAppend<Item>; /// Read the length of the storage value without decoding the entire value under the /// given `key1` and `key2`. /// /// `V` is required to implement [`StorageDecodeLength`]. /// /// If the value does not exists or it fails to decode the length, `None` is returned. /// Otherwise `Some(len)` is returned. /// /// # Warning /// /// `None` does not mean that `get()` does not return a value. The default value is completly /// ignored by this function. fn decode_len<KArg1, KArg2>(key1: KArg1, key2: KArg2) -> Option<usize> where KArg1: EncodeLike<K1>, KArg2: EncodeLike<K2>, V: StorageDecodeLength, { V::decode_len(&Self::hashed_key_for(key1, key2)) } /// Migrate an item with the given `key1` and `key2` from defunct `OldHasher1` and /// `OldHasher2` to the current hashers. /// /// If the key doesn't exist, then it's a no-op. If it does, then it returns its value. fn migrate_keys< OldHasher1: StorageHasher, OldHasher2: StorageHasher, KeyArg1: EncodeLike<K1>, KeyArg2: EncodeLike<K2>, >(key1: KeyArg1, key2: KeyArg2) -> Option<V>; } /// Iterate over a prefix and decode raw_key and raw_value into `T`. /// /// If any decoding fails it skips it and continues to the next key. pub struct PrefixIterator<T> { prefix: Vec<u8>, previous_key: Vec<u8>, /// If true then value are removed while iterating drain: bool, /// Function that take `(raw_key_without_prefix, raw_value)` and decode `T`. /// `raw_key_without_prefix` is the raw storage key without the prefix iterated on. closure: fn(&[u8], &[u8]) -> Result<T, codec::Error>, } impl<T> Iterator for PrefixIterator<T> { type Item = T; fn next(&mut self) -> Option<Self::Item> { loop { let maybe_next = sp_io::storage::next_key(&self.previous_key) .filter(|n| n.starts_with(&self.prefix)); break match maybe_next { Some(next) => { self.previous_key = next; let raw_value = match unhashed::get_raw(&self.previous_key) { Some(raw_value) => raw_value, None => { crate::debug::error!( "next_key returned a key with no value at {:?}", self.previous_key ); continue } }; if self.drain { unhashed::kill(&self.previous_key) } let raw_key_without_prefix = &self.previous_key[self.prefix.len()..]; let item = match (self.closure)(raw_key_without_prefix, &raw_value[..]) { Ok(item) => item, Err(e) => { crate::debug::error!( "(key, value) failed to decode at {:?}: {:?}", self.previous_key, e ); continue } }; Some(item) } None => None, } } } } /// Trait for maps that store all its value after a unique prefix. /// /// By default the final prefix is: /// ```nocompile /// Twox128(module_prefix) ++ Twox128(storage_prefix) /// ``` pub trait StoragePrefixedMap<Value: FullCodec> { /// Module prefix. Used for generating final key. fn module_prefix() -> &'static [u8]; /// Storage prefix. Used for generating final key. fn storage_prefix() -> &'static [u8]; /// Final full prefix that prefixes all keys. fn final_prefix() -> [u8; 32] { let mut final_key = [0u8; 32]; final_key[0..16].copy_from_slice(&Twox128::hash(Self::module_prefix())); final_key[16..32].copy_from_slice(&Twox128::hash(Self::storage_prefix())); final_key } /// Remove all value of the storage. fn remove_all() { sp_io::storage::clear_prefix(&Self::final_prefix()) } /// Iter over all value of the storage. /// /// NOTE: If a value failed to decode becaues storage is corrupted then it is skipped. fn iter_values() -> PrefixIterator<Value> { let prefix = Self::final_prefix(); PrefixIterator { prefix: prefix.to_vec(), previous_key: prefix.to_vec(), drain: false, closure: |_raw_key, mut raw_value| Value::decode(&mut raw_value), } } /// Translate the values of all elements by a function `f`, in the map in no particular order. /// By returning `None` from `f` for an element, you'll remove it from the map. /// /// NOTE: If a value fail to decode because storage is corrupted then it is skipped. /// /// # Warning /// /// This function must be used with care, before being updated the storage still contains the /// old type, thus other calls (such as `get`) will fail at decoding it. /// /// # Usage /// /// This would typically be called inside the module implementation of on_runtime_upgrade. fn translate_values<OldValue: Decode, F: Fn(OldValue) -> Option<Value>>(f: F) { let prefix = Self::final_prefix(); let mut previous_key = prefix.clone().to_vec(); while let Some(next) = sp_io::storage::next_key(&previous_key) .filter(|n| n.starts_with(&prefix)) { previous_key = next; let maybe_value = unhashed::get::<OldValue>(&previous_key); match maybe_value { Some(value) => match f(value) { Some(new) => unhashed::put::<Value>(&previous_key, &new), None => unhashed::kill(&previous_key), }, None => { crate::debug::error!( "old key failed to decode at {:?}", previous_key ); continue }, } } } } /// Marker trait that will be implemented for types that support the `storage::append` api. /// /// This trait is sealed. pub trait StorageAppend<Item: Encode>: private::Sealed {} /// Marker trait that will be implemented for types that support to decode their length in an /// effificent way. It is expected that the length is at the beginning of the encoded object /// and that the length is a `Compact<u32>`. /// /// This trait is sealed. pub trait StorageDecodeLength: private::Sealed + codec::DecodeLength { /// Decode the length of the storage value at `key`. /// /// This function assumes that the length is at the beginning of the encoded object /// and is a `Compact<u32>`. /// /// Returns `None` if the storage value does not exist or the decoding failed. fn decode_len(key: &[u8]) -> Option<usize> { // `Compact<u32>` is 5 bytes in maximum. let mut data = [0u8; 5]; let len = sp_io::storage::read(key, &mut data, 0)?; let len = data.len().min(len as usize); <Self as codec::DecodeLength>::len(&data[..len]).ok() } } /// Provides `Sealed` trait to prevent implementing trait `StorageAppend` & `StorageDecodeLength` /// outside of this crate. mod private { use super::*; pub trait Sealed {} impl<T: Encode> Sealed for Vec<T> {} impl<Hash: Encode> Sealed for Digest<Hash> {} } impl<T: Encode> StorageAppend<T> for Vec<T> {} impl<T: Encode> StorageDecodeLength for Vec<T> {} /// We abuse the fact that SCALE does not put any marker into the encoding, i.e. /// we only encode the internal vec and we can append to this vec. We have a test that ensures /// that if the `Digest` format ever changes, we need to remove this here. impl<Hash: Encode> StorageAppend<DigestItem<Hash>> for Digest<Hash> {} #[cfg(test)] mod test { use super::*; use sp_core::hashing::twox_128; use sp_io::TestExternalities; use generator::StorageValue as _; #[test] fn prefixed_map_works() { TestExternalities::default().execute_with(|| { struct MyStorage; impl StoragePrefixedMap<u64> for MyStorage { fn module_prefix() -> &'static [u8] { b"MyModule" } fn storage_prefix() -> &'static [u8] { b"MyStorage" } } let key_before = { let mut k = MyStorage::final_prefix(); let last = k.iter_mut().last().unwrap(); *last = last.checked_sub(1).unwrap(); k }; let key_after = { let mut k = MyStorage::final_prefix(); let last = k.iter_mut().last().unwrap(); *last = last.checked_add(1).unwrap(); k }; unhashed::put(&key_before[..], &32u64); unhashed::put(&key_after[..], &33u64); let k = [twox_128(b"MyModule"), twox_128(b"MyStorage")].concat(); assert_eq!(MyStorage::final_prefix().to_vec(), k); // test iteration assert!(MyStorage::iter_values().collect::<Vec<_>>().is_empty()); unhashed::put(&[&k[..], &vec![1][..]].concat(), &1u64); unhashed::put(&[&k[..], &vec![1, 1][..]].concat(), &2u64); unhashed::put(&[&k[..], &vec![8][..]].concat(), &3u64); unhashed::put(&[&k[..], &vec![10][..]].concat(), &4u64); assert_eq!(MyStorage::iter_values().collect::<Vec<_>>(), vec![1, 2, 3, 4]); // test removal MyStorage::remove_all(); assert!(MyStorage::iter_values().collect::<Vec<_>>().is_empty()); // test migration unhashed::put(&[&k[..], &vec![1][..]].concat(), &1u32); unhashed::put(&[&k[..], &vec![8][..]].concat(), &2u32); assert!(MyStorage::iter_values().collect::<Vec<_>>().is_empty()); MyStorage::translate_values(|v: u32| Some(v as u64)); assert_eq!(MyStorage::iter_values().collect::<Vec<_>>(), vec![1, 2]); MyStorage::remove_all(); // test migration 2 unhashed::put(&[&k[..], &vec![1][..]].concat(), &1u128); unhashed::put(&[&k[..], &vec![1, 1][..]].concat(), &2u64); unhashed::put(&[&k[..], &vec![8][..]].concat(), &3u128); unhashed::put(&[&k[..], &vec![10][..]].concat(), &4u32); // (contains some value that successfully decoded to u64) assert_eq!(MyStorage::iter_values().collect::<Vec<_>>(), vec![1, 2, 3]); MyStorage::translate_values(|v: u128| Some(v as u64)); assert_eq!(MyStorage::iter_values().collect::<Vec<_>>(), vec![1, 2, 3]); MyStorage::remove_all(); // test that other values are not modified. assert_eq!(unhashed::get(&key_before[..]), Some(32u64)); assert_eq!(unhashed::get(&key_after[..]), Some(33u64)); }); } // This test ensures that the Digest encoding does not change without being noticied. #[test] fn digest_storage_append_works_as_expected() { TestExternalities::default().execute_with(|| { struct Storage; impl generator::StorageValue<Digest<u32>> for Storage { type Query = Digest<u32>; fn module_prefix() -> &'static [u8] { b"MyModule" } fn storage_prefix() -> &'static [u8] { b"Storage" } fn from_optional_value_to_query(v: Option<Digest<u32>>) -> Self::Query { v.unwrap() } fn from_query_to_optional_value(v: Self::Query) -> Option<Digest<u32>> { Some(v) } } Storage::append(DigestItem::ChangesTrieRoot(1)); Storage::append(DigestItem::Other(Vec::new())); let value = unhashed::get_raw(&Storage::storage_value_final_key()).unwrap(); let expected = Digest { logs: vec![DigestItem::ChangesTrieRoot(1), DigestItem::Other(Vec::new())], }; assert_eq!(Digest::decode(&mut &value[..]).unwrap(), expected); }); } }