Provable-Games / loot-survivor

A fully onchain arcade dungeon crawler built on Starknet in conjunction with Realms.world. Explore the dynamically generated dungeons while you fight for your life against beasts and obstacles in pursuit of a spot on the esteemed leaderboard.
https://survivor.realms.world
MIT License
5 stars 7 forks source link

Change token id u32 u128 #262

Closed loothero closed 1 month ago

loothero commented 1 month ago

Summary by CodeRabbit

vercel[bot] commented 1 month ago

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

Name Status Preview Comments Updated (UTC)
loot-survivor ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 0:05am
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve modifying the data types of several fields and parameters related to token identifiers across multiple files in the Cairo contracts. Specifically, the u32 type has been replaced with u128 for fields such as launch_tournament_winner_token_id and token_id, enhancing the capacity for larger numerical values. Updates were made to the packing and unpacking logic, as well as to test cases, ensuring compatibility with the new data types.

Changes

Files Change Summary
contracts/adventurer/src/adventurer_meta.cairo Modified launch_tournament_winner_token_id from u32 to u128 in AdventurerMetadata struct and related functions. Updated packing logic and test cases accordingly.
contracts/game/src/game/interfaces.cairo Changed several function parameters from u32 to u128, including launch_tournament_winner_token_id, token_id in various functions.
contracts/game/src/lib.cairo Updated function signatures and internal structures to replace u32 with u128 for token IDs, enhancing handling capabilities for larger values.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GameContract
    participant AdventurerContract

    User->>GameContract: Launch Tournament with u128 token_id
    GameContract->>AdventurerContract: Notify tournament launch with u128 token_id
    AdventurerContract-->>GameContract: Confirm tournament launch
    GameContract-->>User: Tournament launched successfully

🐰 In fields of code, we hop and play,
With numbers big, we leap and sway.
From u32 to u128, we cheer,
A broader range brings joy, oh dear!
In contracts bright, our tokens gleam,
Hopping along, we code and dream! 🌟

[!TIP]

Announcements - The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment. - We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838) on our Discord. - Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the [discussion post](https://discordapp.com/channels/1134356397673414807/1282535539299323995) on our Discord. - Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file. - Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between b76e58bfc6e937387b9a5adbbac48faa0b6e8198 and 0037c31d948321540877c198deb5629a6918d8a0.
Files selected for processing (3) * contracts/adventurer/src/adventurer_meta.cairo (7 hunks) * contracts/game/src/game/interfaces.cairo (4 hunks) * contracts/game/src/lib.cairo (18 hunks)
Additional comments not posted (19)
contracts/game/src/game/interfaces.cairo (4)
`23-23`: **LGTM!** The code change is approved. Changing the `launch_tournament_winner_token_id` parameter to `u128` allows for a broader range of token ID values. --- Line range hint `28-28`: **LGTM!** The code change is approved. Modifying the `token_id` parameter to `u128` in the `explore` function aligns with the broader range of token ID values introduced in the `launch_tournament_winner_token_id` parameter. --- `74-74`: **LGTM!** The code change is approved. Transitioning the `token_id` parameter to `u128` in the `enter_launch_tournament_with_signature` function is consistent with the broader range of token ID values introduced in other functions. --- `136-136`: **LGTM!** The code change is approved. Changing the `token_id` parameter to `u128` in the `free_game_available` function allows for a broader scope of token types that can be checked for availability, consistent with the updates to other functions.
contracts/adventurer/src/adventurer_meta.cairo (4)
`12-12`: **LGTM!** The code change is approved. Changing the `launch_tournament_winner_token_id` field to `u128` within the `AdventurerMetadata` struct enhances its capacity to store larger values. --- `97-97`: **LGTM!** The code change is approved. Updating the `launch_tournament_winner_token_id` parameter to `u128` in the `ImplAdventurerMetadata` function aligns with the change made to the `AdventurerMetadata` struct. --- Line range hint `135-225`: **LGTM!** The code changes are approved. The updated test cases in the `test_adventurer_metadata_packing` function ensure that the packing and unpacking processes handle the expanded range of values for the `launch_tournament_winner_token_id` field correctly. The introduction of constants like `U32_MAX` and `U128_MAX` supports the new logic effectively. --- Line range hint `252-266`: **Skipped.** The test case for the `test_new_adventurer_metadata` function remains unchanged and continues to test the creation of a new `AdventurerMetadata` struct as expected.
contracts/game/src/lib.cairo (11)
Line range hint `380-392`: **LGTM!** The change of the `launch_tournament_winner_token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- Line range hint `996-1010`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- Line range hint `1057-1067`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `1269-1271`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- Line range hint `1341-1351`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- Line range hint `3696-3700`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `3705-3707`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `4644-4646`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `4656-4658`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `4666-4668`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR. --- `4725-4727`: **LGTM!** The change of the `token_id` parameter type from `u32` to `u128` is approved. This allows for a larger range of token IDs, which is consistent with the overall goal of the PR.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.