[move] removing public functions where unecessary (#206)

Author: 0o-de-lally

framework/cached-packages/src/libra_framework_sdk_builder.rs

@@ -136,6 +136,12 @@ pub enum EntryFunctionCall {
         cap_update_table: Vec<u8>,
     },
 
+    /// User opts into burns being sent to community (recycle burn).
+    /// default is false (burn is final).
+    BurnSetSendCommunity {
+        community: bool,
+    },
+
     /// Same as `publish_package` but as an entry function which can be called as a transaction. Because
     /// of current restrictions for txn parameters, the metadata needs to be passed in serialized form.
     CodePublishPackageTxn {
@@ -171,12 +177,6 @@ pub enum EntryFunctionCall {
         check_threshold: u64,
     },
 
-    DemoPrintThis {},
-
-    DemoSetMessage {
-        message: Vec<u8>,
-    },
-
     DiemGovernanceAddApprovedScriptHashScript {
         proposal_id: u64,
     },
@@ -266,6 +266,8 @@ pub enum EntryFunctionCall {
         id: u64,
     },
 
+    EpochBoundarySmokeTriggerEpoch {},
+
     /// Only a Voucher of the validator can flip the unjail bit.
     /// This is a way to make sure the validator is ready to rejoin.
     JailUnjailByVoucher {
@@ -475,13 +477,10 @@ pub enum EntryFunctionCall {
         epoch_expiry: u64,
     },
 
-    /// Creates a new resource account and rotates the authentication key to either
-    /// the optional auth key if it is non-empty (though auth keys are 32-bytes)
-    /// or the source accounts current auth key.
-    ResourceAccountCreateResourceAccount {
-        seed: Vec<u8>,
-        optional_auth_key: Vec<u8>,
-    },
+    /// This fucntion initiates governance for the multisig. It is called by the sponsor address, and is only callable once.
+    /// init_gov fails gracefully if the governance is already initialized.
+    /// init_type will throw errors if the type is already initialized.
+    SafeInitPaymentMultisig {},
 
     SlowWalletSmokeTestVmUnlock {
         user_addr: AccountAddress,
@@ -634,6 +633,7 @@ impl EntryFunctionCall {
                 new_public_key_bytes,
                 cap_update_table,
             ),
+            BurnSetSendCommunity { community } => burn_set_send_community(community),
             CodePublishPackageTxn {
                 metadata_serialized,
                 code,
@@ -664,8 +664,6 @@ impl EntryFunctionCall {
                 check_addresses,
                 check_threshold,
             } => community_wallet_init_init_community(check_addresses, check_threshold),
-            DemoPrintThis {} => demo_print_this(),
-            DemoSetMessage { message } => demo_set_message(message),
             DiemGovernanceAddApprovedScriptHashScript { proposal_id } => {
                 diem_governance_add_approved_script_hash_script(proposal_id)
             }
@@ -737,6 +735,7 @@ impl EntryFunctionCall {
                 multisig_address,
                 id,
             } => donor_voice_txs_vote_veto_tx(multisig_address, id),
+            EpochBoundarySmokeTriggerEpoch {} => epoch_boundary_smoke_trigger_epoch(),
             JailUnjailByVoucher { addr } => jail_unjail_by_voucher(addr),
             LibraCoinClaimMintCapability {} => libra_coin_claim_mint_capability(),
             LibraCoinDelegateMintCapability { to } => libra_coin_delegate_mint_capability(to),
@@ -841,10 +840,7 @@ impl EntryFunctionCall {
             ProofOfFeePofUpdateBid { bid, epoch_expiry } => {
                 proof_of_fee_pof_update_bid(bid, epoch_expiry)
             }
-            ResourceAccountCreateResourceAccount {
-                seed,
-                optional_auth_key,
-            } => resource_account_create_resource_account(seed, optional_auth_key),
+            SafeInitPaymentMultisig {} => safe_init_payment_multisig(),
             SlowWalletSmokeTestVmUnlock {
                 user_addr,
                 unlocked,
@@ -1156,6 +1152,23 @@ pub fn account_rotate_authentication_key_with_rotation_capability(
     ))
 }
 
+/// User opts into burns being sent to community (recycle burn).
+/// default is false (burn is final).
+pub fn burn_set_send_community(community: bool) -> 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!("burn").to_owned(),
+        ),
+        ident_str!("set_send_community").to_owned(),
+        vec![],
+        vec![bcs::to_bytes(&community).unwrap()],
+    ))
+}
+
 /// Same as `publish_package` but as an entry function which can be called as a transaction. Because
 /// of current restrictions for txn parameters, the metadata needs to be passed in serialized form.
 pub fn code_publish_package_txn(
@@ -1267,36 +1280,6 @@ pub fn community_wallet_init_init_community(
     ))
 }
 
