Merge pull request #71 from gidson5/gid-p-c

Added vote functionlities

Author: mubarak23

src/campaign.cairo

@@ -6,33 +6,36 @@ mod TokengiverCampaigns {
     //                            IMPORT
     // *************************************************************************
     use core::traits::TryInto;
+    use openzeppelin::access::ownable::OwnableComponent;
+    use openzeppelin::token::erc20::interface::{IERC20Dispatcher, IERC20DispatcherTrait};
+    use openzeppelin::upgrades::UpgradeableComponent;
+    use openzeppelin::upgrades::interface::IUpgradeable;
+    use starknet::class_hash::class_hash_const;
+    use starknet::storage::{
+        Map, StoragePathEntry, StoragePointerReadAccess, StoragePointerWriteAccess,
+    };
+    use starknet::syscalls::deploy_syscall;
     use starknet::{
-        ContractAddress, get_caller_address, get_block_timestamp, ClassHash, get_contract_address,
-        contract_address_const, syscalls::deploy_syscall, SyscallResultTrait, syscalls,
-        class_hash::class_hash_const,
-        storage::{Map, StoragePathEntry, StoragePointerReadAccess, StoragePointerWriteAccess}
+        ClassHash, ContractAddress, SyscallResultTrait, contract_address_const, get_block_timestamp,
+        get_caller_address, get_contract_address, syscalls,
     };
-    use tokengiver::interfaces::ITokenGiverNft::{
-        ITokenGiverNftDispatcher, ITokenGiverNftDispatcherTrait
+    use token_bound_accounts::interfaces::ILockable::{
+        ILockableDispatcher, ILockableDispatcherTrait,
     };
-    use tokengiver::interfaces::IRegistry::{
-        IRegistryDispatcher, IRegistryDispatcherTrait, IRegistryLibraryDispatcher
+    use tokengiver::base::errors::Errors::{
+        INSUFFICIENT_BALANCE, NOT_CAMPAIGN_OWNER, NOT_CONTRACT_OWNER, TRANSFER_FAILED,
     };
+    use tokengiver::base::types::Campaign;
+    use tokengiver::interfaces::ICampaign::ICampaign;
     use tokengiver::interfaces::IERC721::{IERC721Dispatcher, IERC721DispatcherTrait};
     use tokengiver::interfaces::IGovernanceToken::{
-        IGovernanceTokenDispatcher, IGovernanceTokenDispatcherTrait
+        IGovernanceTokenDispatcher, IGovernanceTokenDispatcherTrait,
     };
-    use tokengiver::interfaces::ICampaign::ICampaign;
-    use tokengiver::base::types::Campaign;
-    use tokengiver::base::errors::Errors::{
-        NOT_CAMPAIGN_OWNER, INSUFFICIENT_BALANCE, TRANSFER_FAILED, NOT_CONTRACT_OWNER
+    use tokengiver::interfaces::IRegistry::{
+        IRegistryDispatcher, IRegistryDispatcherTrait, IRegistryLibraryDispatcher,
     };
-    use openzeppelin::token::erc20::interface::{IERC20Dispatcher, IERC20DispatcherTrait};
-    use openzeppelin::access::ownable::OwnableComponent;
-    use openzeppelin::upgrades::UpgradeableComponent;
-    use openzeppelin::upgrades::interface::IUpgradeable;
-    use token_bound_accounts::interfaces::ILockable::{
-        ILockableDispatcher, ILockableDispatcherTrait
+    use tokengiver::interfaces::ITokenGiverNft::{
+        ITokenGiverNftDispatcher, ITokenGiverNftDispatcherTrait,
     };
 
     component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);
@@ -65,7 +68,7 @@ mod TokengiverCampaigns {
         donations: Map<ContractAddress, u256>,
         donation_count: Map<ContractAddress, u16>,
         donation_details: Map<
-            (ContractAddress, ContractAddress), DonationDetails
+            (ContractAddress, ContractAddress), DonationDetails,
         >, // map((), donation_details)
         campaign_nft_token: Map<ContractAddress, (ContractAddress, u256)>,
         strk_address: ContractAddress,
@@ -144,7 +147,7 @@ mod TokengiverCampaigns {
         token_giver_nft_class_hash: ClassHash,
         token_giver_nft_contract_address: ContractAddress,
         strk_address: ContractAddress,
-        owner: ContractAddress
+        owner: ContractAddress,
     ) {
         self.token_giver_nft_class_hash.write(token_giver_nft_class_hash);
         self.token_giver_nft_contract_address.write(token_giver_nft_contract_address);
@@ -178,7 +181,7 @@ mod TokengiverCampaigns {
 
             //set dispatcher
             let token_giver_dispatcher = ITokenGiverNftDispatcher {
-                contract_address: token_giver_nft_contract_address
+                contract_address: token_giver_nft_contract_address,
             };
 
             // mint the nft
@@ -189,10 +192,10 @@ mod TokengiverCampaigns {
             let token_id = token_giver_dispatcher.get_user_token_id(get_caller_address());
 
             let campaign_address = IRegistryLibraryDispatcher {
-                class_hash: registry_hash.try_into().unwrap()
+                class_hash: registry_hash.try_into().unwrap(),
             }
                 .create_account(
-                    implementation_hash, token_giver_nft_contract_address, token_id.clone(), salt
+                    implementation_hash, token_giver_nft_contract_address, token_id.clone(), salt,
                 );
 
             let token_uri = token_giver_dispatcher.get_token_uri(token_id);
@@ -224,7 +227,7 @@ mod TokengiverCampaigns {
                         token_giver_nft_address: token_giver_nft_contract_address,
                         nft_token_uri: token_uri,
                         block_timestamp: get_block_timestamp(),
-                    }
+                    },
                 );
 
             campaign_address
@@ -254,8 +257,8 @@ mod TokengiverCampaigns {
 
             // get instance of the governance token
             let governance_token = IGovernanceTokenDispatcher {
-                contract_address: contract_address_const::<0x0, // change to real address
-                >()
+                contract_address: contract_address_const::<0x0 // change to real address
+                >(),
             };
 
             let time = get_block_timestamp();
@@ -271,7 +274,7 @@ mod TokengiverCampaigns {
                         amount: amount,
                         token_id: campaign.token_id,
                         block_timestamp: time,
-                    }
+                    },
                 );
         }
 
@@ -306,18 +309,18 @@ mod TokengiverCampaigns {
                         recipient: caller,
                         amount: amount,
                         block_timestamp: get_block_timestamp(),
-                    }
+                    },
                 );
         }
 
         fn set_available_withdrawal(
-            ref self: ContractState, campaign_address: ContractAddress, amount: u256
+            ref self: ContractState, campaign_address: ContractAddress, amount: u256,
         ) {
             self.withdrawal_balance.write(campaign_address, amount);
         }
 
         fn lock_campaign(
-            ref self: ContractState, campaign_address: ContractAddress, lock_until: u64
+            ref self: ContractState, campaign_address: ContractAddress, lock_until: u64,
         ) {
             // Get campaign details
             let campaign: Campaign = self.campaign.read(campaign_address);
@@ -338,7 +341,7 @@ mod TokengiverCampaigns {
             self.donations.read(campaign_address)
         }
         fn get_available_withdrawal(
-            self: @ContractState, campaign_address: ContractAddress
+            self: @ContractState, campaign_address: ContractAddress,
         ) -> u256 {
             // self.withdrawal_balance.read(campaign_address)
             let token_address = self.strk_address.read();
@@ -366,7 +369,7 @@ mod TokengiverCampaigns {
         fn update_token_giver_nft(
             ref self: ContractState,
             token_giver_nft_class_hash: ClassHash,
-            token_giver_nft_contract_address: ContractAddress
+            token_giver_nft_contract_address: ContractAddress,
         ) {
             // This function can only be called by the owner
             self.ownable.assert_only_owner();

src/campaign_pool.cairo

@@ -5,23 +5,28 @@ mod CampaignPools {
     // *************************************************************************
     //                            IMPORT
     // *************************************************************************
+    use core::num::traits::Zero;
     use core::traits::TryInto;
-    use starknet::{
-        ContractAddress, get_caller_address, get_block_timestamp, ClassHash, get_contract_address,
-        syscalls::deploy_syscall, SyscallResultTrait, syscalls, class_hash::class_hash_const,
-        storage::{Map, StoragePathEntry, StoragePointerReadAccess, StoragePointerWriteAccess}
-    };
-    use tokengiver::base::errors::Errors;
-    use tokengiver::interfaces::ICampaignPool::ICampaignPool;
-    use tokengiver::base::types::CampaignPool;
     use openzeppelin::access::ownable::OwnableComponent;
     use openzeppelin::upgrades::UpgradeableComponent;
     use openzeppelin::upgrades::interface::IUpgradeable;
-    use tokengiver::interfaces::ITokenGiverNft::{
-        ITokenGiverNftDispatcher, ITokenGiverNftDispatcherTrait
+    use starknet::class_hash::class_hash_const;
+    use starknet::storage::{
+        Map, StoragePathEntry, StoragePointerReadAccess, StoragePointerWriteAccess,
     };
+    use starknet::syscalls::deploy_syscall;
+    use starknet::{
+        ClassHash, ContractAddress, SyscallResultTrait, get_block_timestamp, get_caller_address,
+        get_contract_address, syscalls,
+    };
+    use tokengiver::base::errors::Errors;
+    use tokengiver::base::types::CampaignPool;
+    use tokengiver::interfaces::ICampaignPool::ICampaignPool;
     use tokengiver::interfaces::IRegistry::{
-        IRegistryDispatcher, IRegistryDispatcherTrait, IRegistryLibraryDispatcher
+        IRegistryDispatcher, IRegistryDispatcherTrait, IRegistryLibraryDispatcher,
+    };
+    use tokengiver::interfaces::ITokenGiverNft::{
+        ITokenGiverNftDispatcher, ITokenGiverNftDispatcherTrait,
     };
 
     component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);
@@ -40,16 +45,16 @@ mod CampaignPools {
     struct Storage {
         campaign_pool: Map<ContractAddress, CampaignPool>,
         campaign_pool_applications: Map<
-            ContractAddress, (ContractAddress, u256)
+            ContractAddress, (ContractAddress, u256),
         >, // map<Campaign Address, (campaign pool address, amount)>
         campaign_pool_count: u16,
         campaign_pool_nft_token: Map<
-            ContractAddress, (ContractAddress, u256)
+            ContractAddress, (ContractAddress, u256),
         >, // (recipient, (campaign_address, token_id));
         donations: Map<ContractAddress, u256>,
         donation_count: Map<ContractAddress, u16>,
         donation_details: Map<
-            (ContractAddress, ContractAddress), DonationDetails
+            (ContractAddress, ContractAddress), DonationDetails,
         >, // map((campaign pool address, Campaign Address), donation_details)
         strk_address: ContractAddress,
         token_giver_nft_contract_address: ContractAddress,
@@ -59,6 +64,8 @@ mod CampaignPools {
         ownable: OwnableComponent::Storage,
         #[substorage(v0)]
         upgradeable: UpgradeableComponent::Storage,
+        donor_votes: Map<(ContractAddress, ContractAddress), VoteData>,
+        campaign_votes_count: Map<ContractAddress, u256>,
     }
 
 
@@ -71,12 +78,20 @@ mod CampaignPools {
         CreateCampaignPool: CreateCampaignPool,
         DonationMade: DonationMade,
         ApplicationMade: ApplicationMade,
+        DonorVoted: DonorVoted,
         #[flat]
         OwnableEvent: OwnableComponent::Event,
         #[flat]
         UpgradeableEvent: UpgradeableComponent::Event,
     }
 
+    #[derive(Drop, starknet::Event)]
+    pub struct DonorVoted {
+        campaign_address: ContractAddress,
+        donor_address: ContractAddress,
+        time: u64,
+    }
+
     #[derive(Drop, starknet::Event)]
     pub struct CreateCampaignPool {
         #[key]
@@ -121,6 +136,12 @@ mod CampaignPools {
         amount: u256,
     }
 
+    #[derive(Drop, Copy, Serde, starknet::Store)]
+    pub struct VoteData {
+        campaign_address: ContractAddress,
+        donor: ContractAddress,
+    }
+
     // *************************************************************************
     //                              CONSTRUCTOR
     // *************************************************************************
@@ -130,7 +151,7 @@ mod CampaignPools {
         token_giver_nft_class_hash: ClassHash,
         token_giver_nft_contract_address: ContractAddress,
         strk_address: ContractAddress,
-        owner: ContractAddress
+        owner: ContractAddress,
     ) {
         self.token_giver_nft_class_hash.write(token_giver_nft_class_hash);
         self.token_giver_nft_contract_address.write(token_giver_nft_contract_address);
@@ -155,15 +176,15 @@ mod CampaignPools {
             let campaign_pool_count: u16 = self.campaign_pool_count.read() + 1;
             let token_giver_nft_contract_address = self.token_giver_nft_contract_address.read();
             let nft_contract_dispatcher = ITokenGiverNftDispatcher {
-                contract_address: token_giver_nft_contract_address
+                contract_address: token_giver_nft_contract_address,
             };
             let token_id: u256 = nft_contract_dispatcher.mint_token_giver_nft(get_caller_address());
 
             let campaign_address = IRegistryLibraryDispatcher {
-                class_hash: registry_hash.try_into().unwrap()
+                class_hash: registry_hash.try_into().unwrap(),
             }
                 .create_account(
-                    implementation_hash, token_giver_nft_contract_address, token_id.clone(), salt
+                    implementation_hash, token_giver_nft_contract_address, token_id.clone(), salt,
                 );
             let token_uri = nft_contract_dispatcher.get_token_uri(token_id);
             let campaign_details = CampaignPool {
@@ -187,26 +208,57 @@ mod CampaignPools {
                         campaign_pool_id: campaign_pool_count.try_into().unwrap(),
                         nft_token_uri: token_uri.clone(),
                         token_giver_nft_address: token_giver_nft_contract_address,
-                        block_timestamp: get_block_timestamp()
-                    }
+                        block_timestamp: get_block_timestamp(),
+                    },
                 );
 
             campaign_address
         }
 
+        fn vote_project(
+            ref self: ContractState,
+            campaign_pool_address: ContractAddress,
+            campaign_address: ContractAddress,
+        ) {
+            let caller = get_caller_address();
+
+            let user_votes = self.donor_votes.read((caller, campaign_address));
+            let caller_donation = self.donations.read(caller);
+            let campaign_count = self.campaign_votes_count.read(campaign_address);
+
+            assert(caller_donation > 0, 'Caller not donor');
+
+            assert(user_votes.donor.is_non_zero(), 'Voted already');
+
+            let new_vote = VoteData { campaign_address: campaign_address, donor: caller };
+
+            self.donor_votes.write((caller, campaign_address), new_vote);
+
+            self.campaign_votes_count.write(campaign_address, campaign_count + 1);
+
+            self
+                .emit(
+                    DonorVoted {
+                        campaign_address: campaign_address,
+                        donor_address: caller,
+                        time: get_block_timestamp(),
+                    },
+                );
+        }
+
         fn get_campaign(self: @ContractState, campaign_address: ContractAddress) -> CampaignPool {
             self.campaign_pool.read(campaign_address)
         }
 
         fn donate_campaign_pool(
-            ref self: ContractState, campaign_pool_address: ContractAddress, amount: u256
+            ref self: ContractState, campaign_pool_address: ContractAddress, amount: u256,
         ) {}
 
         fn apply_to_campaign_pool(
             ref self: ContractState,
             campaign_address: ContractAddress,
             campaign_pool_address: ContractAddress,
-            amount: u256
+            amount: u256,
         ) {
             // Get caller address to identify who is applying
             let caller = get_caller_address();
@@ -243,11 +295,11 @@ mod CampaignPools {
                         recipient: caller,
                         amount: amount,
                         block_timestamp: get_block_timestamp(),
-                    }
+                    },
                 );
         }
         fn get_campaign_application(
-            self: @ContractState, campaign_address: ContractAddress
+            self: @ContractState, campaign_address: ContractAddress,
         ) -> (ContractAddress, u256) {
             self.campaign_pool_applications.read(campaign_address)
         }

src/interfaces/ICampaign.cairo

@@ -1,4 +1,4 @@
-use starknet::{ContractAddress, ClassHash};
+use starknet::{ClassHash, ContractAddress};
 use tokengiver::base::types::Campaign;
 // *************************************************************************
 //                              INTERFACE of TOKEN GIVER NFT
@@ -27,7 +27,7 @@ pub trait ICampaign<TState> {
     fn update_token_giver_nft(
         ref self: TState,
         token_giver_nft_class_hash: ClassHash,
-        token_giver_nft_contract_address: ContractAddress
+        token_giver_nft_contract_address: ContractAddress,
     );
 
     //     fn approve_campaign_spending(ref self: TState, campaign_address: ContractAddress);