Revamp the whole codebase

Author: Samuel1-ona

src/interfaces.cairo

@@ -1,3 +1 @@
-pub mod weaver;
-pub mod interfaces;
-pub mod WeaverNFT;
+pub mod mods;

src/lib.cairo

@@ -0,0 +1,16 @@
+pub mod types;
+pub mod events;
+pub mod errors;
+
+pub mod token{
+    pub mod WeaverNFT;
+}
+
+pub mod interfaces{
+    pub mod IWeaver;
+    pub mod IWeaverNFT;
+}
+
+pub mod weaver_contract{
+    pub mod weaver;
+}

src/mods.cairo

@@ -0,0 +1,11 @@
+pub mod Errors{
+    pub  const USER_ALREADY_REGISTERED: felt252 = 'USER_ALREADY_REGISTERED';
+    pub  const USER_NOT_REGISTERED: felt252 = 'USER_NOT_REGISTERED';
+    pub  const TASK_ALREADY_EXISTS: felt252 = 'TASK_ALREADY_EXISTS';
+    pub  const TASK_NOT_EXISTS: felt252 = 'TASK_NOT_EXISTS';
+    pub  const PROTOCOL_ALREADY_REGISTERED: felt252 = 'PROTOCOL_ALREADY_REGISTERED';
+    pub  const INVALID_PROTOCOL_NAME: felt252 = 'INVALID_PROTOCOL_NAME';
+    pub  const UNAUTHORIZED: felt252 = 'UNAUTHORIZED';
+    pub  const INVALID_ADDRESS: felt252 = 'INVALID_ADDRESS';
+    pub const CLASS_HASH_CANNOT_BE_ZERO: felt252 = 'CLASS_HASH_CANNOT_BE_ZERO';
+}

src/mods/errors.cairo

@@ -0,0 +1,28 @@
+use starknet::{ClassHash, ContractAddress};
+
+
+#[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
+pub struct Upgraded {
+    pub implementation: ClassHash,
+}
+
+#[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
+pub struct UserRegistered {
+    #[key]
+    pub user: ContractAddress,
+}
+
+#[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
+pub struct ProtocolRegistered {
+    #[key]
+    pub user: ContractAddress,
+}
+
+
+#[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
+pub struct TaskMinted {
+    #[key]
+    pub task_id: u256,
+    #[key]
+    pub user: ContractAddress,
+}

src/mods/events.cairo

@@ -5,22 +5,8 @@ use starknet::class_hash::ClassHash;
 //                              INTERFACE of  WEAVER
 // *************************************************************************
 
-#[derive(Drop, Serde, Debug, PartialEq, starknet::Store)]
-pub struct User {
-    pub Details: ByteArray,
-}
-
-#[derive(Copy, Drop, Serde, starknet::Store)]
-pub struct TaskInfo {
-    pub task_id: u256,
-    pub user: ContractAddress,
-    pub is_completed: bool,
-}
 
