Skip to content

refactor: streamline code formatting and improve documentation in Pse… #126

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.

Sign up for GitHub

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

Merged
coxmars merged 1 commit into from
May 31, 2025
Merged

refactor: streamline code formatting and improve documentation in Pse… #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions backend/dojo_examples/combat_game/src/helpers/pseudo_random.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,24 @@ pub mod PseudoRandom {
/// # Returns
///
/// A pseudo-random `u8` value within the specified range.
pub fn generate_random_u8(
unique_id: u16,
salt: u16,
min: u8,
max: u8
) -> u8 {
pub fn generate_random_u8(unique_id: u16, salt: u16, min: u8, max: u8) -> u8 {
assert!(min < max, "min must be less than max");

// Get entropy values
let block_timestamp = get_block_timestamp();
let block_number = get_block_number();

// Create unique seeds with your parameters
let timestamp_seed: felt252 = block_timestamp.into() + salt.into();
let block_seed: felt252 = block_number.into() + unique_id.into();
let combined_seed: felt252 = timestamp_seed + (unique_id.wrapping_mul(salt)).into();

// Hash for randomness
let hash_input = combined_seed + block_seed;
let hash_state = PedersenTrait::new(0);
let hash_state = hash_state.update(hash_input);
let hash = hash_state.finalize();

// Convert to range
let range: u64 = max.into() - min.into() + 1_u64.into();
let hash_u256: u256 = hash.into();
Expand All @@ -66,9 +61,11 @@ pub mod PseudoRandom {
mod tests {
use super::PseudoRandom::generate_random_u8;

/// Tests the `generate_random_u8` function to ensure it returns a value within the specified range.
/// Tests the `generate_random_u8` function to ensure it returns a value within the specified
/// range.
///
/// This test ensures that the random value generated is always between `min` and `max`, inclusive.
/// This test ensures that the random value generated is always between `min` and `max`,
/// inclusive.
#[test]
#[available_gas(1000000)]
fn test_generate_random_u8() {
Expand Down Expand Up @@ -98,7 +95,8 @@ mod tests {
assert!(result >= min && result <= max, "Random u8 out of range");
}

/// Tests the `generate_random_u8` function to ensure it produces deterministic outputs within a block.
/// Tests the `generate_random_u8` function to ensure it produces deterministic outputs within a
/// block.
///
/// This test verifies that the random number generated is consistent when called multiple times
/// within the same block (i.e., using the same timestamp and block number).
Expand Down
8 changes: 2 additions & 6 deletions backend/dojo_examples/combat_game/src/models/bag.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ impl BagActions of BagActionsTrait {

#[cfg(test)]
mod tests {
use super::{Bag, BagActions};
use super::{Bag, BagActions};
use crate::types::potion::Potion;
use starknet::contract_address_const;
use core::result::ResultTrait;
Expand All @@ -44,11 +44,7 @@ mod tests {
let bag_id = 1_u256;
let player_id = contract_address_const::<0x0>();

let bag = Bag {
bag_id,
player: player_id,
item: Potion::Health,
};
let bag = Bag { bag_id, player: player_id, item: Potion::Health };

assert_eq!(bag.bag_id, bag_id, "Bag ID should match");
assert_eq!(bag.player, player_id, "Player ID should match");
Expand Down
2 changes: 1 addition & 1 deletion backend/dojo_examples/combat_game/src/types/potion.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ pub enum Potion {
Health,
Mana,
Stamina,
}
}