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/to adress tron #342

Merged
merged 10 commits into from
Sep 27, 2024
Merged

Fix/to adress tron #342

merged 10 commits into from
Sep 27, 2024

Conversation

haunv3
Copy link
Contributor

@haunv3 haunv3 commented Sep 27, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced address validation and assignment during the universal swap process.
    • Improved handling of recipient addresses, including conditional format conversion between Tron and Ethereum.
  • Updates

    • Incremented version of @oraichain/oraiswap-v3 from 0.1.8 to 0.1.20.
    • Updated dependency for @oraichain/oraidex-common to version ^1.1.21.
    • Incremented version of @oraichain/oraidex-universal-swap from 1.1.10 to 1.1.11.
  • Chores

    • Removed outdated GitHub Actions workflow for publishing Oraiswap v3.

Copy link

coderabbitai bot commented Sep 27, 2024

Walkthrough

The pull request includes the deletion of a GitHub Actions workflow for publishing the Oraiswap v3 package, updates to the version numbers in the package.json files for @oraichain/oraiswap-v3 and @oraichain/oraidex-universal-swap, and modifications to the UniversalSwapHandler class to improve address validation and assignment during the swap process. These changes reflect ongoing updates and refinements to the Oraiswap v3 package and its associated components.

Changes

File Path Change Summary
.github/workflows/publish_oraiswap_v3.yml Deleted workflow for publishing Oraiswap v3 package, triggered on pushes and manual executions.
packages/oraiswap-v3/package.json Version updated from 0.1.8 to 0.1.20; dependency @oraichain/oraidex-common updated from ^1.1.6 to ^1.1.21.
packages/universal-swap/package.json Version updated from 1.1.10 to 1.1.11.
packages/universal-swap/src/handler.ts Updated UniversalSwapHandler for improved recipient address validation and assignment logic.

Possibly related PRs

Suggested reviewers

  • trungbach
  • quangdz1704

Poem

🐇 In the garden where code does bloom,
Changes sprout, dispelling gloom.
Versions rise, workflows fade,
A rabbit hops, new paths are laid.
With each swap, we dance and play,
Celebrating code in a joyful way! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cac26ca and 665c312.

📒 Files selected for processing (1)
  • packages/universal-swap/src/handler.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/universal-swap/src/handler.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
🪧 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.

Copy link

github-actions bot commented Sep 27, 2024

badge

Code Coverage Summary

