add optional term extension feature (#13)

* add optional term extension feature

* update test script

Author: LKY-stephen

README.md

@@ -42,6 +42,8 @@ The deposit pool module allows users to deposit base tokens and earn loyalty tok
 - Pending withdrawal period (optional)
 - Admin-controlled reward pool integration
 - Receipts for each deposit, enabling precise reward calculation
+- Admin-controlled term extending option
+- User can extend a pre-mature existed deposit to a higher term 
 
 #### Usage
 

deploy.sh

@@ -130,14 +130,14 @@ echo "Talus coin at : \"$TALUS_COIN\""
 ###########################################
 # Faucet Deployment (Optional)
 ###########################################
+# Calculate split amounts for faucet
+if [ -z "$INIT_AMOUNT" ]; then
+    SPLIT_AMOUNT=$DEFAULT_INIT
+else
+    SPLIT_AMOUNT=$(_calculate_amount "$TOTAL_SUPPLY-$INIT_AMOUNT")
+fi
 
 if [[ "${DEPLOY_FAUCET,,}" =~ ^(y|yes)$ ]]; then
-    # Calculate split amounts for faucet
-    if [ -z "$INIT_AMOUNT" ]; then
-        SPLIT_AMOUNT=$DEFAULT_INIT
-    else
-        SPLIT_AMOUNT=$(_calculate_amount "$TOTAL_SUPPLY-$INIT_AMOUNT")
-    fi
 
     echo "Split coin"
     _spliter=$($SUI client split-coin --coin-id $TALUS_COIN --amounts $SPLIT_AMOUNT)
@@ -184,8 +184,8 @@ echo "Loyalty Program Contract at: \"$LoyaltyProgramContractID\""
 echo "Loyalty Token Contract at: \"$LoyaltyTokenContractID\""
 echo "Loyalty Token Cap at: \"$LoyaltyTreasuryCap\""
 
-# Initialize reward pool
-echo "Init reward pool and Deposit Pool"
+# Initialize deposit pool
+echo "Init Deposit pool"
 script=$($SUI client call --package $LoyaltyProgramContractID --module deposit_pool --function new \
         --type-args $TOKEN_CONTRACT_ID::us::US --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
         --args $LoyaltyTreasuryCap --args $BASE_APY --args [] --args false --args 0 \
@@ -239,7 +239,7 @@ echo "Policy at $PolicyID"
 #          --type-args $TOKEN_CONTRACT_ID::us::US \
 #          --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
 #          --args $DEPOSIT_POOL \
-#          --args <us coin> \
+#          --args <us coin id> \
 #          --args 0 --args $USER \
 #          --args [] --args 0x6 --dry-run
 
@@ -250,8 +250,53 @@ echo "Policy at $PolicyID"
 #         --args 0x6 --gas-budget 10000000
 
 # echo "Test claim reward"
-# $SUI client call --package $LoyaltyProgramContractID --module reward_program \
+# $SUI client call --package $LoyaltyProgramContractID --module reward_pool \
 #         --function claim \
 #         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \ 
 #         --type-args $TOKEN_CONTRACT_ID::us::US 
 #         --args $DEPOSIT_POOL --args <token id> --args $PolicyID --args [] \
+
+# echo "Test add term"
+# $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#         --function upsert_lock_term \
+#         --type-args $TOKEN_CONTRACT_ID::us::US \
+#         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#         --args $DEPOSIT_POOL --args $ADMIN_CAP --args 30 --args 10 --dry-run 
+
+# $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#         --function upsert_lock_term \
+#         --type-args $TOKEN_CONTRACT_ID::us::US \
+#         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#         --args $DEPOSIT_POOL --args $ADMIN_CAP --args 60 --args 20 --dry-run 
+
+
+# echo "Test deposit to pool"
+#  $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#          --function deposit \
+#          --type-args $TOKEN_CONTRACT_ID::us::US \
+#          --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#          --args $DEPOSIT_POOL \
+#          --args <us coin id> \
+#          --args 30 --args $USER \
+#          --args [] --args 0x6 --dry-run
+
+# should error now
+# $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#         --function upgrade_term \
+#         --type-args $TOKEN_CONTRACT_ID::us::US \
+#         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#         --args $DEPOSIT_POOL --args <receipt id> --args 60 \
+#         --args [20] --args 0x6 --dry-run 
+
+# $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#         --function enable_extending_terms \
+#         --type-args $TOKEN_CONTRACT_ID::us::US \
+#         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#         --args $DEPOSIT_POOL --args $ADMIN_CAP --dry-run 
+
+# $SUI client call --package $LoyaltyProgramContractID --module deposit_pool \
+#         --function upgrade_term \
+#         --type-args $TOKEN_CONTRACT_ID::us::US \
+#         --type-args $LoyaltyTokenContractID::loyalty::LOYALTY \
+#         --args $DEPOSIT_POOL --args <receipt id> --args 60 \
+#         --args [20] --args 0x6 --dry-run 

deposit_pool/sources/deposit_pool.move

@@ -29,6 +29,10 @@ const EPendingWithdrawal: u64 = 5;
 const ERemovingDefaultTerm: u64 = 6;
 /// Error when user choose a term with apy less than expectation;
 const EApyMismatched: u64 = 7;
+/// Error when user tries to extend term when the pool not support it;
+const ENotSupportExtendTerm: u64 = 8;
+/// Error when user tries to extend term with wrong parameters;
+const EInvalidExtendTerm: u64 = 9;
 
 // ====================== Const =================
 /// Current version of the contract
@@ -43,6 +47,9 @@ const KEY_SUPPORT_EARLY_WITHDRAWAL: u8 = 1;
 /// Option key for withdrawal pending window (days: u32), optional.
 const KEY_WITHDRAWAL_PENDING: u8 = 2;
 
+/// Option key for enable upgrade the term for higher apy (bool), optional.
+const KEY_SUPPORT_TERM_EXTENSION: u8 = 3;
+
 public struct AdminCap has key, store {
     id: UID,
 }
@@ -131,9 +138,9 @@ public fun deposit<Base, Loyalty>(
     assert!(pool.version == VERSION, EWrongVersion);
 
     let (lock_term, apy) = if (pool.return_rates.contains(term)) {
-        (term as u64, *pool.return_rates.borrow(term))
+        (term as u64, pool.return_rates[term])
     } else {
-        (0, *pool.return_rates.borrow(0))
+        (0, pool.return_rates[0])
     };
 
     // if expected_apy has some value, ensure fetched apy is higer.
@@ -166,7 +173,7 @@ entry fun withdraw<Base, Loyalty>(
 
     // Check eligible for execute withdrawal. Option always exists as this immutable option
     // was added during pool creation
-    if (pool.options.borrow(KEY_SUPPORT_EARLY_WITHDRAWAL)!= true) {
+    if (!pool.options[KEY_SUPPORT_EARLY_WITHDRAWAL]) {
         assert!(clock.timestamp_ms() >= receipt.mature_at_ms, ENotSupportEarlyWithdrawal);
     };
 
@@ -181,7 +188,7 @@ entry fun withdraw<Base, Loyalty>(
             df::add(
                 &mut pool.id,
                 id(&receipt),
-                clock.timestamp_ms() + *pool.options.borrow(KEY_WITHDRAWAL_PENDING),
+                clock.timestamp_ms() + pool.options[KEY_WITHDRAWAL_PENDING],
             );
             transfer::transfer(receipt, ctx.sender());
             return
@@ -215,6 +222,41 @@ entry fun withdraw<Base, Loyalty>(
     transfer::public_transfer(pool.balance.split(amount).into_coin(ctx), ctx.sender());
 }
 
+/// Upgrade the term of premature deposit receipt if support
+public fun upgrade_term<Base, Loyalty>(
+    pool: &mut DepositPool<Base, Loyalty>,
+    receipt: &mut Receipt,
+    target_term: u32,
+    target_apy: Option<u16>,
+    clock: &Clock,
+) {
+    assert!(pool.version == VERSION, EWrongVersion);
+    assert!(receipt.pool_id == object::id(pool), EWrongPool);
+
+    // if option does not exists, directly abort
+    assert!(pool.options.contains(KEY_SUPPORT_TERM_EXTENSION), ENotSupportExtendTerm);
+
+    // mature receipt cannot extend, thus if the receipt within withdrwal pending will
+    // not get additional benefits. An early withdrawal pending will not get any token
+    // so we can safely ignore the withdrawal pending situation.
+    assert!(receipt.mature_at_ms > clock.timestamp_ms(), EInvalidExtendTerm);
+
+    // new apy must exists
+    let new_apy = pool.return_rates[target_term];
+
+    // To prevent misoperation, if user did not specify the apy, then new apy should be no less than the old one
+    // However, user may explicilty choose a lower apy.
+    assert!(new_apy>=target_apy.destroy_or!(receipt.apy), EApyMismatched);
+
+    let new_mature_at_ms = receipt.issue_at_ms + (target_term as u64)*MS_PER_DAY;
+
+    // mature term should be increase only.
+    assert!(new_mature_at_ms>receipt.mature_at_ms, EInvalidExtendTerm);
+
+    receipt.mature_at_ms = new_mature_at_ms;
+    receipt.apy = new_apy;
+}
+
 /// Updates or adds a new lock term period with corresponding APY
 public fun upsert_lock_term<Base, Loyalty>(
     pool: &mut DepositPool<Base, Loyalty>,
@@ -257,6 +299,27 @@ public fun delete_lock_term<Base, Loyalty>(
     pool.return_rates.remove(days);
 }
 
+public fun enable_extending_terms<Base, Loyalty>(
+    pool: &mut DepositPool<Base, Loyalty>,
+    admin: &mut AdminCap,
+) {
+    assert!(pool.admin_cap_id == object::id(admin), ENotAdmin);
+    assert!(pool.version == VERSION, EWrongVersion);
+
+    pool.options.add(KEY_SUPPORT_TERM_EXTENSION, true);
+}
+
+public fun disable_extending_terms<Base, Loyalty>(
+    pool: &mut DepositPool<Base, Loyalty>,
+    admin: &mut AdminCap,
+) {
+    assert!(pool.admin_cap_id == object::id(admin), ENotAdmin);
+    assert!(pool.version == VERSION, EWrongVersion);
+
+    // abort if not exists, then no meaning to disable it.
+    pool.options.remove<u8, bool>(KEY_SUPPORT_TERM_EXTENSION);
+}
+
 /// Adds a new reward pool policy for loyalty tokens
 #[allow(lint(self_transfer))]
 public fun add_reward_program<Policy: drop, Base, Loyalty>(
@@ -298,7 +361,7 @@ fun calculate_token_amount<Base, Loyalty>(
     apy: u16,
 ): u64 {
     let withdraw_at_ms = if (pool.options.contains(KEY_WITHDRAWAL_PENDING)) {
-        df::remove(&mut pool.id, receipt_id) - *pool.options.borrow(KEY_WITHDRAWAL_PENDING)
+        df::remove(&mut pool.id, receipt_id) - pool.options[KEY_WITHDRAWAL_PENDING]
     } else {
         clock.timestamp_ms()
     };