odradev / odra

Odra framework
MIT License
62 stars 2 forks source link

Improve UnwrapOrRevert interface #493

Closed kpob closed 4 months ago

kpob commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits Files that changed from the base of the PR and between e3c4d0092127a83d78c4002a29f59bd99ffe4d62 and 43c4ecd6be2f5af6201aae8a07de39804e853f74.
Files selected for processing (2) * core/src/mapping.rs (4 hunks) * core/src/var.rs (5 hunks)
 ______________________________________________________________________________________________________________________________________________
< Eliminate effects between unrelated things. Design components that are self-contained, independent, and have a single, well-defined purpose. >
 ----------------------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Walkthrough

The codebase was primarily refactored to introduce a new Revertible trait, which centralizes error handling and contract reversion across various components. The changes include implementing Revertible for different modules and adjusting method calls to use this trait, improving code readability and maintainability by reducing the necessity to pass environment references directly in error scenarios.

Changes

Files/Groups Change Summary
core/src/contract_env.rs Added Revertible trait implementations for ContractEnv and ExecutionEnv; modified method call syntax.
core/src/list.rs Introduced Revertible trait; updated replace and get_previous methods to use self.env directly.
core/src/mapping.rs Added Revertible trait for Mapping; refactored add and subtract methods to handle overflow reversion.
core/src/module.rs Introduced Revertible trait with implementations for Rc<ContractEnv> and T: Module; updated imports.
core/src/named_keys.rs Modified key handling methods to adapt to new Revertible trait; updated method signatures.
core/src/sequence.rs Implemented Revertible trait for Sequence<T>; updated imports.
core/src/unwrap_or_revert.rs Updated UnwrapOrRevert trait to use Revertible; refactored methods for Result and Option.
core/src/var.rs Added Revertible trait for Var<T>; consolidated casper_types imports.
examples/src/features/cross_calls.rs Refactored unwrap_or_revert calls to use self instead of &self.env().
examples/src/features/livenet.rs Modified pop_from_stack to use self instead of &self.env().
examples/src/features/module_nesting.rs Updated unwrap_or_revert method call argument from self.env() to self.
modules/src/cep18/storage.rs Refactored unwrap_or_revert calls to use self instead of &self.env() in add and sub functions.
modules/src/cep18_token.rs Modified unwrap_or_revert_with calls in three locations to pass self instead of &self.env().
modules/src/cep78/metadata.rs Removed self.env() in unwrap_or_revert call; used self directly in Metadata implementation.
modules/src/cep78/reverse_lookup.rs Refactored unwrap_or_revert calls to use self instead of &self.env() in ReverseLookup implementation.
modules/src/cep78/token.rs Updated unwrap_or_revert call to use self instead of self.__env in Cep78 implementation.
modules/src/wrapped_native.rs Modified unwrap_or_revert call parameter for handling token amounts in WrappedNativeToken.

Poem

In fields of code where logic thrives,
The Revertible trait now arrives,
Error handling, sharp and clear,
With self ensuring no more fear.
Bugs and chaos now take flight,
Harmony restored, all systems tight.
📜✨


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 Configration 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.
github-actions[bot] commented 4 months ago

Benchmark report

Action Details Gas diff
Wasm Deploy Filename: Benchmark.wasm :red_circle: +0.162050115 CSPR (0.10%)
Contract Call Entry point: set_variable :green_circle: -0.00007555 CSPR (0.05%)
Contract Call Entry point: set_mapping :green_circle: -0.00007555 CSPR (0.05%)
github-actions[bot] commented 4 months ago

Benchmark report

Action Details Gas diff
Wasm Deploy Filename: Benchmark.wasm :red_circle: +0.162050115 CSPR (0.10%)
Contract Call Entry point: set_variable :green_circle: -0.00007555 CSPR (0.05%)
Contract Call Entry point: set_mapping :green_circle: -0.00007555 CSPR (0.05%)