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 #1852

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

RamRamez
Copy link
Collaborator

@RamRamez RamRamez commented Oct 2, 2024

#1777

Summary by CodeRabbit

  • New Features

    • Enhanced token creation process with validation checks for required fields.
    • Added prevention of duplicate tokens based on address and symbol.
  • Bug Fixes

    • Improved error handling to provide more informative messages during token creation.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes focus on the tokenTab.ts file, specifically enhancing the createToken function. Validation checks have been added to ensure that required fields (address, decimals, name, networkId, and symbol) are provided before creating a token. The function now also queries the database to prevent the creation of duplicate tokens based on address and symbol within the same network. Error handling has been improved to deliver more informative messages when validation fails.

Changes

File Path Change Summary
src/server/adminJs/tabs/tokenTab.ts Enhanced createToken function with validation checks for required fields and duplicate prevention. Updated error handling for more informative messages. generateTokenTab remains largely unchanged.

Suggested reviewers

  • ae2079
  • CarlosQ96
  • Meriem-BM

Poem

🐇 In the garden where tokens bloom,
We check for fields to clear the gloom.
No duplicates shall take their place,
Each token shines with a unique grace.
With validations set, we hop with cheer,
Creating tokens, our mission is clear! 🌼


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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0c0aea2 and e4d210f.

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

Comment on lines +156 to +168
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 message to reflect all duplicate fields

When both the token address and symbol already exist, the current error message only indicates one of them. To provide clearer feedback to the user, consider updating the error message to list all duplicate fields that are causing the conflict.

Apply this diff to enhance the error message:

        if (duplicateSymbol || duplicateAddress) {
-          message = `Token ${
-            duplicateAddress ? 'address' : 'symbol'
-          } already exists!`;
+          let duplicateFields = [];
+          if (duplicateAddress) duplicateFields.push('address');
+          if (duplicateSymbol) duplicateFields.push('symbol');
+          const fields = duplicateFields.join(' and ');
+          message = `Token ${fields} already exist${duplicateFields.length > 1 ? '' : 's'}!`;
          type = 'danger';
          return {
            record: {},
            notice: {
              message,
              type,
            },
          };
        }

This change ensures that if both the address and symbol are duplicates, the error message will inform the user accordingly.

📝 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) {
let duplicateFields = [];
if (duplicateAddress) duplicateFields.push('address');
if (duplicateSymbol) duplicateFields.push('symbol');
const fields = duplicateFields.join(' and ');
message = `Token ${fields} already exist${duplicateFields.length > 1 ? '' : 's'}!`;
type = 'danger';
return {
record: {},
notice: {
message,
type,
},
};
}

Comment on lines +132 to +141
if (!address || !decimals || !name || !networkId || !symbol) {
message = 'Please fill all required fields';
type = 'danger';
return {
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

Validate 'decimals' is a valid number

Currently, 'decimals' is only checked for a truthy value. If 'decimals' cannot be converted to a valid number, Number(decimals) will result in NaN, which may cause issues when saving the token. Consider adding a validation check to ensure 'decimals' is a valid number before proceeding.

Apply this diff to improve validation:

        if (!address || !decimals || !name || !networkId || !symbol) {
          message = 'Please fill all required fields';
          type = 'danger';
          return {
            notice: {
              message,
              type,
            },
          };
        }
+       if (isNaN(Number(decimals))) {
+         message = 'Decimals must be a valid number';
+         type = 'danger';
+         return {
+           notice: {
+             message,
+             type,
+           },
+         };
+       }
📝 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 (!address || !decimals || !name || !networkId || !symbol) {
message = 'Please fill all required fields';
type = 'danger';
return {
notice: {
message,
type,
},
};
}
if (!address || !decimals || !name || !networkId || !symbol) {
message = 'Please fill all required fields';
type = 'danger';
return {
notice: {
message,
type,
},
};
}
if (isNaN(Number(decimals))) {
message = 'Decimals must be a valid number';
type = 'danger';
return {
notice: {
message,
type,
},
};
}

Copy link
Collaborator

@Meriem-BM Meriem-BM left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @RamRamez

@RamRamez RamRamez merged commit 046b6e8 into staging Oct 2, 2024
5 checks passed
@RamRamez RamRamez deleted the prevent-duplicate-tokens-being-added-in-admin branch October 2, 2024 12:04
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.

2 participants