Stellar address uniqueness for project creation/update

[Meriem-BM]

Summary by CodeRabbit

• New Features

  • Enhanced GraphQL API clarity with the toWalletMemo field now explicitly defined as a nullable string.
  • Improved address lookup functionality by allowing filtering based on an optional memo parameter.
  • Expanded wallet address validation to accept additional context through optional chain type and memo parameters.
  • Enhanced error handling in validation logic to provide clearer feedback based on memo context.
  • Introduced a migration to enforce uniqueness for project addresses with memo for Stellar chain types.

• Bug Fixes

  • Adjusted query logic to ensure accurate results based on the presence of the memo in address lookups.

[coderabbitai]

Walkthrough

The changes involve updates to several functions and classes across various files. Key modifications include the addition of an optional memo parameter in multiple function signatures, enhancing their capabilities to filter and validate wallet addresses based on additional criteria. The GraphQL field definition for toWalletMemo has also been refined to explicitly define its type and nullability. Additionally, a migration has been introduced to enforce unique address-memo combinations for Stellar.

Changes

Files	Change Summary
src/entities/draftDonation.ts	Modified toWalletMemo field in DraftDonation class from @Field() to @Field(_type => String, { nullable: true }), clarifying its type and nullability in the GraphQL schema.
src/repositories/projectAddressRepository.ts	Added an optional memo parameter to findRelatedAddressByWalletAddress function, enhancing its filtering capabilities based on wallet address and memo. Updated query logic to incorporate the memo parameter for Stellar chain type.
src/resolvers/projectResolver.ts	Enhanced walletAddressIsValid method to accept chainType and memo as optional parameters, allowing for more flexible wallet address validation. Updated internal logic to pass these parameters to validateProjectWalletAddress function.
src/utils/validators/projectValidator.ts	Introduced a new optional memo parameter in validateProjectWalletAddress function, allowing it to utilize additional context when validating wallet addresses. This parameter is passed to findRelatedAddressByWalletAddress function.
src/services/cronJobs/checkQRTransactionJob.ts	Added a logging statement in checkTransactions function to indicate failed transactions with associated id.
migration/1725188424424-UniqueProjectAdressWithMomoForStellar.ts	Introduced a migration to create a unique index on the project_address table for the combination of address and memo fields where chainType is 'STELLAR', enhancing data integrity.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant R as ProjectResolver
    participant V as Validator
    participant A as Address Repository

    C->>R: walletAddressIsValid(address, chainType, memo)
    R->>V: validateProjectWalletAddress(walletAddress, projectId, chainType, memo)
    V->>A: findRelatedAddressByWalletAddress(walletAddress, chainType, memo)
    A-->>V: Return related address
    V-->>R: Validation result
    R-->>C: Return validation response

Loading

Poem

🐰 In fields of code, we hop with glee,
New memos dance, so wild and free!
With wallets bright, and chains that flow,
Our changes bloom, like spring's first show!
Hooray for tweaks, both big and small,
A joyful leap, we celebrate all! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 230cc91 and 553f32b.

Files selected for processing (1)

• migration/1725188424424-UniqueProjectAdressWithMomoForStellar.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• migration/1725188424424-UniqueProjectAdressWithMomoForStellar.ts

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[coderabbitai]

Actionable comments posted: 1

[mohammadranjbarz]

@Meriem-BM Please add a migration to add this unique index to the DB

[Meriem-BM]

@Meriem-BM Please add a migration to add this unique index to the DB

@mohammadranjbarz I added the index if you can re-review it, Thanks

[mohammadranjbarz]

Thanks @Meriem-BM LGTM