fix(core): introduce DojoStore trait to handle some specific storage cases

Cargo.toml

@@ -210,9 +210,19 @@ rpassword = "7.2.0"
 rstest = "0.18.2"
 rstest_reuse = "0.6.0"
 salsa = "0.16.1"
-scarb = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
-scarb-metadata = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
-scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
+
+#scarb = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
+#scarb-metadata = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
+#scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "22aa38f53de205af25bf73b3ffc2c5334999d480" }
+
+scarb = { git = "https://github.com/remybar/scarb", rev = "fb905dd49264dcf5a38d09470529ef143f4a8762" }
+scarb-metadata = { git = "https://github.com/remybar/scarb", rev = "fb905dd49264dcf5a38d09470529ef143f4a8762" }
+scarb-ui = { git = "https://github.com/remybar/scarb", rev = "fb905dd49264dcf5a38d09470529ef143f4a8762" }
+
+#scarb = { path = "/Users/remybaranx/pro/projets/contribs/dojo/scarb/scarb" }
+#scarb-metadata = { path = "/Users/remybaranx/pro/projets/contribs/dojo/scarb/scarb-metadata" }
+#scarb-ui = { path = "/Users/remybaranx/pro/projets/contribs/dojo/scarb/utils/scarb-ui" }
+
 semver = "1.0.5"
 serde = { version = "1.0", features = [ "derive" ] }
 serde_json = { version = "1.0", features = [ "arbitrary_precision" ] }

crates/benches/contracts/src/models/character.cairo