-pub fn demo_print_this() -> 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!("demo").to_owned(),
-        ),
-        ident_str!("print_this").to_owned(),
-        vec![],
-        vec![],
-    ))
-}
-
-pub fn demo_set_message(message: Vec<u8>) -> 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!("demo").to_owned(),
-        ),
-        ident_str!("set_message").to_owned(),
-        vec![],
-        vec![bcs::to_bytes(&message).unwrap()],
-    ))
-}
-
 pub fn diem_governance_add_approved_script_hash_script(proposal_id: u64) -> TransactionPayload {
     TransactionPayload::EntryFunction(EntryFunction::new(
         ModuleId::new(
@@ -1589,6 +1572,21 @@ pub fn donor_voice_txs_vote_veto_tx(
     ))
 }
 
+pub fn epoch_boundary_smoke_trigger_epoch() -> 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!("epoch_boundary").to_owned(),
+        ),
+        ident_str!("smoke_trigger_epoch").to_owned(),
+        vec![],
+        vec![],
+    ))
+}
+
 /// Only a Voucher of the validator can flip the unjail bit.
 /// This is a way to make sure the validator is ready to rejoin.
 pub fn jail_unjail_by_voucher(addr: AccountAddress) -> TransactionPayload {
@@ -2198,27 +2196,21 @@ pub fn proof_of_fee_pof_update_bid(bid: u64, epoch_expiry: u64) -> TransactionPa
     ))
 }
 
-/// Creates a new resource account and rotates the authentication key to either
-/// the optional auth key if it is non-empty (though auth keys are 32-bytes)
-/// or the source accounts current auth key.
-pub fn resource_account_create_resource_account(
-    seed: Vec<u8>,
-    optional_auth_key: Vec<u8>,
-) -> TransactionPayload {
+/// This fucntion initiates governance for the multisig. It is called by the sponsor address, and is only callable once.
+/// init_gov fails gracefully if the governance is already initialized.
+/// init_type will throw errors if the type is already initialized.
+pub fn safe_init_payment_multisig() -> 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!("resource_account").to_owned(),
+            ident_str!("safe").to_owned(),
         ),
-        ident_str!("create_resource_account").to_owned(),
+        ident_str!("init_payment_multisig").to_owned(),
+        vec![],
         vec![],
-        vec![
-            bcs::to_bytes(&seed).unwrap(),
-            bcs::to_bytes(&optional_auth_key).unwrap(),
-        ],
     ))
 }
 
@@ -2610,6 +2602,16 @@ mod decoder {
         }
     }
 
