chore: add small Peggy contract refactors

[gorgos]

Summary by CodeRabbit

• New Features

  • Enhanced validation for transfer amounts in the batch submission process.
  • Improved clarity in the handling of token transfers.

• Bug Fixes

  • Ensured that only positive transfer amounts are processed, preventing potential errors.

• Refactor

  • Simplified logic in the submitBatch function to improve readability and maintainability.

[coderabbitai]

Walkthrough

The changes in the Peggy contract involve enhancements to the submitBatch and sendToInjective functions. A new requirement ensures that the transferAmount is greater than zero in both functions, improving validation. The submitBatch function has been refactored to reduce stack depth by introducing a local variable for the last batch nonce, simplifying logic and improving clarity. These modifications aim to enhance the robustness and readability of the contract's logic regarding batch submissions and token transfers.

Changes

File	Change Summary
solidity/contracts/Peggy.sol	- Added requirement in submitBatch for transferAmount to be greater than zero. - Refactored submitBatch to use a local variable currentBatchNonce for the last batch nonce to reduce stack depth. - Updated checks for batch nonce and maximum nonce jump limit to utilize the local variable. - Adjusted sendToInjective to check transferAmount after transfer logic before emitting events.

Poem

In the land of code where bunnies play,
A new check for transfers brightens the day.
With nonce in hand, we hop with glee,
Validations strong, as strong as can be!
So let’s celebrate, with a joyful cheer,
For clearer logic, we hold dear! 🐇✨

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 20e6df8 and c874bc9.

📒 Files selected for processing (1)

• solidity/contracts/Peggy.sol (2 hunks)

🧰 Additional context used

🔇 Additional comments (1)

solidity/contracts/Peggy.sol (1)

379-380: Excellent refactoring for stack depth reduction and improved readability.

The introduction of the currentBatchNonce local variable is a good optimization. It reduces repeated access to the state variable state_lastBatchNonces[_tokenContract], which can save gas. Additionally, it improves code readability by giving a clear name to the value being used in the subsequent checks.

The updated batch nonce checks using this new variable maintain the same logic while being consistent with the refactoring. This change doesn't alter the behavior of the function but makes it more efficient and easier to understand.

Also applies to: 383-383, 389-389

[maxrobot]

is the comment correct?

[gorgos]

yes, why would it be wrong?