XRDao platform

Author: aus87

5-DAO/xrdao/src/lib.rs

@@ -1,36 +1,59 @@
 /// **This submission does not need to be judged due to being incomplete***
 /// 
 /// XRDao protocol is built for medium to long term XRD holders and XRD altcoin
-/// investors.  XRDao is the main component where most of the interactions
-/// take place.  This blueprint allows users to mint XRDao which is pegged 1:1 to XRD.  The
-/// XRDao token has a small tax taken for every trade, transfer, mint, or burn starting at .5%
-/// and can change from governance vote.  Platform fees go towards buying protocol owned
-/// liquidity from the radiswap component and rewarding users
-/// 
-/// The basis of this platform is that as
-/// Users can add Radix altcoins to the investments available for the platform by 
-/// governance proposal and vote.  Users take their XRDao tokens and invest in these
-/// tokens in similar ways as doing it themselves. Users are incentivized to use the 
-/// platform by earning repuataion (rep) tokens when making successful trades and/or earning
-/// fees for the protocol. The more rep a user earns, the higher rank the user can achieve.
-/// Higher ranks allow users to 
-///     1) Earn substantially higher shares of platform fees distributed
-///     2) Increases Users base voting power curve
-///     3) 
-/// 
-///   
-/// 
-/// the protocol takes a small fee on minting and burning
-/// 
-/// The  
-/// 
-/// 
-/// 
-/// XRDaoUsers component organizes users information and stores this
-/// data on soul bound tokens (SBTs) given to each user.  This component is responsible
-/// for keeping all data and balances up to date on these SBTs.
-/// 
-/// XRDaoProposal component allows users to create
+/// investors that are interested in a sustainable rewards structure.  XRDao is the main
+/// component where most of the interactions take place.  This blueprint allows users to mint 
+/// XRDao which is pegged 1:1 to XRD.  The XRDao token has a small tax taken for every trade, 
+/// transfer, mint, or burn starting at .5% and can change from governance vote.  A percent of platform 
+/// fees (which also can change via governanve vote) go towards buying protocol owned liquidity from the 
+/// radiswap component.  The rest of platform fees collected are distributed to users of XRDao
+/// that make successful trades and strategies  when investing through the platform. Future investment
+/// choices will be added along with altcoin investing such as staking to trustworthy validators, loaning
+/// funds to a lending platform for interest.  In order to use XRDao, a user would send XRD
+/// to the platform and mint XRDao token.  The exchange rate for minting and burning XRDao always remains
+/// 1:1 minus the buy/sell fee.  The user would then use these XRDao tokens to pick investment options
+/// just as they would with XRD, but the platform would be making the actual trades/stakes for you.
+/// When a user makes a successful trade, Repuation (rep) tokens are awarded for the amount of xrd earned.
+/// 
+/// For example:
+///     User 1 has 100 xrd and mints 99.5 xrdao, 
+///     User 1 invests 99.5 xrdao into oci,
+///     Oci goes 2x up in price relative to xrd,
+///     User 1 exits oci position
+///     User 1 sends xrdao to burn in return for xrd
+/// 
+/// User 1 now has 198.005 xrdao tokens that can be burned and exchanged for xrd minus the burn fee, as
+/// well as 1.495 Rep. Rep is a soulbound token created by the XRDao platform to signify who is most profitable
+/// for the platform.  It can't be bought, sold, or traded, but it can be earned and minted for good behavior
+/// or removed and burned for bad behavior.  Users are catagorized into Rank by the amount of rep they hold 
+/// into the following ranks:
+///     
+///    President, Highest rep, linear relationship between xrdao and voting power, top 1% of users, 3x reward multiplier
+///    VicePresident, x = y^1.1 voting power, top 10% of users, 1.67x reward multiplier
+///    Senator, x = y^1.2 voting power, top 30% of users, 1.25x reward multiplier
+///    Governor, x = y^1.3 voting power, top 50% of users, 1x reward multiplier
+///    Citizen, x = y^1.5 voting power, top 75% of users, .925x reward multiplier
+///    Pleb,  Lowest rep, quadratic relationship, x = y^2 voting power, top 100% of users, 0x reward multiplier
+/// 
+/// As you can see, different ranks give different curves to determine voting power and different shares of the
+/// fees generated from the platform.  The more money you make, the more rep you earn, the more fees you acrue.
+/// You might be asking yourself, why wouldnt these users just invest themselves and avoid platform fees
+/// alltogether?  XRDao harneses sustainable revenues from market volatility.  When the protocol buys liquidity
+/// from radiswap for XRDao-XRD, XRD volatility will generate price differences between the two tokens in the pool.
+/// When there is ever a price difference above the fee that is being charged (.5%) there will be a profitable
+/// arbitration opportunity within the pool.  Whether an arbitrage bot or a user makes it, fees are then
+/// generated from that trade and go back to buying more liquidity and rewarding each user based on reputation. 
+/// 
+/// The majority of my work here is to the xrdaouser and user components.  Tokentax is a start of an attempt to 
+/// design a component that a token must pass through in order to extract taxes from dex transactions.  My 
+/// understanding is this feature doesnt current work at the resource level, but hopefully it will be in the
+/// future. xrdaoproposal is mostly still copy paste from the Liquidity Dao scrypto examples.  Radiswap is instantiated
+/// to trade and provide liquidity for XRDao-XRD token.
+/// 
+/// written by Austin
+/// @aus877 on twitter
+/// @aus87 on telegram
+
 
 mod radiswap;
 mod xrdao;  

5-DAO/xrdao/src/tokentax.rs

@@ -40,7 +40,7 @@ blueprint! {
         pub fn take_tax() {
             /// take in bucket of token
             /// assert token address matches token address from component
-            /// take tax from bucket, put
+            /// take tax from bucket, put in xrd_fees_collected vault in xrdao component
             /// pass remainder back to user
             /// present admin badge to allow the portion sent back to user to be used in trade/swap/transfer
         }

5-DAO/xrdao/src/xrdao.rs

@@ -152,11 +152,16 @@ blueprint! {
 
             // take fee in put tokens in fee vault
             let total_fee: Decimal = xrd_deposit.amount() * self.buy_fee; // Calculate fees
-            self.xrd_fees_collected.put(xrd_deposit.amount(total_fee)); // puts the collected fee in vault
+            let fee_collected: Bucket = xrd_deposit.take(total_fee);
+            self.xrd_fees_collected.put(fee_collected); // puts the collected fee in vault***********************
 
             // Take remainder and send back to user
+            
+            // test how much is actually in here? has fee been successfully taken?
+            info!("amount to mint is {:?}", xrd_deposit.amount()) // ***should be 99.5
+
             let xrdao_to_mint: Decimal = xrd_deposit.amount();
-            self.collected_xrd.put(xrd_deposit.amount(xrdao_to_mint)); // puts xrd in vault
+            self.collected_xrd.put(xrd_deposit); // puts xrd in vault *****************************************
 
             // Mint xrdao according to how much xrd was deposited
             let xrdao_resource_manager: &mut Resourcemanager = borrow_resource_manager!(self.xrdao_address);
@@ -308,11 +313,14 @@ blueprint! {
         }    
 
         // Buy xrdao-xrd liquidity and deposit LP tokens to vault in this component
+
+        // make sure no dangeling resources or leftovers
         fn buy_xrdao_lp(&mut self, xrd_tokens: Bucket) -> () {
             let radiswap: Radiswap = self.xrdao_radiswap_component.into(); 
             let half = xrd_tokens.take(xrd_tokens.amount()/dec!("2"));
             let (xrdao_tokens, swap_remainder) = radiswap.swap(half);
             self.collected_xrd_fees.put(swap_remainder); // put any remainder back in vault
+            //verify what resource remainder is to put in correct vault ******************************
             let (lp_tokens, lp_remainder) = radiswap.add_liquidity(xrd_tokens.empty(), xrdao_tokens);
             self.lp_token_vault.put(lp_tokens);
             self.collected_xrd_fees.put(lp_remainder); // put any remainder back in vault