Filename                                                                      Stmts    Miss  Cover    Missing
--------------------------------------------------------------------------  -------  ------  -------  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
docs/assets/main.js                                                              58      58  0.00%    1-58
docs/assets/search.js                                                             1       1  0.00%    1
packages/ibc-routing/hardhat.config.ts                                           59      59  0.00%    1-75
packages/ibc-routing/src/db.ts                                                  158     158  0.00%    1-263
packages/ibc-routing/src/event.ts                                                85      85  0.00%    1-122
packages/ibc-routing/src/index.ts                                                31      31  0.00%    1-56
packages/ibc-routing/src/machine.ts                                              30      30  0.00%    1-34
packages/ibc-routing/test/mock-eth-ws.ts                                         52      52  0.00%    1-55
packages/ibc-routing/test/mock-tendermint-ws.spec.ts                             25      17  32.00%   7-24
packages/oraidex-common/src/alpha-network.ts                                     61       0  100.00%
packages/oraidex-common/src/axios-request.ts                                     11      11  0.00%    1-20
packages/oraidex-common/src/bigdecimal.ts                                       139      50  64.02%   23-24, 30-33, 40-41, 45-54, 63-65, 71-73, 120-124, 127-146, 149-150, 153-154, 180-181, 184-185
packages/oraidex-common/src/constant.ts                                         169       0  100.00%
packages/oraidex-common/src/helper.ts                                           466     142  69.52%   141-142, 145-156, 159-169, 267-269, 286-293, 296-309, 319-325, 335-350, 353-360, 363-393, 396-404, 407-409, 412-414, 418-427, 436-450, 456-458, 543-544, 569-572
packages/oraidex-common/src/ibc-info.ts                                         183     183  0.00%    1-215
packages/oraidex-common/src/index.ts                                             13      13  0.00%    1-13
packages/oraidex-common/src/network.ts                                         1022       0  100.00%
packages/oraidex-common/src/pairs.ts                                            154       4  97.40%   151-152, 157-158
packages/oraidex-common/src/token.ts                                             71       0  100.00%
packages/oraidex-common/src/wallet.ts                                           146     146  0.00%    1-236
packages/oraidex-common/src/config/chainInfosWithIcon.ts                        208     208  0.00%    1-222
packages/oraidex-common/src/interface/index.ts                                    1       1  0.00%    1
packages/oraidex-common/src/interface/wallet.ts                                  19      19  0.00%    1-20
packages/oraidex-common/tests/bigdecimal.spec.ts                                220       0  100.00%
packages/oraidex-common/tests/helper.spec.ts                                    560       8  98.57%   97-98, 337-338, 628-629, 659-660
packages/oraidex-common/tests/pairs.spec.ts                                      24       0  100.00%
packages/oraiswap-v3/src/const.ts                                                11       0  100.00%
packages/oraiswap-v3/src/error.ts                                                 5       2  60.00%   3-4
packages/oraiswap-v3/src/handler.ts                                             292      28  90.41%   63-64, 100-101, 216-217, 341-355, 358-366
packages/oraiswap-v3/src/helpers.ts                                             444     234  47.29%   122-123, 133-134, 159-160, 188-189, 199-200, 283-287, 290-297, 300-356, 359-364, 367-376, 380-436, 439-447, 450-481, 484-497, 500-523, 526-532, 535-549
packages/oraiswap-v3/src/index.ts                                                 7       0  100.00%
packages/oraiswap-v3/src/main.ts                                                 37      37  0.00%    1-72
packages/oraiswap-v3/src/types.ts                                                13       0  100.00%
packages/oraiswap-v3/src/zap-consumer.ts                                        496     478  3.62%    54-58, 61-62, 65-98, 101-143, 146-165, 168-186, 189-219, 222-331, 334-567, 570-608
packages/oraiswap-v3/src/wasm/oraiswap_v3_wasm.d.ts                              32      32  0.00%    469-500
packages/oraiswap-v3/src/wasm/oraiswap_v3_wasm.js                              1543     710  53.98%   32-34, 92-94, 100-101, 103-108, 113-120, 136-145, 160-223, 233-255, 264-284, 293-313, 322-342, 351-371, 380-400, 409-429, 463-464, 480-502, 508-511, 518-530, 536-548, 555-558, 565-579, 587-590, 595-598, 611-614, 620-623, 636-639, 660-663, 668-671, 688-729, 736-754, 762-776, 783-786, 793-807, 817-838, 848-869, 884-885, 910-911, 929-953, 958-961, 966-969, 976-979, 984-987, 992-995, 1002-1005, 1010-1013, 1028-1031, 1036-1039, 1044-1047, 1062-1065, 1080-1083, 1088-1091, 1096-1099, 1106-1109, 1114-1117, 1122-1125, 1132-1135, 1149-1150, 1161-1164, 1170-1173, 1179-1182, 1188-1191, 1196-1199, 1204-1207, 1214-1217, 1219-1225, 1300-1301, 1329-1330, 1333-1335, 1356-1361, 1364-1365, 1368-1372, 1386-1387, 1390-1391, 1394-1395, 1398-1399, 1402-1403, 1406-1407, 1410-1413, 1416-1417, 1420-1421, 1424-1425, 1428-1431, 1434-1437, 1444, 1447-1448, 1451-1458, 1465-1466, 1469-1470, 1473-1474, 1477, 1480-1481, 1484-1491, 1500-1504, 1507, 1510-1511
packages/oraiswap-v3/tests/handler.spec.ts                                      276       0  100.00%
packages/oraiswap-v3/tests/helpers.spec.ts                                      577       0  100.00%
packages/oraiswap-v3/tests/test-common.ts                                        32       0  100.00%
packages/oraiswap-v3/tests/zap-consumer.spec.ts                                  50       0  100.00%
packages/universal-swap/src/handler.ts                                         1228     662  46.09%   79-80, 101-102, 117-119, 125-128, 150-155, 176-198, 278-308, 365-370, 421-441, 492-497, 544-555, 579, 581-585, 598-609, 616-631, 634-692, 703-713, 716-726, 733-740, 754-831, 835-866, 870-889, 892-909, 913-970, 975-1059, 1065-1150, 1160-1167, 1196-1197, 1199-1200, 1206, 1220-1244, 1274-1277, 1310-1313, 1320-1330, 1335-1355, 1396-1397, 1410-1453, 1516-1517
packages/universal-swap/src/helper.ts                                           948     326  65.61%   87-89, 225-226, 272-277, 305-306, 340-352, 366-420, 461-463, 488-494, 520-522, 526-528, 535-562, 624-625, 658-665, 672-713, 725-779, 818-819, 834, 862, 869-892, 894-895, 937-938, 942-945, 955-997, 1005-1021, 1080-1090, 1101-1106, 1125, 1151-1163, 1281-1292
packages/universal-swap/src/index.ts                                              6       6  0.00%    1-6
packages/universal-swap/src/swap-filter.ts                                       40       0  100.00%
packages/universal-swap/src/types.ts                                             10       0  100.00%
packages/universal-swap/src/wrapper.ts                                           79      79  0.00%    1-117
packages/universal-swap/src/proto/index.ts                                        1       1  0.00%    1
packages/universal-swap/src/proto/universal-swap-memo-proto-handler.ts           66      60  9.09%    21-46, 50-91
packages/universal-swap/src/proto/universal_swap_memo.ts                        911     818  10.20%   110-112, 116-132, 135-183, 186-193, 196-213, 216-217, 219-230, 233-235, 239-243, 246-266, 269-274, 277-282, 285-286, 288-291, 294-296, 300-304, 307-327, 330-333, 336-341, 344-345, 347-350, 353-355, 359-366, 369-396, 399-405, 408-416, 419-420, 422-426, 429-431, 435-445, 448-482, 485-490, 493-504, 507-508, 510-515, 518-520, 524-534, 537-571, 574-583, 586-597, 600-601, 603-613, 616-618, 622-635, 638-679, 682-690, 693-707, 710-711, 713-727, 730-732, 736-752, 755-803, 806-813, 816-833, 836-837, 839-846, 849-851, 855-871, 874-922, 925-932, 935-952, 955-956, 958-965, 968-970, 974-981, 984-1011, 1014-1018, 1021-1029, 1032-1033, 1035-1039, 1042-1044, 1048-1052, 1055-1075, 1078-1079, 1082-1087, 1090-1091, 1093-1096, 1111-1119, 1122-1128
packages/universal-swap/src/universal-demos/alpha-smart-router.ts               114     114  0.00%    1-589
packages/universal-swap/src/universal-demos/evm-to-evm.ts                        52      52  0.00%    1-68
packages/universal-swap/src/universal-demos/from-cosmos-to-evm.ts                41      41  0.00%    1-53
packages/universal-swap/src/universal-demos/from-oraichain-to-evm.ts             42      42  0.00%    1-62
packages/universal-swap/src/universal-demos/from-oraichain-to-oraichain.ts       49      49  0.00%    1-66
packages/universal-swap/src/universal-demos/handle-simulate-swap.ts              32      32  0.00%    1-36
packages/universal-swap/src/universal-demos/ibc-hooks-demo.ts                    40      40  0.00%    1-55
packages/universal-swap/src/universal-demos/neutaro-ibc-demo.ts                  40      40  0.00%    1-47
packages/universal-swap/src/universal-demos/noble-ibc-demo.ts                    41      41  0.00%    1-45
packages/universal-swap/src/universal-demos/offline-wallet.ts                    19      19  0.00%    1-21
packages/universal-swap/tests/helper.spec.ts                                    697      24  96.55%   378, 947-969
packages/universal-swap/tests/index.spec.ts                                    1743      32  98.16%   240-243, 271-272, 283-284, 289-290, 292-293, 295-296, 1138-1157
packages/universal-swap/tests/smart-router-common.ts                            864       0  100.00%
packages/universal-swap/tests/test-common.ts                                     56       0  100.00%
TOTAL                                                                         14900    5275  64.59%

