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

feat(synapse-interface): refund RFQ transaction [SLT-272] #3197

Merged
merged 15 commits into from
Sep 26, 2024

Conversation

bigboydiamonds
Copy link
Collaborator

@bigboydiamonds bigboydiamonds commented Sep 26, 2024

Description
Implements transaction status updates for when a RFQ transaction gets refunded after deadline passes. Builds on top of existing Transaction flow, adds another 'refunded' status tag to track behavior.

95862fa: synapse-interface preview link

Summary by CodeRabbit

  • New Features

    • Introduced a new transaction status: 'refunded'.
    • Added a routerAddress property to various components for enhanced transaction tracking.
    • Implemented a custom hook to manage and check the refund status of transactions.
  • Bug Fixes

    • Updated transaction support messaging to accurately reflect refund and reverted statuses.
  • Localization

    • Added translations for "Refunded" and related messages in Arabic, English, Spanish, French, Japanese, Turkish, and Chinese.
  • Documentation

    • Enhanced documentation for components and hooks to reflect new properties and functionalities.

Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

Walkthrough

The changes introduce a new transaction status, 'refunded', across various components and hooks within the Synapse interface. This update includes modifications to interfaces, props, and rendering logic to accommodate the refund status. Additionally, new localization entries for multiple languages have been added to support the updated transaction messaging. The overall structure of related components remains intact, but their functionality is enhanced to provide better user feedback regarding transaction refunds.

Changes

Files Change Summary
packages/synapse-interface/components/_Transaction/_Transaction.tsx, packages/synapse-interface/components/_Transaction/_Transactions.tsx, packages/synapse-interface/components/_Transaction/components/AnimatedProgressBar.tsx, packages/synapse-interface/components/_Transaction/components/TimeRemaining.tsx, packages/synapse-interface/components/_Transaction/components/TransactionSupport.tsx Added 'refunded' status to various components, updated props and rendering logic accordingly, and introduced new hooks for refund status.
packages/synapse-interface/components/_Transaction/helpers/calculateEstimatedTimeStatus.ts, packages/synapse-interface/components/_Transaction/helpers/useTxRefundStatus.ts Enhanced transaction timing checks and introduced a new hook to manage refund status, including asynchronous functions for contract checks.
packages/synapse-interface/slices/_transactions/reducer.ts, packages/synapse-interface/slices/transactions/actions.ts Updated _TransactionDetails interface to include 'refunded' status and added action creator for refunding transactions.
packages/synapse-interface/utils/hooks/use_TransactionsListener.ts Added routerAddress to the transaction listener function.
packages/synapse-interface/messages/*.json Added localization entries for 'Refunded' and related messages in multiple languages (Arabic, English, Spanish, French, Japanese, Turkish, Chinese).
packages/synapse-interface/pages/state-managed-bridge/index.tsx Introduced routerAddress to the StateManagedBridge component.

Suggested labels

size/m

Suggested reviewers

  • aureliusbtc
  • trajan0x
  • ChiTimesChi
  • Defi-Moses

Poem

In the land of transactions, a change is here,
A new status of 'refunded', let's give a cheer!
With messages in many tongues, clear and bright,
Our users will know when funds take flight.
Hopping through code, with joy we embrace,
A smoother experience in this digital space! 🐇✨


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.

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.

@bigboydiamonds bigboydiamonds changed the title Fe/refund transaction feat(synapse-interface): refund RFQ transaction Sep 26, 2024
Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 446aad3
Status: ✅  Deploy successful!
Preview URL: https://df8747cf.sanguine-fe.pages.dev
Branch Preview URL: https://fe-refund-transaction.sanguine-fe.pages.dev

View logs

Copy link

Deploying sanguine with  Cloudflare Pages  Cloudflare Pages

Latest commit: 446aad3
Status: ✅  Deploy successful!
Preview URL: https://321e39d4.sanguine.pages.dev
Branch Preview URL: https://fe-refund-transaction.sanguine.pages.dev

View logs

Copy link

codecov bot commented Sep 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 26.23968%. Comparing base (3e75b0d) to head (446aad3).
Report is 14 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (3e75b0d) and HEAD (446aad3). Click for more details.

HEAD has 3 uploads less than BASE
Flag BASE (3e75b0d) HEAD (446aad3)
promexporter 1 0
solidity 2 0
Additional details and impacted files
@@                 Coverage Diff                  @@
##              master       #3197          +/-   ##
====================================================
- Coverage   39.46606%   26.23968%   -13.22638%     
====================================================
  Files            479         677         +198     
  Lines          26932       49307       +22375     
  Branches         342          82         -260     
====================================================
+ Hits           10629       12938        +2309     
- Misses         15557       35051       +19494     
- Partials         746        1318         +572     
Flag Coverage Δ
cctp-relayer ?
opbot ?
packages 90.56974% <ø> (-0.39294%) ⬇️
promexporter ?
solidity ?

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.

Copy link

codecov bot commented Sep 26, 2024

Bundle Report

Changes will decrease total bundle size by 26.34MB (-73.67%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
synapse-interface-server-cjs 1.49MB 125.43kB (-7.74%) ⬇️
synapse-interface-client-array-push 7.28MB 20.64kB (0.28%) ⬆️
explorer-ui-server-cjs (removed) 865.78kB (-100.0%) ⬇️
explorer-ui-edge-server-array-push (removed) 83 bytes (-100.0%) ⬇️
explorer-ui-client-array-push (removed) 2.31MB (-100.0%) ⬇️
widget-cjs-esm (removed) 281.92kB (-100.0%) ⬇️
docs-bridge-client-array-push (removed) 7.9MB (-100.0%) ⬇️
docs-bridge-server-cjs (removed) 14.88MB (-100.0%) ⬇️

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

🧹 Outside diff range and nitpick comments (18)
packages/synapse-interface/components/_Transaction/helpers/calculateEstimatedTimeStatus.ts (2)

24-24: LGTM: New refund check condition.

The introduction of isCheckTxForRefund and its inclusion in the return object directly supports the PR objective of implementing refund functionality for RFQ transactions. The implementation is consistent with the existing pattern in the function.

Consider renaming isCheckTxForRefund to shouldCheckTxForRefund for clarity, as it indicates an action that should be taken rather than a state. This would make it consistent with the naming convention of other boolean variables in the function that start with "is".

-  const isCheckTxForRefund = elapsedTime > fourHoursInSeconds
+  const shouldCheckTxForRefund = elapsedTime > fourHoursInSeconds

   return {
     // ... other properties
-    isCheckTxForRefund,
+    shouldCheckTxForRefund,
   }

Also applies to: 38-38


Line range hint 1-40: Overall, changes align well with PR objectives.

The modifications successfully introduce the ability to track refund status for RFQ transactions, aligning perfectly with the PR objectives. The implementation is consistent with the existing code structure and doesn't introduce any apparent issues.

Consider updating the function's JSDoc comment to include information about the new isCheckTxForRefund (or shouldCheckTxForRefund if renamed) property in the return object. This will help maintain clear documentation for future developers.

 /**
  * Calculates remaining time based on given initial, current, and estimated times.
  *
  * @param currentTime - The current time, as a unix timestamp.
  * @param initialTime - The initial time, as a unix timestamp.
  * @param estimatedTime - The estimated duration to calculate, in seconds.
+ * @returns An object containing various time-related statuses, including a flag
+ * indicating whether the transaction should be checked for a refund.
  */
packages/synapse-interface/components/_Transaction/components/TransactionSupport.tsx (2)

16-18: Simplified logic for 'reverted' status

The change from isReverted to status === 'reverted' is good. It's consistent with the new prop type and simplifies the logic.

For consistency with the other status checks, consider using a template literal for the translation key:

-      {status === 'reverted' && (
-        <div>{t('Transaction reverted, funds returned')}</div>
+      {status === 'reverted' && (
+        <div>{t(`Transaction ${status}, funds returned`)}</div>
       )}

This change would make it easier to maintain consistent messaging across different statuses.


20-23: New rendering logic for 'refunded' status

The addition of a specific rendering condition for the 'refunded' status is good. It aligns with the PR objective and follows the existing pattern for other statuses.

To improve flexibility and reduce duplication, consider refactoring the 'reverted' and 'refunded' cases:

const statusMessages = {
  reverted: 'Transaction reverted, funds returned',
  refunded: 'Transaction refunded, funds returned',
};

{['reverted', 'refunded'].includes(status) && (
  <div>{t(statusMessages[status as keyof typeof statusMessages])}</div>
)}

This approach would make it easier to add or modify status messages in the future.

packages/synapse-interface/components/_Transaction/components/TimeRemaining.tsx (1)

15-15: LGTM! Consider using a TypeScript union type for better maintainability.

The addition of the 'refunded' status to the prop type definition is correct and aligns with the PR objective.

For improved maintainability, consider defining a union type for the status:

type TransactionStatus = 'pending' | 'completed' | 'reverted' | 'refunded';

// Then use it in the prop definition:
status: TransactionStatus

This approach would make it easier to update the status types in the future and reuse them across different components if needed.

packages/synapse-interface/utils/hooks/use_TransactionsListener.ts (1)

Line range hint 1-63: Consider optimizations and error handling improvements

While the overall structure of the hook is sound, consider the following suggestions for optimization and robustness:

  1. Performance: The useEffect hook runs on every change to pendingBridgeTransactions or transactions. Consider using useMemo for expensive computations or useCallback for function memoization to optimize re-renders.

  2. Error Handling: Add try-catch blocks around the dispatch calls to handle potential errors gracefully.

  3. Typescript: Consider using more specific types instead of any for better type safety, especially for the tx object in the forEach loop.

  4. Dependency Array: Ensure all variables used inside the useEffect are included in the dependency array to avoid potential stale closures.

Here's a sample of how you might implement some of these suggestions:

import { useEffect, useCallback } from 'react'

// ... other imports ...

export const use_TransactionsListener = () => {
  // ... existing code ...

  const processPendingTransactions = useCallback(() => {
    if (checkTransactionsExist(pendingBridgeTransactions)) {
      pendingBridgeTransactions.forEach((tx: PendingBridgeTransaction) => {
        // ... existing checks ...

        if (txnConfirmed && !txnExists) {
          try {
            dispatch(
              addTransaction({
                // ... existing properties ...
                routerAddress: tx.routerAddress,
                // ... other properties ...
              })
            )
          } catch (error) {
            console.error('Failed to add transaction:', error)
            // Consider adding more robust error handling here
          }
        }
      })
    }
  }, [pendingBridgeTransactions, transactions, dispatch, address])

  useEffect(() => {
    processPendingTransactions()
  }, [processPendingTransactions])

  return null
}

This refactored version uses useCallback to memoize the processPendingTransactions function, adds basic error handling, and ensures all dependencies are properly declared.

packages/synapse-interface/components/_Transaction/helpers/useBridgeTxUpdater.ts (1)

31-32: Update JSDoc to include new parameter

The new isTxRefunded parameter is correctly added to the function signature. However, the JSDoc comment above the function should be updated to include a description of this new parameter.

Consider updating the JSDoc comment as follows:

 * @param {boolean} isTxReverted - Whether bridge transaction was reverted, queried on-chain.
+ * @param {boolean} isTxRefunded - Whether the RFQ transaction has been refunded after the deadline.
 */
packages/synapse-interface/slices/_transactions/reducer.ts (3)

21-21: LGTM: Addition of refunded status

The new refunded status in the _TransactionDetails interface's status property directly addresses the PR objective. This addition will allow for better tracking of refunded RFQ transactions.

Consider improving readability by formatting the union type vertically:

status:
  | 'pending'
  | 'completed'
  | 'reverted'
  | 'refunded'

This format can make it easier to add or remove statuses in the future.


91-103: LGTM: Implementation of refundTransaction action

The refundTransaction action is well-implemented and aligns with the PR objective of handling refunded transactions. It follows the established pattern for status update actions in this slice.

Consider adding a console warning or throwing an error when the transaction is not found:

if (txIndex !== -1) {
  state.transactions[txIndex].status = 'refunded'
} else {
  console.warn(`Transaction with hash ${originTxHash} not found for refund.`)
}

This can help with debugging in case of unexpected behavior.


Missing Usage of refundTransaction Action

The refundTransaction action introduced in packages/synapse-interface/slices/_transactions/reducer.ts is not imported or used in other parts of the codebase. This may indicate that the action is defined but not dispatched, which could lead to incomplete refund functionality.

  • Ensure that the refundTransaction action is dispatched appropriately in relevant components or middleware.
🔗 Analysis chain

Line range hint 1-118: Summary: Successful implementation of refund functionality

The changes in this file successfully implement the refund functionality for RFQ transactions as outlined in the PR objectives. Key points:

  1. The _TransactionDetails interface has been updated to include routerAddress and the new refunded status.
  2. A new refundTransaction action has been implemented and exported.
  3. The changes maintain consistency with the existing code structure and patterns.

These modifications enhance the transaction management capabilities of the system, allowing for better tracking and handling of refunded transactions.

To ensure the changes are properly integrated, please run the following verification script:

This script will help identify any places where the new functionality should be integrated or where additional updates might be necessary.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the new refundTransaction action and refunded status

# Test 1: Check for imports of the new refundTransaction action
echo "Checking for imports of refundTransaction:"
rg --type typescript "import.*refundTransaction.*from.*_transactions/reducer"

# Test 2: Check for uses of the new refunded status
echo "Checking for uses of the refunded status:"
rg --type typescript "'refunded'"

# Test 3: Check for uses of the new routerAddress property
echo "Checking for uses of the routerAddress property:"
rg --type typescript "routerAddress"

Length of output: 558


Script:

#!/bin/bash
# Description: Verify the usage of the new refundTransaction action and refunded status

# Test 1: Check for imports of the new refundTransaction action
echo "Checking for imports of refundTransaction:"
rg "import.*refundTransaction.*from.*_transactions/reducer" -g "*.ts" -g "*.tsx"

# Test 2: Check for uses of the refunded status
echo "Checking for uses of the refunded status:"
rg "'refunded'" -g "*.ts" -g "*.tsx"

# Test 3: Check for uses of the routerAddress property
echo "Checking for uses of the routerAddress property:"
rg "routerAddress" -g "*.ts" -g "*.tsx"

Length of output: 9947

packages/synapse-interface/components/_Transaction/components/AnimatedProgressBar.tsx (2)

20-20: LGTM: Type definition updated correctly

The type definition for the status prop has been properly updated to include the new 'refunded' status, which is consistent with the PR objectives and the JSDoc comment.

Consider using a TypeScript enum or a union type alias for the status values to improve maintainability and reduce the risk of typos. For example:

type TransactionStatus = 'pending' | 'completed' | 'reverted' | 'refunded';

// Then use it in the component props:
status: TransactionStatus

This would make it easier to update the status values in the future and ensure consistency across the codebase.


28-28: Consider separating 'refunded' from error states

The condition for isError has been updated to include the new 'refunded' status, which is consistent with the PR objectives. However, classifying a refunded transaction as an error might not provide the best user experience.

Consider separating the 'refunded' status from the error states. Refunds are often part of normal business operations and may not necessarily indicate an error condition. You might want to handle 'refunded' transactions differently in the UI to provide clearer feedback to the user.

For example, you could introduce a new variable:

const isRefunded = status === 'refunded';
const isError = status === 'reverted';

Then, update the component's logic to handle 'refunded' status separately from error states. This would allow for more flexible styling and messaging specific to refunded transactions.

packages/synapse-interface/constants/abis/fastBridgeRouter.json (1)

1-387: Overall, the ABI is well-defined but requires careful implementation

The ABI for the FastBridgeRouter contract is comprehensive and well-structured. It covers essential functionality for token swapping, cross-chain bridging, and contract management. However, given the complexity and potential risks associated with such operations, consider the following recommendations:

  1. Implement thorough input validation for all functions, especially adapterSwap and bridge.
  2. Ensure proper access control mechanisms are in place for state-changing functions.
  3. Implement comprehensive unit tests covering all possible execution paths.
  4. Consider conducting a professional security audit of the contract implementation.
  5. Implement a contract upgradeability pattern to allow for future improvements or bug fixes.
packages/synapse-interface/messages/jp.json (1)

311-311: LGTM: Accurate translation with a minor suggestion

The Japanese translation "取引が返金され、資金が戻されました" for "Transaction refunded, funds returned" is accurate and follows the polite form used throughout the file. However, to enhance clarity, consider the following minor adjustment:

-    "Transaction refunded, funds returned": "取引が返金され、資金が戻されました",
+    "Transaction refunded, funds returned": "取引が返金され、資金が返還されました",

This change replaces "戻されました" with "返還されました", which more precisely conveys the sense of "returned" in a financial context. Both versions are correct, but "返還" is more commonly used in formal financial communications.

packages/synapse-interface/messages/en-US.json (1)

309-311: LGTM with a minor suggestion for consistency.

The new entries for the refunded status are well-placed and clearly worded. They align with the PR objectives and follow the existing pattern in the localization file.

For consistency with the "Reverted" status message, consider changing:

-    "Transaction refunded, funds returned": "Transaction refunded, funds returned",
+    "Transaction refunded, funds returned": "Transaction refunded, funds returned.",

This adds a period at the end of the message, matching the format of the "Reverted" status message.

packages/synapse-interface/messages/tr.json (1)

309-311: LGTM with a minor suggestion.

The new translations for "Refunded" and "Transaction refunded, funds returned" are correctly implemented and align with the PR objectives. These additions will help Turkish users understand the new 'refunded' status for RFQ transactions.

For consistency with other entries in this file, consider capitalizing the first letter of each word in the Turkish translation for "Transaction refunded, funds returned".

Consider applying this change:

-    "Transaction refunded, funds returned": "İşlem iade edildi, fonlar geri gönderildi",
+    "Transaction refunded, funds returned": "İşlem İade Edildi, Fonlar Geri Gönderildi",
packages/synapse-interface/constants/abis/fastBridge.json (1)

807-850: Custom errors enhance gas efficiency and error handling.

The ABI defines a comprehensive set of custom errors, which is a gas-efficient approach to error handling. These errors cover various failure scenarios, including:

  • Access control issues (e.g., AccessControlUnauthorizedAccount)
  • Timing-related problems (e.g., DeadlineExceeded, DeadlineNotExceeded)
  • Incorrect input validation (e.g., AmountIncorrect, ChainIncorrect)
  • Contract-specific issues (e.g., DisputePeriodNotPassed, TransactionRelayed)

This approach provides more informative error messages while optimizing gas usage. The inclusion of timing-related errors suggests careful handling of deadline-sensitive operations, which is crucial for a bridge contract.

Consider adding a custom error for the refund operation (e.g., RefundNotAllowed) to provide more specific error handling for the new refund functionality.

packages/synapse-interface/components/_Transaction/_Transaction.tsx (1)

202-204: Clarify Menu Item Text for Refunded Transactions

The condition isTxReverted || isTxRefunded displays the text 'Clear notification'. For better user clarity, consider specifying the notification type.

Suggestion:

text={
  isTxReverted
    ? t('Clear reverted notification')
    : isTxRefunded
    ? t('Clear refund notification')
    : t('Clear transaction')
}

This change provides more specific information to the user.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 90ac800 and 446aad3.

📒 Files selected for processing (21)
  • packages/synapse-interface/components/_Transaction/_Transaction.tsx (6 hunks)
  • packages/synapse-interface/components/_Transaction/_Transactions.tsx (1 hunks)
  • packages/synapse-interface/components/_Transaction/components/AnimatedProgressBar.tsx (2 hunks)
  • packages/synapse-interface/components/_Transaction/components/TimeRemaining.tsx (2 hunks)
  • packages/synapse-interface/components/_Transaction/components/TransactionSupport.tsx (1 hunks)
  • packages/synapse-interface/components/_Transaction/helpers/calculateEstimatedTimeStatus.ts (2 hunks)
  • packages/synapse-interface/components/_Transaction/helpers/useBridgeTxUpdater.ts (3 hunks)
  • packages/synapse-interface/components/_Transaction/helpers/useTxRefundStatus.ts (1 hunks)
  • packages/synapse-interface/constants/abis/fastBridge.json (1 hunks)
  • packages/synapse-interface/constants/abis/fastBridgeRouter.json (1 hunks)
  • packages/synapse-interface/messages/ar.json (1 hunks)
  • packages/synapse-interface/messages/en-US.json (1 hunks)
  • packages/synapse-interface/messages/es.json (1 hunks)
  • packages/synapse-interface/messages/fr.json (1 hunks)
  • packages/synapse-interface/messages/jp.json (1 hunks)
  • packages/synapse-interface/messages/tr.json (1 hunks)
  • packages/synapse-interface/messages/zh-CN.json (1 hunks)
  • packages/synapse-interface/pages/state-managed-bridge/index.tsx (1 hunks)
  • packages/synapse-interface/slices/_transactions/reducer.ts (3 hunks)
  • packages/synapse-interface/slices/transactions/actions.ts (1 hunks)
  • packages/synapse-interface/utils/hooks/use_TransactionsListener.ts (1 hunks)
🔇 Additional comments (39)
packages/synapse-interface/components/_Transaction/helpers/calculateEstimatedTimeStatus.ts (1)

19-19: LGTM: New constant for refund check threshold.

The introduction of fourHoursInSeconds is a good practice. It clearly defines the threshold for checking if a transaction should be considered for a refund, which aligns with the PR objective of implementing refund functionality for RFQ transactions.

packages/synapse-interface/components/_Transaction/components/TransactionSupport.tsx (3)

4-8: Improved type safety for the status prop

The change from a generic string type to a union of specific string literals ('pending', 'completed', 'reverted', 'refunded') for the status prop is a good improvement. This enhances type safety and makes the component's API more explicit.

This change:

  1. Aligns with the PR objective of introducing a 'refunded' status.
  2. Reduces the likelihood of runtime errors by catching invalid status values at compile-time.
  3. Improves code readability and self-documentation.

24-25: Updated logic for 'pending' status

The explicit check for 'pending' status is good. It's consistent with the new prop type and other status checks in the component.

This change improves code clarity and maintains the existing functionality for pending transactions.


Line range hint 1-50: Overall assessment of TransactionSupport component changes

The changes to the TransactionSupport component are well-implemented and align with the PR objectives. The introduction of the 'refunded' status and the improved type safety for the status prop enhance the component's functionality and robustness.

Key improvements:

  1. More specific prop types for better type safety.
  2. Consistent handling of different transaction statuses.
  3. Addition of the 'refunded' status to support the new use case.

The suggestions provided in the review comments, if implemented, would further improve the component's maintainability and flexibility. Great work overall!

packages/synapse-interface/slices/transactions/actions.ts (1)

19-19: Approved addition of routerAddress. Please provide more context.

The addition of routerAddress to the PendingBridgeTransaction interface is approved. However, to improve code clarity and maintainability:

  1. Could you please clarify the purpose of routerAddress and how it will be used in the context of pending bridge transactions?
  2. Consider adding a brief comment above this property to explain its purpose and any constraints (e.g., format expectations).

To ensure this change doesn't break existing code, please run the following script:

This will help identify any places where the code might need to be updated to include the new routerAddress property.

packages/synapse-interface/components/_Transaction/components/TimeRemaining.tsx (2)

Line range hint 1-58: Summary: Successfully implemented 'refunded' status in TimeRemaining component

The changes in this file effectively introduce the new 'refunded' status to the TimeRemaining component. The implementation is consistent with existing patterns, maintains code quality, and aligns with the PR objective. The modifications are minimal and focused, which reduces the risk of unintended side effects.

Key points:

  1. The status prop type has been updated to include 'refunded'.
  2. A new conditional rendering block for the 'refunded' status has been added.
  3. The changes maintain the component's clear and understandable logic.

Overall, these changes enhance the component's functionality to handle refunded transactions without compromising its existing behavior.


39-45: LGTM! Verify the 'Refunded' translation key.

The implementation of the 'refunded' status rendering is correct and consistent with the existing pattern.

Please ensure that the 'Refunded' translation key exists in all relevant language files. Run the following script to verify:

If the key is missing in any language file, please add it to maintain consistency across all supported languages.

✅ Verification successful

LGTM! The 'Refunded' translation key exists in the language files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for the 'Refunded' translation key in language files

# Test: Search for 'Refunded' key in language files
rg --type json '"Refunded"' packages/synapse-interface/lang/

Length of output: 135


Script:

#!/bin/bash
# Description: Search for the 'Refunded' translation key in all JSON language files

fd --type f --extension json --exec rg '"Refunded"' {} +

Length of output: 10707

packages/synapse-interface/utils/hooks/use_TransactionsListener.ts (1)

53-53: LGTM: Addition of routerAddress to transaction object

The addition of routerAddress to the transaction object is consistent with the PR objective of enhancing transaction management. This change will allow for better tracking and handling of transactions, potentially supporting the new 'refunded' status mentioned in the PR summary.

Let's verify if this change is consistent across the codebase:

✅ Verification successful

Let's update the search to include both ts and tsx file types to ensure all TypeScript files are covered:


Let's modify the search to target .ts and .tsx files explicitly:


Verified: routerAddress is consistently used across the codebase

The addition of routerAddress to the transaction object is consistently implemented across all relevant files, ensuring uniform transaction management throughout the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistency of routerAddress usage in transaction objects

# Search for other occurrences of transaction object creation or usage
rg --type typescript -e 'addTransaction\(' -e 'PendingBridgeTransaction' -A 10 -B 5

Length of output: 118


Script:

# Description: Check for consistency of routerAddress usage in transaction objects

# Search for other occurrences of transaction object creation or usage
rg --type ts --type tsx -e 'addTransaction\(' -e 'PendingBridgeTransaction' -A 10 -B 5

Length of output: 114


Script:

#!/bin/bash
# Description: Check for consistency of routerAddress usage in transaction objects

# Search for other occurrences of transaction object creation or usage in .ts and .tsx files
rg --glob "*.ts" --glob "*.tsx" -e 'addTransaction\(' -e 'PendingBridgeTransaction' -A 10 -B 5

Length of output: 27661

packages/synapse-interface/components/_Transaction/helpers/useBridgeTxUpdater.ts (3)

8-8: LGTM: New import for refundTransaction action

The import for the refundTransaction action is correctly added and aligns with the new functionality for handling refunded transactions.


54-59: LGTM: New useEffect for handling refunded transactions

The new useEffect hook correctly implements the logic for updating the transaction status to 'refunded' when appropriate. It checks both the isTxRefunded flag and the current status in the store before dispatching the action, which prevents unnecessary updates.


60-60: LGTM: Improved readability

The added empty line improves the code's readability by visually separating the new useEffect hook from the existing one.

packages/synapse-interface/components/_Transaction/_Transactions.tsx (1)

59-59: LGTM! Verify usage in _Transaction component.

The addition of the routerAddress prop is correct and consistent with how other props are passed. This change aligns with the PR objective of enhancing transaction management.

To ensure proper implementation, please verify the usage of this new prop in the _Transaction component:

✅ Verification successful

routerAddress prop correctly added and utilized in _Transaction component.

The routerAddress prop is properly passed to the _Transaction component and correctly used within it as a string and type-cast to Address. This addition aligns with the PR objective of enhancing transaction management and follows consistent patterns used for other props.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the implementation of routerAddress in _Transaction component

# Search for the _Transaction component definition
echo "Searching for _Transaction component definition:"
ast-grep --lang typescript --pattern 'export const _Transaction = ({ $$$' packages/synapse-interface/components/_Transaction/_Transaction.tsx

# Search for usage of routerAddress within the component
echo "\nSearching for routerAddress usage in _Transaction component:"
rg "routerAddress" packages/synapse-interface/components/_Transaction/_Transaction.tsx

Length of output: 888


Script:

#!/bin/bash
# Description: Improved search for _Transaction component definition and routerAddress usage

# Search for the _Transaction component definition using rg
echo "Searching for _Transaction component definition using ripgrep:"
rg "export\s+(const|function)\s+_Transaction\s*\(" packages/synapse-interface/components/_Transaction/_Transaction.tsx

# Search for usage of routerAddress within the component
echo "\nVerifying usage of routerAddress in _Transaction component:"
rg "routerAddress" packages/synapse-interface/components/_Transaction/_Transaction.tsx

Length of output: 546


Script:

#!/bin/bash
# Description: Comprehensive search for _Transaction component definition and routerAddress usage

# Search for the _Transaction component definition with various export patterns
echo "Searching for _Transaction component definition with different export patterns:"
rg "(export\s+default\s+|export\s+(const|function)\s+)_Transaction\s*\(" packages/synapse-interface/components/_Transaction/_Transaction.tsx

# If not found, search globally in the repository
if [[ $? -ne 0 ]]; then
  echo "\n_Component _Transaction definition not found in _Transaction.tsx. Searching entire repository:"
  rg "(_Transaction\s*=\s*|function\s+_Transaction\s*\()" .
fi

# Search for all imports of _Transaction to identify its source
echo "\nSearching for imports of _Transaction component to locate its definition:"
rg "import\s+.*_Transaction.*from\s+['\"]" .

Length of output: 1889

packages/synapse-interface/slices/_transactions/reducer.ts (2)

17-17: LGTM: Addition of routerAddress property

The new routerAddress property in the _TransactionDetails interface is a good addition. It enhances the transaction details, which aligns with the PR's objective of improving transaction management.


116-116: LGTM: Export of refundTransaction action

The refundTransaction action is correctly exported, which is necessary for it to be used in other parts of the application. This export ensures that the new refund functionality is accessible where needed.

packages/synapse-interface/components/_Transaction/components/AnimatedProgressBar.tsx (1)

8-8: LGTM: JSDoc comment updated correctly

The JSDoc comment for the status parameter has been properly updated to include the new 'refunded' status, which aligns with the PR objectives.

packages/synapse-interface/constants/abis/fastBridgeRouter.json (5)

1-12: Constructor looks good

The constructor is well-defined, taking an owner_ parameter of type address. This is a standard practice for setting up initial ownership of the contract.


70-160: Carefully review bridge function implementation

The bridge function is critical for cross-chain operations. Ensure that:

  1. The contract properly validates the chainId parameter.
  2. The SwapQuery structs (originQuery and destQuery) are correctly processed.
  3. There are safeguards against potential reentrancy attacks, given the payable nature of the function.
  4. The contract implements proper error handling for failed bridging attempts.

18-301: Other functions appear well-defined

The remaining functions, including view functions like GAS_REBATE_FLAG and fastBridge, and management functions like setFastBridge and transferOwnership, are appropriately defined for their purposes. Ensure that access control is properly implemented in the contract, especially for functions that modify contract state.


302-346: Events are well-defined

The three events (FastBridgeSet, OwnershipTransferred, and SwapQuoterSet) are appropriately defined to log important contract state changes. The indexing of parameters in OwnershipTransferred is good for efficient event filtering.


31-68: Review adapterSwap function carefully

The adapterSwap function is a key part of the contract, handling token swaps. Ensure that:

  1. The rawParams are properly validated and sanitized in the contract implementation.
  2. The function correctly handles both ERC20 tokens and native ETH (given its payable status).
  3. There are appropriate checks for slippage and deadline in the contract logic.

Consider running the following script to check for similar swap functions in other contracts:

packages/synapse-interface/messages/jp.json (2)

309-309: LGTM: Accurate translation for "Refunded"

The Japanese translation "返金済み" for "Refunded" is accurate and concise. It correctly conveys the meaning of a completed refund action.


309-311: Summary: Successfully implemented "refunded" status translations

The new entries for the "refunded" status have been successfully added to the Japanese localization file. The translations are accurate, consistent with the existing style, and properly placed within the JSON structure. These additions will effectively communicate the refund status to Japanese users of the Synapse interface.

packages/synapse-interface/messages/ar.json (2)

309-311: LGTM: New refund status translations added.

The new entries for "Refunded" and "Transaction refunded, funds returned" have been successfully added to the Arabic localization file. These additions align with the PR objective of implementing transaction status updates for refunded RFQ transactions.


309-311: Verify consistency of translations across language files.

While the additions look good, it's important to ensure that these new entries are consistently added and correctly translated across all supported language files.

Let's verify the consistency of these new entries across other language files:

This script will help us confirm that the new entries are present in all language files and allow us to compare their translations for consistency.

✅ Verification successful

Consistency of translations verified across all language files. All new entries are present and correctly translated in all supported languages.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new refund status entries are present in all language files
# and compare their structure to ensure consistency.

# Find all JSON files in the messages directory
message_files=$(fd -e json . packages/synapse-interface/messages)

echo "Checking for 'Refunded' entry:"
for file in $message_files; do
  echo "File: $file"
  jq -r '."Time"."Refunded" // "Not found"' "$file"
  echo "---"
done

echo "Checking for 'Transaction refunded, funds returned' entry:"
for file in $message_files; do
  echo "File: $file"
  jq -r '."Time"."Transaction refunded, funds returned" // "Not found"' "$file"
  echo "---"
done

Length of output: 4494

packages/synapse-interface/pages/state-managed-bridge/index.tsx (1)

305-305: LGTM: Important addition of routerAddress to pending transaction data

The addition of routerAddress to the pending bridge transaction object is a valuable enhancement. This information is crucial for transaction tracking and potentially for handling refunds, aligning well with the PR's objective of improving RFQ transaction management.

packages/synapse-interface/messages/es.json (1)

309-311: LGTM! New translations for refund status added.

The new Spanish translations for "Refunded" and "Transaction refunded, funds returned" have been correctly added. They are consistent with the PR objectives and appear to be grammatically correct.

Let's verify if similar translations have been added to other language files:

✅ Verification successful

Verification Successful: All translations are present across language files.

All added translation entries for "Refunded" and "Transaction refunded, funds returned" are consistently present in all supported language files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if "Refunded" and "Transaction refunded, funds returned" translations exist in other language files.

# Test: Search for "Refunded" in all JSON files within the messages directory
echo "Searching for 'Refunded' translations:"
rg --type json '"Refunded"' packages/synapse-interface/messages

# Test: Search for "Transaction refunded, funds returned" in all JSON files within the messages directory
echo "Searching for 'Transaction refunded, funds returned' translations:"
rg --type json '"Transaction refunded, funds returned"' packages/synapse-interface/messages

Length of output: 1786

packages/synapse-interface/messages/fr.json (1)

309-311: LGTM! New translations for refund status added correctly.

The new French translations for "Refunded" and "Transaction refunded, funds returned" have been added appropriately to the "Time" section of the JSON file. The translations are grammatically correct and consistent with the existing content.

As a minor suggestion, consider adding these translations to other language files (if they exist) to maintain consistency across all supported languages.

packages/synapse-interface/constants/abis/fastBridge.json (5)

1-8: Constructor looks good.

The constructor is properly defined with an _owner parameter, which is a common pattern for setting up initial ownership of the contract.


9-15: View and pure functions are well-defined and comprehensive.

The ABI includes a wide range of view and pure functions that provide access to important contract states and constants. These functions cover various aspects of the bridge functionality, including:

  • Role management (e.g., DEFAULT_ADMIN_ROLE, GOVERNOR_ROLE)
  • Bridge parameters (e.g., DISPUTE_PERIOD, FEE_RATE_MAX)
  • Transaction statuses and proofs
  • Fee-related information

The functions follow consistent naming conventions and provide a clear interface for interacting with the contract's read-only data.

Also applies to: 16-22, 23-29, 30-36, 37-43, 44-50, 51-57, 58-64, 65-71, 72-78, 124-132, 133-139, 140-152, 153-166, 167-173, 184-190, 204-272, 273-281, 282-291, 292-300, 311-320, 321-327, 328-334, 335-341, 416-424


79-122: State-changing functions are well-implemented and align with PR objectives.

The ABI defines a comprehensive set of state-changing functions that cover the core operations of the bridge contract:

  • bridge: Initiates a bridge transaction
  • claim: Allows claiming of bridged funds
  • dispute: Handles dispute resolution
  • prove: Provides proof for a bridge transaction
  • refund: Implements refund functionality (aligning with the PR objective)
  • relay: Relays a bridge transaction

The inclusion of role-based access control functions (grantRole, revokeRole) suggests a secure approach to managing permissions. The refund function specifically addresses the PR objective of implementing refund functionality for RFQ transactions.

Also applies to: 174-183, 191-203, 342-351, 352-360, 361-369, 370-383, 384-393, 394-406, 407-415, 425-434


435-731: Events are well-defined and crucial for transparency.

The ABI includes a comprehensive set of events that log important contract actions:

  • Bridge-related events (e.g., BridgeDepositClaimed, BridgeDepositRefunded, BridgeProofDisputed)
  • Role management events (RoleGranted, RoleRevoked)
  • Parameter update events (ChainGasAmountUpdated, FeeRateUpdated)

These events are crucial for:

  1. Off-chain monitoring and indexing of contract activities
  2. Providing transparency for users and auditors
  3. Facilitating integration with external systems

The BridgeDepositRefunded event specifically supports the PR objective of implementing refund functionality. The appropriate use of indexing in event parameters allows for efficient filtering of logs.

Also applies to: 732-806


1-851: The FastBridge ABI is well-designed and aligns with PR objectives.

This comprehensive ABI defines a robust interface for a cross-chain bridge contract. Key points:

  1. Core bridge functionalities (bridge, claim, refund) are well-represented.
  2. Role-based access control is implemented for security.
  3. Events provide transparency and support off-chain monitoring.
  4. Custom errors offer gas-efficient and informative error handling.
  5. The refund functionality aligns with the PR objective.

The ABI suggests a feature-rich and security-conscious contract design. However, it's crucial to note that while the ABI looks solid, the actual contract implementation should undergo thorough testing and auditing to ensure it behaves as expected and is free from vulnerabilities.

To ensure the contract behaves as expected, particularly regarding the new refund functionality, consider running the following verification:

packages/synapse-interface/components/_Transaction/_Transaction.tsx (7)

22-22: Importing 'useTxRefundStatus' Hook

The new import statement correctly brings in the useTxRefundStatus hook, which is necessary for handling refunded transaction status.


34-34: Add 'routerAddress' to '_TransactionProps' Interface

Adding routerAddress: string to the _TransactionProps interface ensures that the component receives the necessary router address prop for refund status checks.


39-39: Extend 'status' Prop with 'refunded' Option

Including 'refunded' in the status prop type extends the transaction status handling to cover refunded transactions.


54-54: Include 'routerAddress' in Component Destructuring

Destructuring routerAddress from the component props ensures that it's available within the component scope.


127-127: Update 'showTransactionSupport' Condition with 'refunded' Status

Adding status === 'refunded' to the condition ensures that users receive appropriate support prompts for refunded transactions.


120-121: Confirm 'useBridgeTxUpdater' Accepts New Parameters

Verify that the useBridgeTxUpdater hook accepts isTxReverted and isTxRefunded as parameters in the correct order.

Run the following script to check the definition of useBridgeTxUpdater:

#!/bin/bash
# Description: Confirm 'useBridgeTxUpdater' parameters
rg --type javascript 'function useBridgeTxUpdater' -A 5

# Expected output should show 'isTxReverted' and 'isTxRefunded' as parameters.

86-86: Ensure 'isCheckTxForRefund' is Returned by 'calculateEstimatedTimeStatus'

Verify that the calculateEstimatedTimeStatus function returns isCheckTxForRefund as expected. If not, the destructuring will result in undefined.

Run the following script to confirm that isCheckTxForRefund is included in the return statement:

Comment on lines +101 to +102
throw new Error(error)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix error rethrowing to properly capture error messages

Similarly, in the checkRFQTxBridgeStatus function, rethrowing an error with throw new Error(error) may lose important error details if error is an Error object. Rethrow the original error instead.

Apply this diff to fix the error rethrowing:

-        throw new Error(error)
+        throw error
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
throw new Error(error)
}
throw error
}

