Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prevent duplicate tokens being added in adminJS #1851

Closed

Conversation

RamRamez
Copy link
Collaborator

@RamRamez RamRamez commented Oct 2, 2024

#1777

Summary by CodeRabbit

  • New Features

    • Enhanced token creation process with required field validation.
    • Improved duplicate token checks to prevent entry of existing tokens.
  • Bug Fixes

    • Added error messages for missing fields and duplicate tokens to improve user feedback.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes in this pull request focus on the tokenTab.ts file, specifically enhancing the createToken function. New validation checks have been implemented to ensure required fields are filled before token creation, and the logic for detecting duplicate tokens has been expanded. The function now queries the database for existing tokens with the same address and symbol within the same network. The overall structure of the function has been modified to incorporate these validations while maintaining the existing response format.

Changes

File Change Summary
src/server/adminJs/tabs/tokenTab.ts Enhanced createToken function with validation for required fields and duplicate token checks.

Possibly related PRs

Suggested reviewers

  • ae2079
  • CarlosQ96
  • Meriem-BM

Poem

In the garden where tokens grow,
A check for duplicates now will show.
With fields all filled, the process flows,
Creating tokens, as the rabbit knows! 🐇✨
No more errors, just a smooth ride,
In the world of tokens, we take pride!


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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 0c0aea2 and b125c2a.

📒 Files selected for processing (1)
  • src/server/adminJs/tabs/tokenTab.ts (1 hunks)
🔇 Additional comments (3)
src/server/adminJs/tabs/tokenTab.ts (3)

133-142: Validation for required fields is appropriate

The code correctly checks that all required fields (address, decimals, name, networkId, and symbol) are provided before proceeding, which helps prevent incomplete data from being processed.


143-149: Duplicate address check ensures uniqueness

The query effectively checks for an existing token with the same address and network ID, using case-insensitive comparison to prevent duplicate entries.


150-156: Duplicate symbol check ensures uniqueness

The query appropriately checks for an existing token with the same symbol and network ID, ensuring that token symbols remain unique within the network.

Comment on lines +157 to +169
if (duplicateSymbol || duplicateAddress) {
message = `Token ${
duplicateAddress ? 'address' : 'symbol'
} already exists!`;
type = 'danger';
return {
record: {},
notice: {
message,
type,
},
};
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Improve error messaging when both address and symbol already exist

Currently, if both duplicateAddress and duplicateSymbol are true, the error message will only mention the address due to the conditional operator. This could confuse users if both the address and symbol are duplicates.

Consider updating the error message to inform the user when both the address and symbol already exist. Here's a suggested modification:

        if (duplicateSymbol || duplicateAddress) {
-         message = `Token ${
-           duplicateAddress ? 'address' : 'symbol'
-         } already exists!`;
+         if (duplicateAddress && duplicateSymbol) {
+           message = 'Token address and symbol already exist!';
+         } else if (duplicateAddress) {
+           message = 'Token address already exists!';
+         } else if (duplicateSymbol) {
+           message = 'Token symbol already exists!';
+         }
          type = 'danger';
          return {
            record: {},
            notice: {
              message,
              type,
            },
          };
        }

This change provides clearer feedback to the user, specifying exactly which fields are causing the duplication issue.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (duplicateSymbol || duplicateAddress) {
message = `Token ${
duplicateAddress ? 'address' : 'symbol'
} already exists!`;
type = 'danger';
return {
record: {},
notice: {
message,
type,
},
};
}
if (duplicateSymbol || duplicateAddress) {
if (duplicateAddress && duplicateSymbol) {
message = 'Token address and symbol already exist!';
} else if (duplicateAddress) {
message = 'Token address already exists!';
} else if (duplicateSymbol) {
message = 'Token symbol already exists!';
}
type = 'danger';
return {
record: {},
notice: {
message,
type,
},
};
}

@RamRamez RamRamez closed this Oct 2, 2024
@RamRamez RamRamez deleted the prevent-duplicate-tokens-being-added-in-adminJS- branch October 2, 2024 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant