search

andromedaprotocol / andromeda-core

Operating System and ADO Smart Contracts
https://andromedaprotocol.io/
38 stars 27 forks source link

feat: CustomError #505

Closed joemonem closed 2 months ago

joemonem commented 4 months ago

Motivation

Addresses Issue #500

Implementation

Add a CustomError variant to our ContractError Enum. This new variant takes a custom message as input, so external developers can display any error message they want in case they didn't find their desired Error variant in our ContractError

Testing

N/A

Version Changes

No version changes

Notes

This solution is based off the assumption that external developers will import our ContractError enum.

Future work

We can easily add the most used custom errors as new variants to ContractError.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The ContractError enum in packages/std/src/error.rs has been enhanced with a new CustomError variant, allowing developers to specify custom error messages. Additionally, the ADOContract in execute.rs has been updated to adopt a more flexible error handling approach, permitting various error types through generic parameters, thereby improving the usability and robustness of error management.

Changes

Files Change Summary
packages/std/src/error.rs Added CustomError variant to ContractError enum
packages/std/src/ado_contract/execute.rs Updated ExecuteContextFunction and execute_amp_receive to support generic error types, enhancing flexibility in error handling.

Poem

In the meadow of code where errors reside,
A new variant blooms, with developers' pride.
Custom messages now dance in the air,
Flexibility grows, and troubles beware.
With every change, our contracts grow bright,
Tailored errors make coding a delight!
🐇✨🌼

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.
crnbarr93 commented 3 months ago

I think this can be achieved in a cleaner fashion using a generic with From<ContractError>

cowboy0015 commented 3 months ago

I am not sure if current approach is actually going to solve the problem. External ADOs should not be forced to throw core repo's ContractError. execute_amp_receive function is supposed to be used for external ADOs as it is responsible for sending ibc packets but it is throwing the core repo's ContractError and thus incompatible with external ADOs.

For the ExecuteContextFunction type used in execute_amp_receive,

type ExecuteContextFunction<M, E = ContractError> = fn(ExecuteContext, M) -> Result<Response, E>;

I see that it was originally designed with generic E but forced to use ContractError. Is there any technical problems with this?

To solve the issue, I think it should be changed like this

- type ExecuteContextFunction<M, E = ContractError> = fn(ExecuteContext, M) -> Result<Response, E>;
+ type ExecuteContextFunction<M, E> = fn(ExecuteContext, M) -> Result<Response, E>;

and update the execute_amp_receive with generic E parameter.

crnbarr93 commented 3 months ago

I am not sure if current approach is actually going to solve the problem. External ADOs should not be forced to throw core repo's ContractError. execute_amp_receive function is supposed to be used for external ADOs as it is responsible for sending ibc packets but it is throwing the core repo's ContractError and thus incompatible with external ADOs.

For the ExecuteContextFunction type used in execute_amp_receive,

type ExecuteContextFunction<M, E = ContractError> = fn(ExecuteContext, M) -> Result<Response, E>;

I see that it was originally designed with generic E but forced to use ContractError. Is there any technical problems with this?

To solve the issue, I think it should be changed like this

- type ExecuteContextFunction<M, E = ContractError> = fn(ExecuteContext, M) -> Result<Response, E>;
+ type ExecuteContextFunction<M, E> = fn(ExecuteContext, M) -> Result<Response, E>;

and update the execute_amp_receive with generic E parameter.

I think the only shortcoming here is that the error type needs to implement From<ContractError> as we call verify_origin which can return a ContractError result.

This also requires the developer to wrap our error type as an enum type in their error type:

pub enum MyContractError {
 /// Their error types
 AndromedaError(AndromedaContractError)
}