Diff against main

Filename                                  Stmts    Miss  Cover
--------------------------------------  -------  ------  --------
packages/universal-swap/src/handler.ts       +2      +1  +0.01%
TOTAL                                        +2      +1  +100.00%

Results for commit: 665c312

Minimum allowed coverage is 0%

♻️ This comment has been updated with latest results

Copy link

@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 and nitpick comments (2)
packages/universal-swap/src/handler.ts (2)

1153-1166: LGTM. Consider additional validation and error handling.

The changes to the processUniversalSwap method improve the handling of recipient addresses. The new validation check and the use of ChainIdEnum.TRON are good additions. However, consider the following suggestions:

  1. Add a null check for recipientAddress before using it in the validation.
  2. Consider using a more descriptive error message in the generateError call.
  3. The ternary operator for setting toAddress could be made more readable by using an if-else statement.

Consider refactoring the toAddress assignment for better readability:

-      toAddress =
-        originalToToken.chainId === ChainIdEnum.TRON
-          ? tronToEthAddress(recipientAddress)
-          : this.swapData.recipientAddress;
+      if (originalToToken.chainId === ChainIdEnum.TRON) {
+        toAddress = tronToEthAddress(recipientAddress);
+      } else {
+        toAddress = recipientAddress;
+      }

234-234: LGTM. Consider additional error handling.

