returned min_units_for_deposit as min_campaign_budget

Author: simzzz

adapter/src/dummy.rs

@@ -209,6 +209,7 @@ mod test {
         let channel_context = ChainOf {
             context: channel,
             token: TokenInfo {
+                min_campaign_budget: 1_u64.into(),
                 min_validator_fee: 1_u64.into(),
                 precision: NonZeroU8::new(UnifiedNum::PRECISION).expect("Non zero u8"),
                 address: channel.token,

adapter/src/ethereum/client.rs

@@ -684,7 +684,7 @@ mod test {
             let web3 = GANACHE_1.init_web3().expect("Init web3");
 
             // deploy contracts
-            let token = Erc20Token::deploy(&web3)
+            let token = Erc20Token::deploy(&web3, 1_000)
                 .await
                 .expect("Correct parameters are passed to the Token constructor.");
 

adapter/src/ethereum/test_util.rs

@@ -258,7 +258,10 @@ impl Erc20Token {
     }
 
     /// Deploys the Mock Token contract from [`LEADER`]
-    pub async fn deploy(web3: &Web3<Http>) -> web3::contract::Result<Self> {
+    pub async fn deploy(
+        web3: &Web3<Http>,
+        min_campaign_budget: u64,
+    ) -> web3::contract::Result<Self> {
         let token_contract = Contract::deploy(web3.eth(), &MOCK_TOKEN_ABI)
             .expect("Invalid ABI of Mock Token contract")
             .confirmations(0)
@@ -272,6 +275,7 @@ impl Erc20Token {
         let token_address = Address::from(token_contract.address().to_fixed_bytes());
 
         let token_info = TokenInfo {
+            min_campaign_budget: BigNum::from(min_campaign_budget),
             precision: NonZeroU8::new(18).expect("should create NonZeroU8"),
             // 0.000_001
             min_validator_fee: BigNum::from(1_000_000_000_000),

adapter/tests/dummy.rs

@@ -82,6 +82,7 @@ async fn main() {
     let channel_context = ChainOf {
         context: DUMMY_CAMPAIGN.channel,
         token: TokenInfo {
+            min_campaign_budget: 1_u64.into(),
             min_validator_fee: 1_u64.into(),
             precision: NonZeroU8::new(18).unwrap(),
             address: "0x6B83e7D6B72c098d48968441e0d05658dc17Adb9"

docs/config/dev.toml

@@ -54,17 +54,23 @@ sweeper = '0x333420fc6a897356e69b62417cd17ff012177d2b'
     [chain."Ethereum Mainnet".token.DAI]
     address = '0x6B175474E89094C44Da98b954EedeAC495271d0F' # checked
     precision = 18
+    # 1 * 10^-10 = 0.0_000_000_001
+    min_campaign_budget = '100000000'
     min_validator_fee = '100000000'
 
     [chain."Ethereum Mainnet".token.USDT]
     address = '0xdAC17F958D2ee523a2206206994597C13D831ec7' # checked
     precision = 6
+    # 1.000_000
+    min_campaign_budget = '1000000'
     # 0.001
     min_validator_fee = '1000'
 
     [chain."Ethereum Mainnet".token.USDC]
     address = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' # checked
     precision = 6
+    # 1.000_000
+    min_campaign_budget = '1000000'
     # 0.001
     min_validator_fee = '1000'
 
@@ -80,6 +86,8 @@ sweeper = '0x333420fc6a897356e69b62417cd17ff012177d2b'
     [chain."Ethereum Ropsten".token.DAI]
     address = '0x65600c50Ea42e225368Ded6c3789a539284aA62C' # checked
     precision = 18
+    # 1 * 10^-10 = 0.0_000_000_001
+    min_campaign_budget = '100000000'
     min_validator_fee = '100000000'
 
     # [chain."Ethereum Ropsten".token.USDT]

docs/config/ganache.toml

@@ -56,6 +56,8 @@ outpace = '0x26CBc2eAAe377f6Ac4b73a982CD1125eF4CEC96f'
     [chain."Ganache #1".token."Mocked TOKEN 1"]
     address = '0x12a28f2bfBFfDf5842657235cC058242f40fDEa6' # checked
     precision = 18
+    # 1 * 10^18 = 1.0000 TOKEN
+    min_campaign_budget = '1000000000000000000'
     # multiplier = 10^12 - 10^18 (token precision) = 10^-6
     # min_validator_fee = 1 * 10^-6 = 0.000_001
     min_validator_fee = '1000000000000'
@@ -70,6 +72,8 @@ outpace = '0xAbc27d46a458E2e49DaBfEf45ca74dEDBAc3DD06'
     [chain."Ganache #1337".token."Mocked TOKEN 1337"]
     address = '0x2bcaf6968aec8a3b5126fbfab5fd419da6e8ad8e' # checked
     precision = 18
+    # 1 * 10^18 = 1.0000 TOKEN
+    min_campaign_budget = '1000000000000000000'
     # multiplier = 10^12 - 10^18 (token precision) = 10^-6
     # min_validator_fee = 1 * 10^-6 = 0.000_001
     min_validator_fee = '1000000000000'

docs/config/prod.toml

@@ -31,19 +31,25 @@ admins = ['0x5d6A3F1AD7b124ecDFDf4841D9bB246eD5fBF04c']
 # DAI
 # Polygon: https://polygonscan.com/token/0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063
 address = '0x6b175474e89094c44da98b954eedeac495271d0f'
+# 1 * 10^-10 = 0.0_000_000_001
+min_campaign_budget = '100000000'
 min_validator_fee = '100000000'
 precision = 18
 
 [[token_address_whitelist]]
 # SAI
 address = '0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359'
+# 1 * 10^-10 = 0.0_000_000_001
+min_campaign_budget = '100000000'
 min_validator_fee = '100000000'
 precision = 18
 
 [[token_address_whitelist]]
 # USDT
 # Polygon: https://polygonscan.com/token/0xc2132d05d31c914a87c6611c10748aeb04b58e8f
 address = '0xdac17f958d2ee523a2206206994597c13d831ec7'
+# 1.000_000
+min_campaign_budget = '1000000'
 # 0.001
 min_validator_fee = '1000'
 precision = 6
@@ -52,6 +58,8 @@ precision = 6
 # USDC
 # Polygon: https://polygonscan.com/token/0x2791bca1f2de4661ed88a30c99a7a9449aa84174
 address = '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
+# 1.000_000
+min_campaign_budget = '100000000'
 # 0.001
 min_validator_fee = '1000'
 precision = 6

primitives/src/campaign_validator.rs

@@ -24,6 +24,7 @@ pub enum Validation {
     UnlistedValidator,
     UnlistedCreator,
     UnlistedAsset,
+    MinimumDepositNotMet,
     MinimumValidatorFeeNotMet,
     FeeConstraintViolated,
 }
@@ -71,6 +72,15 @@ impl Validator for Campaign {
             .find_chain_of(self.channel.token)
             .ok_or(Validation::UnlistedAsset)?;
 
+        // Check if the campaign budget is above the minimum deposit configured
+        if self
+            .budget
+            .to_precision(chain_context.token.precision.get())
+            < chain_context.token.min_campaign_budget
+        {
+            return Err(Validation::MinimumDepositNotMet.into());
+        }
+
         // Check if the validator fee is greater than the minimum configured fee
         if whoami_validator
             .fee
@@ -289,6 +299,20 @@ mod test {
             );
         }
 
+        // budget < min_deposit
+        {
+            let mut campaign = DUMMY_CAMPAIGN.clone();
+            campaign.budget = UnifiedNum::from_u64(0);
+
+            let validation_error = campaign
+                .validate(&config, IDS[&LEADER])
+                .expect_err("Should trigger validation error");
+            assert_eq!(
+                Error::Validation(Validation::MinimumDepositNotMet),
+                validation_error,
+            );
+        }
+
         // validator_fee < min_fee
         {
             let campaign = DUMMY_CAMPAIGN.clone();
@@ -316,99 +340,99 @@ mod test {
             );
         }
 
-        // let sum_fees = |validators: &Validators| -> UnifiedNum {
-        //     validators
-        //         .iter()
-        //         .map(|validator| validator.fee)
-        //         .sum::<Option<_>>()
-        //         .expect("Validators sum of fees should not overflow")
-        // };
-
-        // // total_fee > budget
-        // // budget = total_fee - 1
-        // {
-        //     let mut campaign = DUMMY_CAMPAIGN.clone();
-        //     let campaign_token = config.find_chain_of(campaign.channel.token).unwrap().token;
-
-        //     // makes the sum of all validator fees = 2 * min token units for deposit
-        //     campaign.validators = {
-        //         let new_validators = campaign
-        //             .validators
-        //             .iter()
-        //             .map(|validator| {
-        //                 let mut new_validator = validator.clone();
-        //                 new_validator.fee = UnifiedNum::from_precision(
-        //                     campaign_token.min_token_units_for_deposit.clone(),
-        //                     campaign_token.precision.into(),
-        //                 )
-        //                 .expect("Should not overflow");
-
-        //                 new_validator
-        //             })
-        //             .collect::<Vec<_>>();
-
-        //         assert_eq!(
-        //             2,
-        //             new_validators.len(),
-        //             "Dummy Campaign validators should always be 2 - a leader & a follower"
-        //         );
-
-        //         Validators::new((new_validators[0].clone(), new_validators[1].clone()))
-        //     };
-
-        //     campaign.budget = sum_fees(&campaign.validators) - UnifiedNum::from(1);
-
-        //     let validation_error = campaign
-        //         .validate(&config, IDS[&LEADER])
-        //         .expect_err("Should trigger validation error");
-        //     assert_eq!(
-        //         Error::Validation(Validation::FeeConstraintViolated),
-        //         validation_error,
-        //     );
-        // }
-
-        // // total_fee = budget
-        // {
-        //     let mut campaign = DUMMY_CAMPAIGN.clone();
-
-        //     let campaign_token = config.find_chain_of(campaign.channel.token).unwrap().token;
-
-        //     // makes the sum of all validator fees = 2 * min token units for deposit
-        //     campaign.validators = {
-        //         let new_validators = campaign
-        //             .validators
-        //             .iter()
-        //             .map(|validator| {
-        //                 let mut new_validator = validator.clone();
-        //                 new_validator.fee = UnifiedNum::from_precision(
-        //                     campaign_token.min_token_units_for_deposit.clone(),
-        //                     campaign_token.precision.into(),
-        //                 )
-        //                 .expect("Should not overflow");
-
-        //                 new_validator
-        //             })
-        //             .collect::<Vec<_>>();
-
-        //         assert_eq!(
-        //             2,
-        //             new_validators.len(),
-        //             "Dummy Campaign validators should always be 2 - a leader & a follower"
-        //         );
-
-        //         Validators::new((new_validators[0].clone(), new_validators[1].clone()))
-        //     };
-
-        //     campaign.budget = sum_fees(&campaign.validators);
-
-        //     let validation_error = campaign
-        //         .validate(&config, IDS[&LEADER])
-        //         .expect_err("Should trigger validation error");
-        //     assert_eq!(
-        //         Error::Validation(Validation::FeeConstraintViolated),
-        //         validation_error,
-        //     );
-        // }
+        let sum_fees = |validators: &Validators| -> UnifiedNum {
+            validators
+                .iter()
+                .map(|validator| validator.fee)
+                .sum::<Option<_>>()
+                .expect("Validators sum of fees should not overflow")
+        };
+
+        // total_fee > budget
+        // budget = total_fee - 1
+        {
+            let mut campaign = DUMMY_CAMPAIGN.clone();
+            let campaign_token = config.find_chain_of(campaign.channel.token).unwrap().token;
+
+            // makes the sum of all validator fees = 2 * min token units for deposit
+            campaign.validators = {
+                let new_validators = campaign
+                    .validators
+                    .iter()
+                    .map(|validator| {
+                        let mut new_validator = validator.clone();
+                        new_validator.fee = UnifiedNum::from_precision(
+                            campaign_token.min_campaign_budget.clone(),
+                            campaign_token.precision.into(),
+                        )
+                        .expect("Should not overflow");
+
+                        new_validator
+                    })
+                    .collect::<Vec<_>>();
+
+                assert_eq!(
+                    2,
+                    new_validators.len(),
+                    "Dummy Campaign validators should always be 2 - a leader & a follower"
+                );
+
+                Validators::new((new_validators[0].clone(), new_validators[1].clone()))
+            };
+
+            campaign.budget = sum_fees(&campaign.validators) - UnifiedNum::from(1);
+
+            let validation_error = campaign
+                .validate(&config, IDS[&LEADER])
+                .expect_err("Should trigger validation error");
+            assert_eq!(
+                Error::Validation(Validation::FeeConstraintViolated),
+                validation_error,
+            );
+        }
+
+        // total_fee = budget
+        {
+            let mut campaign = DUMMY_CAMPAIGN.clone();
+
+            let campaign_token = config.find_chain_of(campaign.channel.token).unwrap().token;
+
+            // makes the sum of all validator fees = 2 * min token units for deposit
+            campaign.validators = {
+                let new_validators = campaign
+                    .validators
+                    .iter()
+                    .map(|validator| {
+                        let mut new_validator = validator.clone();
+                        new_validator.fee = UnifiedNum::from_precision(
+                            campaign_token.min_campaign_budget.clone(),
+                            campaign_token.precision.into(),
+                        )
+                        .expect("Should not overflow");
+
+                        new_validator
+                    })
+                    .collect::<Vec<_>>();
+
+                assert_eq!(
+                    2,
+                    new_validators.len(),
+                    "Dummy Campaign validators should always be 2 - a leader & a follower"
+                );
+
+                Validators::new((new_validators[0].clone(), new_validators[1].clone()))
+            };
+
+            campaign.budget = sum_fees(&campaign.validators);
+
+            let validation_error = campaign
+                .validate(&config, IDS[&LEADER])
+                .expect_err("Should trigger validation error");
+            assert_eq!(
+                Error::Validation(Validation::FeeConstraintViolated),
+                validation_error,
+            );
+        }
 
         // should validate
         {

primitives/src/config.rs

@@ -164,6 +164,7 @@ impl ChainInfo {
 /// Precision can differ for the same token from one [`Chain`] to another.
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Hash)]
 pub struct TokenInfo {
+    pub min_campaign_budget: BigNum,
     pub min_validator_fee: BigNum,
     pub precision: NonZeroU8,
     pub address: Address,

sentry/Cargo.toml

@@ -40,7 +40,10 @@ redis = { version = "0.21", features = ["aio", "tokio-comp"] }
 deadpool = "0.9"
 deadpool-postgres = "0.10"
 # Should be the same version as in `primitives` and `deadpool-postgres`!
-tokio-postgres = { version = "0.7", features = ["with-chrono-0_4", "with-serde_json-1"] }
+tokio-postgres = { version = "0.7", features = [
+  "with-chrono-0_4",
+  "with-serde_json-1",
+] }
 postgres-types = { version = "0.2", features = [
   "derive",
   "with-chrono-0_4",