Refactor cep18 storage modules

[kpob]

Summary by CodeRabbit

• Refactor

  • Simplified and improved maintainability of token storage by using macro-based implementations for name, decimals, symbol, total supply, balances, and allowances.

• Bug Fixes

  • Enhanced balance retrieval and transfer logic to handle cases where balances may not exist, ensuring more accurate and reliable token operations.

[coderabbitai]

Walkthrough

The recent changes involve a significant refactor in the storage modules for a token, simplifying the code by using macros to handle common storage patterns. This change enhances maintainability and reduces redundancy. Additionally, the balance_of and raw_transfer functions in the Cep18 implementation have been updated to use get instead of get_or_default for balance retrieval, ensuring more precise handling of balance data.

Changes

File	Change Summary
modules/src/cep18/storage.rs	Refactored storage modules using macros for single and compound value storage.
modules/src/cep18_token.rs	Updated balance_of and raw_transfer functions to use get instead of get_or_default.

Poem

In the realm of code, a change so grand,
Macros now lend a helping hand.
Balances checked with precision's might,
Tokens transfer smooth, just right.
Simpler paths and cleaner ways,
For brighter, more maintainable days.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cdf5479 and ce88b1c.

Files selected for processing (2)

• modules/src/cep18/storage.rs (4 hunks)
• modules/src/cep18_token.rs (2 hunks)

Additional comments not posted (5)

modules/src/cep18/storage.rs (3)

22-30: Refactor using single_value_storage! macro enhances maintainability.

This change simplifies the storage handling for single values like name, decimals, symbol, and total supply by using a macro, which makes the code cleaner and more maintainable.

---

50-61: Refactor using base64_encoded_key_value_storage! macro for balance storage.

The use of base64_encoded_key_value_storage! for balance storage is a good practice as it ensures data integrity and simplifies the retrieval and update of balance data.

---

Line range hint 68-86: Refactor using compound_key_value_storage! macro for allowance storage.

The introduction of compound_key_value_storage! for handling allowances is a significant improvement. It simplifies complex key-value storage scenarios, which is crucial for maintaining allowances between addresses.

modules/src/cep18_token.rs (2)

153-153: Update in balance_of function to use unwrap_or_default.

The change from get_or_default to get(...).unwrap_or_default() in the balance_of function is a subtle but important improvement. It makes the handling of default values more explicit, which is crucial for clarity and error handling.

---

284-284: Update in raw_transfer function to use unwrap_or_default.

The modification in raw_transfer to use unwrap_or_default for balance retrieval before performing the transfer ensures that the operation does not proceed on non-existent balances, thus preventing potential errors or security issues.