refactor: move setWorld to init method

evgongora commented 1 month ago

Pull Request Overview

📝 Summary

Closes #13

Changes to setWorld method to dojo_init function following example: https://github.com/dojoengine/dojo/blob/d039c6d46f819edc3f2161c0520b8c8fecec0092/examples/spawn-and-move/src/others.cairo#L18

🔄 Changes Made

Added dojo_init function inside the world contract module, this function directly initializes the world elements
Removed modular interface IWorldSetup and its implementation WorldSetupImpl
The setWorld function, which was part of the interface, has been removed.

🔧 Tests Results

🔜 Next Steps

Summary by CodeRabbit

New Features
- Introduced a new initialization function, dojo_init, for setting up game entities like Beast, Player, Potion, and Mt.
Improvements
- Simplified the module by removing the IWorldSetup trait, enhancing direct access to initialization logic and reducing complexity.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in the world_setup.cairo file involve the removal of the IWorldSetup trait and its setWorld method, which accepted an IWorldDispatcher reference. A new function, dojo_init, is introduced to replace this functionality, directly initializing game entities such as Beast, Player, Potion, and Mt. This refactor simplifies the module by eliminating the trait and consolidating the initialization logic.

Changes

File	Change Summary
src/systems/world_setup.cairo	Removed `IWorldSetup` trait and `setWorld` method; added `dojo_init` function for world initialization.

Assessment against linked issues

Objective	Addressed	Explanation
Create init so we create the world entities when the contracts are deployed (#13)	✅

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 , 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 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

RolandoDrRobot commented 1 month ago

@evgongora Hello Erick could you post the following testing

sozo build
A pic of the successful deploy of the contracts sozo migrate appply
right after that, could you open Torii and check that those first values for those models exists in Katana/Torii
Last, sozo test Thanks!

great job so far

RolandoDrRobot commented 1 month ago

@evgongora could you describe in a comment how did you fix the deploy thing? remember? It was like a versions problem with the rpc, thanks

evgongora commented 2 weeks ago

Hello @RolandoDrRobot! Per my conversation with Glihm I was able to get the next information:

[!IMPORTANT] The init function wil keep being the same as dojo_init since we need permissions to be set first, hence the contract must be registered first. This so when you register a contract in dojo using the sozo migrate, constructor is always empty. Then you use the dojo_init, that can be called once.

[!NOTE]
The error that is showing when using the new dojo_init is because of sozo old versions.

RolandoDrRobot commented 1 week ago

This one is not gonna have any coed merged, I'll close It, thanks @evgongora for the findings and effort!

ByteBuildersLabs / ByteBeastsBackend