Fixing issue for wallet integration [SLT-270]

[Defi-Moses]

Fixing the return for this specific edge case:

https://api.synapseprotocol.com/destinationTx?originChainId=1&txHash=0x1fb8e977e6ba84a0655dd3d62c16c1e0f9748245387c80387fa8a1574db96a02

The problem was that we had not indexed a specific contract in the explorer, meaning that the wrong values were returned (improper decimals and bridged asset instead of the final asset). We also add a verification of using the tokenAddress to generate the symbol (which always returns the final or beginning asset) instead of relying on tokenSymbol, which is assigned during the bridge_event (so will be the bridged token instead of the start/end asset)

I also add a small nit for the frontend explorer here.

Summary by CodeRabbit

• New Features

  • Enhanced transaction responses to include chainID and tokenSymbol.
  • Improved retrieval of token information based on chainID and tokenAddress.
  • Dynamic generation of token symbols in the transaction details based on token address and chain ID.

• Bug Fixes

  • Adjusted the method for calculating tokenDecimals to utilize chainID directly.

cac5153: explorer-ui preview link
4c81004: explorer-ui preview link

[coderabbitai]

Walkthrough

The changes in the destinationTxController.ts and BridgeTransaction function in tx/[kappa].tsx enhance the handling of token information by incorporating chainID alongside tokenAddress and value. A new utility function is introduced to dynamically derive token symbols based on chainID and tokenAddress, improving the accuracy and flexibility of token data retrieval in the response objects.

Changes

File	Change Summary
packages/rest-api/src/controllers/destinationTxController.ts, packages/explorer-ui/pages/tx/[kappa].tsx	Modified destinationTxController to include chainID in destructuring from toInfo, updated response to include chainID and tokenSymbol. In BridgeTransaction, replaced static token symbol assignment with dynamic retrieval using addressToSymbol.

Possibly related PRs

• fix(synapse-interface): RFQ input vs bridgeQuote validation #2742: Modifies how token symbols are derived in the BridgeTransaction function, relevant to the main PR's focus on token information.
• changing native token address standard [SLT-210] #3157: Changes the native token address standard, related to the handling of token addresses in the destinationTxController.
• fix(api): formatted bridge fee amount [SLT-227] #3165: Updates the calculation of bridgeFeeFormatted using token information, aligning with the main PR's focus on token handling.

Suggested labels

M-docs, size/s

Suggested reviewers

• trajan0x
• abtestingalpha
• bigboydiamonds

🐇 In the meadow of code, where changes take flight,
A chainID added brings clarity and light.
With tokens now dancing, their symbols set free,
We hop through the functions, as happy as can be.
Let’s celebrate progress, with each little tweak,
For in every new line, our project grows sleek! 🌼

---

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.

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.

[cloudflare-workers-and-pages]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	ffffb07
Status:	✅  Deploy successful!
Preview URL:	https://bab01a07.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-explorer-graphql.sanguine-fe.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

packages/rest-api/src/controllers/destinationTxController.ts (3)

53-54: LGTM: Improved token information retrieval and decimal calculation.

The use of tokenAddressToToken and the modified getTokenDecimals call address the PR objectives by ensuring correct token verification and decimal calculation. This should resolve the issues with incorrect decimal values and token symbols.

Consider adding a comment explaining the purpose of tokenAddressToToken, as it's crucial for understanding the fix:

+ // Retrieve token information to ensure correct symbol is used
const tokenInfo = tokenAddressToToken(chainID.toString(), tokenAddress)

---

60-62: LGTM: Updated response structure with correct token information.

The changes to the response structure, including the addition of chainID and the derivation of tokenSymbol from tokenInfo, align well with the PR objectives. This ensures that the correct symbol is returned, addressing the issue mentioned in the PR description.

Consider adding a log or comment when tokenInfo is not available, as this might indicate an unexpected scenario:

tokenSymbol: tokenInfo ? tokenInfo?.symbol : null,
+ // Log if tokenInfo is not available for debugging purposes
+ tokenInfo || console.log(`Warning: No token info found for chainID ${chainID} and address ${tokenAddress}`),

---

Action Required: Address Remaining Uses of toInfo.tokenSymbol

The verification process identified a remaining direct use of toInfo.tokenSymbol in the codebase:

• explorer-ui/pages/tx/[kappa].tsx: tokenSymbol={toInfo.tokenSymbol}

Please update this instance to utilize the new tokenAddressToToken utility to ensure consistency and prevent potential issues related to wallet integration.

🔗 Analysis chain

Line range hint 1-76: Summary: Effective implementation addressing the wallet integration issue.

The changes made in this file successfully address the PR objectives by:

1. Introducing a new utility function tokenAddressToToken to verify and retrieve correct token information.
2. Modifying the response structure to include the correct chainID and tokenSymbol.
3. Updating the token decimal calculation to use the correct chainID.

These modifications should effectively resolve the edge case where incorrect values were being returned due to improper indexing of a specific contract in the explorer.

To ensure the changes are consistent across the codebase, please run the following verification script:

This script will help ensure that the changes are consistently applied across the codebase and that there are no remaining instances of the old pattern that could lead to similar issues.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of tokenAddressToToken and related changes

# Test 1: Check for other occurrences of tokenAddressToToken
echo "Checking for other uses of tokenAddressToToken:"
rg "tokenAddressToToken" --type typescript

# Test 2: Verify the import in other files
echo "Verifying import in other files:"
rg "import.*from '../utils/tokenAddressToToken'" --type typescript

# Test 3: Check for any remaining direct uses of toInfo.tokenSymbol
echo "Checking for any remaining direct uses of toInfo.tokenSymbol:"
rg "toInfo\.tokenSymbol" --type typescript

# Test 4: Verify consistent use of chainID in getTokenDecimals
echo "Verifying consistent use of chainID in getTokenDecimals:"
rg "getTokenDecimals\([^)]*\)" --type typescript

Length of output: 789

---

Script:

#!/bin/bash
# Description: Verify the usage of tokenAddressToToken and related changes

# Test 1: Check for other occurrences of tokenAddressToToken
echo "Checking for other uses of tokenAddressToToken:"
rg "tokenAddressToToken" --glob "*.ts" --glob "*.tsx"

# Test 2: Verify the import in other files
echo "Verifying import in other files:"
rg "import.*from '../utils/tokenAddressToToken'" --glob "*.ts" --glob "*.tsx"

# Test 3: Check for any remaining direct uses of toInfo.tokenSymbol
echo "Checking for any remaining direct uses of toInfo.tokenSymbol:"
rg "toInfo\.tokenSymbol" --glob "*.ts" --glob "*.tsx"

# Test 4: Verify consistent use of chainID in getTokenDecimals
echo "Verifying consistent use of chainID in getTokenDecimals:"
rg "getTokenDecimals\([^)]*\)" --glob "*.ts" --glob "*.tsx"

Length of output: 5348

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between abeea4d and 5e3e93c.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (1)

• packages/rest-api/src/controllers/destinationTxController.ts (2 hunks)

🔇 Additional comments (2)

packages/rest-api/src/controllers/destinationTxController.ts (2)

5-5: LGTM: New utility function import.

The import of tokenAddressToToken aligns with the PR objectives and is necessary for the subsequent changes in the controller function.

---

51-51: LGTM: Enhanced destructuring of toInfo.

The inclusion of chainID in the destructuring is consistent with the PR objectives and necessary for the new token verification process. The use of the spread operator for the remaining properties is a good practice for maintaining flexibility.

[codecov]

Bundle Report

Changes will increase total bundle size by 11.69kB (0.03%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
explorer-ui-server-cjs	866.07kB	283 bytes (0.03%) ⬆️
explorer-ui-client-array-push	2.31MB	750 bytes (0.03%) ⬆️
widget-esm-cjs*	283.95kB	10.65kB (3.9%) ⬆️

ℹ️ *Bundle size includes cached data from a previous commit

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

packages/explorer-ui/pages/tx/[kappa].tsx (2)

160-163: LGTM: Improved token symbol derivation for sent amount.

The change correctly implements the addressToSymbol function to derive the token symbol, addressing the PR objective. This should resolve the issue of incorrect symbol display for the sent amount.

Consider destructuring the fromInfo object to improve code readability:

-tokenSymbol={addressToSymbol({
-  tokenAddress: fromInfo.tokenAddress,
-  chainId: fromInfo.chainID,
-})}
+tokenSymbol={addressToSymbol({
+  tokenAddress,
+  chainId: chainID,
+})}

This change would require destructuring fromInfo earlier in the component:

const { tokenAddress, chainID, value } = fromInfo;

---

189-192: LGTM: Improved token symbol derivation for received amount.

The change correctly implements the addressToSymbol function to derive the token symbol for the received amount, addressing the PR objective. This should resolve the issue of incorrect symbol display for the received amount.

For consistency with the suggested improvement for the sent amount, consider destructuring the toInfo object:

-tokenSymbol={addressToSymbol({
-  tokenAddress: toInfo.tokenAddress,
-  chainId: toInfo.chainID,
-})}
+tokenSymbol={addressToSymbol({
+  tokenAddress,
+  chainId: chainID,
+})}

This change would require destructuring toInfo earlier in the component:

const { tokenAddress, chainID, value } = toInfo;

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5e3e93c and 62a26cb.

📒 Files selected for processing (1)

• packages/explorer-ui/pages/tx/[kappa].tsx (3 hunks)

🔇 Additional comments (1)

packages/explorer-ui/pages/tx/[kappa].tsx (1)

13-13: LGTM: New utility function import.

The import of the addressToSymbol function from the utils module is correctly placed and aligns with the PR objectives to improve token symbol derivation.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.56974%. Comparing base (fc6ddae) to head (ffffb07).
Report is 3 commits behind head on master.

Additional details and impacted files

@@                 Coverage Diff                  @@
##              master       #3194          +/-   ##
====================================================
+ Coverage   40.97344%   90.56974%   +49.59630%     
====================================================
  Files            459          54         -405     
  Lines          25641        1018       -24623     
  Branches         342          82         -260     
====================================================
- Hits           10506         922        -9584     
+ Misses         14383          93       -14290     
+ Partials         752           3         -749     

Flag	Coverage Δ
cctp-relayer	?
core	?
ethergo	?
git-changes-action	?
omnirpc	?
opbot	?
packages	90.56974% <ø> (ø)
screener-api	?
scribe	?
solidity	?
tools	?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.