-#[derive(Drop, Serde, Debug, PartialEq, starknet::Store)]
-pub struct ProtocolInfo {
-    pub protocol_name: ByteArray,
-}
+use crate::mods::types::{ProtocolInfo, TaskInfo, User};
 
 #[starknet::interface]
 pub trait IWeaver<TContractState> {

src/interfaces/IERC721.cairo src/mods/interfaces/IERC721.cairo

@@ -13,7 +13,7 @@ pub mod WeaverNFT {
         Map, StoragePointerWriteAccess, StoragePointerReadAccess, StorageMapReadAccess,
         StorageMapWriteAccess
     };
-    use weaver_contract::interfaces::IWeaverNFT;
+    use crate::mods::interfaces::IWeaverNFT;
 
     // *************************************************************************
     //                             COMPONENTS

src/interfaces/IWeaver.cairo src/mods/interfaces/IWeaver.cairo

@@ -0,0 +1,18 @@
+use starknet::ContractAddress;
+
+#[derive(Drop, Serde, Debug, PartialEq, starknet::Store)]
+pub struct User {
+    pub Details: ByteArray,
+}
+
+#[derive(Copy, Drop, Serde, starknet::Store)]
+pub struct TaskInfo {
+    pub task_id: u256,
+    pub user: ContractAddress,
+    pub is_completed: bool,
+}
+
+#[derive(Drop, Serde, Debug, PartialEq, starknet::Store)]
+pub struct ProtocolInfo {
+    pub protocol_name: ByteArray,
+}

src/interfaces/IWeaverNFT.cairo src/mods/interfaces/IWeaverNFT.cairo

@@ -16,9 +16,11 @@ pub mod Weaver {
         get_caller_address,
     };
 
-    use weaver_contract::interfaces::IWeaver::{User, ProtocolInfo, TaskInfo};
-    use weaver_contract::interfaces::IWeaver::IWeaver;
-    use weaver_contract::interfaces::IWeaverNFT::{IWeaverNFTDispatcher, IWeaverNFTDispatcherTrait};
+    use crate::mods::types::{ProtocolInfo, TaskInfo, User};
+    use crate::mods::events::{ProtocolRegistered, TaskMinted, Upgraded, UserRegistered};
+    use crate::mods::errors::Errors;
+    use crate::mods::interfaces::IWeaver::IWeaver;
+    use crate::mods::interfaces::IWeaverNFT::{IWeaverNFTDispatcher,IWeaverNFTDispatcherTrait};
 
     // *************************************************************************
     //                              STORAGE
@@ -50,27 +52,6 @@ pub mod Weaver {
     }
 
 
-    #[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
-    pub struct Upgraded {
-        pub implementation: ClassHash,
-    }
-
-    #[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
-    pub struct UserRegistered {
-        pub user: ContractAddress,
-    }
-
-    #[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
-    pub struct ProtocolRegistered {
-        pub user: ContractAddress,
-    }
-
-
-    #[derive(Copy, Drop, Debug, PartialEq, starknet::Event)]
-    pub struct TaskMinted {
-        pub task_id: u256,
-        pub user: ContractAddress,
-    }
 
 
     #[constructor]
@@ -85,7 +66,7 @@ pub mod Weaver {
     #[abi(embed_v0)]
     impl WeaverImpl of IWeaver<ContractState> {
         fn register_User(ref self: ContractState, Details: ByteArray) {
-            assert(!self.registered.read(get_caller_address()), 'user already registered');
+            assert(!self.registered.read(get_caller_address()), Errors::USER_ALREADY_REGISTERED);
             self.registered.write(get_caller_address(), true);
             self.users.write(get_caller_address(), User { Details });
             let total_users = self.user_count.read() + 1;
@@ -102,10 +83,10 @@ pub mod Weaver {
             let caller = get_caller_address();
 
             // Verify user is registered
-            assert(self.registered.read(caller), 'USER_NOT_REGISTERED');
+            assert(self.registered.read(caller), Errors::USER_NOT_REGISTERED);
 
             // Veriy task does not exist
-            assert(!self.task_registry.read(task_id).is_completed, 'TASK_ALREADY_EXISTS');
+            assert(!self.task_registry.read(task_id).is_completed, Errors::TASK_ALREADY_EXISTS);
 
             let task_info = TaskInfo { task_id, user: caller, is_completed: true };
             self.task_registry.write(task_id, task_info);
@@ -122,10 +103,10 @@ pub mod Weaver {
 
 
         fn protocol_register(ref self: ContractState, protocol_name: ByteArray) {
-            assert(protocol_name.len() > 0, 'INVALID_PROTOCOL_NAME');
+            assert(protocol_name.len() > 0, Errors::INVALID_PROTOCOL_NAME);
 
             let protocol_info = self.protocol_registrations.read(get_caller_address());
-            assert(protocol_info.protocol_name.len() == 0, 'PROTOCOL_ALREADY_REGISTERED');
+            assert(protocol_info.protocol_name.len() == 0, Errors::PROTOCOL_ALREADY_REGISTERED);
             self.protocol_registrations.write(get_caller_address(), ProtocolInfo { protocol_name });
 
             // Dispatch the mint_weaver_nft call to the NFT contract
@@ -169,17 +150,17 @@ pub mod Weaver {
         }
 
         fn upgrade(ref self: ContractState, Imp_hash: ClassHash) {
-            assert(Imp_hash.is_non_zero(), 'Clash Hasd Cannot be Zero');
-            assert(get_caller_address() == self.owner.read(), 'UNAUTHORIZED');
+            assert(Imp_hash.is_non_zero(), Errors::CLASS_HASH_CANNOT_BE_ZERO);
+            assert(get_caller_address() == self.owner.read(), Errors::UNAUTHORIZED);
             starknet::syscalls::replace_class_syscall(Imp_hash).unwrap_syscall();
             self.version.write(self.version.read() + 1);
             self.emit(Event::Upgraded(Upgraded { implementation: Imp_hash }));
         }
 
 
         fn set_erc721(ref self: ContractState, address: ContractAddress) {
-            assert(get_caller_address() == self.owner.read(), 'UNAUTHORIZED');
-            assert(address.is_non_zero(), 'INVALID_ADDRESS');
+            assert(get_caller_address() == self.owner.read(), Errors::UNAUTHORIZED);
+            assert(address.is_non_zero(), Errors::INVALID_ADDRESS);
             self.weaver_nft_address.write(address);
         }
     }

src/WeaverNFT.cairo src/mods/token/WeaverNFT.cairo

@@ -10,10 +10,11 @@ use snforge_std::{
 
 use starknet::{ContractAddress, get_block_timestamp};
 
-use weaver_contract::interfaces::IWeaverNFT::{IWeaverNFTDispatcher, IWeaverNFTDispatcherTrait};
-use weaver_contract::interfaces::IWeaver::{IWeaverDispatcher, IWeaverDispatcherTrait};
-use weaver_contract::weaver::Weaver::{Event};
-use weaver_contract::weaver::Weaver::{UserRegistered, ProtocolRegistered, TaskMinted};
+use weaver_contract::mods::interfaces::IWeaver::{IWeaverDispatcher, IWeaverDispatcherTrait};
+use weaver_contract::mods::interfaces::IWeaverNFT::{IWeaverNFTDispatcher, IWeaverNFTDispatcherTrait};
+use weaver_contract::mods::events::{UserRegistered, ProtocolRegistered, TaskMinted};
+use weaver_contract::mods::weaver_contract::weaver::Weaver::{Event};
+
 
 
 fn OWNER() -> ContractAddress {
@@ -100,7 +101,7 @@ fn test_register_user_emit_event() {
 
 
 #[test]
-#[should_panic(expected: 'user already registered')]
+#[should_panic(expected: 'USER_ALREADY_REGISTERED')]
 fn test_already_registered_should_panic() {
     let weaver_contract_address = __setup__();
     let weaver_contract = IWeaverDispatcher { contract_address: weaver_contract_address };