feat: support passing titleEscrowAddress to fetchEndorsementChain

[Moiz47]

Changes

• fetchEndorsementChain method accepts optional titleEscrowAddress
• If titleEscrowAddress present in param, removed re computation

Summary by CodeRabbit

• New Features
  • Enhanced endorsement chain retrieval to optionally accept a title escrow address for greater flexibility.

[coderabbitai]

Walkthrough

The fetchEndorsementChain function in useEndorsementChain.ts was updated to accept an optional titleEscrowAddress parameter. The function now conditionally uses this parameter or fetches the address as before, updating all internal references to use the resolved address.

Changes

File(s)	Change Summary
src/core/endorsement-chain/useEndorsementChain.ts	Updated fetchEndorsementChain to accept an optional titleEscrowAddress parameter and use it conditionally throughout the function.

Poem

A chain of trust, with keys in hand,
Now takes an address, just as planned.
If you know the way, you show the path—
If not, we fetch it, do the math!
Rabbits hop with code so neat,
Endorsements resolved, the loop’s complete.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-10T05_43_57_079Z-debug-0.log

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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: 0

🧹 Nitpick comments (1)

src/core/endorsement-chain/useEndorsementChain.ts (1)

213-213: Consider validating the provided titleEscrowAddress.

While the optimization is beneficial, there's no validation that the provided titleEscrowAddress is valid or corresponds to the given tokenRegistryAddress and tokenId. An invalid address could lead to confusing error messages downstream.

Consider adding basic validation:

  const resolvedTitleEscrowAddress =
-    titleEscrowAddress ?? (await getTitleEscrowAddress(tokenRegistryAddress, tokenId, provider));
+    titleEscrowAddress ?? (await getTitleEscrowAddress(tokenRegistryAddress, tokenId, provider));
+
+  // Optional: Validate the provided address is valid
+  if (titleEscrowAddress && !ethers.utils.isAddress(titleEscrowAddress)) {
+    throw new Error('Invalid titleEscrowAddress provided');
+  }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c125eb2 and ba81a58.

📒 Files selected for processing (1)

• src/core/endorsement-chain/useEndorsementChain.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/core/endorsement-chain/useEndorsementChain.ts (3)

src/core/endorsement-chain/types.ts (1)

• EndorsementChain (63-63)

src/core/endorsement-chain/fetchEscrowTransfer.ts (2)

• fetchEscrowTransfersV4 (21-40)
• fetchEscrowTransfersV5 (42-60)

src/core/endorsement-chain/helpers.ts (1)

• mergeTransfersV4 (28-59)

🔇 Additional comments (5)

src/core/endorsement-chain/useEndorsementChain.ts (5)

203-203: LGTM: Function signature enhancement maintains backward compatibility.

The addition of the optional titleEscrowAddress parameter is well-designed and maintains backward compatibility while enabling the performance optimization described in the PR objectives.

---

208-209: LGTM: Efficient conditional resolution logic.

The use of the nullish coalescing operator (??) properly implements the optimization by using the provided address when available or falling back to the existing computation logic. This achieves the stated goal of skipping re-computation when the address is already known.

---

218-218: LGTM: Consistent usage of resolved address.

The function call correctly uses the resolvedTitleEscrowAddress to maintain consistency with the optimization pattern.

---

233-233: LGTM: Proper integration with V4 transfer fetching.

The call to fetchEscrowTransfersV4 correctly uses the resolved address, maintaining the optimization benefit.

---

240-240: LGTM: Proper integration with V5 transfer fetching.

The call to fetchEscrowTransfersV5 correctly uses the resolved address, completing the optimization implementation across both versions.

[nghaninn]

🎉 This PR is included in version 1.6.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