Impl of Work

Cargo.toml

@@ -2,6 +2,8 @@
 resolver = "2"
 
 members = [
-    "gas-burner",
-    "gas-burner/meta"
+    "gas-burner-contracts/gas-burner",
+    "gas-burner-contracts/gas-burner/meta",
+    "gas-burner-contracts/owner-sc",
+    "gas-burner-contracts/owner-sc/meta"
 ]

gas-burner-contracts/README.md

@@ -0,0 +1,7 @@
+## Setup steps
+
+- deploy the owner-sc
+- deploy gas-burner, giving it the owner-sc's address at init. Make sure it's payable by SC
+- set gas-burner address in owner-sc
+- change the owner of gas-burner to owner-sc
+- unpause gas-burner through owner-sc

gas-burner-contracts/gas-burner/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "gas-burner"
+version = "0.0.0"
+authors = ["you"]
+edition = "2021"
+publish = false
+
+[lib]
+path = "src/lib.rs"
+
+[dependencies.multiversx-sc]
+version = "=0.52.3"
+
+[dependencies.multiversx-sc-modules]
+version = "=0.52.3"
+
+[dependencies.owner-sc]
+path = "../owner-sc"
+
+[dev-dependencies]
+num-bigint = "0.4"
+
+[dev-dependencies.multiversx-sc-scenario]
+version = "=0.52.3"

gas-burner-contracts/gas-burner/src/leaderboard.rs

@@ -0,0 +1,150 @@
+use crate::week_timekeeping::Week;
+
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+#[derive(TypeAbi, TopEncode, TopDecode, PartialEq, Debug)]
+pub struct LeaderboardEntry<M: ManagedTypeApi> {
+    pub user_id: AddressId,
+    pub work_amount: BigUint<M>,
+}
+
+#[multiversx_sc::module]
+pub trait LeaderboardModule:
+    crate::week_timekeeping::WeekTimekeepingModule + crate::signature::SignatureModule
+{
+    /// A placement of 0 means the user does not exist for the given week
+    #[view(getUserLeaderboardPlacement)]
+    fn get_user_leaderboard_placement(&self, user: ManagedAddress, week: Week) -> usize {
+        let user_id = self.user_id().get_id(&user);
+        if user_id == 0 {
+            return 0;
+        }
+
+        self.user_index_in_leaderboard(user_id, week).get()
+    }
+
+    fn increase_leaderboard_entry(&self, user: &ManagedAddress, amount: u64) {
+        let current_week = self.get_current_week();
+        let user_id = self.user_id().get_id_or_insert(user);
+        let user_index = self.user_index_in_leaderboard(user_id, current_week).get();
+        if user_index != 0 {
+            self.increase_work_amount(user_index, amount, current_week);
+        } else {
+            self.add_new_user_entry(user_id, amount, current_week);
+        }
+    }
+
+    fn add_new_user_entry(&self, user_id: AddressId, amount: u64, current_week: Week) {
+        let mut leaderboard_mapper = self.leaderboard(current_week);
+        let new_user_entry = LeaderboardEntry {
+            user_id,
+            work_amount: amount.into(),
+        };
+        let _ = leaderboard_mapper.push(&new_user_entry);
+
+        let leaderboard_len = leaderboard_mapper.len();
+        self.user_index_in_leaderboard(user_id, current_week)
+            .set(leaderboard_len);
+
+        if leaderboard_len == 1 {
+            return;
+        }
+
+        self.set_new_user_entry_in_mapper(
+            current_week,
+            &new_user_entry,
+            leaderboard_len,
+            &mut leaderboard_mapper,
+        );
+    }
+
+    fn set_new_user_entry_in_mapper(
+        &self,
+        current_week: Week,
+        new_user_entry: &LeaderboardEntry<Self::Api>,
+        leaderboard_len: usize,
+        leaderboard_mapper: &mut VecMapper<LeaderboardEntry<Self::Api>>,
+    ) {
+        let mut new_user_index = leaderboard_len;
+        for user_index in (1..=leaderboard_len - 1).rev() {
+            let existing_user_entry = leaderboard_mapper.get_unchecked(user_index);
+            if new_user_entry.work_amount <= existing_user_entry.work_amount {
+                break;
+            }
+
+            self.move_user_down_lb(current_week, &existing_user_entry, leaderboard_mapper);
+            new_user_index -= 1;
+        }
+
+        if new_user_index != leaderboard_len {
+            leaderboard_mapper.set(new_user_index, new_user_entry);
+        }
+
+        self.user_index_in_leaderboard(new_user_entry.user_id, current_week)
+            .set(new_user_index);
+    }
+
+    fn move_user_down_lb(
+        &self,
+        current_week: Week,
+        user_entry: &LeaderboardEntry<Self::Api>,
+        leaderboard_mapper: &mut VecMapper<LeaderboardEntry<Self::Api>>,
+    ) {
+        let prev_user_index = self
+            .user_index_in_leaderboard(user_entry.user_id, current_week)
+            .update(|user_index| {
+                let prev_user_index = *user_index;
+                *user_index += 1;
+
+                prev_user_index
+            });
+
+        let new_user_index = prev_user_index + 1;
+        leaderboard_mapper.set(new_user_index, user_entry);
+    }
+
+    fn increase_work_amount(&self, user_index: usize, work_amount: u64, current_week: Week) {
+        let mut leaderboard_mapper = self.leaderboard(current_week);
+        let mut user_entry = leaderboard_mapper.get(user_index);
+        user_entry.work_amount += work_amount;
+
+        self.update_leaderboard_placement(
+            current_week,
+            &user_entry,
+            user_index,
+            &mut leaderboard_mapper,
+        );
+    }
+
+    fn update_leaderboard_placement(
+        &self,
+        current_week: Week,
+        updated_user_entry: &LeaderboardEntry<Self::Api>,
+        current_user_index: usize,
+        leaderboard_mapper: &mut VecMapper<LeaderboardEntry<Self::Api>>,
+    ) {
+        let mut new_user_index = current_user_index;
+        for user_index in (1..=current_user_index - 1).rev() {
+            let existing_user_entry = leaderboard_mapper.get_unchecked(user_index);
+            if updated_user_entry.work_amount <= existing_user_entry.work_amount {
+                break;
+            }
+
+            self.move_user_down_lb(current_week, &existing_user_entry, leaderboard_mapper);
+            new_user_index -= 1;
+        }
+
+        leaderboard_mapper.set(new_user_index, updated_user_entry);
+        self.user_index_in_leaderboard(updated_user_entry.user_id, current_week)
+            .set(new_user_index);
+    }
+
+    #[storage_mapper("userIndexInLb")]
+    fn user_index_in_leaderboard(&self, user_id: AddressId, week: Week)
+        -> SingleValueMapper<usize>;
+
+    #[view(getLeaderboardForWeek)]
+    #[storage_mapper("leaderboard")]
+    fn leaderboard(&self, week: Week) -> VecMapper<LeaderboardEntry<Self::Api>>;
+}

gas-burner-contracts/gas-burner/src/lib.rs

@@ -0,0 +1,40 @@
+#![no_std]
+
+multiversx_sc::imports!();
+
+pub mod leaderboard;
+pub mod rewards;
+pub mod signature;
+pub mod week_timekeeping;
+pub mod work;
+
+#[multiversx_sc::contract]
+pub trait GasBurner:
+    work::WorkModule
+    + leaderboard::LeaderboardModule
+    + rewards::RewardsModule
+    + signature::SignatureModule
+    + week_timekeeping::WeekTimekeepingModule
+    + multiversx_sc_modules::pause::PauseModule
+{
+    #[init]
+    fn init(&self, owner_sc: ManagedAddress, signer: ManagedAddress, token_id: TokenIdentifier) {
+        require!(token_id.is_valid_esdt_identifier(), "Invalid ESDT token");
+        require!(
+            !owner_sc.is_zero() && self.blockchain().is_smart_contract(&owner_sc),
+            "Invalid SC address"
+        );
+
+        self.owner_sc().set(owner_sc);
+        self.signer().set(signer);
+        self.token().set_token_id(token_id);
+
+        let current_epoch = self.blockchain().get_block_epoch();
+        self.first_week_start_epoch().set(current_epoch);
+
+        self.set_paused(true);
+    }
+
+    #[upgrade]
+    fn upgrade(&self) {}
+}