✨ Add AchievementIcon type

cartridge-gg · Oct 18, 2024 · ada22f6 · ada22f6
1 parent b5a128b
commit ada22f6
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 16 deletions.
diff --git a/contracts/manifests/dev/base/abis/models/game_center-AchievementCreation-604e47bb.json b/contracts/manifests/dev/base/abis/models/game_center-AchievementCreation-604e47bb.json
@@ -426,7 +426,7 @@
       },
       {
         "name": "icon",
-        "type": "core::byte_array::ByteArray"
+        "type": "core::felt252"
       },
       {
         "name": "time",

diff --git a/contracts/manifests/dev/base/models/game_center-AchievementCreation-604e47bb.toml b/contracts/manifests/dev/base/models/game_center-AchievementCreation-604e47bb.toml
@@ -1,6 +1,6 @@
 kind = "DojoModel"
-class_hash = "0x2f4c5d5380b7cca9297f71ce1ed138a433b1f5f451e1d1f95b490d0d1ca3c72"
-original_class_hash = "0x2f4c5d5380b7cca9297f71ce1ed138a433b1f5f451e1d1f95b490d0d1ca3c72"
+class_hash = "0x535e56e14f5c19117d153ad353efe78e4831b4926126c7783322f137509ca4c"
+original_class_hash = "0x535e56e14f5c19117d153ad353efe78e4831b4926126c7783322f137509ca4c"
 abi = "manifests/dev/base/abis/models/game_center-AchievementCreation-604e47bb.json"
 tag = "game_center-AchievementCreation"
 qualified_path = "achievement::events::index::achievement_creation"
@@ -58,7 +58,7 @@ key = false
 
 [[members]]
 name = "icon"
-type = "ByteArray"
+type = "felt252"
 key = false
 
 [[members]]

diff --git a/packages/achievement/src/components/achievable.cairo b/packages/achievement/src/components/achievable.cairo
@@ -48,7 +48,7 @@ mod AchievableComponent {
             description: ByteArray,
             hidden_description: ByteArray,
             image_uri: ByteArray,
-            icon: ByteArray,
+            icon: felt252,
         ) {
             // [Setup] Store
             let store: Store = StoreTrait::new(world);

diff --git a/packages/achievement/src/events/creation.cairo b/packages/achievement/src/events/creation.cairo
@@ -27,7 +27,7 @@ impl AchievementCreationImpl of AchievementCreationTrait {
         description: ByteArray,
         hidden_description: ByteArray,
         image_uri: ByteArray,
-        icon: ByteArray,
+        icon: felt252,
         time: u64,
     ) -> AchievementCreation {
         // [Check] Inputs
@@ -84,6 +84,7 @@ mod tests {
     const HIDDEN: bool = false;
     const POINTS: u16 = 100;
     const TOTAL: u32 = 100;
+    const ICON: felt252 = 'ICON';
 
     #[test]
     fn test_achievement_creation_new() {
@@ -98,7 +99,7 @@ mod tests {
             "DESCRIPTION",
             "HIDDEN_DESCRIPTION",
             "IMAGE_URI",
-            "ICON",
+            ICON,
             1000000000,
         );
         assert_eq!(achievement.namespace, NAMESPACE);
@@ -110,6 +111,9 @@ mod tests {
         assert_eq!(achievement.hidden_title, "HIDDEN_TITLE");
         assert_eq!(achievement.description, "DESCRIPTION");
         assert_eq!(achievement.hidden_description, "HIDDEN_DESCRIPTION");
+        assert_eq!(achievement.image_uri, "IMAGE_URI");
+        assert_eq!(achievement.icon, ICON);
+        assert_eq!(achievement.time, 1000000000);
     }
 
     #[test]
@@ -126,7 +130,7 @@ mod tests {
             "DESCRIPTION",
             "HIDDEN_DESCRIPTION",
             "IMAGE_URI",
-            "ICON",
+            ICON,
             1000000000
         );
     }
@@ -145,7 +149,7 @@ mod tests {
             "DESCRIPTION",
             "HIDDEN_DESCRIPTION",
             "IMAGE_URI",
-            "ICON",
+            ICON,
             1000000000
         );
     }
@@ -164,7 +168,7 @@ mod tests {
             "DESCRIPTION",
             "HIDDEN_DESCRIPTION",
             "IMAGE_URI",
-            "ICON",
+            ICON,
             1000000000
         );
     }

diff --git a/packages/achievement/src/events/index.cairo b/packages/achievement/src/events/index.cairo
@@ -14,7 +14,7 @@ pub struct AchievementCreation {
     description: ByteArray,
     hidden_description: ByteArray,
     image_uri: ByteArray,
-    icon: ByteArray,
+    icon: felt252,
     time: u64,
 }
 

diff --git a/packages/achievement/src/lib.cairo b/packages/achievement/src/lib.cairo
@@ -1,6 +1,10 @@
 mod constants;
 mod store;
 
+mod types {
+    mod icon;
+}
+
 mod models {
     mod index;
     mod game;

diff --git a/packages/achievement/src/store.cairo b/packages/achievement/src/store.cairo
@@ -69,7 +69,7 @@ impl StoreImpl of StoreTrait {
         description: ByteArray,
         hidden_description: ByteArray,
         image_uri: ByteArray,
-        icon: ByteArray,
+        icon: felt252,
         time: u64,
     ) {
         let _event: AchievementCreation = AchievementCreationTrait::new(

diff --git a/packages/achievement/src/tests/mocks/achiever.cairo b/packages/achievement/src/tests/mocks/achiever.cairo
@@ -11,7 +11,7 @@ trait IAchiever<TContractState> {
         description: ByteArray,
         hidden_description: ByteArray,
         image_uri: ByteArray,
-        icon: ByteArray,
+        icon: felt252,
     );
     fn update(self: @TContractState, identifier: felt252, player_id: felt252, progress: u32,);
 }
@@ -65,7 +65,7 @@ pub mod Achiever {
             description: ByteArray,
             hidden_description: ByteArray,
             image_uri: ByteArray,
-            icon: ByteArray,
+            icon: felt252,
         ) {
             self
                 .achievable

diff --git a/packages/achievement/src/tests/test_achievable.cairo b/packages/achievement/src/tests/test_achievable.cairo
@@ -10,6 +10,7 @@ use starknet::testing;
 
 // Internal imports
 
+use achievement::types::icon::AchievementIcon;
 use achievement::events::index::{AchievementCreation, AchievementCompletion};
 use achievement::tests::mocks::achiever::{Achiever, IAchieverDispatcher, IAchieverDispatcherTrait};
 use achievement::tests::setup::setup::{spawn_game, clear_events, Systems, PLAYER};
@@ -40,7 +41,7 @@ fn test_achievable_create() {
             "Description",
             "Hidden Description",
             "Image",
-            "Icon"
+            AchievementIcon::Khanda.into(),
         );
     let event = starknet::testing::pop_log::<AchievementCreation>(world.contract_address).unwrap();
     // FIXME: Cannot check keys because they are shifted due to dojo macros
@@ -52,7 +53,7 @@ fn test_achievable_create() {
     assert_eq!(event.description, "Description");
     assert_eq!(event.hidden_description, "Hidden Description");
     assert_eq!(event.image_uri, "Image");
-    assert_eq!(event.icon, "Icon");
+    assert_eq!(event.icon, AchievementIcon::Khanda.into());
 }
 
 #[test]

diff --git a/packages/achievement/src/types/icon.cairo b/packages/achievement/src/types/icon.cairo
@@ -0,0 +1,24 @@
+// Types
+
+#[derive(Copy, Drop)]
+pub enum AchievementIcon {
+    None,
+    Khanda,
+    Dice,
+    Bolt,
+    Skull,
+}
+
+impl IntoAchievementIconFelt252 of core::Into<AchievementIcon, felt252> {
+    #[inline]
+    fn into(self: AchievementIcon) -> felt252 {
+        match self {
+            AchievementIcon::None => 0,
+            AchievementIcon::Khanda => 'KHANDA',
+            AchievementIcon::Dice => 'DICE',
+            AchievementIcon::Bolt => 'BOLT',
+            AchievementIcon::Skull => 'SKULL',
+        }
+    }
+}
+