The changes to the getIbcMemo method improve the handling of recipient addresses. The new validation check and the use of ChainIdEnum.TRON are good additions. However, consider the following suggestion:

  1. Add error handling for the case when tronToEthAddress fails to convert the address.

Consider adding a try-catch block for the tronToEthAddress conversion:

-      transferAddress = toToken.chainId === ChainIdEnum.TRON ? tronToEthAddress(recipientAddress) : recipientAddress;
+      if (toToken.chainId === ChainIdEnum.TRON) {
+        try {
+          transferAddress = tronToEthAddress(recipientAddress);
+        } catch (error) {
+          throw generateError(`Failed to convert Tron address: ${error.message}`);
+        }
+      } else {
+        transferAddress = recipientAddress;
+      }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3bcdc19 and cac26ca.

📒 Files selected for processing (4)
  • .github/workflows/publish_oraiswap_v3.yml (0 hunks)
  • packages/oraiswap-v3/package.json (2 hunks)
  • packages/universal-swap/package.json (1 hunks)
  • packages/universal-swap/src/handler.ts (3 hunks)
💤 Files not reviewed due to no reviewable changes (1)
  • .github/workflows/publish_oraiswap_v3.yml
✅ Files skipped from review due to trivial changes (1)
  • packages/universal-swap/package.json
🔇 Additional comments (4)
packages/oraiswap-v3/package.json (2)

16-16: Dependency update approved, but more context needed.

The update of @oraichain/oraidex-common from ^1.1.6 to ^1.1.21 is approved. However, could you provide more information on how this update relates to the PR objective of "Fix/to adress tron"? Understanding the connection between this dependency update and the Tron-related changes would be helpful.


3-3: Please clarify the significant version jump.

The package version has been updated from 0.1.8 to 0.1.20, which is a significant jump of 12 minor versions. Could you provide more context about the changes that warrant this version increase? It's unusual to see such a large version jump without corresponding changes in the package.

packages/universal-swap/src/handler.ts (2)

43-44: LGTM. Verify usage of new imports.

The addition of toDisplay and ChainIdEnum imports from "@oraichain/oraidex-common" looks good. Ensure these new imports are used appropriately in the updated code.

✅ Verification successful

Please run the updated shell script to verify the usage of the new imports.


Verified usage of new imports.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the usage of new imports
rg --type typescript 'toDisplay|ChainIdEnum' packages/universal-swap/src/handler.ts

Length of output: 120


Script:

#!/bin/bash
# Verify the usage of new imports with correct file type
rg --type ts 'toDisplay|ChainIdEnum' packages/universal-swap/src/handler.ts

Length of output: 327


Line range hint 1-1568: Overall improvements in address handling. Tests needed.

The changes in this file primarily focus on improving recipient address handling and validation, which is a positive step towards more robust code. The use of ChainIdEnum for type-safe chain ID checks is also a good practice.

However, there are a few areas that could use attention:

  1. The TODO comments throughout the file indicate that several methods still need test cases. It's crucial to implement these tests to ensure the reliability of the code, especially given the complexity of the swap operations.

  2. Consider implementing the suggested improvements in error handling and readability from the previous comments.

  3. Given the complexity of this file, it might be beneficial to consider breaking it down into smaller, more manageable modules in the future.

As the UniversalSwapHandler class grows in complexity, consider refactoring it into smaller, more focused classes or modules. This could improve maintainability and make it easier to test individual components.

Copy link
Contributor

@quangdz1704 quangdz1704 left a comment

Choose a reason for hiding this comment

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

lgtm

@haunv3 haunv3 merged commit c8e6eb5 into main Sep 27, 2024
4 checks passed
@haunv3 haunv3 deleted the fix/toAdress-tron branch September 27, 2024 07:21
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.

3 participants