[move] set slow wallet entry function (#143)

Author: 0o-de-lally

.github/workflows/ci.yaml

@@ -12,7 +12,7 @@ on:
       - synchronize
     branches:
       - "release**"
-      - "main"
+      - "main**"
 env:
   DIEM_FORGE_NODE_BIN_PATH: ${{github.workspace}}/diem-node
   LIBRA_CI: 1
@@ -166,4 +166,4 @@ jobs:
       - name: rescue
         if: always()
         working-directory: ./tools/rescue
-        run: RUST_MIN_STACK=104857600 cargo test --no-fail-fast -- --test-threads=1
+        run: RUST_MIN_STACK=104857600 cargo test --no-fail-fast -- --test-threads=1

.github/workflows/cleanliness.yaml

@@ -11,7 +11,7 @@ on:
       - synchronize
     branches:
       - 'release**'
-      - 'main'
+      - 'main**'
 env:
   DIEM_FORGE_NODE_BIN_PATH: ${{github.workspace}}/diem-node
   LIBRA_CI: 1

.github/workflows/formal.yaml

@@ -11,7 +11,7 @@ on:
       - synchronize
     branches:
       - 'release**'
-      - 'main'
+      - 'main**'
 env:
   DOTNET_ROOT: "/home/runner/.dotnet"
   Z3_EXE: "/home/runner/bin/z3"

.github/workflows/move.yaml

@@ -12,7 +12,7 @@ on:
       - synchronize
     branches:
       - 'release**'
-      - 'main'
+      - 'main**'
 
 jobs:
   functional-tests:

framework/cached-packages/src/libra_framework_sdk_builder.rs

@@ -466,6 +466,11 @@ pub enum EntryFunctionCall {
         transferred: u64,
     },
 
+    /// Users can change their account to slow, by calling the entry function
+    /// Warning: this is permanent for the account. There's no way to
+    /// reverse a "slow wallet".
+    SlowWalletUserSetSlow {},
+
     /// Initialize the validator account and give ownership to the signing account
     /// except it leaves the ValidatorConfig to be set by another entity.
     /// Note: this triggers setting the operator and owner, set it to the account's address
@@ -811,6 +816,7 @@ impl EntryFunctionCall {
                 unlocked,
                 transferred,
             } => slow_wallet_smoke_test_vm_unlock(user_addr, unlocked, transferred),
+            SlowWalletUserSetSlow {} => slow_wallet_user_set_slow(),
             StakeInitializeStakeOwner {
                 initial_stake_amount,
                 operator,
@@ -2128,6 +2134,24 @@ pub fn slow_wallet_smoke_test_vm_unlock(
     ))
 }
 
+/// Users can change their account to slow, by calling the entry function
+/// Warning: this is permanent for the account. There's no way to
+/// reverse a "slow wallet".
+pub fn slow_wallet_user_set_slow() -> TransactionPayload {
+    TransactionPayload::EntryFunction(EntryFunction::new(
+        ModuleId::new(
+            AccountAddress::new([
+                0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+                0, 0, 0, 1,
+            ]),
+            ident_str!("slow_wallet").to_owned(),
+        ),
+        ident_str!("user_set_slow").to_owned(),
+        vec![],
+        vec![],
+    ))
+}
+
 /// Initialize the validator account and give ownership to the signing account
 /// except it leaves the ValidatorConfig to be set by another entity.
 /// Note: this triggers setting the operator and owner, set it to the account's address
@@ -3078,6 +3102,14 @@ mod decoder {
         }
     }
 
