Merge pull request #133 from scryptonight/main

A few fixes and a few more tests

Author: klembee

Diff for: 5-DAO/smorgasdao/rtm/smorgasdao/execute_proposal_return.rtm

@@ -9,7 +9,10 @@
 #
 # $proposal_duration: Duration of proposals in epochs, e.g. 10
 #
-# $quorum: Quorum to use, e.g. Any
+# $quorum: Quorum to use, e.g. 
+#          "Percent",Decimal("35")
+#          "Fixed",Decimal("10000")
+#          "Any"
 #
 # $vote_token: Token to use for voting with, e.g. resource_sim1qqqq...yag
 #              (even if the XRD token isn't really recommended).
@@ -30,7 +33,7 @@ CALL_FUNCTION
    "SmorgasDao"
    "instantiate_smorgasdao"
    ${proposal_duration}u64
-   Enum("${quorum}")
+   Enum(${quorum})
    ResourceAddress("${vote_token}")
    ${id_token}
    Enum("${vote_tally}")

Diff for: 5-DAO/smorgasdao/rtm/smorgasdao/instantiate_smorgasdao.rtm

@@ -0,0 +1,41 @@
+# Previously placed voting tokens are withdrawn.
+#
+# Parameters:
+#
+# $component: address of the SmorgasDao instance to use
+#
+# $account: address of the user account running this transaction
+#
+# $proposal: proposal id to withdraw votes from, e.g. 2284
+#
+# $receipt_nfres: the ResourceAddress of the receipt we received
+#                 when we placed the votes
+#
+# $receipt_nfid: the NonFungibleId of the receipt we received
+#                when we placed the votes
+CALL_METHOD 
+   ComponentAddress("${account}")
+   "lock_fee"
+   Decimal("10");
+
+CALL_METHOD
+   ComponentAddress("${account}")
+   "withdraw_by_ids"
+   Set<NonFungibleId>(NonFungibleId("${receipt_nfid}"))
+   ResourceAddress("${receipt_nfres}");
+
+TAKE_FROM_WORKTOP_BY_IDS
+   Set<NonFungibleId>(NonFungibleId("${receipt_nfid}"))
+   ResourceAddress("${receipt_nfres}")
+   Bucket("receipt_bucket");
+
+CALL_METHOD
+   ComponentAddress("${component}")
+   "withdraw_votes_with_receipt"
+   ${proposal}u64
+   Bucket("receipt_bucket");
+
+CALL_METHOD
+   ComponentAddress("${account}")
+   "deposit_batch"
+   Expression("ENTIRE_WORKTOP");

Diff for: 5-DAO/smorgasdao/rtm/smorgasdao/withdraw_votes_with_receipt.rtm

@@ -48,10 +48,13 @@ blueprint! {
             .instantiate().globalize()
         }
 
-        /// This is the first of three stages needed for the
+        /// This is the first of two stages needed for the
         /// SmorgasDAO to alter its own configuration with an
         /// executive proposal.
         ///
+        /// We need two stages because the engine doesn't allow us to
+        /// do a re-entrant call back into the DAO direct.
+        ///
         /// This method receives the SmorgasDAO's admin badge after an
         /// executive proposal passes, and stores it for the
         /// multi-stage implmenetation of the proposal. 
