feat-System leaderboard

[KevinMB0220]

📝 Pull Request Overview

Implements Leaderboard System in Cairo

Closes: Implement leaderboard system and functions #28 (reemplaza con el enlace al issue si corresponde)

---

🔄 Changes Made

Leaderboard System Creation

• Created a new Leaderboard system.
• Defined the following functionalities within the system:
  • create_leaderboard: Initializes a leaderboard with attributes like name, description, and last_updated.
  • add_entry: Adds a new player entry to the leaderboard with details such as player_name, score, wins, and losses.
  • get_all_entries: Retrieves all entries stored in the leaderboard.
  • remove_entry: Removes a player's entry from the leaderboard based on player_id.
  • update_entry: Updates a player's stats in the leaderboard.
  • calculate_score: Computes the player's score based on predefined rules.
  • get_slice: Retrieves a segment of the leaderboard based on rank range (start to end).
  • upgrade_entry_stats: Updates a player's stats incrementally (e.g., adding new wins, losses, or highest scores).

---

🔧 System Design

Data Models

• Leaderboard struct:

  • Attributes:
    • leaderboard_id: Unique identifier for the leaderboard.
    • name: Name of the leaderboard.
    • description: Description of the leaderboard's purpose.
    • entries: Array of LeaderboardEntry structs.
    • last_updated: Timestamp indicating the last update to the leaderboard.

• LeaderboardEntry struct:

  • Attributes:
    • player_id: Unique identifier for the player.
    • player_name: Name of the player.
    • score: Calculated score of the player.
    • wins: Total wins.
    • losses: Total losses.
    • highest_score: Highest single-game score.
    • is_active: Boolean indicating if the player is active.

---

🔬 Tests

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive leaderboard system, allowing users to create leaderboards, add and manage entries, and calculate scores.
  • Added a configuration file for the leaderboard contract, specifying essential attributes for interaction.
  • Included a new module for leaderboard functionality and associated test cases.

• Bug Fixes

  • Commented out inactive modules and test cases to streamline the codebase and improve maintainability.

[coderabbitai]

Walkthrough

The pull request introduces a new leaderboard system for a blockchain application, encapsulated in a JSON ABI file and a corresponding TOML configuration file. The JSON file defines multiple interfaces and structs, including IContract, IWorldProvider, and ILeaderboardAction, which collectively facilitate the management of leaderboard functionalities such as creating leaderboards, adding and updating entries, and calculating scores. Additionally, it outlines structures for ByteArray and LeaderboardEntry, as well as events for contract upgrades. The TOML file provides configuration details for the contract, including its type, class hashes, and ABI file location, while indicating that there are no predefined read or write functions. Furthermore, the src/lib.cairo file sees the addition of the leaderboard module and its associated test module, while the src/systems/leaderboard.cairo file introduces the implementation of the leaderboard system's functionalities, ensuring interaction with the game world through the IWorldDispatcher.

Possibly related PRs

• Add tests for tournament_system #101: The changes in this PR introduce a leaderboard system with interfaces and functions that closely relate to the tournament system's management functionalities, particularly in the handling of entries and scores.

Suggested labels

ODHack10

Suggested reviewers

• coxmars
• danielcdz

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94b39e8 and 52dc238.

📒 Files selected for processing (1)

• src/lib.cairo (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/lib.cairo

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coxmars]

@KevinMB0220 fix the github actions, you have to run sozo build, sozo test and finally sozo build