search

NibiruChain / nibiru

Nibiru Chain: The breakthrough smart contract platform ushering in the next era of money. Nibiru powers an ecosystem of dApps including perps, RWAs, and more.
https://nibiru.fi
Apache License 2.0
182 stars 200 forks source link

feat(evm): typed events for contract creation, contract execution and transfer #1971

Closed onikonychev closed 1 month ago

onikonychev commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates to the NibiruChain project significantly enhance the Ethereum Virtual Machine (EVM) functionality by introducing typed events for contract interactions, improving event tracking and monitoring capabilities. Additionally, new structures and functions facilitate contract execution and testing, while existing tests have been refined for better clarity and robustness. Overall, these changes streamline event management and transaction handling, enhancing usability and performance.

Changes

Files Change Summary
CHANGELOG.md, proto/eth/evm/v1/events.proto Added typed events for contract creation, execution, and transfer to improve event clarity.
x/evm/evmtest/smart_contract.go, x/evm/evmtest/tx.go Introduced ArgsExecuteContract struct and enhanced transaction creation with new parameters.
x/evm/evmtest/smart_contract_test.go Added test for contract execution and updated existing tests for better validation and robustness.
x/evm/keeper/grpc_query_test.go, x/evm/keeper/msg_ethereum_tx_test.go Renamed a test function and added new tests for contract execution, streamlining test case handling.
x/evm/keeper/msg_server.go Enhanced ApplyEvmTx function to emit typed events based on transaction types for better tracking.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EVM
    participant EventEmitter
    User->>EVM: Create/Execute Contract
    EVM->>EventEmitter: Emit EventContractDeployed (for creation)
    EVM->>EventEmitter: Emit EventContractExecuted (for execution)
    EVM->>EventEmitter: Emit EventTransfer (if transfer occurs)

πŸ‡ "In the realm of code, we hop and play,
New events and features brighten the way!
With contracts created, executed with flair,
Our EVM dances, a sight so rare!
So let’s celebrate, with joy and cheer,
In the world of blockchain, there’s nothing to fear!" 🌟

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.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 73.46939% with 13 lines in your changes missing coverage. Please review.

Project coverage is 66.00%. Comparing base (afc7c0f) to head (123ae5d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1971 +/- ## ========================================== + Coverage 65.95% 66.00% +0.05% ========================================== Files 258 258 Lines 16384 16432 +48 ========================================== + Hits 10806 10846 +40 Misses 4772 4772 - Partials 806 814 +8 ``` | [Files](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1971?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain) | Coverage Ξ” | | |---|---|---| | [x/evm/keeper/msg\_server.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1971?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Fmsg_server.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL21zZ19zZXJ2ZXIuZ28=) | `72.38% <100.00%> (+0.80%)` | :arrow_up: | | [x/evm/evmtest/smart\_contract.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1971?src=pr&el=tree&filepath=x%2Fevm%2Fevmtest%2Fsmart_contract.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZXZtdGVzdC9zbWFydF9jb250cmFjdC5nbw==) | `83.67% <83.33%> (-0.95%)` | :arrow_down: | | [x/evm/evmtest/tx.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1971?src=pr&el=tree&filepath=x%2Fevm%2Fevmtest%2Ftx.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZXZtdGVzdC90eC5nbw==) | `0.00% <0.00%> (ΓΈ)` | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1971/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain)
onikonychev commented 1 month ago

Left small improvement comment. Looks great overall

@Unique-Divine you probably didn't finish the review as the comment is invisible.