[donor-voice] refactor cw unlocked advance workflow (#393)

Co-authored-by: Isa McConey <[email protected]>
Co-authored-by: Sofi De Bittern <[email protected]>

Author: 3 people

framework/cached-packages/src/libra_framework_sdk_builder.rs

@@ -191,13 +191,8 @@ pub enum EntryFunctionCall {
     /// Public function for production triggering of epoch boundary.
     DiemGovernanceTriggerEpoch {},
 
-    /// A signer of the multisig can propose a payment
-    /// Public entry function required for txs cli
-    DonorVoiceTxsProposeAdvanceTx {
+    DonorVoiceTxsMaybeCloseReauth {
         multisig_address: AccountAddress,
-        payee: AccountAddress,
-        value: u64,
-        description: Vec<u8>,
     },
 
     /// A donor can propose the liquidation of a Donor Voice account
@@ -206,13 +201,12 @@ pub enum EntryFunctionCall {
         multisig_address: AccountAddress,
     },
 
-    /// A signer of the multisig can propose a payment
-    /// Public entry function required for txs cli.
     DonorVoiceTxsProposePaymentTx {
         multisig_address: AccountAddress,
         payee: AccountAddress,
         value: u64,
         description: Vec<u8>,
+        advance_unlocked: bool,
     },
 
     /// A donor of the program can propose a veto to a scheduled transaction
@@ -499,12 +493,9 @@ impl EntryFunctionCall {
             } => diem_governance_ol_vote(proposal_id, should_pass),
             DiemGovernanceSmokeTriggerEpoch {} => diem_governance_smoke_trigger_epoch(),
             DiemGovernanceTriggerEpoch {} => diem_governance_trigger_epoch(),
-            DonorVoiceTxsProposeAdvanceTx {
-                multisig_address,
-                payee,
-                value,
-                description,
-            } => donor_voice_txs_propose_advance_tx(multisig_address, payee, value, description),
+            DonorVoiceTxsMaybeCloseReauth { multisig_address } => {
+                donor_voice_txs_maybe_close_reauth(multisig_address)
+            }
             DonorVoiceTxsProposeLiquidateTx { multisig_address } => {
                 donor_voice_txs_propose_liquidate_tx(multisig_address)
             }
@@ -513,7 +504,14 @@ impl EntryFunctionCall {
                 payee,
                 value,
                 description,
-            } => donor_voice_txs_propose_payment_tx(multisig_address, payee, value, description),
+                advance_unlocked,
+            } => donor_voice_txs_propose_payment_tx(
+                multisig_address,
+                payee,
+                value,
+                description,
+                advance_unlocked,
+            ),
             DonorVoiceTxsProposeVetoTx {
                 multisig_address,
                 tx_id,
@@ -998,14 +996,7 @@ pub fn diem_governance_trigger_epoch() -> TransactionPayload {
     ))
 }
 
-/// A signer of the multisig can propose a payment
-/// Public entry function required for txs cli
-pub fn donor_voice_txs_propose_advance_tx(
-    multisig_address: AccountAddress,
-    payee: AccountAddress,
-    value: u64,
-    description: Vec<u8>,
-) -> TransactionPayload {
+pub fn donor_voice_txs_maybe_close_reauth(multisig_address: AccountAddress) -> TransactionPayload {
     TransactionPayload::EntryFunction(EntryFunction::new(
         ModuleId::new(
             AccountAddress::new([
@@ -1014,14 +1005,9 @@ pub fn donor_voice_txs_propose_advance_tx(
             ]),
             ident_str!("donor_voice_txs").to_owned(),
         ),
-        ident_str!("propose_advance_tx").to_owned(),
+        ident_str!("maybe_close_reauth").to_owned(),
         vec![],
-        vec![
-            bcs::to_bytes(&multisig_address).unwrap(),
-            bcs::to_bytes(&payee).unwrap(),
-            bcs::to_bytes(&value).unwrap(),
-            bcs::to_bytes(&description).unwrap(),
-        ],
+        vec![bcs::to_bytes(&multisig_address).unwrap()],
     ))
 }
 
@@ -1044,13 +1030,12 @@ pub fn donor_voice_txs_propose_liquidate_tx(
     ))
 }
 
-/// A signer of the multisig can propose a payment
-/// Public entry function required for txs cli.
 pub fn donor_voice_txs_propose_payment_tx(
     multisig_address: AccountAddress,
     payee: AccountAddress,
     value: u64,
     description: Vec<u8>,
+    advance_unlocked: bool,
 ) -> TransactionPayload {
     TransactionPayload::EntryFunction(EntryFunction::new(
         ModuleId::new(
@@ -1067,6 +1052,7 @@ pub fn donor_voice_txs_propose_payment_tx(
             bcs::to_bytes(&payee).unwrap(),
             bcs::to_bytes(&value).unwrap(),
             bcs::to_bytes(&description).unwrap(),
+            bcs::to_bytes(&advance_unlocked).unwrap(),
         ],
     ))
 }
@@ -1845,15 +1831,12 @@ mod decoder {
         }
     }
 
-    pub fn donor_voice_txs_propose_advance_tx(
+    pub fn donor_voice_txs_maybe_close_reauth(
         payload: &TransactionPayload,
     ) -> Option<EntryFunctionCall> {
         if let TransactionPayload::EntryFunction(script) = payload {
-            Some(EntryFunctionCall::DonorVoiceTxsProposeAdvanceTx {
+            Some(EntryFunctionCall::DonorVoiceTxsMaybeCloseReauth {
                 multisig_address: bcs::from_bytes(script.args().first()?).ok()?,
-                payee: bcs::from_bytes(script.args().get(1)?).ok()?,
-                value: bcs::from_bytes(script.args().get(2)?).ok()?,
-                description: bcs::from_bytes(script.args().get(3)?).ok()?,
             })
         } else {
             None
@@ -1881,6 +1864,7 @@ mod decoder {
                 payee: bcs::from_bytes(script.args().get(1)?).ok()?,
                 value: bcs::from_bytes(script.args().get(2)?).ok()?,
                 description: bcs::from_bytes(script.args().get(3)?).ok()?,
+                advance_unlocked: bcs::from_bytes(script.args().get(4)?).ok()?,
             })
         } else {
             None
@@ -2291,8 +2275,8 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             Box::new(decoder::diem_governance_trigger_epoch),
         );
         map.insert(
-            "donor_voice_txs_propose_advance_tx".to_string(),
-            Box::new(decoder::donor_voice_txs_propose_advance_tx),
+            "donor_voice_txs_maybe_close_reauth".to_string(),
+            Box::new(decoder::donor_voice_txs_maybe_close_reauth),
         );
         map.insert(
             "donor_voice_txs_propose_liquidate_tx".to_string(),

framework/libra-framework/sources/ol_sources/community_wallet_advance.move

@@ -21,7 +21,7 @@ module ol_framework::community_wallet_advance {
   use std::error;
   use std::signer;
   use std::timestamp;
-  use diem_framework::account::{Self, WithdrawCapability};
+  use diem_framework::account::{Self, GUIDCapability, WithdrawCapability};
   use diem_framework::coin::{Coin};
   use ol_framework::ol_account;
   use ol_framework::libra_coin::{Self, LibraCoin};
@@ -100,13 +100,6 @@ module ol_framework::community_wallet_advance {
     }
   }
 
-  /// check if amount withdrawn will be below credit limit
-  fun can_withdraw_amount(dv_account: address, amount: u64):bool acquires Advances {
-    assert!(amount> 0, error::invalid_argument(EAMOUNT_IS_ZERO));
-    assert!(!is_delinquent(dv_account), error::invalid_state(ELOAN_OVERDUE));
-    let available = total_credit_available(dv_account);
-    available > amount
-  }
   /// Only can be called on epoch boundary as part of the donor_voice_txs.move authorization flow.
   /// Will withdraw funds and track the logger
   public(friend) fun transfer_credit(withdraw_cap: &WithdrawCapability, recipient: address, amount: u64): u64 acquires Advances {
@@ -124,6 +117,22 @@ module ol_framework::community_wallet_advance {
     amount
   }
 
+  public(friend) fun transfer_credit_vm(framework: &signer, guid_cap: &GUIDCapability, recipient: address, amount: u64): u64 acquires Advances {
+    let dv_account = account::get_guid_capability_address(guid_cap);
+
+    can_withdraw_amount(dv_account, amount);
+    log_withdrawal(dv_account, amount);
+
+    ol_account::vm_transfer(
+      framework,
+      dv_account,
+      recipient,
+      amount,
+    );
+    // TODO: check if there is any possibility of partial amount sent
+    amount
+  }
+
   /// Service the loan with new coins
   /// If the balance outstanding is lower than the coin value,
   /// then only log the amount which is to be debited.
@@ -175,6 +184,17 @@ module ol_framework::community_wallet_advance {
     }
   }
 
+  //////// VIEW FUNCTIONS ////////
+
+  #[view]
+  /// check if amount withdrawn will be below credit limit
+  public fun can_withdraw_amount(dv_account: address, amount: u64): bool acquires Advances {
+    assert!(amount> 0, error::invalid_argument(EAMOUNT_IS_ZERO));
+    assert!(!is_delinquent(dv_account), error::invalid_state(ELOAN_OVERDUE));
+    let available = total_credit_available(dv_account);
+    available > amount
+  }
+
   #[view]
   /// Has the CW account made a payment in the last year
   // TODO: need to check amount of payment history in the last year, but we're not tracking individual payments.

framework/libra-framework/sources/ol_sources/donor_voice_migration.move

@@ -19,6 +19,7 @@ module ol_framework::donor_voice_migration {
     use ol_framework::migration_capability::{Self, MigrationCapability};
     use ol_framework::donor_voice;
     use ol_framework::donor_voice_governance;
+    use ol_framework::community_wallet_advance;
 
 
     friend ol_framework::migrations;
@@ -60,6 +61,8 @@ module ol_framework::donor_voice_migration {
             // create Offer structure
             multi_action::maybe_init_auth_offer(&multisig_signer, multisig_address);
 
+            community_wallet_advance::initialize(&multisig_signer);
+
             donor_voice_governance::maybe_init_dv_governance(&multisig_signer);
             activity::lazy_initialize(&multisig_signer, timestamp::now_seconds());