fix(logic)!: remove unsafe prolog predicates from registry

amimart commented 1 month ago

Closes https://github.com/axone-protocol/axoned/issues/624 Closes https://github.com/axone-protocol/axoned/issues/617 Closes https://github.com/axone-protocol/axoned/issues/336

Purpose

This PR aims to make the logic module prolog vm finally safe, by removing unsafe predicates from the registry. By doing so they cannot be added even through a governance proposal.

The idea is to expose through the registry only safe to use predicates.

Details

Since the recent changes in the VM I was honestly quite disappointed to discover only 2 unsafe predicates 😅. AFAIS previously suspected predicates have all been fixed by the improved VM.

Here are the removed predicates:

halt/1: Make a node to halt, if used in the context of a transaction the network is stopped;
set_prolog_flag/2: This one doesn't seem really unsafe to me regarding the flags we are able to change, but the intent of changing the VM's behaviour (e.g. enable debug mode) is not desirable to me;

Let me know if you have any other potentially unsafe predicates in mind.

Summary by CodeRabbit

New Features
- Updated the interpreter's registry for enhanced functionality by removing specific commands, streamlining the available options for users.
Bug Fixes
- Addressed potential runtime errors by removing access to deprecated functions, improving overall stability of the interpreter.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes in the codebase involve the removal of two Prolog predicates, "set_prolog_flag/2" and "halt/1", from the interpreter's registry. This adjustment is part of an effort to enhance security and streamline functionality, addressing concerns about potential misuse that could lead to operational disruptions in the blockchain environment.

Changes

Files	Change Summary
`x/logic/interpreter/registry.go`	Removed entries for `{"set_prolog_flag/2", engine.SetPrologFlag}` and `{"halt/1", engine.Halt}`.

Assessment against linked issues

Objective	Addressed	Explanation
Remove `halt/1` to prevent potential DOS risks (✅ #624)	✅
Address security concerns linked to `halt/1` and non-deterministic predicates (✅ #617, #336)	✅

Poem

🐇 In the garden where logic blooms bright,
Two predicates vanished, making things right.
No more halting, just smooth, steady flow,
Our blockchain hops high, with each leap we grow!
A safer path now, with each line we write,
A dance of the code, under moon's gentle light. 🌙

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

All modified and coverable lines are covered by tests :white_check_mark:

@@           Coverage Diff           @@
##             main     #710   +/-   ##
=======================================
  Coverage   54.42%   54.42%           
=======================================
  Files          73       73           
  Lines        2901     2901           
=======================================
  Hits         1579     1579           
  Misses       1228     1228           
  Partials       94       94

axone-protocol / axoned