feat: add get_scores view function (#175)

* feat: add `get_scores` view function * chore: add comments
initia-labs · Feb 10, 2025 · c639f88 · c639f88
1 parent f90d5dc
commit c639f88
Show file tree

Hide file tree

Showing 12 changed files with 60 additions and 0 deletions.
diff --git a/precompile/binaries/minlib/bigdecimal.mv b/precompile/binaries/minlib/bigdecimal.mv
diff --git a/precompile/binaries/minlib/ed25519.mv b/precompile/binaries/minlib/ed25519.mv
diff --git a/precompile/binaries/minlib/multisig.mv b/precompile/binaries/minlib/multisig.mv
diff --git a/precompile/binaries/minlib/simple_map.mv b/precompile/binaries/minlib/simple_map.mv
diff --git a/precompile/binaries/minlib/table.mv b/precompile/binaries/minlib/table.mv
diff --git a/precompile/binaries/minlib/vip_score.mv b/precompile/binaries/minlib/vip_score.mv
diff --git a/precompile/binaries/stdlib/bigdecimal.mv b/precompile/binaries/stdlib/bigdecimal.mv
diff --git a/precompile/binaries/stdlib/ed25519.mv b/precompile/binaries/stdlib/ed25519.mv
diff --git a/precompile/binaries/stdlib/multisig.mv b/precompile/binaries/stdlib/multisig.mv
diff --git a/precompile/binaries/stdlib/simple_map.mv b/precompile/binaries/stdlib/simple_map.mv
diff --git a/precompile/binaries/stdlib/table.mv b/precompile/binaries/stdlib/table.mv
diff --git a/precompile/modules/minitia_stdlib/sources/vip/score.move b/precompile/modules/minitia_stdlib/sources/vip/score.move
@@ -2,6 +2,7 @@
 module minitia_std::vip_score {
     use std::vector;
     use std::event;
+    use std::option::{Self, Option};
 
     use minitia_std::signer;
     use minitia_std::table;
@@ -20,6 +21,12 @@ module minitia_std::vip_score {
         score: table::Table<address /* user */, u64>
     }
 
+    //
+    // Constants
+    //
+
+    const MAX_LIMIT: u16 = 1000;
+
     //
     // Errors
     //
@@ -157,6 +164,59 @@ module minitia_std::vip_score {
     // View functions
     //
 
+    struct GetScoresResponse {
+        stage: u64,
+        scores: vector<Score>
+    }
+
+    struct Score {
+        addr: address,
+        score: u64
+    }
+
+    #[view]
+    public fun get_scores(
+        // The stage number
+        stage: u64,
+        // Number of results to return (Max: 1000)
+        limit: u16, 
+        // Pagination key. If None, start from the beginning.  
+        // If provided, return results after this key in descending order.  
+        // Use the last returned address to fetch the next page.
+        start_after: Option<address> 
+    ): GetScoresResponse acquires ModuleStore {
+        let module_store = borrow_global<ModuleStore>(@minitia_std);
+        let scores: vector<Score> = vector[];
+
+        // check stage exists
+        if (!table::contains(&module_store.scores, stage)) {
+            return GetScoresResponse { stage, scores }
+        };
+
+        // check max limit
+        if (limit > MAX_LIMIT) {
+            limit = MAX_LIMIT
+        };
+
+        // collect scores
+        let score = table::borrow(&module_store.scores, stage);
+        let iter = table::iter(
+            &score.score,
+            option::none(),
+            start_after, // exclusive
+            2
+        );
+
+        while (table::prepare<address, u64>(iter)
+            && vector::length(&scores) < (limit as u64)) {
+            let (addr, score) = table::next<address, u64>(iter);
+
+            vector::push_back(&mut scores, Score { addr, score: *score });
+        };
+
+        return GetScoresResponse { stage, scores }
+    }
+
     #[view]
     public fun get_score(account: address, stage: u64): u64 acquires ModuleStore {
         let module_store = borrow_global<ModuleStore>(@minitia_std);