+    pub fn burn_set_send_community(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
+        if let TransactionPayload::EntryFunction(script) = payload {
+            Some(EntryFunctionCall::BurnSetSendCommunity {
+                community: bcs::from_bytes(script.args().get(0)?).ok()?,
+            })
+        } else {
+            None
+        }
+    }
+
     pub fn code_publish_package_txn(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
         if let TransactionPayload::EntryFunction(script) = payload {
             Some(EntryFunctionCall::CodePublishPackageTxn {
@@ -2677,24 +2679,6 @@ mod decoder {
         }
     }
 
-    pub fn demo_print_this(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
-        if let TransactionPayload::EntryFunction(_script) = payload {
-            Some(EntryFunctionCall::DemoPrintThis {})
-        } else {
-            None
-        }
-    }
-
-    pub fn demo_set_message(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
-        if let TransactionPayload::EntryFunction(script) = payload {
-            Some(EntryFunctionCall::DemoSetMessage {
-                message: bcs::from_bytes(script.args().get(0)?).ok()?,
-            })
-        } else {
-            None
-        }
-    }
-
     pub fn diem_governance_add_approved_script_hash_script(
         payload: &TransactionPayload,
     ) -> Option<EntryFunctionCall> {
@@ -2872,6 +2856,16 @@ mod decoder {
         }
     }
 
+    pub fn epoch_boundary_smoke_trigger_epoch(
+        payload: &TransactionPayload,
+    ) -> Option<EntryFunctionCall> {
+        if let TransactionPayload::EntryFunction(_script) = payload {
+            Some(EntryFunctionCall::EpochBoundarySmokeTriggerEpoch {})
+        } else {
+            None
+        }
+    }
+
     pub fn jail_unjail_by_voucher(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
         if let TransactionPayload::EntryFunction(script) = payload {
             Some(EntryFunctionCall::JailUnjailByVoucher {
@@ -3222,14 +3216,9 @@ mod decoder {
         }
     }
 
-    pub fn resource_account_create_resource_account(
-        payload: &TransactionPayload,
-    ) -> Option<EntryFunctionCall> {
-        if let TransactionPayload::EntryFunction(script) = payload {
-            Some(EntryFunctionCall::ResourceAccountCreateResourceAccount {
-                seed: bcs::from_bytes(script.args().get(0)?).ok()?,
-                optional_auth_key: bcs::from_bytes(script.args().get(1)?).ok()?,
-            })
+    pub fn safe_init_payment_multisig(payload: &TransactionPayload) -> Option<EntryFunctionCall> {
+        if let TransactionPayload::EntryFunction(_script) = payload {
+            Some(EntryFunctionCall::SafeInitPaymentMultisig {})
         } else {
             None
         }
@@ -3433,6 +3422,10 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             "account_rotate_authentication_key_with_rotation_capability".to_string(),
             Box::new(decoder::account_rotate_authentication_key_with_rotation_capability),
         );
+        map.insert(
+            "burn_set_send_community".to_string(),
+            Box::new(decoder::burn_set_send_community),
+        );
         map.insert(
             "code_publish_package_txn".to_string(),
             Box::new(decoder::code_publish_package_txn),
@@ -3453,14 +3446,6 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             "community_wallet_init_init_community".to_string(),
             Box::new(decoder::community_wallet_init_init_community),
         );
-        map.insert(
-            "demo_print_this".to_string(),
-            Box::new(decoder::demo_print_this),
-        );
-        map.insert(
-            "demo_set_message".to_string(),
-            Box::new(decoder::demo_set_message),
-        );
         map.insert(
             "diem_governance_add_approved_script_hash_script".to_string(),
             Box::new(decoder::diem_governance_add_approved_script_hash_script),
@@ -3517,6 +3502,10 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             "donor_voice_txs_vote_veto_tx".to_string(),
             Box::new(decoder::donor_voice_txs_vote_veto_tx),
         );
+        map.insert(
+            "epoch_boundary_smoke_trigger_epoch".to_string(),
+            Box::new(decoder::epoch_boundary_smoke_trigger_epoch),
+        );
         map.insert(
             "jail_unjail_by_voucher".to_string(),
             Box::new(decoder::jail_unjail_by_voucher),
@@ -3634,8 +3623,8 @@ static SCRIPT_FUNCTION_DECODER_MAP: once_cell::sync::Lazy<EntryFunctionDecoderMa
             Box::new(decoder::proof_of_fee_pof_update_bid),
         );
         map.insert(
-            "resource_account_create_resource_account".to_string(),
-            Box::new(decoder::resource_account_create_resource_account),
+            "safe_init_payment_multisig".to_string(),
+            Box::new(decoder::safe_init_payment_multisig),
         );
         map.insert(
             "slow_wallet_smoke_test_vm_unlock".to_string(),

framework/libra-framework/sources/aggregator/aggregator_factory.move

@@ -12,6 +12,7 @@ module diem_framework::aggregator_factory {
 
     friend diem_framework::genesis;
     friend diem_framework::optional_aggregator;
+    friend diem_framework::coin;
 
     /// Aggregator factory is not published yet.
     const EAGGREGATOR_FACTORY_NOT_FOUND: u64 = 1;
@@ -45,7 +46,7 @@ module diem_framework::aggregator_factory {
 
     /// This is currently a function closed for public. This can be updated in the future by on-chain governance
     /// to allow any signer to call.
-    public fun create_aggregator(account: &signer, limit: u128): Aggregator acquires AggregatorFactory {
+    public(friend) fun create_aggregator(account: &signer, limit: u128): Aggregator acquires AggregatorFactory {
         // Only Diem Framework (0x1) account can call this for now.
         system_addresses::assert_diem_framework(account);
         create_aggregator_internal(limit)

framework/libra-framework/sources/block.move

@@ -77,7 +77,7 @@ module diem_framework::block {
 
     /// Update the epoch interval.
     /// Can only be called as part of the Diem governance proposal process established by the DiemGovernance module.
-    public fun update_epoch_interval_microsecs(
+    public(friend) fun update_epoch_interval_microsecs(
         diem_framework: &signer,
         new_epoch_interval: u64,
     ) acquires BlockResource {
@@ -200,6 +200,10 @@ module diem_framework::block {
 
     ///  Emit a `NewBlockEvent` event. This function will be invoked by write set script directly to generate the
     ///  new block event for WriteSetPayload.
+    // NOTE: This function is not `(friend)` because governance scripts need to
+    // call it.
+    // TODO: refactor diem_governance so that this can again have only
+    // friend visibility.
     public fun emit_writeset_block_event(vm_signer: &signer, fake_block_hash: address) acquires BlockResource {
         system_addresses::assert_vm(vm_signer);
         let block_metadata_ref = borrow_global_mut<BlockResource>(@diem_framework);

framework/libra-framework/sources/chain_status.move

@@ -8,6 +8,9 @@ module diem_framework::chain_status {
 
     friend diem_framework::genesis;
 
+    //////// 0L ////////
+    friend ol_framework::sacred_cows;
+
     /// Marker to publish at the end of genesis.
     struct GenesisEndMarker has key {}
 
@@ -37,12 +40,12 @@ module diem_framework::chain_status {
     }
 
     /// Helper function to assert operating (not genesis) state.
-    public fun assert_operating() {
+    public(friend) fun assert_operating() {
         assert!(is_operating(), error::invalid_state(ENOT_OPERATING));
     }
 
     /// Helper function to assert genesis state.
-    public fun assert_genesis() {
+    public(friend) fun assert_genesis() {
         assert!(is_genesis(), error::invalid_state(ENOT_OPERATING));
     }
 }