change borrow weight bps to added borrow weight bps

0xripleys · 0xripleys · commit f03e9234f316 · 2023-02-14T13:02:28.000-05:00
diff --git a/token-lending/cli/src/main.rs b/token-lending/cli/src/main.rs
@@ -872,7 +872,7 @@ fn main() {
                     fee_receiver: liquidity_fee_receiver_keypair.pubkey(),
                     protocol_liquidation_fee,
                     protocol_take_rate,
-                    borrow_weight_bps: 10000,
+                    added_borrow_weight_bps: 10000,
                 },
                 source_liquidity_pubkey,
                 source_liquidity_owner_keypair,
diff --git a/token-lending/program/src/processor.rs b/token-lending/program/src/processor.rs
@@ -2877,10 +2877,6 @@ fn validate_reserve_config(config: ReserveConfig) -> ProgramResult {
         msg!("Protocol take rate must be in range [0, 100]");
         return Err(LendingError::InvalidConfig.into());
     }
-    if config.borrow_weight_bps < 10000 {
-        msg!("Borrow weight bps must be greater than 10000!");
-        return Err(LendingError::InvalidConfig.into());
-    }
     Ok(())
 }
 
diff --git a/token-lending/program/tests/borrow_weight.rs b/token-lending/program/tests/borrow_weight.rs
@@ -26,7 +26,7 @@ async fn test_refresh_obligation() {
     let (mut test, lending_market, _, _, _, obligation) = scenario_1(
         &test_reserve_config(),
         &ReserveConfig {
-            borrow_weight_bps: 20_000,
+            added_borrow_weight_bps: 10_000,
             ..test_reserve_config()
         },
     )
@@ -55,7 +55,7 @@ async fn test_borrow() {
     let (mut test, lending_market, usdc_reserve, wsol_reserve, _, _) = setup_world(
         &test_reserve_config(),
         &ReserveConfig {
-            borrow_weight_bps: 20_000,
+            added_borrow_weight_bps: 10_000,
             fees: ReserveFees {
                 borrow_fee_wad: 10_000_000_000_000_000, // 1%
                 host_fee_percentage: 20,
@@ -207,7 +207,7 @@ async fn test_liquidation() {
         setup_world(
             &test_reserve_config(),
             &ReserveConfig {
-                borrow_weight_bps: 10_000,
+                added_borrow_weight_bps: 0,
                 fees: ReserveFees {
                     borrow_fee_wad: 10_000_000_000_000_000, // 1%
                     host_fee_percentage: 20,
@@ -341,7 +341,7 @@ async fn test_liquidation() {
             &lending_market_owner,
             &wsol_reserve,
             ReserveConfig {
-                borrow_weight_bps: 11_000,
+                added_borrow_weight_bps: 1_000,
                 ..wsol_reserve.account.config
             },
             wsol_reserve.account.rate_limiter.config,
diff --git a/token-lending/program/tests/helpers/mod.rs b/token-lending/program/tests/helpers/mod.rs
@@ -53,7 +53,7 @@ pub fn test_reserve_config() -> ReserveConfig {
         fee_receiver: Keypair::new().pubkey(),
         protocol_liquidation_fee: 0,
         protocol_take_rate: 0,
-        borrow_weight_bps: 10_000,
+        added_borrow_weight_bps: 0,
     }
 }
 
diff --git a/token-lending/program/tests/init_reserve.rs b/token-lending/program/tests/init_reserve.rs
@@ -299,35 +299,6 @@ async fn test_invalid_fees() {
     }
 }
 
-#[tokio::test]
-async fn test_init_reserve_invalid_borrow_weight_bps() {
-    let (mut test, lending_market, lending_market_owner) = setup().await;
-    let res = test
-        .init_reserve(
-            &lending_market,
-            &lending_market_owner,
-            &usdc_mint::id(),
-            &ReserveConfig {
-                borrow_weight_bps: 9999,
-                ..test_reserve_config()
-            },
-            &Keypair::new(),
-            1000,
-            None,
-        )
-        .await
-        .unwrap_err()
-        .unwrap();
-
-    assert_eq!(
-        res,
-        TransactionError::InstructionError(
-            1,
-            InstructionError::Custom(LendingError::InvalidConfig as u32)
-        )
-    );
-}
-
 #[tokio::test]
 async fn test_update_reserve_config() {
     let (mut test, lending_market, lending_market_owner) = setup().await;
@@ -424,56 +395,3 @@ async fn test_update_invalid_oracle_config() {
         )
     );
 }
-
-#[tokio::test]
-async fn test_update_invalid_reserve_config_bad_borrow_weight_bps() {
-    let (mut test, lending_market, lending_market_owner) = setup().await;
-    let wsol_reserve = test
-        .init_reserve(
-            &lending_market,
-            &lending_market_owner,
-            &wsol_mint::id(),
-            &test_reserve_config(),
-            &Keypair::new(),
-            1000,
-            None,
-        )
-        .await
-        .unwrap();
-
-    let oracle = test.mints.get(&wsol_mint::id()).unwrap().unwrap();
-
-    let new_reserve_config = ReserveConfig {
-        borrow_weight_bps: 9999,
-        ..test_reserve_config()
-    };
-    let new_rate_limiter_config = RateLimiterConfig {
-        window_duration: 50,
-        max_outflow: 100,
-    };
-
-    let res = lending_market
-        .update_reserve_config(
-            &mut test,
-            &lending_market_owner,
-            &wsol_reserve,
-            new_reserve_config,
-            new_rate_limiter_config,
-            Some(&Oracle {
-                pyth_product_pubkey: oracle.pyth_product_pubkey,
-                pyth_price_pubkey: oracle.pyth_price_pubkey,
-                switchboard_feed_pubkey: Some(NULL_PUBKEY),
-            }),
-        )
-        .await
-        .unwrap_err()
-        .unwrap();
-
-    assert_eq!(
-        res,
-        TransactionError::InstructionError(
-            0,
-            InstructionError::Custom(LendingError::InvalidConfig as u32)
-        )
-    );
-}
diff --git a/token-lending/sdk/src/instruction.rs b/token-lending/sdk/src/instruction.rs
@@ -510,7 +510,7 @@ impl LendingInstruction {
                 let (fee_receiver, rest) = Self::unpack_pubkey(rest)?;
                 let (protocol_liquidation_fee, rest) = Self::unpack_u8(rest)?;
                 let (protocol_take_rate, rest) = Self::unpack_u8(rest)?;
-                let (borrow_weight_bps, _rest) = Self::unpack_u64(rest)?;
+                let (added_borrow_weight_bps, _rest) = Self::unpack_u64(rest)?;
                 Self::InitReserve {
                     liquidity_amount,
                     config: ReserveConfig {
@@ -531,7 +531,7 @@ impl LendingInstruction {
                         fee_receiver,
                         protocol_liquidation_fee,
                         protocol_take_rate,
-                        borrow_weight_bps,
+                        added_borrow_weight_bps,
                     },
                 }
             }
@@ -594,7 +594,7 @@ impl LendingInstruction {
                 let (fee_receiver, rest) = Self::unpack_pubkey(rest)?;
                 let (protocol_liquidation_fee, rest) = Self::unpack_u8(rest)?;
                 let (protocol_take_rate, rest) = Self::unpack_u8(rest)?;
-                let (borrow_weight_bps, rest) = Self::unpack_u64(rest)?;
+                let (added_borrow_weight_bps, rest) = Self::unpack_u64(rest)?;
                 let (window_duration, rest) = Self::unpack_u64(rest)?;
                 let (max_outflow, _rest) = Self::unpack_u64(rest)?;
 
@@ -617,7 +617,7 @@ impl LendingInstruction {
                         fee_receiver,
                         protocol_liquidation_fee,
                         protocol_take_rate,
-                        borrow_weight_bps,
+                        added_borrow_weight_bps,
                     },
                     rate_limiter_config: RateLimiterConfig {
                         window_duration,
@@ -744,7 +744,7 @@ impl LendingInstruction {
                         fee_receiver,
                         protocol_liquidation_fee,
                         protocol_take_rate,
-                        borrow_weight_bps,
+                        added_borrow_weight_bps: borrow_weight_bps,
                     },
             } => {
                 buf.push(2);
@@ -835,7 +835,7 @@ impl LendingInstruction {
                 buf.extend_from_slice(&config.fee_receiver.to_bytes());
                 buf.extend_from_slice(&config.protocol_liquidation_fee.to_le_bytes());
                 buf.extend_from_slice(&config.protocol_take_rate.to_le_bytes());
-                buf.extend_from_slice(&config.borrow_weight_bps.to_le_bytes());
+                buf.extend_from_slice(&config.added_borrow_weight_bps.to_le_bytes());
                 buf.extend_from_slice(&rate_limiter_config.window_duration.to_le_bytes());
                 buf.extend_from_slice(&rate_limiter_config.max_outflow.to_le_bytes());
             }
diff --git a/token-lending/sdk/src/state/reserve.rs b/token-lending/sdk/src/state/reserve.rs
@@ -66,7 +66,9 @@ impl Reserve {
 
     /// get borrow weight. Guaranteed to be greater than 1
     pub fn borrow_weight(&self) -> Decimal {
-        Decimal::from_bps(std::cmp::max(self.config.borrow_weight_bps, 10_000))
+        Decimal::one()
+            .try_add(Decimal::from_bps(self.config.added_borrow_weight_bps))
+            .unwrap()
     }
 
     /// find price of tokens in quote currency
@@ -718,8 +720,9 @@ pub struct ReserveConfig {
     pub protocol_liquidation_fee: u8,
     /// Protocol take rate is the amount borrowed interest protocol recieves, as a percentage  
     pub protocol_take_rate: u8,
-    /// Borrow weight in basis points. This value cannot be less than 1.
-    pub borrow_weight_bps: u64,
+    /// Added borrow weight in basis points. THIS FIELD SHOULD NEVER BE USED DIRECTLY. Always use
+    /// borrow_weight()
+    pub added_borrow_weight_bps: u64,
 }
 
 /// Additional fee information on a reserve
@@ -877,7 +880,7 @@ impl Pack for Reserve {
             config_protocol_take_rate,
             liquidity_accumulated_protocol_fees_wads,
             rate_limiter,
-            config_borrow_weight_bps,
+            config_added_borrow_weight_bps,
             _padding,
         ) = mut_array_refs![
             output,
@@ -970,7 +973,7 @@ impl Pack for Reserve {
 
         self.rate_limiter.pack_into_slice(rate_limiter);
 
-        *config_borrow_weight_bps = self.config.borrow_weight_bps.to_le_bytes();
+        *config_added_borrow_weight_bps = self.config.added_borrow_weight_bps.to_le_bytes();
     }
 
     /// Unpacks a byte buffer into a [ReserveInfo](struct.ReserveInfo.html).
@@ -1011,7 +1014,7 @@ impl Pack for Reserve {
             config_protocol_take_rate,
             liquidity_accumulated_protocol_fees_wads,
             rate_limiter,
-            config_borrow_weight_bps,
+            config_added_borrow_weight_bps,
             _padding,
         ) = array_refs![
             input,
@@ -1104,11 +1107,7 @@ impl Pack for Reserve {
                 fee_receiver: Pubkey::new_from_array(*config_fee_receiver),
                 protocol_liquidation_fee: u8::from_le_bytes(*config_protocol_liquidation_fee),
                 protocol_take_rate: u8::from_le_bytes(*config_protocol_take_rate),
-                borrow_weight_bps: {
-                    // this is a new field, so we need to handle the case where borrow_weight == 0
-                    let borrow_weight_bps = u64::from_le_bytes(*config_borrow_weight_bps);
-                    std::cmp::max(borrow_weight_bps, 10_000)
-                },
+                added_borrow_weight_bps: u64::from_le_bytes(*config_added_borrow_weight_bps),
             },
             rate_limiter: RateLimiter::unpack_from_slice(rate_limiter)?,
         })
@@ -1653,7 +1652,7 @@ mod test {
         // reserve state
         market_price: Decimal,
         decimal: u8,
-        borrow_weight_bps: u64,
+        added_borrow_weight_bps: u64,
 
         borrow_fee_wad: u64,
         host_fee: u8,
@@ -1671,7 +1670,7 @@ mod test {
 
                 market_price: Decimal::from(1u64),
                 decimal: 9,
-                borrow_weight_bps: 10000,
+                added_borrow_weight_bps: 0,
 
                 borrow_fee_wad: 10_000_000_000_000_000, // 1%
                 host_fee: 20,
@@ -1691,7 +1690,7 @@ mod test {
 
                 market_price: Decimal::from(1u64),
                 decimal: 9,
-                borrow_weight_bps: 10000,
+                added_borrow_weight_bps: 0,
 
                 borrow_fee_wad: 10_000_000_000_000_000, // 1%
                 host_fee: 20,
@@ -1711,7 +1710,7 @@ mod test {
 
                 market_price: Decimal::from(1u64),
                 decimal: 9,
-                borrow_weight_bps: 20_000,
+                added_borrow_weight_bps: 10_000,
 
                 borrow_fee_wad: 0,
                 host_fee: 0,
@@ -1731,7 +1730,7 @@ mod test {
 
                 market_price: Decimal::from(1u64),
                 decimal: 9,
-                borrow_weight_bps: 20_000,
+                added_borrow_weight_bps: 10_000,
 
                 borrow_fee_wad: 0,
                 host_fee: 0,
@@ -1751,7 +1750,7 @@ mod test {
         fn calculate_borrow(test_case in calculate_borrow_test_cases()) {
             let reserve = Reserve {
                 config: ReserveConfig {
-                    borrow_weight_bps: test_case.borrow_weight_bps,
+                    added_borrow_weight_bps: test_case.added_borrow_weight_bps,
                     fees: ReserveFees {
                         borrow_fee_wad: test_case.borrow_fee_wad,
                         host_fee_percentage: test_case.host_fee,
@@ -1774,20 +1773,4 @@ mod test {
             ), test_case.result);
         }
     }
-
-    // test that unpacking a reserve with a borrow weight of 0 fails
-    #[test]
-    fn test_unpack_reserve_with_zero_borrow_weight() {
-        let mut reserve = Reserve {
-            version: PROGRAM_VERSION,
-            ..Reserve::default()
-        };
-        reserve.config.borrow_weight_bps = 0;
-
-        let mut buf = [0u8; Reserve::LEN];
-        Reserve::pack(reserve, &mut buf).unwrap();
-
-        let unpacked_reserve = Reserve::unpack(&buf).unwrap();
-        assert_eq!(unpacked_reserve.config.borrow_weight_bps, 10_000);
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -2877,10 +2877,6 @@ fn validate_reserve_config(config: ReserveConfig) -> ProgramResult {`
`2877`	`2877`	`msg!("Protocol take rate must be in range [0, 100]");`
`2878`	`2878`	`return Err(LendingError::InvalidConfig.into());`
`2879`	`2879`	`}`
`2880`		`- if config.borrow_weight_bps < 10000 {`
`2881`		`- msg!("Borrow weight bps must be greater than 10000!");`
`2882`		`- return Err(LendingError::InvalidConfig.into());`
`2883`		`- }`
`2884`	`2880`	`Ok(())`
`2885`	`2881`	`}`
`2886`	`2882`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ pub fn test_reserve_config() -> ReserveConfig {`
`53`	`53`	`fee_receiver: Keypair::new().pubkey(),`
`54`	`54`	`protocol_liquidation_fee: 0,`
`55`	`55`	`protocol_take_rate: 0,`
`56`		`- borrow_weight_bps: 10_000,`
	`56`	`+ added_borrow_weight_bps: 0,`
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`