more comments + fix bugs

Author: yetininoliviercoulibaly

2-oracles/tweeter-oracle/README.md

@@ -1,24 +1,19 @@
-# TwitterOracle
+# TweeterOracle
 
-> ✨ Bootstrapped with Create Snowpack App (CSA).
+ This oracle stores data from the twitter API. Instantiating this component makes it possible to administer this data and make it available to those who need it within the data ledger
+ For example is the radixdlt user account followed by the cyover user account? Or has a tweet been liked by cyover user account ?
+ This data can be useful for automating airdrops. An example of component automating the airdrop was created to test this Oracle (AirdropWithTweeterOracle)
 
-## Available Scripts
+## Quick Start 
 
-### npm start
+1. Build scrypto :  `./scrypto/build.sh`
+2. Test TweeterOracle with shell: `cd  ./tweeter-oracle/scrypto/tweeter-oracle/demo && ./tweeter_oracle.sh`
+3. Test TweeterOracle on web browser : `npm install && npm start` and Open http://localhost:8080 to view it in the browser.
 
-Runs the app in the development mode.
-Open http://localhost:8080 to view it in the browser.
+# AirdropWithTweeterOracle 
+This component allows airdrop automation. A certain number of tasks are defined by the creators of the airdrop component : Follow 1 and/or more accounts, like a tweet and/or more tweets and/retweet one or more tweets.
+Users register for the airdrop via the Register method by specifying their tweeter account and receive in return a non-fungible token to claim the amount of the airdrop when possible.
+At the stage of finalizing the airdrop method (finalize_airdrop) the Tweeter_oracle component is used to verify that all tasks have been executed by subscribers.
 
