fuel-core-storage 0.45.0

Storage types and primitives used by Fuel core protocol.
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
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
//! The module contains implementations and tests for the `ContractsState` table.

#[cfg(feature = "smt")]
mod smt {
    use crate::{
        Mappable,
        blueprint::sparse::{
            PrimaryKey,
            Sparse,
        },
        codec::raw::Raw,
        column::Column,
        structured_storage::TableWithBlueprint,
        tables::{
            ContractsState,
            merkle::{
                ContractsStateMerkleData,
                ContractsStateMerkleMetadata,
            },
        },
    };
    use alloc::borrow::Cow;

    /// The key convertor used to convert the key from the `ContractsState` table
    /// to the key of the `ContractsStateMerkleMetadata` table.
    pub struct KeyConverter;

    impl PrimaryKey for KeyConverter {
        type InputKey = <ContractsState as Mappable>::Key;
        type OutputKey = <ContractsStateMerkleMetadata as Mappable>::Key;

        fn primary_key(key: &Self::InputKey) -> Cow<Self::OutputKey> {
            Cow::Borrowed(key.contract_id())
        }
    }

    impl TableWithBlueprint for ContractsState {
        type Blueprint = Sparse<
            Raw,
            Raw,
            ContractsStateMerkleMetadata,
            ContractsStateMerkleData,
            KeyConverter,
        >;
        type Column = Column;

        fn column() -> Column {
            Column::ContractsState
        }
    }

    #[cfg(test)]
    #[allow(non_snake_case)]
    mod test {
        use rand::{
            Rng,
            prelude::StdRng,
        };

        use crate::blueprint::sparse::root_storage_tests_smt::SMTTestDataGenerator;

        use super::*;

        fn generate_key(
            primary_key: &<ContractsStateMerkleMetadata as Mappable>::Key,
            rng: &mut impl rand::Rng,
        ) -> <ContractsState as Mappable>::Key {
            let mut bytes = [0u8; 32];
            rng.fill(bytes.as_mut());
            <ContractsState as Mappable>::Key::new(primary_key, &bytes.into())
        }

        fn generate_key_for_same_contract(
            rng: &mut impl rand::Rng,
        ) -> <ContractsState as Mappable>::Key {
            generate_key(&fuel_core_types::fuel_tx::ContractId::zeroed(), rng)
        }

        crate::basic_storage_tests!(
            ContractsState,
            <ContractsState as Mappable>::Key::default(),
            [0u8; 32],
            vec![0u8; 32].into(),
            generate_key_for_same_contract
        );

        impl SMTTestDataGenerator for ContractsState {
            type Key = <ContractsState as Mappable>::Key;
            type PrimaryKey = <ContractsStateMerkleMetadata as Mappable>::Key;
            type Value = <ContractsState as Mappable>::OwnedValue;

            fn primary_key() -> Self::PrimaryKey {
                fuel_core_types::fuel_tx::ContractId::from([1u8; 32])
            }

            fn foreign_key() -> Self::PrimaryKey {
                fuel_core_types::fuel_tx::ContractId::from([2u8; 32])
            }

            fn generate_key(
                current_key: &Self::PrimaryKey,
                rng: &mut StdRng,
            ) -> Self::Key {
                let mut bytes = [0u8; 32];
                rng.fill(bytes.as_mut());
                <ContractsState as Mappable>::Key::new(current_key, &bytes.into())
            }

            fn generate_value(rng: &mut StdRng) -> Self::Value {
                let mut bytes = [0u8; 32];
                rng.fill(bytes.as_mut());
                <ContractsState as Mappable>::OwnedValue::from(bytes.as_slice())
            }
        }

        crate::root_storage_tests!(ContractsState);
    }

    #[cfg(test)]
    #[allow(non_snake_case)]
    mod structured_storage_tests {
        use crate::{
            StorageAsMut,
            StorageMutate,
            StorageWrite,
            column::Column,
            structured_storage::test::InMemoryStorage,
            transactional::ReadTransaction,
        };
        use fuel_vm_private::{
            prelude::{
                Bytes32,
                ContractId,
            },
            storage::{
                ContractsState,
                ContractsStateKey,
            },
        };
        use rand::{
            Rng,
            SeedableRng,
            prelude::StdRng,
        };

