Skip to content

Commit efb6820

Browse files
authored
Updated doc of scrub to further emphasize its non-recursive nature. (#8743)
1 parent 48a7657 commit efb6820

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

corelib/src/starknet/storage_access.cairo

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,11 @@ pub trait Store<T> {
217217
///
218218
/// The operation writes zeroes to storage starting from the specified base address and offset,
219219
/// and continues for the size of the type as determined by the `size()` function.
220+
///
221+
/// Note: This is a flat operation. It only zeros the storage slots that belong to this value as
222+
/// determined by `size()`. It does not traverse or delete storage that is pointed to by
223+
/// pointers within the value (e.g., ByteArray data stored via pointers). To fully clear such
224+
/// nested data, users should handle clearing on the nested storage components as well.
220225
#[inline]
221226
fn scrub(
222227
address_domain: u32, base: StorageBaseAddress, offset: u8,

0 commit comments

Comments
 (0)