hats-finance / Circles-0x6ca9ca24d78af44582951825bef9eadcb210e5cf

Circles Protocol contracts
https://aboutcircles.com
GNU Affero General Public License v3.0
0 stars 0 forks source link

Default name prefix inconsistent with comments #94

Open hats-bug-reporter[bot] opened 2 months ago

hats-bug-reporter[bot] commented 2 months ago

Github username: -- Twitter username: -- Submission hash (on-chain): 0xdd4c3aa80076f7753f6333d7b37054f18092fa50d3ecb2ee7fc642301ba37ef2 Severity: low

Description: Description\ The default Circles name prefix is set to "Rings-" in the code, but the associated comment indicates that this should be the default prefix for Circles. This inconsistency may lead to confusion, especially for other developers or users.

    /**
     * @notice The default name prefix for Circles
     * @dev to test pre-release codes, we use a toy name prefix
     * so that we can easily identify the test Circles
     */
    string public constant DEFAULT_CIRCLES_NAME_PREFIX = "Rings-";

    /**
     * @notice The default symbol for Circles
     */
    string public constant DEFAULT_CIRCLES_SYMBOL = "RING";

Recommendation:

  1. If "Rings-" is indeed intended as a test prefix, update the comment to accurately reflect this.

  2. If this is an unintended error, change the prefix to "Circles-" to be consistent with the comment.

  3. Consider using a configurable variable to set the prefix, allowing for easy switching between test and production environments.

benjaminbollen commented 2 months ago
/**
  * @notice The default name prefix for Circles
  * @dev to test pre-release codes, we use a toy name prefix
  * so that we can easily identify the test Circles
  */