+    pub fn slow_wallet_user_set_slow(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
+        if let TransactionPayload::EntryFunction(_script) = payload {
+            Some(EntryFunctionCall::SlowWalletUserSetSlow {})
+        } else {
+            None
+        }
+    }
+
     pub fn stake_initialize_stake_owner(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
         if let TransactionPayload::EntryFunction(script) = payload {
             Some(EntryFunctionCall::StakeInitializeStakeOwner {
@@ -3450,6 +3482,10 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             "slow_wallet_smoke_test_vm_unlock".to_string(),
             Box::new(decoder::slow_wallet_smoke_test_vm_unlock),
         );
+        map.insert(
+            "slow_wallet_user_set_slow".to_string(),
+            Box::new(decoder::slow_wallet_user_set_slow),
+        );
         map.insert(
             "stake_initialize_stake_owner".to_string(),
             Box::new(decoder::stake_initialize_stake_owner),

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

@@ -188,6 +188,8 @@ module ol_framework::ol_account {
       assert!(amount < limit, error::invalid_state(EINSUFFICIENT_BALANCE));
 
       let coin = coin::withdraw_with_capability(cap, amount);
+      slow_wallet::maybe_track_unlocked_withdraw(payer, amount);
+
       // the outgoing coins should trigger an update on this account
       // order matters here
       maybe_update_burn_tracker_impl(payer);
@@ -202,16 +204,15 @@ module ol_framework::ol_account {
             assume !system_addresses::signer_is_ol_root(sender);
             assume chain_status::is_operating();
         };
-        // never abort when its a system address
-        // if (system_addresses::signer_is_ol_root(sender)) return
-        // coin::zero<LibraCoin>(); // and VM needs to figure this out.
 
         let addr = signer::address_of(sender);
         assert!(amount > 0, error::invalid_argument(EZERO_TRANSFER));
 
         let limit = slow_wallet::unlocked_amount(addr);
         assert!(amount <= limit, error::invalid_state(EINSUFFICIENT_BALANCE));
         let coin = coin::withdraw<LibraCoin>(sender, amount);
+        slow_wallet::maybe_track_unlocked_withdraw(addr, amount);
+
         // the outgoing coins should trigger an update on this account
         // order matters here
         maybe_update_burn_tracker_impl(addr);
@@ -235,7 +236,7 @@ module ol_framework::ol_account {
         assert!(coin::is_account_registered<LibraCoin>(recipient), error::invalid_argument(EACCOUNT_NOT_REGISTERED_FOR_GAS));
 
         // must track the slow wallet on both sides of the transfer
-        slow_wallet::maybe_track_slow_transfer(payer, recipient, amount);
+        // slow_wallet::maybe_track_slow_transfer(payer, recipient, amount);
 
         // maybe track cumulative deposits if this is a donor directed wallet
         // or other wallet which tracks cumulative payments.
@@ -324,10 +325,6 @@ module ol_framework::ol_account {
 
     }
 
-    // public fun withdraw_with_capability(cap: &WithdrawCapability, amount: u64): Coin<LibraCoin> {
-    //   coin::withdraw_with_capability(cap, amount)
-    // }
-
     //////// 0L ////////
 
     #[view]

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

@@ -98,6 +98,14 @@ module ol_framework::slow_wallet {
       }
     }
 
+    /// Users can change their account to slow, by calling the entry function
+    /// Warning: this is permanent for the account. There's no way to
+    /// reverse a "slow wallet".
+    public entry fun user_set_slow(sig: &signer) acquires SlowWalletList {
+      set_slow(sig);
+    }
+
+    /// implementation of setting slow wallet, allows contracts to call.
     public fun set_slow(sig: &signer) acquires SlowWalletList {
       assert!(exists<SlowWalletList>(@ol_framework), error::invalid_argument(EGENESIS_ERROR));
 

framework/libra-framework/sources/ol_sources/tests/slow_wallet.test.move

@@ -16,7 +16,7 @@ module ol_framework::test_slow_wallet {
   use ol_framework::rewards;
   use std::vector;
 
-  // use diem_std::debug::print;
+  use diem_std::debug::print;
 
   #[test(root = @ol_framework)]
   // we are testing that genesis creates the needed struct
@@ -118,6 +118,10 @@ module ol_framework::test_slow_wallet {
     // slow transfer
     let b_balance = coin::balance<LibraCoin>(@0x456);
     assert!(b_balance == transfer_amount, 735704);
+    print(&alice_init_balance);
+    print(&transfer_amount);
+    print(&slow_wallet::unlocked_amount(@0x123));
+
     assert!(slow_wallet::unlocked_amount(@0x123) == (alice_init_balance - transfer_amount), 735705);
     assert!(slow_wallet::unlocked_amount(@0x456) == transfer_amount, 735706);