initia-labs / movevm

Other
14 stars 9 forks source link

feat: clear compiler options to use bcs and adopt additional_named_address #114

Closed beer-1 closed 3 weeks ago

beer-1 commented 3 weeks ago

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The recent changes involve significant code refactoring across various files, primarily focusing on the simplification and standardization of compiler argument handling. Several enumerations and structures related to compiler options have been removed, while function signatures have been modified to use ByteSliceView and new CompilerArguments types. This restructuring aims to unify and streamline the interface for compiler-related operations, enhancing the clarity and efficiency of the codebase.

Changes

Files Summary of Changes
api/bindings_compiler.h, libcompiler/bindings_compiler.h Removed multiple enumerations and structures, changing function signatures to accept ByteSliceView types instead of complex argument types.
api/compiler.go, types/compiler/compiler.go Refactored function signatures to utilize types.CompilerArguments, consolidating argument handling and enhancing clarity.
api/compiler_test.go Updated test functions to reflect changes in function signatures and argument types, improving consistency and clarity in test configurations.
crates/compiler/src/command.rs, crates/compiler/src/compiler.rs Removed Prove variant from Command enum and associated functionalities, streamlining command options.
crates/compiler/src/lib.rs Eliminated the prover module from the public interface, changing the visibility of related features.
crates/types/Cargo.toml Introduced new dependencies and reorganized existing ones, enhancing dependency management.
crates/types/src/compiler.rs Added new data structures for compiler configurations, improving usability and configurability.
libcompiler/Cargo.toml Removed several dependencies and added new ones to streamline project complexity and enhance functionality.
libcompiler/src/interface.rs Updated multiple functions to replace CompilerArgument with ByteSliceView, enhancing consistency in argument handling. Removed the prove_move_package function.
tools/generate-bcs-go/src/main.rs Enhanced tracing functionality by incorporating new types related to compiler configurations.
types/bcs.go Introduced new types and serialization functions for compiler options, improving the robustness of the serialization framework.
types/compiler/build/options.go Defined functional options for creating CompilerBuildConfig, enhancing configurability.
types/compiler/docgen/options.go Added functions for managing documentation generation options, allowing flexible customization.
types/compiler/test/options.go Created functions for managing compiler test options, enhancing testing flexibility.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CompilerInterface
    participant CompilerOptions

    User->>CompilerInterface: Request build with options
    CompilerInterface->>CompilerOptions: Serialize options using ByteSliceView
    CompilerOptions-->>CompilerInterface: Serialized options
    CompilerInterface-->>User: Return build result

🐰 In a burrow deep, where the code does spin,
Whiskers twitch with joy, let the changes begin!
From options old, to a new, bright way,
Simplified and clear, hopping through the day.
With each byte and slice, we dance and we play!
Let's build and create, come what may! 🌷✨


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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.