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

// Copyright 2018-2022 Parity Technologies (UK) Ltd.
//
// 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.

mod impls;

#[cfg(test)]
mod tests;

use crate::traits::KeyPtr;
use ink_env::hash::{
    Blake2x256,
    Keccak256,
    Sha2x256,
};
use ink_metadata::layout::{
    CryptoHasher,
    Layout,
};

/// Implemented by types that have a storage layout.
pub trait StorageLayout {
    /// Returns the static storage layout of `Self`.
    ///
    /// The given key pointer is guiding the allocation of static fields onto
    /// the contract storage regions.
    fn layout(key_ptr: &mut KeyPtr) -> Layout;
}

/// Types implementing this trait are supported layouting crypto hashers.
pub trait LayoutCryptoHasher {
    /// Returns the layout crypto hasher for `Self`.
    fn crypto_hasher() -> CryptoHasher;
}

impl LayoutCryptoHasher for Blake2x256 {
    fn crypto_hasher() -> CryptoHasher {
        CryptoHasher::Blake2x256
    }
}

impl LayoutCryptoHasher for Sha2x256 {
    fn crypto_hasher() -> CryptoHasher {
        CryptoHasher::Sha2x256
    }
}

impl LayoutCryptoHasher for Keccak256 {
    fn crypto_hasher() -> CryptoHasher {
        CryptoHasher::Keccak256
    }
}