@@ -86,6 +89,8 @@ blueprint! {
         /// configuration change on the originating SmorgasDao
         /// component.
         ///
+        /// The badge is then sent back to the SmorgasDao.
+        ///
         /// ---
         ///
         /// **Access control:** This method doesn't do anything useful
@@ -96,32 +101,15 @@ blueprint! {
         /// by a different component. Since users are not meant to
         /// call it directly no transaction manifest is provided.
         pub fn execute_dao_call(&mut self) {
-            self.dao_admin_badge.authorize(
+            let badge = self.dao_admin_badge.take_all();
+            badge.authorize(
                 ||
                     borrow_component!(self.dao_component).call::<()>(
                         "set_proposal_duration",
                         args!(100u64)));
-        }
-
-        /// This is the third stage of effecting a configuration
-        /// change of the SmorgasDAO.
-        ///
-        /// This method return the Admin badge we stored here back to
-        /// the DAO.
-        ///
-        /// ---
-        ///
-        /// **Access control:** This method doesn't do anything useful
-        /// unless it's called with the DAO's admin badge in
-        /// `badges[0]`
-        ///
-        /// **Transaction manifest:** This method is only ever called
-        /// by a different component. Since users are not meant to
-        /// call it directly no transaction manifest is provided.
-        pub fn return_dao_admin_token(&mut self) {
             borrow_component!(self.dao_component).call::<()>(
                 "return_internal_badge",
-                args!(self.dao_admin_badge.take_all()));
+                args!(badge));
         }
 
         /// This method relays a call from a SmorgasDAO executive

Diff for: 5-DAO/smorgasdao/src/intermediary.rs

@@ -18,8 +18,8 @@
 //! and then the [intermediary module] to gain a good understanding of
 //! how the Radfolio functions.
 //!
-//! [radfolio module]: crate::smorgasdao
-//! [investment vehicle module]: crate::intermediary
+//! [intermediary module]: crate::intermediary
+//! [smorgasdao module]: crate::smorgasdao
 //!
 //! In a nutshell, the `SmorgasDAO` component stores admin badges for
 //! other components and calls them as its administrators would, but

Diff for: 5-DAO/smorgasdao/src/lib.rs

@@ -80,8 +80,8 @@
 //! complication here as the intermediary cannot call the DAO back
 //! directly (this would be an invalid re-entrant call) but instead it
 //! must store the admin token awaiting a second call from the
-//! transaction manifest which then calls the DAO. Finally, a third
-//! call must be made to return the Admin token to the DAO component.
+//! transaction manifest which then calls the DAO to do the
+//! configuration change, before returning the admin badge to the DAO.
 //!
 //! Note that the current DAO implementation only offers a single
 //! configuration method, for the `proposal_duration` option, but of
@@ -361,6 +361,11 @@ pub struct Proposal {
     target_funding: Option<Decimal>,
 }
 
+fn blah() {
+    let _f: PreciseDecimal;
+    let _a = dec!("28");
+}
+
 blueprint! {
     struct SmorgasDao {
         /// This holds the XRD we use for our vote subsidies and for
@@ -684,6 +689,9 @@ blueprint! {
         /// You will be returned a receipt NFT which you will need
         /// later to recover your voting tokens.
         ///
+        /// Also returns the ResourceAddress and NonFungibleId of the
+        /// receipt NFT.
+        ///
         /// ---
         ///
         /// **Access control:** If the DAO is configured to require an
@@ -695,7 +703,8 @@ blueprint! {
         #[doc = include_str!("../rtm/smorgasdao/vote_with_receipt.rtm")]
         /// ```
         pub fn vote_with_receipt(&mut self,
-                                 proposal: u64, tokens: Bucket, vote_for: usize) -> Bucket {
+                                 proposal: u64, tokens: Bucket, vote_for: usize)
+                                 -> (Bucket, ResourceAddress, NonFungibleId) {
             assert!(self.id_token.is_none(),
                     "We only accept votes with an id NFT");
 
@@ -722,11 +731,11 @@ blueprint! {
             }
 
             // Record votes
-            proposal.votes_cast.insert(receipt_nfaddr, VotesCast {
+            proposal.votes_cast.insert(receipt_nfaddr.clone(), VotesCast {
                 option: vote_for,
                 votes: Vault::with_bucket(tokens) });
 
-            receipt_nft
+            (receipt_nft, receipt_nfaddr.resource_address(), receipt_nfaddr.non_fungible_id())
         }
 
         /// Call this to pull out your votes from a proposal when you
@@ -747,8 +756,11 @@ blueprint! {
         /// **Access control:** If the DAO is configured to require an
         /// id, no one can call this method.
         ///
-        /// **Transaction manifest:** This method is not in the test
-        /// suite and does not yet have a transaction manifest.
+        /// **Transaction manifest:** 
+        /// `rtm/smorgasdao/withdraw_votes_with_receipt.rtm`
+        /// ```text
+        #[doc = include_str!("../rtm/smorgasdao/withdraw_votes_with_receipt.rtm")]
+        /// ```
         pub fn withdraw_votes_with_receipt(&mut self,
                                            proposal: u64,
                                            id: Bucket) -> Bucket {
@@ -766,7 +778,7 @@ blueprint! {
                 "This proposal does not exist");
 
             let removed_votes =
-                proposal.votes_cast.remove(&id_nfaddr);
+                proposal.votes_cast.get_mut(&id_nfaddr);
 
             // burn the temporary id NFT
             self.id_mint_badge.authorize(|| id.burn());
@@ -775,8 +787,8 @@ blueprint! {
             removed_votes.unwrap().votes.take_all()
         }
 
-        /// Call this method to vote on a DAO that identity NFTs when
-        /// voting.
+        /// Call this method to vote on a DAO that uses identity NFTs
+        /// when voting.
         ///
         /// Provide the unique id of the proposal to vote on, a proof
         /// of your identity, the bucket of tokens you want to bind up
@@ -1128,10 +1140,13 @@ blueprint! {
             // already take tally type into account
             let mut result = vec![Decimal::ZERO; proposal.options.len()];
 
-            // We use PreciseDecimal here and further down because
-            // we're multiplying Decimals together and want to prevent
-            // overflow when we do so.
-            let mut tokens_cast = PreciseDecimal::ZERO;
+            // We should use PreciseDecimal here and further down
+            // because we're multiplying Decimals together and want to
+            // prevent overflow when we do so. We don't do so yet
+            // because Decimal and PreciseDecimal don't seem to play
+            // nice together, you get strange results when you add a
+            // Decimal to a PreciseDecimal.
+            let mut tokens_cast = Decimal::ZERO;
 
             for voter in proposal.votes_cast.values() {
                 result[voter.option] +=
@@ -1172,12 +1187,12 @@ blueprint! {
             match self.quorum {
                 Quorum::Percent(p) => {
                     let cmgr: &ResourceManager = borrow_resource_manager!(self.vote_token);
-                    let supply: PreciseDecimal = cmgr.total_supply().into();
+                    let supply: Decimal = cmgr.total_supply().into();
                     if supply.is_zero() {
                         // Avoid divide by zero
                         meets_quorum = p.is_zero();
                     } else {
-                        let attendance = PreciseDecimal::from("100") * tokens_cast / supply;
+                        let attendance = Decimal::from("100") * tokens_cast / supply;
                         meets_quorum = attendance >= p.into();
                     }
                 },