Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix battle #2422

Merged
merged 2 commits into from
Dec 11, 2024
Merged

fix battle #2422

merged 2 commits into from
Dec 11, 2024

Conversation

credence0x
Copy link
Collaborator

@credence0x credence0x commented Dec 11, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a method to enforce minimum troop counts for battles, ensuring readiness before engagement.
    • Added stamina checks for armies during pillaging to verify sufficient energy for actions.
  • Bug Fixes

    • Enhanced validation logic for battle initiation, ensuring armies are alive and in the same location.
  • Refactor

    • Streamlined battle creation process with improved checks for troop and stamina readiness.

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The pull request introduces a new method assert_minimum_for_battle in the TroopsImpl trait, which enforces a minimum troop count of 100 for knights, paladins, and crossbowmen before engaging in battle. Additionally, it modifies the battle_start and battle_pillage functions in the battle_systems and battle_pillage_systems modules to incorporate this new validation, ensuring that only adequately staffed armies can initiate combat or pillaging. The changes also include stamina checks for armies involved in pillaging.

Changes

File Path Change Summary
contracts/src/models/combat.cairo Added method fn assert_minimum_for_battle(self: Troops) in TroopsImpl to enforce minimum troop counts.
contracts/src/systems/combat/contracts/battle_systems.cairo Updated fn battle_start(ref self: T, attacking_army_id: ID, defending_army_id: ID) with additional validation logic.
contracts/src/systems/combat/contracts/battle_pillage_systems.cairo Updated fn battle_pillage(ref self: T, army_id: ID, structure_id: ID) with additional validation logic and stamina checks.

Possibly related PRs

Suggested reviewers

  • edisontim
  • ponderingdemocritus

🐇 In battles we stand tall,
With knights and paladins, we won't fall.
A hundred strong, we take our stance,
Ready to fight, ready to dance.
With stamina high, our spirits soar,
Together we conquer, forevermore! 🌟


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
🪧 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.

Copy link
Contributor

mentatbot bot commented Dec 11, 2024

You are out of MentatBot reviews. Your usage will refresh December 16 at 08:00 AM.

Copy link

vercel bot commented Dec 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eternum ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 1:23pm
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 1:23pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 1:23pm

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
contracts/src/models/combat.cairo (1)

173-173: Update error messages to match actual usage.

The error messages mention "merge or battle" but the function is only used for battle and pillage operations. Consider updating the messages to be more specific:

-    "you need to at least have 100 knights to merge or battle"
+    "you need to at least have 100 knights to battle"
-    "you need to at least have 100 paladins to merge or battle"
+    "you need to at least have 100 paladins to battle"
-    "you need to at least have 100 crossbowmen to merge or battle"
+    "you need to at least have 100 crossbowmen to battle"

Also applies to: 178-178, 183-183

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 545c706 and 1d5dc26.

📒 Files selected for processing (2)
  • contracts/src/models/combat.cairo (1 hunks)
  • contracts/src/systems/combat/contracts/battle_systems.cairo (2 hunks)
🔇 Additional comments (3)
contracts/src/systems/combat/contracts/battle_systems.cairo (2)

367-367: LGTM! Well-placed validation for minimum troop requirements.

The validation is correctly placed before other battle-related checks, ensuring that armies meet the minimum troop requirements before proceeding with battle initialization.


881-881: LGTM! Consistent validation for minimum troop requirements in pillaging.

The validation is correctly placed after basic checks but before the pillaging logic, maintaining consistency with the battle_start implementation.

contracts/src/models/combat.cairo (1)

170-185: LGTM! Well-implemented minimum troop validation.

The implementation correctly:

  • Uses RESOURCE_PRECISION for decimal handling
  • Validates all three troop types independently
  • Provides clear error messages

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
contracts/src/models/combat.cairo (1)

170-176: Consider making the minimum troop count configurable

While the implementation is correct, having the minimum troop count of 100 hardcoded makes it less flexible for future adjustments. Consider moving this value to the TroopConfig struct to make it configurable.

 struct TroopConfig {
     config_id: u32,
     health: u32,
+    min_troops_for_battle: u32,
     // ... other fields
 }

 fn assert_minimum_for_battle(self: Troops) {
     let total = self.knight_count + self.paladin_count + self.crossbowman_count;
     assert!(
-        total >= (100 * RESOURCE_PRECISION).try_into().unwrap(),
+        total >= (self.min_troops_for_battle * RESOURCE_PRECISION).try_into().unwrap(),
         "you need to have at least have 100 troops for battle"
     );
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1d5dc26 and 2f69731.

📒 Files selected for processing (1)
  • contracts/src/models/combat.cairo (1 hunks)

Comment on lines +170 to +176
fn assert_minimum_for_battle(self: Troops) {
let total = self.knight_count + self.paladin_count + self.crossbowman_count;
assert!(
total >= (100 * RESOURCE_PRECISION).try_into().unwrap(),
"you need to have at least have 100 troops for battle"
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add test coverage for minimum troop requirement

The new assert_minimum_for_battle method lacks test coverage. Consider adding the following test cases:

#[test]
fn test_assert_minimum_for_battle_success() {
    let troops = mock_troops(40 * RESOURCE_PRECISION, 40 * RESOURCE_PRECISION, 40 * RESOURCE_PRECISION);
    // Should pass as total troops > 100
    troops.assert_minimum_for_battle();
}

#[test]
#[should_panic(expected: "you need to have at least have 100 troops")]
fn test_assert_minimum_for_battle_failure() {
    let troops = mock_troops(20 * RESOURCE_PRECISION, 20 * RESOURCE_PRECISION, 20 * RESOURCE_PRECISION);
    // Should fail as total troops < 100
    troops.assert_minimum_for_battle();
}

#[test]
fn test_assert_minimum_for_battle_exact() {
    let troops = mock_troops(34 * RESOURCE_PRECISION, 33 * RESOURCE_PRECISION, 33 * RESOURCE_PRECISION);
    // Should pass as total troops = 100
    troops.assert_minimum_for_battle();
}

@ponderingdemocritus ponderingdemocritus merged commit 54f1955 into next Dec 11, 2024
7 checks passed
@ponderingdemocritus ponderingdemocritus deleted the battle-fixxx branch December 11, 2024 13:26
@coderabbitai coderabbitai bot mentioned this pull request Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants