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

fee affiliates #318

Merged
merged 5 commits into from
Aug 13, 2024
Merged

fee affiliates #318

merged 5 commits into from
Aug 13, 2024

Conversation

haunv3
Copy link
Contributor

@haunv3 haunv3 commented Aug 12, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced logic for calculating and deducting affiliate fees during token transfers, improving accuracy in the transfer amount.
    • Added an optional parameter for affiliate flagging in the transfer message function to accommodate new fee logic.
    • Significant updates to token changes and routing capabilities in the swap operations, including new action types and sender address adjustments.
  • Version Update

    • Updated the package version to 1.1.0, indicating a move to a new stable release.

Copy link

github-actions bot commented Aug 12, 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                                         161       0  100.00%
packages/oraidex-common/src/helper.ts                                           464     139  70.04%   141-142, 145-156, 159-169, 276-283, 286-299, 309-315, 325-340, 343-350, 353-383, 386-394, 397-399, 402-404, 408-417, 426-440, 446-448, 533-534, 559-562
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                                          968       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                        196     196  0.00%    1-210
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/handler.ts                                             262       6  97.70%   60-61, 97-98, 213-214
packages/oraiswap-v3/src/helpers.ts                                             212      10  95.28%   96-97, 107-108, 133-134, 162-163, 173-174
packages/oraiswap-v3/src/index.ts                                                 5       0  100.00%
packages/oraiswap-v3/src/types.ts                                                 0       0  100.00%
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                                      277       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/universal-swap/src/handler.ts                                         1274     602  52.74%   81-82, 103-104, 119-121, 127-130, 141-143, 155-160, 181-203, 282-312, 369-374, 425-445, 496-501, 548-559, 583, 585-589, 602-613, 620-666, 730-740, 743-753, 760-767, 781-858, 862-893, 897-916, 919-936, 940-991, 996-1078, 1084-1169, 1179-1184, 1214-1216, 1218-1219, 1225, 1269-1284, 1294-1297, 1309-1321, 1365-1368, 1375-1383, 1388-1394, 1435-1436, 1468-1479, 1546-1547
packages/universal-swap/src/helper.ts                                           831     315  62.09%   83-85, 221-222, 268-273, 301-302, 336-348, 362-416, 457-459, 481-487, 511-513, 517-519, 526-556, 615-616, 653-660, 667-708, 724-792, 831-832, 847, 875, 882-903, 905-906, 939-940, 943-946, 956-998, 1006-1022, 1081-1091, 1102-1107, 1126
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                95      95  0.00%    1-574
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-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                                    1745      30  98.28%   240-243, 283-284, 289-290, 292-293, 295-296, 1130-1149
packages/universal-swap/tests/smart-router-common.ts                            864       0  100.00%
packages/universal-swap/tests/test-common.ts                                     56       0  100.00%
TOTAL                                                                         13830    4363  68.45%

Diff against main

Filename                                                             Stmts    Miss  Cover
-----------------------------------------------------------------  -------  ------  --------
packages/universal-swap/src/handler.ts                                 +43     +19  +0.10%
packages/universal-swap/src/universal-demos/alpha-smart-router.ts      +19     +19  +100.00%
TOTAL                                                                  +62     +38  -0.13%

Results for commit: 33e30a5

Minimum allowed coverage is 0%

♻️ This comment has been updated with latest results

Copy link

coderabbitai bot commented Aug 12, 2024

Walkthrough

The updates to the @oraichain/oraidex-universal-swap package reflect a move to a stable release, highlighting enhancements in managing affiliate fees during token transfers. The UniversalSwapHandler class has been refined to ensure that affiliate fees are deducted from the token amount before transfers, optimizing the overall process while preserving the existing control flow.

Changes

File Change Summary
packages/universal-swap/package.json Updated package version from 1.0.99 to 1.1.0, indicating a move to a new stable release.
packages/universal-swap/src/handler.ts Enhanced UniversalSwapHandler logic to incorporate affiliate fees during token transfers, introducing a new optional parameter and adjusting tokenAmount accordingly without altering the existing control flow.
packages/universal-swap/src/universal-demos/alpha-smart-router.ts Significant modifications to the router object and alphaSwapToOraichain function, including increased token amounts, updated identifiers, and added bridging actions, enhancing routing capabilities and affiliate support.

Poem

🐰 In the meadow where tokens play,
Fees now dance and track their way.
With affiliates here, they find their share,
A leap to stable, a joyful flair!
Hopping forth, with code so bright,
The swaps now sparkle in delight! ✨


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.

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 598c309 and 393bd64.

Files selected for processing (2)
  • packages/universal-swap/package.json (1 hunks)
  • packages/universal-swap/src/handler.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • packages/universal-swap/package.json
Additional comments not posted (1)
packages/universal-swap/src/handler.ts (1)

115-115: Extracting affiliates from swapData.

The extraction of affiliates from swapData is clear and straightforward. Ensure that swapData is correctly populated with affiliate information before calling this method.

packages/universal-swap/src/handler.ts Outdated Show resolved Hide resolved
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 393bd64 and 1bf7234.

Files selected for processing (2)
  • packages/universal-swap/package.json (1 hunks)
  • packages/universal-swap/src/handler.ts (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • packages/universal-swap/package.json
  • packages/universal-swap/src/handler.ts

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1bf7234 and 5273ff6.

Files selected for processing (1)
  • packages/universal-swap/src/handler.ts (9 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/universal-swap/src/handler.ts

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, codebase verification and nitpick comments (1)
packages/universal-swap/src/universal-demos/alpha-smart-router.ts (1)

Line range hint 563-567:
Enhance error logging for better debugging.

Consider including more context in the error logs to facilitate debugging, such as the input parameters or state at the time of the error.

-  console.trace("error: ", error);
+  console.trace("Error during swap process: ", error, {
+    sender,
+    fromAmount,
+    originalFromToken,
+    originalToToken
+  });
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5273ff6 and 33e30a5.

Files selected for processing (2)
  • packages/universal-swap/src/handler.ts (10 hunks)
  • packages/universal-swap/src/universal-demos/alpha-smart-router.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/universal-swap/src/handler.ts
Additional comments not posted (4)
packages/universal-swap/src/universal-demos/alpha-smart-router.ts (4)

Line range hint 570-572:
Confirm the intention of immediate invocation.

The alphaSwapToOraichain function is invoked immediately. Ensure this is intentional and that it aligns with the desired execution flow.


474-486: Verify updated token amounts and identifiers.

The returnAmount and token identifiers have been significantly updated. Ensure these changes reflect the intended swap logic and that the new token identifiers are accurate.


548-556: Verify simulatePrice and affiliates configuration.

The simulatePrice has been updated, and an affiliates field has been added. Ensure that the simulatePrice reflects current market conditions and that the affiliate address and fee are correct.


Line range hint 1-5:
Verify the necessity and usage of imports.

Ensure that all imported modules are necessary and correctly utilized in the file. Consider removing any unused imports to optimize performance.

Verification successful

All imports are necessary and utilized.

The imported modules CosmosWalletImpl, UniversalSwapHandler, cosmosTokens, flattenTokens, generateError, and toAmount are all used in the file alpha-smart-router.ts. No unused imports were found.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the necessity and usage of imports.

# Test: Check for the usage of each imported module in the file. Expect: All imports are used.
rg --type javascript -A 5 $'import ' | rg -v '//'

Length of output: 83


Script:

#!/bin/bash
# Description: Verify the necessity and usage of imports using ast-grep.

# Find usage of CosmosWalletImpl
ast-grep --lang typescript --pattern 'CosmosWalletImpl' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of UniversalSwapHandler
ast-grep --lang typescript --pattern 'UniversalSwapHandler' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of cosmosTokens
ast-grep --lang typescript --pattern 'cosmosTokens' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of flattenTokens
ast-grep --lang typescript --pattern 'flattenTokens' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of generateError
ast-grep --lang typescript --pattern 'generateError' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of getTokenOnOraichain
ast-grep --lang typescript --pattern 'getTokenOnOraichain' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

# Find usage of toAmount
ast-grep --lang typescript --pattern 'toAmount' packages/universal-swap/src/universal-demos/alpha-smart-router.ts

Length of output: 3099

@haunv3 haunv3 merged commit 5ba1467 into main Aug 13, 2024
2 checks passed
@haunv3 haunv3 deleted the feat/affiliates branch August 13, 2024 11: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