Comment on lines +29 to +45
const getTxRefundStatus = async () => {
try {
const bridgeContract = await getRFQBridgeContract(
routerAddress,
chain?.id
)

const status = await checkRFQTxBridgeStatus(
txId,
bridgeContract as Address,
chain?.id
)

if (status === BridgeStatus.REFUNDED) {
setIsRefunded(true)
}
} catch (error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Ensure required parameters are defined before proceeding

In the getTxRefundStatus function, txId, chain?.id, and bridgeContract might be undefined, which could lead to runtime errors when calling checkRFQTxBridgeStatus. Add checks to ensure these values are defined before using them.

Apply this diff to add checks:

       try {
+        if (!txId || !chain?.id) {
+          throw new Error('txId or chainId is undefined')
+        }
         const bridgeContract = await getRFQBridgeContract(
           routerAddress,
           chain?.id
         )
+        if (!bridgeContract) {
+          throw new Error('Bridge contract address is undefined')
+        }
 
         const status = await checkRFQTxBridgeStatus(
           txId,
           bridgeContract as Address,
           chain?.id
         )
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const getTxRefundStatus = async () => {
try {
const bridgeContract = await getRFQBridgeContract(
routerAddress,
chain?.id
)
const status = await checkRFQTxBridgeStatus(
txId,
bridgeContract as Address,
chain?.id
)
if (status === BridgeStatus.REFUNDED) {
setIsRefunded(true)
}
} catch (error) {
const getTxRefundStatus = async () => {
try {
if (!txId || !chain?.id) {
throw new Error('txId or chainId is undefined')
}
const bridgeContract = await getRFQBridgeContract(
routerAddress,
chain?.id
)
if (!bridgeContract) {
throw new Error('Bridge contract address is undefined')
}
const status = await checkRFQTxBridgeStatus(
txId,
bridgeContract as Address,
chain?.id
)
if (status === BridgeStatus.REFUNDED) {
setIsRefunded(true)
}
} catch (error) {

Comment on lines +77 to +78
throw new Error(error)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix error rethrowing to properly capture error messages

In the getRFQBridgeContract function, rethrowing an error using throw new Error(error) can cause issues if error is already an Error object. The Error constructor expects a string message, not an object. It's better to rethrow the original error to preserve the error information.

Apply this diff to fix the error rethrowing:

-        throw new Error(error)
+        throw error
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
throw new Error(error)
}
throw error
}

Comment on lines +105 to +113
const isTxRefunded = useTxRefundStatus(
kappa,
routerAddress as Address,
originChain,
isCheckTxForRefund &&
status === 'pending' &&
bridgeModuleName === 'SynapseRFQ'
)

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Validate Parameters in 'useTxRefundStatus' Hook

Ensure that all parameters passed to useTxRefundStatus are correct and handle potential edge cases:

  • Confirm that kappa and routerAddress are defined before usage.
  • Ensure routerAddress is correctly cast to Address and is a valid Ethereum address.
  • Verify the logical conditions in the check parameter accurately reflect when to check for a refund.

Consider adding null or undefined checks for kappa and routerAddress to prevent runtime errors. For example:

if (kappa && routerAddress) {
  const isTxRefunded = useTxRefundStatus(
    kappa,
    routerAddress as Address,
    originChain,
    isCheckTxForRefund &&
      status === 'pending' &&
      bridgeModuleName === 'SynapseRFQ'
  )
}

@bigboydiamonds bigboydiamonds changed the title feat(synapse-interface): refund RFQ transaction feat(synapse-interface): refund RFQ transaction [SLT-272] Sep 26, 2024
@abtestingalpha abtestingalpha merged commit f0b13bc into master Sep 26, 2024
39 checks passed
@abtestingalpha abtestingalpha deleted the fe/refund-transaction branch September 26, 2024 17:37
abtestingalpha added a commit that referenced this pull request Sep 26, 2024
* update bl

* remove global solidity extension settings

* use monorepo support in global workspace only

* - use Solidity extension for formatting *.sol files
- use `forge fmt` as formatter in Solidity extension

* REST API Improvements [SLT-179] (#3133)

* fix swaptxinfo function

* Updates test coverage command

* migrating to using token addresses instead of symbols

* fix linting errors

* fixing swaptxinfocontroller

* new tests and new functionality

---------

Co-authored-by: abtestingalpha <[email protected]>

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* fix harmony proxy (#3149)


Co-authored-by: Trajan0x <[email protected]>

* merging rfq indexer into monorepo [SLT-164]  [SLT-176] (#3136)

* merging rfq indexer into monorepo

* nuke .env

* fix commands

* fix package name

* test coverage script

* rough pass at docs and some linting and fixes yarn

* Upgrades wagmi & rainbowkit

* indxer

* Adds invisible but used packages

* +recent-invalid-fills [SLT-188]

* Moves wagmi to root

* new endpoints and clean up linting

---------

Co-authored-by: Trajan0x <[email protected]>
Co-authored-by: abtestingalpha <[email protected]>
Co-authored-by: parodime <[email protected]>

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* Adds /destinationTokens route [SLT-204] (#3151)

* Adds /destinationTokens route
* ZeroAddress & NativeGasAddress
* Adds test for native gas tokens
* Checksums incoming token address params

* Publish

 - @synapsecns/[email protected]

* boba pause (#3150)

* boba pause

* only boba to txns

* Publish

 - @synapsecns/[email protected]

* fix(synapse-interface): Reorders validation to check existence first (#3156)

* Reorders validation to check existence first
* Removes duplicates

* Publish

 - @synapsecns/[email protected]

* Fix boba pause (#3158)

* Publish

 - @synapsecns/[email protected]

* update bl

* feat(rest-api): Adds Swagger for api docs [SLT-205] (#3159)

* Adds Swagger for api docs

* Replace prepended verb Get routes with nouns

* Adds dev flag for swagger serverUrl

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* Pulls version from package json (#3160)

* Publish

 - @synapsecns/[email protected]

* Require vs import due to file location (#3161)

* Require vs import due to file location

* Publish

 - @synapsecns/[email protected]

* Prevent caching of api docs (#3162)

* Publish

 - @synapsecns/[email protected]

* feat(contracts-rfq): relay/prove/claim with different address [SLT-130] (#3138)

* init. solidity ^. FbV2 relay/prove/claim overloads

* +IFastBridgeV2, explicit address0 cast, func scope & inheritdoc fixes

* pragma lock, contract relabel

* feat: start scoping V2 tests

* test: override relayer role scenarios, no longer enforced by V2

* test: finish the parity test

* test: the management methods

* test: dst chain scenarios

* test: bridge

* test: prove

* test: claim

* test: dispute

* test: refund

* test: bridge reverts

* remove redundant extend. rearrange inherit list

* revert 0.8.20 in favor of user (non-ws) setting

---------

Co-authored-by: ChiTimesChi <[email protected]>

* Publish

 - [email protected]

* fix(promexporter): make spans better (#3164)

* move the errors

* [goreleaser]

* fix v to w

* changing native token address standard [SLT-210] (#3157)

* changing native token address standard

* fixing tests

* normalizeNativeTokenAddress middleware, additional tests

---------

Co-authored-by: abtestingalpha <[email protected]>

* Publish

 - @synapsecns/[email protected]

* Refactoring rfq-indexer API and adding swagger docs [SLT-228] (#3167)

* refactoring and adding swagger

* remove testing scripts

* fix typos and consistency with 404 errors

* Publish

 - @synapsecns/[email protected]

* fix read mes (#3168)

* Publish

 - @synapsecns/[email protected]
 - [email protected]
 - @synapsecns/[email protected]

* fix(opbot): use submitter get tx status [SLT-158] (#3134)

* use experimental logger to debug

* fix lint

* [goreleaser]

* use submitter instead of client

* [goreleaser]

* [goreleaser]

* fix(synapse-interface): Additional checks on screen [SLT-166] (#3152)

* Additional checks on screen

* Adds checks on chain/token changes

* Publish

 - @synapsecns/[email protected]

* feat(synapse-interface): confirm new price [SLT-150]  (#3084)

* add bridge quote history middleware

* request user confirm changes when quoted price updates

* add conditions for displaying confirm change state

* track initial quote initializing confirm change state

* specify output delta threshold

* callback functions to handle initialize/accept/reset confirm changes flow

* quote countdown timer animation to signal refresh

* implement automatic refresh intervals

* mouse move to refresh automatic intervals

* add i8n translations for button text

---------

Co-authored-by: abtestingalpha <[email protected]>

* Publish

 - @synapsecns/[email protected]

* fix: formatted bridge fee amount (#3165)

* Publish

 - @synapsecns/[email protected]

* fix(contracts-rfq): CI workflows [SLT-245] (#3178)

* fix: license, files

* fix: package name

* build: update solhint to latest

* build: remove prettier dependencies

* fix: solhint workflows

* build: update solhint in other packages as well

* chore: solhint rules, exceptions

* fix: silence linter warnings in tests

* chore: forge fmt

* add variable to test linter CI

* Revert "add variable to test linter CI"

This reverts commit 0629309.

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* feat(api): bridge limits [SLT-165]  (#3179)

* adds `/bridgeLimits` route, controller

* fetch best sdk quote for min/max origin amounts

* add tests

* implement middleware to normalize addresses

* adds swagger doc

* Publish

 - @synapsecns/[email protected]

* fix(contracts-rfq): limit the amount of solhint warnings [SLT-245] (#3182)

* ci: limit the amount of solhint warnings

* refactor: move the errors into the separate interface

* refactor: errors imports in tests

* Publish

 - @synapsecns/[email protected]

* ci: Solidity gas diff [SLT-259] (#3181)

* ci: run tests w/o coverage first for better visibility

* test: malform the test to check the adjusted workflow

* Revert "test: malform the test to check the adjusted workflow"

This reverts commit e7db6e1.

* ci: add gas-diff workflow

* try changing the contract to trigger gas diffs

* retrigger the workflow

* ci: provide the correct report path

* ci: run on pull requests only

* ci: save gas reports in monorepo root

* Revert "ci: run on pull requests only"

This reverts commit 0a01d60.

* Revert "try changing the contract to trigger gas diffs"

This reverts commit 91bc03e.

* refactor: wrap if statement

* refactor: exclude `solidity-devops` package in a more generic way

* ci: run tests w/o coverage for `solidity-devops`, add comments

* add generic comment to trigger `solidity-devops` workflows

* Revert "add generic comment to trigger `solidity-devops` workflows"

This reverts commit cc35a43.

* Publish

 - @synapsecns/[email protected]

* fix(contracts-core): set very high gas limit for intensive tests [SLT-259] (#3186)

* fix: set very high gas limit for intensive tests

* ci: speed up solidity coverage

* Publish

 - @synapsecns/[email protected]

* feat(rest-api): Adds validateRouteExists validation [SLT-260] (#3180)

* Adds validateRouteExists validation

* Remove timeouts for 400s

* Publish

 - @synapsecns/[email protected]

* add duplicate command warning (#3174)

Co-authored-by: Trajan0x <[email protected]>

* reduce solhint warnings on FbV2 (#3189)

* reduce solhint warnings on FbV2

* fix whitespace

* Publish

 - @synapsecns/[email protected]

* ci: solidity gas diff options [SLT-267] (#3193)

* ci: ignore test files in gas diff report

* add some changes to the test files

* ci: define some options for gas-diff

* try changing the contract to trigger gas diffs

* Revert "try changing the contract to trigger gas diffs"

This reverts commit 4504e3c.

* Revert "add some changes to the test files"

This reverts commit 7e7d6cb.

* prove w/ tx id [SLT-181] (#3169)

* prove w/ tx id SLT-181

* +proveOther tests, forge fmt

* fmt

* fmt

* Publish

 - @synapsecns/[email protected]

* fix(sdk-router): disable ARB airdrop tests (#3195)

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* Fixing issue for wallet integration [SLT-270] (#3194)

* slight modification to graphql call

* fixing explorer frontend as well

* Publish

 - @synapsecns/[email protected]
 - @synapsecns/[email protected]

* store relayer on relay [SLT-182] (#3170)

* store relayer on relay [SLT-182]

* +tests, zeroAddr check, fmt

* Publish

 - @synapsecns/[email protected]

* Adjust text to trigger build (#3199)

* Publish

 - @synapsecns/[email protected]

* feat(synapse-interface): refund RFQ transaction [SLT-272] (#3197)

* Txn transaction refund tracking

* Update store to support tracking

* Query FastBridge contract for `bridgeStatuses` to find refund status

* Track bridge transaction `bridgeQuote.routerAddress` in store

* Fetch FastBridge contract address when only provided router address

* add translations

---------

Co-authored-by: aureliusbtc <[email protected]>
Co-authored-by: ChiTimesChi <[email protected]>
Co-authored-by: abtestingalpha <[email protected]>
Co-authored-by: Defi-Moses <[email protected]>
Co-authored-by: trajan0x <[email protected]>
Co-authored-by: Trajan0x <[email protected]>
Co-authored-by: parodime <[email protected]>
Co-authored-by: abtestingalpha <[email protected]>
Co-authored-by: abtestingalpha <[email protected]>
Co-authored-by: parodime <[email protected]>
Co-authored-by: vro <[email protected]>
Co-authored-by: ChiTimesChi <[email protected]>
Co-authored-by: bigboydiamonds <[email protected]>
Co-authored-by: bigboydiamonds <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants