odradev / odra

Odra framework
MIT License
62 stars 2 forks source link

Add External component #494

Closed kpob closed 4 months ago

kpob commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate limit exceeded

@kpob has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 12 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 09061b52c42c3990d016bfe1b72a8f968f54d535 and b1d80fbe76056d1a8f88e155c4385712bca0f833.

Walkthrough

This update introduces a new External module in the codebase, abstracting the complexities of managing contract references and addresses when calling external contracts. Additionally, the ExecutionError enum is enhanced to handle address-related errors, and several modules have been adjusted to leverage the new External component, simplifying interactions with external contracts.

Changes

File Path Summary
core/src/external.rs Introduced the External module for external contract reference management.
core/src/error.rs Added MissingAddress and AddressAlreadySet variants to ExecutionError.
core/src/lib.rs Included and exported the new external module.
examples/src/contracts/balance_checker.rs Updated BalanceChecker to include a token field of type External<TokenContractRef> and simplified the check_balance method.
modules/src/cep78/utils.rs Modified MockCep78Operator to use External<NftContractContractRef> for nft_contract.
odra-macros/src/ast/... Added SchemaErrorsItem and SchemaEventsItem structs and their implementations.
odra-schema/src/custom_type.rs Added ContractRef and External to the import list and implemented SchemaEvents and SchemaErrors.
odra/src/lib.rs Rearranged exports, added External entity, and adjusted position of GasReport.

Sequence Diagram(s)

sequenceDiagram
    participant BC as BalanceChecker
    participant Ext as External<TokenContractRef>
    participant TC as TokenContract

    BC->>Ext: set(token_address: Address)
    Ext->>TC: Store Address
    BC->>Ext: check_balance(account: Address)
    Ext->>TC: Retrieve token balance
    TC->>Ext: Return balance
    Ext->>BC: Return balance

Possibly related issues

Poem

In the realm of code so grand and vast,
External was born to simplify tasks.
No more fuss with addresses and refs,
Just set it once, let it do the rest.
For contracts now communicate with ease,
Wrapped in elegance, developers at peace.


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.01117587 CSPR (0.01%)
github-actions[bot] commented 4 months ago

Benchmark report

Action Details Gas diff
Wasm Deploy Filename: Benchmark.wasm :red_circle: +0.01117587 CSPR (0.01%)
codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 98.97959% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (release/1.2.0@5d2ea53). Learn more about missing BASE report.

Files Patch % Lines
core/src/external.rs 96.96% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## release/1.2.0 #494 +/- ## ================================================ Coverage ? 87.01% ================================================ Files ? 167 Lines ? 21534 Branches ? 0 ================================================ Hits ? 18737 Misses ? 2797 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kubaplas commented 4 months ago

What if the external contract has a set() method?

github-actions[bot] commented 4 months ago

Benchmark report

Action Details Gas diff
Wasm Deploy Filename: Benchmark.wasm :green_circle: -0.01117587 CSPR (0.01%)