Merge pull request #123 from Fundable-Protocol/refactor_distribute

Add unique_ref to distribute function and Distribution event

Author: mubarak23

src/base/types.cairo

@@ -28,6 +28,8 @@ pub struct Distribution {
     #[key]
     pub amount: u256,
     #[key]
+    pub unique_ref: felt252,
+    #[key]
     pub recipients_count: u32,
 }
 
@@ -41,6 +43,8 @@ pub struct WeightedDistribution {
     pub recipient: ContractAddress,
     #[key]
     pub amount: u256,
+    #[key]
+    pub unique_ref: felt252,
 }
 
 /// @notice Enum representing the possible states of a stream
@@ -77,6 +81,7 @@ pub struct DistributionHistory {
     pub token: ContractAddress,
     pub amount: u256,
     pub recipients_count: u32,
+    pub unique_ref: felt252,
     pub timestamp: u64,
 }
 

src/distribute.cairo

@@ -131,6 +131,7 @@ mod Distributor {
             amount: u256,
             recipients: Array<ContractAddress>,
             token: ContractAddress,
+            unique_ref: felt252,
         ) {
             // Validate inputs
             assert(!recipients.is_empty(), EMPTY_RECIPIENTS);
@@ -160,7 +161,7 @@ mod Distributor {
             let recipients_list = recipients.span();
             for recipient in recipients {
                 token_dispatcher.transfer_from(caller, recipient, amount);
-                self.emit(WeightedDistribution { caller, token, recipient, amount });
+                self.emit(WeightedDistribution { caller, token, recipient, amount, unique_ref });
             }
 
             // Update global statistics
@@ -176,6 +177,7 @@ mod Distributor {
                         token,
                         amount: amount_to_distribute,
                         recipients_count: recipients_list.len(),
+                        unique_ref,
                         timestamp,
                     },
                 );
@@ -189,6 +191,7 @@ mod Distributor {
                             token,
                             amount: amount_to_distribute,
                             recipients_count: recipients_list.len(),
+                            unique_ref,
                         },
                     ),
                 );
@@ -199,6 +202,7 @@ mod Distributor {
             amounts: Array<u256>,
             recipients: Array<ContractAddress>,
             token: ContractAddress,
+            unique_ref: felt252,
         ) {
             // Validate inputs
             assert(!recipients.is_empty(), EMPTY_RECIPIENTS);
@@ -241,7 +245,7 @@ mod Distributor {
                 token_dispatcher.transfer_from(caller, recipient, amount);
 
                 // Emit event for each distribution
-                self.emit(WeightedDistribution { caller, token, recipient, amount });
+                self.emit(WeightedDistribution { caller, token, recipient, amount, unique_ref });
 
                 i += 1;
             }
@@ -259,6 +263,7 @@ mod Distributor {
                         token,
                         amount: amount_to_distribute,
                         recipients_count: recipients.len(),
+                        unique_ref,
                         timestamp,
                     },
                 );
@@ -272,6 +277,7 @@ mod Distributor {
                             token,
                             amount: amount_to_distribute,
                             recipients_count: recipients.len(),
+                            unique_ref,
                         },
                     ),
                 );

src/interfaces/IDistributor.cairo

@@ -8,11 +8,13 @@ pub trait IDistributor<TContractState> {
     /// @param amount The total amount to distribute
     /// @param recipients Array of recipient addresses to distribute to
     /// @param token The ERC20 token to distribute
+    // @param unique_ref uniquely identify the distrubtion
     fn distribute(
         ref self: TContractState,
         amount: u256,
         recipients: Array<ContractAddress>,
         token: ContractAddress,
+        unique_ref: felt252,
     );
 
     /// @notice Distributes tokens to recipients with custom amounts
@@ -24,6 +26,7 @@ pub trait IDistributor<TContractState> {
         amounts: Array<u256>,
         recipients: Array<ContractAddress>,
         token: ContractAddress,
+        unique_ref: felt252,
     );
 
     /// @notice Gets the current protocol fee percentage