odra-core 2.7.0

Core of the Odra Framework
Documentation 
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

/// Creates an Odra module that stores a single value under a given named key.
///
/// The module has two methods: `set` and `get`.
/// If the value is not set and an error is passed as the fourth argument, `get` will revert with the provided error.
#[macro_export]
macro_rules! single_value_storage {
    ($name:ident, $value_ty:ty, $key:expr, $err:expr) => {
        #[odra::module]
        pub struct $name;

        impl $name {
            pub fn set(&self, value: $value_ty) {
                self.env().set_named_value($key, value);
            }

            pub fn get(&self) -> $value_ty {
                self.env()
                    .get_named_value($key)
                    .unwrap_or_revert_with(self, $err)
            }
        }
    };
    ($name:ident, $value_ty:ty, $key:expr) => {
        #[odra::module]
        pub struct $name;

        impl $name {
            pub fn set(&self, value: $value_ty) {
                self.env().set_named_value($key, value);
            }

            pub fn get(&self) -> Option<$value_ty> {
                self.env().get_named_value($key)
            }
        }
    };
}

/// Creates an Odra module that stores a values in a given dictionary.
///
/// The module has three methods: `set`, `get` and `init`.
/// The `key` argument of `set` and `get` is used as a dictionary key.
/// The `init` method initializes the dictionary with the given name.
#[macro_export]
macro_rules! key_value_storage {
    ($name:ident, $dict:expr, $value_type:ty) => {
        #[odra::module]
        pub struct $name;

        impl $name {
            pub fn set(&self, key: &str, value: $value_type) {
                self.env()
                    .set_dictionary_value($dict, key.as_bytes(), value);
            }

            pub fn get(&self, key: &str) -> Option<$value_type> {
                self.env().get_dictionary_value($dict, key.as_bytes())
            }

            pub fn init(&self) {
                self.env().init_dictionary($dict);
            }
        }
    };
}

/// Creates an Odra module that stores a values in a given dictionary.
///
/// The module has three methods: `set`, `get` and `init`.
/// The `key` argument of `set` and `get` is base64-encoded and then used as a dictionary key.
/// The `init` method initializes the dictionary with the given name.
#[macro_export]
macro_rules! base64_encoded_key_value_storage {
    ($name:ident, $dict:expr, $key:ty, $value_type:ty) => {
        #[odra::module]
        pub struct $name;

        impl $name {
            pub fn set(&self, key: &$key, value: $value_type) {
                let encoded_key = Self::key(self, key);
                self.env()
                    .set_dictionary_value($dict, encoded_key.as_bytes(), value);
            }

            pub fn get(&self, key: &$key) -> Option<$value_type> {
                let encoded_key = Self::key(self, key);
                self.env()
                    .get_dictionary_value($dict, encoded_key.as_bytes())
            }

            pub fn init(&self) {
                self.env().init_dictionary($dict);
            }

            #[inline]
            fn key<R: odra::module::Revertible>(rev: &R, key: &$key) -> String {
                use base64::prelude::{Engine, BASE64_STANDARD};
                let key = odra::casper_types::bytesrepr::ToBytes::to_bytes(key);
                let preimage = key.unwrap_or_revert(rev);
                BASE64_STANDARD.encode(preimage)
            }
        }
    };
}

/// Creates an Odra module that stores a values in a given dictionary.
///
/// The module has three methods: `set`, `get` and `init`.
/// The `key1` and `key2` arguments of `set` and `get` are converted to bytes, combined into a single bytes vector,
/// and finally hex-encoded and then used as a dictionary key.
/// The `init` method initializes the dictionary with the given name.
#[macro_export]
macro_rules! compound_key_value_storage {
    ($name:ident, $dict:expr, $k1_type:ty, $k2_type:ty, $value_type:ty) => {
        #[odra::module]
        pub struct $name;

        impl $name {
            pub fn set(&self, key1: &$k1_type, key2: &$k2_type, value: $value_type) {
                let mut key = [0u8; 64];
                let mut preimage = odra::prelude::Vec::new();
                let key1 = odra::casper_types::bytesrepr::ToBytes::to_bytes(key1);
                let key2 = odra::casper_types::bytesrepr::ToBytes::to_bytes(key2);
                preimage.extend_from_slice(&key1.unwrap_or_revert(self));
                preimage.extend_from_slice(&key2.unwrap_or_revert(self));

                let env = self.env();
                let key_bytes = env.hash(&preimage);
                odra::utils::hex_to_slice(&key_bytes, &mut key);
                env.set_dictionary_value($dict, &key, value);
            }

            pub fn get_or_default(&self, key1: &$k1_type, key2: &$k2_type) -> $value_type {
                let mut key = [0u8; 64];
                let mut preimage = odra::prelude::Vec::new();
                let key1 = odra::casper_types::bytesrepr::ToBytes::to_bytes(key1);
                let key2 = odra::casper_types::bytesrepr::ToBytes::to_bytes(key2);
                preimage.extend_from_slice(&key1.unwrap_or_revert(self));
                preimage.extend_from_slice(&key2.unwrap_or_revert(self));

                let env = self.env();
                let key_bytes = env.hash(&preimage);
                odra::utils::hex_to_slice(&key_bytes, &mut key);
                env.get_dictionary_value($dict, &key).unwrap_or_default()
            }

            pub fn init(&self) {
                self.env().init_dictionary($dict);
            }
        }
    };
    ($name:ident, $dict:expr, $k1_type:ty, $value_type:ty) => {
        compound_key_value_storage!($name, $dict, $k1_type, $k1_type, $value_type);
    };
}