Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: CCTX tracking #170

Merged
merged 2 commits into from
Aug 19, 2024
Merged

fix: CCTX tracking #170

merged 2 commits into from
Aug 19, 2024

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented Aug 16, 2024

This is a quick fix to make sure CCTX tracking works, but I'll need to refactor the code to use the latest API endpoints.

Summary by CodeRabbit

  • New Features

    • Updated logic for fetching cross-chain context (CCTX) data, improving data retrieval clarity and accuracy.
    • Adjusted handling of API response properties to align with a new data structure.
  • Bug Fixes

    • Fixed discrepancies in how outbound transaction parameters are accessed, enhancing consistency in data processing.

@fadeev fadeev requested review from andresaiello and a team as code owners August 16, 2024 16:46
Copy link
Contributor

coderabbitai bot commented Aug 16, 2024

Walkthrough

Walkthrough

The recent changes primarily refactor the logic and structure of the fetchCCTXByInbound and fetchCCTXData functions in the trackCCTX.ts file. This update includes altering property names in response data to better align with the API's new structure, enhancing clarity in data retrieval for cross-chain context (CCTX) processing. These modifications aim to streamline the application's interaction with the API and improve transaction processing.

Changes

File Change Summary
packages/client/src/trackCCTX.ts Updated fetchCCTXByInbound and fetchCCTXData functions to reflect new API response structure, changing inTxHashToCctx to inboundHashToCctx and outbound_tx_params to outbound_params.

Possibly Related Issues


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

packages/client/src/trackCCTX.ts Outdated Show resolved Hide resolved
@@ -34,7 +34,7 @@ const fetchCCTXByInbound = async (
try {
const url = `${API}/zeta-chain/crosschain/inTxHashToCctx/${hash}`;
Copy link

@juansalvatore juansalvatore Aug 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the url stil the same or should it change to inboundHashToCctx?
mainly because before it matched with the data key we have on line 37

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (4)
packages/client/src/trackCCTX.ts (4)

Line range hint 96-99:
Enhance error handling in getCCTX.

Currently, the function silently catches errors. Consider logging the error or providing more context for debugging purposes.

try {
  const url = `${API}/zeta-chain/crosschain/cctx/${hash}`;
  const apiResponseData = await apiFetch(url);
  return apiResponseData?.CrossChainTx;
} catch (e) {
  console.error(`Failed to fetch CCTX for hash ${hash}:`, e);
  return null;
}

Line range hint 101-106:
Enhance error handling in fetchNonces.

Currently, the function silently catches errors. Consider logging the error or providing more context for debugging purposes.

try {
  const url = `${API}/zeta-chain/observer/pendingNonces`;
  const apiResponseData = await apiFetch(url);
  const nonces = apiResponseData?.pending_nonces;
  return nonces.filter((n: any) => n.tss === TSS);
} catch (e) {
  console.error(`Failed to fetch pending nonces:`, e);
  return [];
}

Line range hint 108-113:
Enhance error handling in fetchTSS.

Currently, the function silently catches errors. Consider logging the error or providing more context for debugging purposes.

try {
  const url = `${API}/zeta-chain/observer/TSS`;
  const apiResponseData = await apiFetch(url);
  return apiResponseData?.TSS.tss_pubkey;
} catch (e) {
  console.error(`Failed to fetch TSS:`, e);
  return null;
}

Line range hint 115-194:
Consider refactoring for readability and maintainability.

The trackCCTX function contains complex logic with nested conditions and asynchronous operations. Consider breaking it down into smaller, more focused functions to improve readability and maintainability.

// Example: Consider extracting logic into helper functions
async function handleCCTXTracking(hash, emitter, spinners, API, cctxs, json) {
  // Logic for handling CCTX tracking
}

async function processCCTXData(hash, emitter, spinners, API, cctxs, pendingNonces, json) {
  // Logic for processing CCTX data
}

// Usage in trackCCTX
handleCCTXTracking(hash, emitter, spinners, API, cctxs, json);
processCCTXData(hash, emitter, spinners, API, cctxs, pendingNonces, json);
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ff9b248 and d5db87b.

Files selected for processing (1)
  • packages/client/src/trackCCTX.ts (2 hunks)
Additional comments not posted (2)
packages/client/src/trackCCTX.ts (2)

37-37: Verify the property name inboundHashToCctx.

Ensure that the API response structure has been updated to use inboundHashToCctx. This change should be consistent with the API documentation.


61-69: Verify the property names in outbound_params.

Ensure that the API response structure has been updated to use outbound_params and other related property names. This change should be consistent with the API documentation.

@fadeev fadeev merged commit b60b3ce into main Aug 19, 2024
5 checks passed
@fadeev fadeev deleted the cctx-tracking-quick-fix branch August 19, 2024 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants