[feat] #327 Add Legacy Map to Fund Contract for Donation Tracking #334

CollinsC1O · 2025-01-23T15:06:55Z

Description:

This pull request implements donor tracking functionality in the fund contract as requested in issue #327. The implementation introduces a permanent record of donor contributions while maintaining the contract's existing behavior.

Changes Made:

Storage Addition:

Added legacy map for donor addresses and totals

The LegacyMap creates an on-chain record that maps donor addresses to their total contributed amounts. When a new donor makes their first contribution, they are automatically initialized with a zero balance.

The update_receive_donation function now:

Retrieves the caller's address once and stores it for consistent use
Reads the donor's previous total from storage
Updates their total by adding the new donation
Maintains existing goal-checking logic
Emits the donation event with proper donor attribution

Requirements Fulfilled:

✓ Added legacy map to store donator addresses
✓ Track total amount donated by each donor
✓ Update donation records before event emission
✓ Maintain existing contract functionality
✓ Handle both new and existing donors correctly

Current output

Evidence that the code compiles successfully:

Evidence that code was formatted:

Evidence that all test cases passed successfully:

Note:

Commented my implementation/changes to have a clear and well explained code
'scarb build' used for compiling the code
'scarb fmt' for formatting the code, to have a clean code structure
used scarb version 2.6.5, cairo version 2.6.4, sierra version 1.5.0, snforge version 0.27.0

…onations

CollinsC1O · 2025-01-23T15:12:13Z

Hello @EmmanuelAR, I wanted to confirm if I'm to provide test cases for my implementations considering there is an issue #328 to address creating unit test for legacy map. let me Know if I'm to provide this test case for clarity. Thank you

I will love to get your telegram handle or the projects telegram handle, or any means in which I can reach out to you or any member of the team, that's if its ok

EmmanuelAR · 2025-01-23T15:41:12Z

Hey @CollinsC1O, yes the unit test will be work in other issue.

Our discord channel: https://discord.gg/sEpnC6JB2U

tks for the pr, let me check it

EmmanuelAR · 2025-01-23T15:42:34Z

Hey @CollinsC1O could you please add the evidence of

scarb build
scarb fmt
scarb test

please :)

EmmanuelAR · 2025-01-23T15:43:58Z

Also @CollinsC1O, please check this important note attach to the ticket:

Captura de pantalla 2025-01-23 a la(s) 9 43 16 a m

CollinsC1O · 2025-01-23T16:02:13Z

ok I will provide all that you require of me

…and ensure code quality

CollinsC1O · 2025-01-23T16:29:23Z

Hello @EmmanuelAR, below are the provided evidences as also included in the description above, updating the comment

Evidence that code was formatted:

- Evidence that the code compiles successfully:

- Evidence that all test cases passed successfully:

EmmanuelAR · 2025-01-23T16:32:11Z

src/fund.cairo

@@ -88,6 +88,7 @@ pub mod Fund {
        reason: ByteArray,
        up_votes: u32,
        voters: LegacyMap::<ContractAddress, u32>,
+        donator_totals: LegacyMap::<ContractAddress, u256>, // Track total donations per address


Please called the legacy map as: donators
Also remove the comment

EmmanuelAR · 2025-01-23T16:32:29Z

src/fund.cairo

@@ -205,6 +206,12 @@ pub mod Fund {
        }
        fn update_receive_donation(ref self: ContractState, strks: u256) {
            let current_balance = self.get_current_goal_state();
+            // Get caller address


remove this comment

EmmanuelAR · 2025-01-23T16:32:44Z

src/fund.cairo

@@ -205,6 +206,12 @@ pub mod Fund {
        }
        fn update_receive_donation(ref self: ContractState, strks: u256) {
            let current_balance = self.get_current_goal_state();
+            // Get caller address
+            let caller: ContractAddress = get_caller_address();
+            // Read donor's existing total


remove this comment

EmmanuelAR · 2025-01-23T16:32:51Z

src/fund.cairo

+            let caller: ContractAddress = get_caller_address();
+            // Read donor's existing total
+            let prev_total = self.donator_totals.read(caller);
+            // Add current donation to their running total (adding donation)


remove this comment

removing all comments

…donators and remove coments

CollinsC1O · 2025-01-23T17:09:59Z

Hello @EmmanuelAR all requested changes have been observed and implemented. Thanks for your review

EmmanuelAR

lgtm

Collins C Augustine added 2 commits January 23, 2025 15:04

feat: Add legacy map to storage struct to store donator addresses & d…

0b58907

…onations

feat: Update receive_donation method to track donor totals

ff20d9b

EmmanuelAR requested review from EmmanuelAR and adrianvrj January 23, 2025 15:35

CollinsC1O and others added 2 commits January 23, 2025 17:07

Merge branch 'undefinedorgcr:dev' into donor-totals

21d2b36

fix: (undefinedorgcr#327) Add comments to update_receive_donation fn …

dbb1e11

…and ensure code quality

EmmanuelAR requested changes Jan 23, 2025

View reviewed changes

fix: (undefinedorgcr#327) change the storage fild; donator_totals to …

ed5fb37

…donators and remove coments

EmmanuelAR approved these changes Jan 23, 2025

View reviewed changes

EmmanuelAR merged commit 5ac4435 into undefinedorgcr:dev Jan 23, 2025

EmmanuelAR linked an issue Jan 23, 2025 that may be closed by this pull request

[feat] Add Legacy Map to Fund Contract #327

Closed

EmmanuelAR mentioned this pull request Jan 23, 2025

[feat] Add Legacy Map to Fund Contract #327

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] #327 Add Legacy Map to Fund Contract for Donation Tracking #334

[feat] #327 Add Legacy Map to Fund Contract for Donation Tracking #334

CollinsC1O commented Jan 23, 2025 •

edited

Loading

CollinsC1O commented Jan 23, 2025 •

edited

Loading

EmmanuelAR commented Jan 23, 2025

EmmanuelAR commented Jan 23, 2025

EmmanuelAR commented Jan 23, 2025

CollinsC1O commented Jan 23, 2025

CollinsC1O commented Jan 23, 2025

EmmanuelAR Jan 23, 2025

CollinsC1O Jan 23, 2025

EmmanuelAR Jan 23, 2025

CollinsC1O Jan 23, 2025

EmmanuelAR Jan 23, 2025

CollinsC1O Jan 23, 2025

EmmanuelAR Jan 23, 2025

CollinsC1O Jan 23, 2025

CollinsC1O commented Jan 23, 2025 •

edited

Loading

EmmanuelAR left a comment

[feat] #327 Add Legacy Map to Fund Contract for Donation Tracking #334

[feat] #327 Add Legacy Map to Fund Contract for Donation Tracking #334

Conversation

CollinsC1O commented Jan 23, 2025 • edited Loading

Description:

Changes Made:

Storage Addition:

The update_receive_donation function now:

Requirements Fulfilled:

Current output

CollinsC1O commented Jan 23, 2025 • edited Loading

EmmanuelAR commented Jan 23, 2025

EmmanuelAR commented Jan 23, 2025

EmmanuelAR commented Jan 23, 2025

CollinsC1O commented Jan 23, 2025

CollinsC1O commented Jan 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CollinsC1O commented Jan 23, 2025 • edited Loading

EmmanuelAR left a comment

Choose a reason for hiding this comment

CollinsC1O commented Jan 23, 2025 •

edited

Loading

CollinsC1O commented Jan 23, 2025 •

edited

Loading

CollinsC1O commented Jan 23, 2025 •

edited

Loading