@@ -36,13 +36,14 @@ struct Stats {
     romances: u16,
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 enum Weapon {
+    #[default]
     DualWield: (Sword, Sword),
     Fists: (Sword, Sword),
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 struct Sword {
     swordsmith: ContractAddress,
     damage: u32,

crates/dojo/core-cairo-test/Scarb.lock

@@ -3,7 +3,7 @@ version = 1
 
 [[package]]
 name = "dojo"
-version = "1.2.0"
+version = "1.2.2"
 dependencies = [
  "dojo_plugin",
 ]

crates/dojo/core-cairo-test/src/lib.cairo

@@ -17,6 +17,7 @@ pub use world::{
 mod tests {
     mod meta {
         mod introspect;
+        mod layout;
     }
 
     mod event {
@@ -29,8 +30,10 @@ mod tests {
 
     mod storage {
         mod database;
+        mod dojo_store;
         mod packing;
         mod storage;
+        mod layout;
     }
 
     mod contract;

crates/dojo/core-cairo-test/src/tests/expanded/selector_attack.cairo

@@ -60,5 +60,9 @@ pub mod attacker_model {
                 unpacked_size: Self::unpacked_size(self),
             }
         }
+
+        fn use_legacy_storage(self: @ContractState) -> bool {
+            false
+        }
     }
 }

crates/dojo/core-cairo-test/src/tests/helpers/event.cairo

@@ -10,7 +10,7 @@ use crate::world::{spawn_test_world, NamespaceDef, TestResource};
 /// These event contracts are used to test event upgrades in tests/event.cairo.
 
 // This event is used as a base to create the "previous" version of an event to be upgraded.
-#[derive(Introspect)]
+#[derive(Introspect, Serde)]
 struct FooBaseEvent {
     #[key]
     pub caller: ContractAddress,
@@ -63,8 +63,9 @@ struct FooEventMemberAdded {
     pub b: u128,
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 enum MyEnum {
+    #[default]
     X: u8,
 }
 
@@ -77,8 +78,9 @@ struct FooEventMemberChanged {
     pub b: u128,
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 enum AnotherEnum {
+    #[default]
     X: u8,
 }
 

crates/dojo/core-cairo-test/src/tests/helpers/helpers.cairo

@@ -2,6 +2,7 @@ use starknet::{ContractAddress};
 
 use dojo::world::{IWorldDispatcher, WorldStorage, WorldStorageTrait};
 use dojo::model::Model;
+use dojo::storage::ContractAddressDefault;
 
 use crate::world::{
     spawn_test_world, NamespaceDef, TestResource, ContractDefTrait, WorldStorageTestTrait,
@@ -35,9 +36,10 @@ pub struct NotCopiable {
     pub b: ByteArray,
 }
 
-#[derive(Drop, Serde, Debug, PartialEq, Introspect)]
+#[derive(Drop, Serde, Debug, PartialEq, Introspect, Default)]
 pub enum EnumOne {
     One,
+    #[default]
     Two: u32,
     Three: (felt252, u32),
 }
@@ -95,6 +97,10 @@ pub mod foo_invalid_name {
                 unpacked_size: Self::unpacked_size(self),
             }
         }
+
+        fn use_legacy_storage(self: @ContractState) -> bool {
+            false
+        }
     }
 }
 
@@ -127,7 +133,7 @@ pub mod test_contract_with_dojo_init_args {
     }
 }
 
-#[derive(IntrospectPacked, Copy, Drop, Serde)]
+#[derive(IntrospectPacked, Copy, Drop, Serde, Default)]
 pub struct Sword {
     pub swordsmith: ContractAddress,
     pub damage: u32,
@@ -177,8 +183,9 @@ pub struct Stats {
     pub romances: u16,
 }
 
-#[derive(IntrospectPacked, Copy, Drop, Serde)]
+#[derive(IntrospectPacked, Copy, Drop, Serde, Default)]
 pub enum Weapon {
+    #[default]
     DualWield: (Sword, Sword),
     Fists: (Sword, Sword),
 }

crates/dojo/core-cairo-test/src/tests/helpers/model.cairo

@@ -55,8 +55,9 @@ struct FooModelMemberAdded {
     pub b: u128,
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 enum MyEnum {
+    #[default]
     X: u8,
 }
 
@@ -69,8 +70,9 @@ struct FooModelMemberChanged {
     pub b: u128,
 }
 
-#[derive(Introspect, Copy, Drop, Serde)]
+#[derive(Introspect, Copy, Drop, Serde, Default)]
 enum AnotherEnum {
+    #[default]
     X: u8,
 }
 

crates/dojo/core-cairo-test/src/tests/meta/introspect.cairo

@@ -2,116 +2,129 @@ use dojo::meta::introspect::{Introspect, Struct, Enum, Member, Ty, TyCompareTrai
 use dojo::meta::{Layout, FieldLayout};
 use crate::utils::GasCounterTrait;
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde, Default)]
 struct Base {
     value: u32,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct WithArray {
     value: u32,
     arr: Array<u8>,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct WithByteArray {
     value: u32,
     arr: ByteArray,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct WithTuple {
     value: u32,
     arr: (u8, u16, u32),
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct WithNestedTuple {
     value: u32,
     arr: (u8, (u16, u128, u256), u32),
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct WithNestedArrayInTuple {
     value: u32,
     arr: (u8, (u16, Array<u128>, u256), u32),
 }
 
-#[derive(Drop, IntrospectPacked)]
+#[derive(Drop, IntrospectPacked, Serde, Default)]
 struct Vec3 {
     x: u32,
     y: u32,
     z: u32,
 }
 
-#[derive(IntrospectPacked)]
+#[derive(IntrospectPacked, Serde)]
 struct Translation {
     from: Vec3,
     to: Vec3,
 }
 
-#[derive(Drop, IntrospectPacked)]
+#[derive(Drop, IntrospectPacked, Serde)]
 struct StructInnerNotPacked {
     x: Base,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde, Default)]
 enum EnumNoData {
+    #[default]
     One,
     Two,
     Three,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde, Default)]
 enum EnumWithSameData {
+    #[default]
     One: u256,
     Two: u256,
     Three: u256,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde, Default)]
 enum EnumWithSameTupleData {
+    #[default]
     One: (u256, u32),
     Two: (u256, u32),
     Three: (u256, u32),
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde, Default)]
 enum EnumWithVariousData {
+    #[default]
     One: u32,
     Two: (u8, u16),
     Three: Array<u128>,
 }
 
 
-#[derive(Drop, IntrospectPacked)]
+#[derive(Drop, IntrospectPacked, Serde, Default)]
 enum EnumPacked {
+    #[default]
     A: u32,
     B: u32,
 }
 
-#[derive(Drop, IntrospectPacked)]
+#[derive(Drop, IntrospectPacked, Serde, Default)]
 enum EnumInnerPacked {
+    #[default]
     A: (EnumPacked, Vec3),
     B: (EnumPacked, Vec3),
 }
 
-#[derive(Drop, IntrospectPacked)]
+#[derive(Drop, IntrospectPacked, Serde, Default)]
 enum EnumInnerNotPacked {
+    #[default]
     A: (EnumPacked, Base),
     B: (EnumPacked, Base),
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct StructWithOption {
     x: Option<u16>,
 }
 
-#[derive(Drop, Introspect)]
+#[derive(Drop, Introspect, Serde)]
 struct Generic<T> {
     value: T,
 }
 
+#[derive(Drop, Introspect, Serde, Default)]
+enum GenericEnum<T> {
+    #[default]
+    A: T,
+}
+
 fn field(selector: felt252, layout: Layout) -> FieldLayout {
     FieldLayout { selector, layout }
 }
@@ -134,9 +147,13 @@ fn _enum(values: Array<Option<Layout>>) -> Layout {
         }
 
         let v = *values.at(i);
+
+        // in the new Dojo storage layout, variants start from 1.
+        let variant = i + 1;
+
         match v {
-            Option::Some(v) => { items.append(field(i.into(), v)); },
-            Option::None => { items.append(field(i.into(), fixed(array![]))) },
+            Option::Some(v) => { items.append(field(variant.into(), v)); },
+            Option::None => { items.append(field(variant.into(), fixed(array![]))) },
         }
 
         i += 1;