fix(affiliates): [OTE-898] Refactor subaccount username generation

[teddyding]

Changelist

Fix username generation logic.

• Make username deterministic based on${address}/${subaccount_num}/${nonce}. Only generate for subaccounts with subaccount_num = 0. nonce should be almost always be zero.
  See thread

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

• New Features

  • Introduced new constants for subaccounts and addresses, enhancing testing capabilities.
  • Added a new asynchronous function for seeding additional subaccounts.
  • Implemented a new method for generating usernames specifically for subaccounts.
  • Introduced new leaderboard tasks for various time spans.

• Bug Fixes

  • Improved error handling for username generation and data integrity checks.

• Documentation

  • Updated configuration options related to subaccount username generation.

• Chores

  • Updated dependencies in the project configuration.

• Style

  • Enhanced clarity in variable naming conventions across various files.

• Tests

  • Updated test cases to reflect new functionalities and ensure correctness in username generation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve the addition of new constants and methods related to subaccount management, particularly in the context of username generation. New constants for default addresses and subaccounts are introduced, alongside modifications to existing methods for fetching and generating usernames. The test suites have been updated to incorporate these new functionalities, ensuring that the username generation process is deterministic and consistent. Additionally, the configuration settings related to username generation have been enhanced to accommodate these changes.

Changes

File Path	Change Summary
indexer/packages/postgres/__tests__/helpers/constants.ts	Added constants: defaultAddress3, defaultSubaccount2Num0, defaultSubaccount3Num0.
indexer/packages/postgres/__tests__/helpers/mock-generators.ts	Added method: seedAdditionalSubaccounts(), imported new constants.
indexer/packages/postgres/__tests__/stores/subaccount-usernames-table.test.ts	Updated tests to use seedAdditionalSubaccounts and modified method calls for fetching subaccounts.
indexer/packages/postgres/src/stores/subaccount-usernames-table.ts	Renamed method from getSubaccountsWithoutUsernames to getSubaccountZerosWithoutUsernames, added limit parameter.
indexer/packages/postgres/src/types/subaccount-usernames-types.ts	Added address property to SubaccountsWithoutUsernamesResult interface.
indexer/services/comlink/src/controllers/api/v4/affiliates-controller.ts	Renamed variable subaccountRows to subaccountZeroRows, added error logging for duplicate usernames.
indexer/services/roundtable/__tests__/helpers/usernames-helper.test.ts	Replaced test for generateUsername with a new test for generateUsernameForSubaccount.
indexer/services/roundtable/__tests__/tasks/subaccount-username-generator.test.ts	Added call to seedAdditionalSubaccounts() in beforeEach.
indexer/services/roundtable/package.json	Added dependency: "seedrandom": "^3.0.5" and dev dependency: "@types/seedrandom": "^3.0.8".
indexer/services/roundtable/src/config.ts	Added properties: SUBACCOUNT_USERNAME_GENERATOR_LOCK_MULTIPLIER, SUBACCOUNT_USERNAME_BATCH_SIZE, ATTEMPT_PER_SUBACCOUNT.
indexer/services/roundtable/src/helpers/adjectives.json	Modified list of adjectives, adding new ones and removing several.
indexer/services/roundtable/src/helpers/nouns.json	Modified list of nouns, adding new entries and removing several.
indexer/services/roundtable/src/helpers/usernames-helper.ts	Renamed generateUsername to generateUsernameForSubaccount, updated logic to use seedrandom.
indexer/services/roundtable/src/index.ts	Updated startLoop to include SUBACCOUNT_USERNAME_GENERATOR_LOCK_MULTIPLIER, added new leaderboard tasks.
indexer/services/roundtable/src/tasks/subaccount-username-generator.ts	Updated runTask to use new method getSubaccountZerosWithoutUsernames, enhanced error handling and logging.

Possibly related PRs

• [OTE-539] Add subaccounts username table #1917: This PR adds a subaccounts username table, which is directly related to the new constants introduced in the main PR for subaccount management.
• [OTE-540] Add roundtable task to generate usernames #1932: This PR introduces a roundtable task to generate usernames, which utilizes the new constants added in the main PR for subaccount username generation.
• enable username generation roundtable #2361: This PR enables username generation by changing the configuration, which aligns with the new constants and structures introduced in the main PR.
• [OTE-863] update username generation query #2482: This PR updates the username generation query, which is directly related to the changes made in the main PR regarding subaccount constants and structures.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

• affanv14
• jerryfan01234

🐰 In the fields where bunnies roam,
New constants sprout, like seeds we’ve sown.
With usernames crafted, unique and bright,
Subaccounts flourish, what a delight!
Hopping along, we cheer and play,
For changes made, hip-hip-hooray! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[linear]

OTE-898 Refactor username generation

[teddyding]

Expanded/filtered list

[teddyding]

Expanded/filtered list

[teddyding]

@Mergifyio backport release/indexer/v7.x

[mergify]

backport release/indexer/v7.x

✅ Backports have been created

• #2571 fix(affiliates): [OTE-898] Refactor subaccount username generation (backport #2569) has been created for branch release/indexer/v7.x