        #[test]
        fn storage_write__write__generates_the_same_merkle_root_as_storage_insert() {
            type Storage = InMemoryStorage<Column>;

            let mut rng = StdRng::seed_from_u64(1234);

            // Given
            let contract_id = ContractId::default();
            let keys = std::iter::from_fn(|| Some(rng.r#gen::<Bytes32>()))
                .take(10)
                .map(|state_key| ContractsStateKey::from((&contract_id, &state_key)))
                .collect::<Vec<_>>();
            let value = vec![0u8; 32];

            // When
            let merkle_root_write = {
                let storage = Storage::default();
                let mut structure = storage.read_transaction();
                let mut merkle_root = structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root");
                for key in keys.iter() {
                    <_ as StorageWrite<ContractsState>>::write_bytes(
                        &mut structure,
                        key,
                        &value,
                    )
                    .expect("Unable to write storage");
                    let new_merkle_root = structure
                        .storage::<ContractsState>()
                        .root(&contract_id)
                        .expect("Unable to retrieve Merkle root");
                    assert_ne!(merkle_root, new_merkle_root);
                    merkle_root = new_merkle_root;
                }

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            // Then
            let merkle_root_insert = {
                let storage = Storage::default();
                let mut structure = storage.read_transaction();
                for key in keys.iter() {
                    <_ as StorageMutate<ContractsState>>::insert(
                        &mut structure,
                        key,
                        &value,
                    )
                    .expect("Unable to write storage");
                }

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            assert_eq!(merkle_root_write, merkle_root_insert);
        }

        #[test]
        fn storage_write__replace__generates_the_same_merkle_root_as_storage_insert() {
            type Storage = InMemoryStorage<Column>;

            let mut rng = StdRng::seed_from_u64(1234);

            // Given
            let contract_id = ContractId::default();
            let keys = std::iter::from_fn(|| Some(rng.r#gen::<Bytes32>()))
                .take(10)
                .map(|state_key| ContractsStateKey::from((&contract_id, &state_key)))
                .collect::<Vec<_>>();
            let value = vec![0u8; 32];

            // When
            let merkle_root_replace = {
                let storage = Storage::default();
                let mut structure = storage.read_transaction();
                let mut merkle_root = structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root");
                for key in keys.iter() {
                    <_ as StorageWrite<ContractsState>>::replace_bytes(
                        &mut structure,
                        key,
                        &value,
                    )
                    .expect("Unable to write storage");
                    let new_merkle_root = structure
                        .storage::<ContractsState>()
                        .root(&contract_id)
                        .expect("Unable to retrieve Merkle root");
                    assert_ne!(merkle_root, new_merkle_root);
                    merkle_root = new_merkle_root;
                }

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            // Then
            let merkle_root_insert = {
                let storage = Storage::default();
                let mut structure = storage.read_transaction();
                for key in keys.iter() {
                    <_ as StorageMutate<ContractsState>>::insert(
                        &mut structure,
                        key,
                        &value,
                    )
                    .expect("Unable to write storage");
                }

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            assert_eq!(merkle_root_replace, merkle_root_insert);
        }

        #[test]
        fn storage_write__take__generates_the_same_merkle_root_as_storage_remove() {
            type Storage = InMemoryStorage<Column>;

            let mut rng = StdRng::seed_from_u64(1234);

            // Given
            let contract_id = ContractId::default();
            let keys = std::iter::from_fn(|| Some(rng.r#gen::<Bytes32>()))
                .take(10)
                .map(|state_key| ContractsStateKey::from((&contract_id, &state_key)))
                .collect::<Vec<_>>();
            let value = vec![0u8; 32];

            let storage = Storage::default();
            let mut structure = storage.read_transaction();
            let mut merkle_root = structure
                .storage::<ContractsState>()
                .root(&contract_id)
                .expect("Unable to retrieve Merkle root");
            for key in keys.iter() {
                <_ as StorageWrite<ContractsState>>::replace_bytes(
                    &mut structure,
                    key,
                    &value,
                )
                .expect("Unable to write storage");

                let new_merkle_root = structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root");
                assert_ne!(merkle_root, new_merkle_root);
                merkle_root = new_merkle_root;
            }

            // When
            let state_key = rng.r#gen::<Bytes32>();
            let key = ContractsStateKey::from((&contract_id, &state_key));

            let merkle_root_replace = {
                <_ as StorageWrite<ContractsState>>::write_bytes(
                    &mut structure,
                    &key,
                    &value,
                )
                .expect("Unable to write storage");

                <_ as StorageWrite<ContractsState>>::take_bytes(&mut structure, &key)
                    .expect("Unable to take value from storage");

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            // Then
            let merkle_root_remove = {
                <_ as StorageWrite<ContractsState>>::write_bytes(
                    &mut structure,
                    &key,
                    &value,
                )
                .expect("Unable to write storage");

                structure
                    .storage::<ContractsState>()
                    .remove(&key)
                    .expect("Unable to take value from storage");

                structure
                    .storage::<ContractsState>()
                    .root(&contract_id)
                    .expect("Unable to retrieve Merkle root")
            };

            assert_eq!(merkle_root_replace, merkle_root_remove);
        }
    }
}

#[cfg(not(feature = "smt"))]
mod plain {
    use crate::{
        blueprint::plain::Plain,
        codec::raw::Raw,
        column::Column,
        structured_storage::TableWithBlueprint,
        tables::ContractsState,
    };

    impl TableWithBlueprint for ContractsState {
        type Blueprint = Plain<Raw, Raw>;
        type Column = Column;

        fn column() -> Column {
            Column::ContractsState
        }
    }

    #[cfg(test)]
    mod test {
        use super::*;
        use crate::Mappable;
        use fuel_core_types::fuel_tx::ContractId;

        fn generate_key(
            primary_key: &ContractId,
            rng: &mut impl rand::Rng,
        ) -> <ContractsState as Mappable>::Key {
            let mut bytes = [0u8; 32];
            rng.fill(bytes.as_mut());
            <ContractsState as Mappable>::Key::new(primary_key, &bytes.into())
        }

        fn generate_key_for_same_contract(
            rng: &mut impl rand::Rng,
        ) -> <ContractsState as Mappable>::Key {
            generate_key(&fuel_core_types::fuel_tx::ContractId::zeroed(), rng)
        }

        crate::basic_storage_tests!(
            ContractsState,
            <ContractsState as Mappable>::Key::default(),
            [0u8; 32],
            vec![0u8; 32].into(),
            generate_key_for_same_contract
        );
    }
}