feat(multichain): rename token type variants

[lok52]

Summary by CodeRabbit

• New Features
  • Enhanced serialization of TokenType enum with custom names for various token types (ERC-20, ERC-721, ERC-1155, ERC-404).

[coderabbitai]

Walkthrough

The pull request introduces modifications to the build.rs file within the multichain-aggregator-proto project, specifically focusing on enhancing the serialization attributes for the TokenType enum in the Address message. The changes involve adding Serde renaming attributes to various token type enum variants, including ERC-20, ERC-721, ERC-1155, and ERC-404. These attributes will customize how the enum variants are serialized, particularly when converting to JSON formats. The modifications do not alter the fundamental structure of the compile function or change any exported or public entity declarations, representing a targeted enhancement to the project's type serialization capabilities.

Poem

🐰 Hop, hop, through the code's domain,
Token types now with names so plain,
ERC variants dance and sway,
Serialization's rabbit way!
Bytes transform with magical might,
In proto's garden, shining bright 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 57c1884 and 590e679.

📒 Files selected for processing (1)

• multichain-aggregator/multichain-aggregator-proto/build.rs (1 hunks)

🔇 Additional comments (2)

multichain-aggregator/multichain-aggregator-proto/build.rs (2)

22-25: LGTM! Clean and consistent token type renaming

The renaming of token types follows a clear pattern:

• Removes the TOKEN_TYPE_ prefix
• Uses hyphens for better readability (e.g., "ERC-20" instead of "ERC20")
• Consistently applies the pattern across all variants

This will improve the JSON serialization format while maintaining the protobuf enum naming conventions internally.

---

21-21: Verify the impact of adding default attribute

Adding #[serde(default)] means this field will use its default value when missing during deserialization. Ensure this change doesn't affect existing API consumers who might be relying on deserialization failures for validation.

✅ Verification successful

Based on the proto definition and code analysis, I can now generate the final response:

Adding #[serde(default)] is safe and appropriate

The token_type field in the Address message is defined as an enum with TOKEN_TYPE_UNSPECIFIED = 0 as the default value. The codebase shows that:

1. The field is already optional in the database schema (Option<TokenType>)
2. The conversion logic in proto_token_type_to_db_token_type handles the type conversion safely
3. The field is used consistently across the codebase with proper null handling
4. No existing tests or JSON payloads rely on deserialization failures for validation

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for token_type field usage in tests and example JSON payloads
rg -t json "token_type" 
rg -t rust "token_type.*None" 

Length of output: 129

---

Script:

#!/bin/bash
# Let's check the proto definition to understand the default value and current usage
rg -t proto "token_type" -A 5 -B 5

# Also check Rust code for token_type field usage patterns
rg -t rust "token_type" -A 2 -B 2

Length of output: 12052

---

Script:

#!/bin/bash
# Let's check the proto files directly to understand the TokenType enum definition
fd -e proto . -x cat {}

Length of output: 84023

---

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.