Fix: Automatically use unicode syntax for token names with non-ASCII characters #476
+12
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix: Use unicode string literal for token names with non-ASCII characters (OpenZeppelin#475) - Token names with accents/symbols (e.g., "MyTokeć") now use Solidity’s `unicode"..."` syntax to prevent compilation errors. - Double quotes in names/symbols are escaped (`\"`) to avoid syntax issues. - Developers can now use any Unicode name without manual code adjustments. Fixes OpenZeppelin#475
MKVEERENDRA
changed the title
CoveMB
reviewed
Mar 10, 2025
packages/core/solidity/src/erc20.ts
Outdated
| @@ -109,13 +109,22 @@ export function buildERC20(opts: ERC20Options): ContractBuilder { | |||
|
|
|||
| return c; | |||
| } | |||
| // Helper function to format string literals with the `unicode` keyword if they contain non-ASCII characters. | |||
| // Also escapes double quotes in the string. | |||
| function formatLiteral(str: string): string { | |||
There was a problem hiding this comment.
Let's try to make the function name clear and specific enough so we might not need the comment
packages/core/solidity/src/erc20.ts
Outdated
| @@ -109,13 +109,22 @@ export function buildERC20(opts: ERC20Options): ContractBuilder { | |||
|
|
|||
| return c; | |||
| } | |||
| // Helper function to format string literals with the `unicode` keyword if they contain non-ASCII characters. | |||
| // Also escapes double quotes in the string. | |||
| function formatLiteral(str: string): string { | |||
There was a problem hiding this comment.
We could move this in the utils folder
packages/core/solidity/src/erc20.ts
Outdated
|
|
||
| function addBase(c: ContractBuilder, name: string, symbol: string) { | ||
| const ERC20 = { | ||
| name: 'ERC20', | ||
| path: '@openzeppelin/contracts/token/ERC20/ERC20.sol', | ||
| }; | ||
| c.addParent(ERC20, [name, symbol]); | ||
| // Use formatLiteral to wrap name and symbol appropriately | ||
| c.addParent(ERC20, [formatLiteral(name), formatLiteral(symbol)]); |
There was a problem hiding this comment.
great, we should apply this to other contract (not only ERC20) as well maybe in the contract builder
|
Hey @MKVEERENDRA thanks for submitting this fix ⚡ |
From formatLiteral to sanitize
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix: Use unicode string literal for token names with non-ASCII characters (#475)
unicode"..."syntax to prevent compilation errors.\") to avoid syntax issues.Fixes #475