-The page will reload if you make edits.
-You will also see any lint errors in the console.
-
-### npm run build
-
-Builds a static copy of your site to the `build/` folder.
-Your app is ready to be deployed!
-
-**For the best production performance:** Add a build bundler plugin like [@snowpack/plugin-webpack](https://github.com/snowpackjs/snowpack/tree/main/plugins/plugin-webpack) or [snowpack-plugin-rollup-bundle](https://github.com/ParamagicDev/snowpack-plugin-rollup-bundle) to your `snowpack.config.mjs` config file.
-
-### Q: What about Eject?
-
-No eject needed! Snowpack guarantees zero lock-in, and CSA strives for the same.
+## Quick Start 
+1. tests AirdropWithTweeterOracle with shell: `cd  ./tweeter-oracle/scrypto/tweeter-oracle/demo && ./airdrop_with_tweeter_oracle.sh`

2-oracles/tweeter-oracle/public/tweeter_oracle.wasm

@@ -2,19 +2,22 @@ source ./create_components.sh
 
 #
 resim set-default-account $AIRDROP_REGISTER_ADDRESS_CYOVER  $AIRDROP_REGISTER_PVKEY_CYOVER
-#tweeter account cyover registring to the airdrop
+#tweeter account cyover subscribe to the airdrop
+echo 'account cyover subscribe to the airdrop'
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_COMPONENT\") \"register\" \"cyover\" ;" > tx.rtm
 echo "CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress(\"$AIRDROP_REGISTER_ADDRESS_CYOVER\") \"deposit_batch\";" >> tx.rtm
 resim run tx.rtm
 
-# tweeter account cyrolsi registring to the airdrop
+# tweeter account cyrolsi subscribe to the airdrop
+echo 'tweeter account cyrolsi subscribe to the airdrop'
 resim set-default-account $AIRDROP_REGISTER_ADDRESS_CYROLSI  $AIRDROP_REGISTER_PVKEY_CYROLSI
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_COMPONENT\") \"register\" \"cyrolsi\" ;" > tx.rtm
 echo "CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress(\"$AIRDROP_REGISTER_ADDRESS_CYROLSI\") \"deposit_batch\";" >> tx.rtm
 resim run tx.rtm
 
 
 #cyover has completed alls tasks need by the airdrop (like radixdlt, like and reweet tweet1)  in contrast to cyrolsi 
+echo 'cyover has completed alls tasks need by the airdrop (like radixdlt, like and reweet tweet1)  in contrast to cyrolsi '
 resim set-default-account $TWEETER_ORACLE_ADMIN_ADDRESS  $TWEETER_ORACLE_ADMIN_PVKEY
 #inserting datas by TWEETER_ORACLE_ADMIN_ADDRESS
 echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_ADMIN_ADDRESS\") \"create_proof_by_amount\" Decimal(\"1\") ResourceAddress(\"$TWEETER_ORACLE_ADMIN_BADGE\");" > tx.rtm
@@ -24,15 +27,16 @@ echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"insert_tweet
 resim run tx.rtm
 
 
-#AIRDROP_ADMIN_ADDRESS  find and store airdrop recipeints and finalize it
+#AIRDROP_ADMIN_ADDRESS  find and store airdrop recipients and finalize it
+echo 'AIRDROP_ADMIN_ADDRESS  find and store airdrop recipients and finalize it'
 resim set-default-account $AIRDROP_ADMIN_ADDRESS  $AIRDROP_ADMIN_PVKEY
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_ADMIN_ADDRESS\")  \"create_proof_by_amount\" Decimal(\"1\") ResourceAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_ADMIN_BADGE\");" > tx.rtm
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_COMPONENT\") \"find_and_store_airdrop_recipients\" ;" >> tx.rtm
 resim run tx.rtm
 
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_ADMIN_ADDRESS\")  \"create_proof_by_amount\" Decimal(\"1\") ResourceAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_ADMIN_BADGE\");" > tx.rtm
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_ADMIN_ADDRESS\") \"withdraw\" ResourceAddress(\"$XRD\");" >> tx.rtm
-echo "TAKE_FROM_WORKTOP_BY_AMOUNT Decimal(\"100\") ResourceAddress(\"$XRD\") Bucket(\"xrd_bucket\");" >> tx.rtm
+echo "TAKE_FROM_WORKTOP_BY_AMOUNT Decimal(\"1000\") ResourceAddress(\"$XRD\") Bucket(\"xrd_bucket\");" >> tx.rtm
 echo "CALL_METHOD ComponentAddress(\"$AIRDROP_WITH_TWEETER_ORACLE_COMPONENT\") \"finalize_airdrop\" Bucket(\"xrd_bucket\") ;" >> tx.rtm
 echo "CALL_METHOD_WITH_ALL_RESOURCES ComponentAddress(\"$AIRDROP_ADMIN_ADDRESS\") \"deposit_batch\";" >> tx.rtm
 resim run tx.rtm
@@ -42,13 +46,15 @@ rm tx.rtm
 #withdraw
 
 #cyover withdraw is success 
+echo 'cyover withdrawal is a success '
 resim show $AIRDROP_REGISTER_ADDRESS_CYOVER 
 resim set-default-account $AIRDROP_REGISTER_ADDRESS_CYOVER  $AIRDROP_REGISTER_PVKEY_CYOVER
 resim call-method $AIRDROP_WITH_TWEETER_ORACLE_COMPONENT "withdraw" 1,$AIRDROP_WITH_TWEETER_ORACLE_PARTICIPANT_BADGE
 resim show $AIRDROP_REGISTER_ADDRESS_CYOVER 
 
 
-#cyrolsi try to withdraw and get error because he is not a recipient
+#cyrolsi try to withdraw and get error
+echo 'cyrolsi withdrawal is a failure'
 resim show $AIRDROP_REGISTER_ADDRESS_CYROLSI
 resim set-default-account $AIRDROP_REGISTER_ADDRESS_CYROLSI  $AIRDROP_REGISTER_PVKEY_CYROLSI
 resim call-method $AIRDROP_WITH_TWEETER_ORACLE_COMPONENT "withdraw" 1,$AIRDROP_WITH_TWEETER_ORACLE_PARTICIPANT_BADGE

2-oracles/tweeter-oracle/scrypto/tweeter-oracle/demo/airdrop_with_tweeter_oracle.sh

@@ -2,29 +2,6 @@
 set -x
 set -e
 
-# Setup a baseline environment with 2 users each holding a resource they would
-# trade.
-#
-# To avoid parsing resim output I've manually set the variables based on their
-# (deterministic) values.
-#
-# The "Maker" has a pre-swap setup phase where they make sure they have an
-# account to fund trades from and instantate the Maker Component to handle
-# exzecution of their orders by a sender.  This only needs to be done once, no
-# matter how many trades they sign of any resource type.
-#
-# The "Taker" has a pre-swap setup phase where they nominate (or create) a
-# unique resource they own to act as a badge to prevent frontrunning the
-# transaction submission.  Note their transaction signing key could be used as
-# a virtual badge for this purpose to avoid a pre-swap ledger interaction by
-# the Taker.  But, I'm choosing to be explicit for readability/flexibility to
-# show this need not be directly tied to a given public key.  Anyone with the
-# badge could submit the signed order.
-
-
-##############################
-
-
 resim reset
 
 XRD=030000000000000000000000000000000000000000000000000004

2-oracles/tweeter-oracle/scrypto/tweeter-oracle/demo/baseline.sh

@@ -21,14 +21,25 @@ echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"insert_tweet
 resim run tx.rtm
 
 
-#checking datas
+#checking datas after inserting
 echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_account_follower\" \"radixdlt\" \"cyover\";" > tx.rtm
 resim run tx.rtm
 echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_tweet_liker\" \"tweet1\" \"cyover\";" > tx.rtm
 resim run tx.rtm
 echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_tweet_liker\" \"tweet1\" \"titi\";" > tx.rtm
 resim run tx.rtm
-echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_tweet_retweeter\" \"tweet1\" \"cyover\";" > tx.rtm
+echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_tweet_retweeter\" \"tweet1\" \"cyrolsi\";" > tx.rtm
 resim run tx.rtm
 #cyover user follow radixdlt, like and retweet tweet1
 
+resim set-default-account $TWEETER_ORACLE_ADMIN_ADDRESS  $TWEETER_ORACLE_ADMIN_PVKEY
+#removing datas by TWEETER_ORACLE_ADMIN_ADDRESS
+echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_ADMIN_ADDRESS\") \"create_proof_by_amount\" Decimal(\"1\") ResourceAddress(\"$TWEETER_ORACLE_ADMIN_BADGE\");" > tx.rtm
+echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"remove_account_followers\" \"radixdlt\" HashSet<String>(\"cyover\");" >> tx.rtm
+resim run tx.rtm
+
+#checking data after removing
+echo "CALL_METHOD ComponentAddress(\"$TWEETER_ORACLE_COMPONENT\") \"is_account_follower\" \"radixdlt\" \"cyover\";" > tx.rtm
+resim run tx.rtm
+
+rm tx.rtm

2-oracles/tweeter-oracle/scrypto/tweeter-oracle/demo/tweeter_oracle.sh

@@ -137,10 +137,10 @@ blueprint! {
                 "already registered to this airdrop"
             );
 
-            // Check if the airdrop were already finalize
+            // Check if the airdrop has already been finalized
             assert!(
                 self.amount_per_recipient == Decimal::zero(),
-                "The airdrop were already finalize"
+                "The airdrop has already been finalized"
             );
             // Generate NonFungibleId for participant
             let id = NonFungibleId::random();
@@ -167,7 +167,7 @@ blueprint! {
             return participant_badge;
         }
 
-        //This find the participants that have completed the tasks and to store them
+        //This find the participants who have completed the tasks and to store them
         pub fn find_and_store_airdrop_recipients(&mut self) -> usize {
             //find partcipants who made all tasks
             for nft_id in self.airdrop_participants.keys() {
@@ -185,7 +185,7 @@ blueprint! {
             return self.recipients.len();
         }
 
-        // this method makes it possible to finalize the airdrop
+        // this method allows to finalize the airdrop
         // #Arguments
         // * `tokens` Bucket containing the tokens to distribute
         pub fn finalize_airdrop(&mut self, mut tokens: Bucket) -> Bucket {
@@ -202,36 +202,27 @@ blueprint! {
                 "token address must match"
             );
 
+            //clear the recipients
+            self.recipients.clear();
+
+            // find and store recipients
+            self.find_and_store_airdrop_recipients();
+
             // check recipients
             assert!(
                 self.recipients.len() > 0,
                 "there is no recipient for the airdrop"
             );
 
-            // Check if the airdrop were already finalize
+            // Check if the airdrop have already been finalized
             assert!(
                 self.amount_per_recipient == Decimal::zero(),
-                "The airdrop were already finalize"
+                "The airdrop have already been finalized"
             );
 
-            // check tokens quantity for NonFungible
-            // assert!(
-            //     borrow_resource_manager!(tokens.resource_address()).resource_type()
-            //             == ResourceType::NonFungible && tokens.amount() >= Decimal::from(self.recipients.len() as i128 ) ,
-            //     "For non-fungible tokens, a number at least equal to the number of recipients is required"
-            // );
-
             // Calculate the amount of tokens each recipient can receive
-            let mut amount_per_recipient =
+            let amount_per_recipient =
                 tokens.amount() / Decimal::from(self.recipients.len() as i128);
-            
-            // // Special case for NonFongible Token
-            // if borrow_resource_manager!(tokens.resource_address()).resource_type()
-            //     == ResourceType::NonFungible
-            // {
-            //     amount_per_recipient =
-            //         Decimal::from(amount_per_recipient.round(18, RoundingMode::TowardsZero));
-            // }
 
             self.amount_per_recipient = amount_per_recipient;
 
@@ -246,7 +237,7 @@ blueprint! {
 
         //This method allows recipients to withdraw their tokens
         //#Arguments
-        //* `auth` Aidrop registration proof
+        //* `auth` Airdrop registration proof
         //#Return
         // This function return a  bucket containing the quantity of tokens to be distributed
         pub fn withdraw(&mut self, auth: Proof) -> Bucket {
@@ -264,14 +255,16 @@ blueprint! {
             // checking badge amount
             assert_eq!(auth.amount(), dec!("1"), "Invalid Badge Provided");
             let nft_id = auth.non_fungible::<AirdropWithTweeterOracleData>().id();
+
             // checking if current user completed all tasks
             assert!(
                 self.recipients.contains(&nft_id),
                 "you cannot receive the airdrop because you have not excuted all tasks"
             );
             let mut nft_data = auth.non_fungible::<AirdropWithTweeterOracleData>().data();
+
             // checking if withdrawal is already done
-            assert!(!nft_data.is_collected, "withdraw already done");
+            assert!(!nft_data.is_collected, "withdraw is already done");
             nft_data.is_collected = true;
             let amount = self.amount_per_recipient;
             // update nft data
@@ -280,13 +273,13 @@ blueprint! {
                     auth.non_fungible().update_data(nft_data);
                 }
             });
+
             info!("withdraw_token : {}", amount);
             // return tokens to caller
             return self.tokens.take(amount);
         }
 
         fn has_completed_all_tasks(&self, participant_tweeter_account: String) -> bool {
-            
             let is_follower = self.accounts_to_follow.len() == 0
                 || self.accounts_to_follow.clone().into_iter().all(|x| {
                     self.tweeter_oracle

2-oracles/tweeter-oracle/scrypto/tweeter-oracle/demo/tx.rtm

@@ -1,3 +1,3 @@
-mod airdrop_with_twitter_oracle;
+mod airdrop_with_tweeter_oracle;
 mod tweeter_oracle;
 mod utils;