warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.09k stars 96 forks source link

feat(shield): represent ints as big.Int instead of int64 #347

Closed optifat closed 1 month ago

optifat commented 1 month ago

closes #327

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The project has transitioned from using `int64` to `big.Int` for integer representation. This change affects arithmetic operations, parsing, evaluation, and testing of integer values to enhance the handling of large numbers with greater precision. ## Changes | Files/Groups | Change Summaries | |-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | `CHANGELOG.md` | Documented the switch from `int64` to `big.Int` in arithmetic operations and handling negative expressions. | | `proto/shield/ast/ast.proto` | Changed `IntegerLiteral` message field `value` from `int64` to `string`. | | `shield/arithmetic.go` | Updated integer representation to `big.Int` for arithmetic operations. | | `shield/ast/stringify.go` | Modified `Stringify` function to handle `big.Int` values directly without conversion. | | `shield/internal/evaluator/builtins.go` | Imported `math/big`, updated threshold operations and comparisons using `big.Int` methods. | | `shield/internal/evaluator/evaluator.go` | Updated integer parsing, arithmetic operations, and comparisons to use `big.Int`. | | `shield/internal/evaluator/evaluator_test.go` | Introduced `math/big` for tests, added `TestEvalBigIntegerExpression`, updated existing tests to handle `big.Int`. | | `shield/internal/parser/parser.go` | Updated integer parsing logic to use `math/big` instead of `strconv`. | | `shield/internal/parser/parser_test.go` | Added `math/big` for comparisons, introduced `TestBigIntegerExpression`. | | `shield/internal/preprocess/preprocess_test.go`| Updated test assertions to use `big.Int` representations. | | `shield/object/object.go` | Changed `Integer` struct's `Value` field type from `int64` to `*big.Int`. | | `warden/x/warden/keeper/wasm.go` | Updated `parseShieldExpression` to handle integer values using `big.Int` and added handling for string values. | ## Sequence Diagram(s) (Beta) The changes do not introduce new features or modify control flow in a way that necessitates sequence diagrams. ## Assessment against linked issues | Objective | Addressed | Explanation | |------------------------------------------------------------------|-----------|-----------------------------------------------------------------------------| | Move from `int` to `big.Int` in the shield interpreter (#327) | ✅ | | | Add unit tests for handling large numbers (#327) | ✅ | |

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.
optifat commented 1 month ago

the final touch would be to squash the two commits into one, and title it using our convention format: feat(shield): represent ints as big.Int instead of int64 or something like that

everything is in order