Add swap transaction verification #175
Conversation
WalkthroughThis update introduces several modifications to enhance the management of swap transactions. Key changes include the restructuring of the Changes
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (3)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (7)
src/services/cronJobs/syncSwapTransactions.ts (4)
18-27: Periodic job queue logging.Logging the queue size every two minutes is helpful for monitoring. If advanced health checks or metrics are needed, consider capturing more data (like active vs. stalled jobs).
36-45:runCheckPendingSwapsCronJobscheduling.Separating the logic for processing swaps and for scheduling them is good practice. Consider adding error handling in case
addJobToCheckPendingSwapsfails to fetch or enqueue jobs.
47-67:addJobToCheckPendingSwapsfunction.Fetching and enqueuing pending swaps is straightforward. If debugging is needed for failed jobs, it may be helpful to set
removeOnFail: falseto preserve error logs in the queue.
90-117:verifySwapTransactionfunction logic.
- Fetches the swap record.
- Retrieves status from an external API.
- Updates both the swap record and donation records.
The flow is clear. Verify that partial failures (e.g., updating donation fails, but swap status was updated) are unlikely to leave inconsistent states.
src/repositories/swapRepository.ts (3)
37-61: Add validation for chain ID parsingIn lines 54-55, the function parses
fromChainIdandtoChainIdas integers without any error handling. If these values cannot be parsed correctly (e.g., if they contain non-numeric characters), the function will throw an error. Consider adding validation or error handling for these conversions.- fromChainId: parseInt(params.fromChainId), - toChainId: parseInt(params.toChainId), + fromChainId: Number.isNaN(parseInt(params.fromChainId)) ? 0 : parseInt(params.fromChainId), + toChainId: Number.isNaN(parseInt(params.toChainId)) ? 0 : parseInt(params.toChainId),Alternatively, if these fields should never be invalid, consider throwing a more descriptive error:
- fromChainId: parseInt(params.fromChainId), - toChainId: parseInt(params.toChainId), + fromChainId: Number.isNaN(parseInt(params.fromChainId)) + ? (() => { throw new Error(`Invalid fromChainId: ${params.fromChainId}`) })() + : parseInt(params.fromChainId), + toChainId: Number.isNaN(parseInt(params.toChainId)) + ? (() => { throw new Error(`Invalid toChainId: ${params.toChainId}`) })() + : parseInt(params.toChainId),
7-11: Consider returning relations for comprehensive dataThe
getPendingSwapsfunction retrieves swap transactions without any related entities. Depending on how this data is used, you might want to include related entities like donations to avoid N+1 query problems.export const getPendingSwaps = async (): Promise<SwapTransaction[]> => { return await SwapTransaction.createQueryBuilder('swap') .where('swap.status = :status', { status: SWAP_TRANSACTION_STATUS.PENDING }) + .leftJoinAndSelect('swap.donation', 'donation') .getMany(); };
13-17: Consider including relations in getSwapByIdThe
getSwapByIdfunction doesn't include related entities like donations. This could lead to inconsistencies when using this function vs. directly querying with relations. Consider adding an optional parameter to include relations.export const getSwapById = async ( id: number, + relations: string[] = [], ): Promise<SwapTransaction | null> => { - return await SwapTransaction.findOne({ where: { id } }); + return await SwapTransaction.findOne({ + where: { id }, + relations, + }); };Then update the usage in
updateSwapDonationStatus:- const swap = await getSwapById(swapId); + const swap = await getSwapById(swapId, ['donation']);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
src/repositories/swapRepository.ts(1 hunks)src/server/bootstrap.ts(2 hunks)src/services/cronJobs/syncSwapTransactions.ts(1 hunks)src/services/squidService.ts(1 hunks)src/entities/donation.ts(1 hunks)src/repositories/projectRoundRecordRepository.ts(2 hunks)src/repositories/projectUserRecordRepository.ts(1 hunks)src/server/adminJs/tabs/donationTab.ts(1 hunks)src/server/bootstrap.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (12)
src/entities/donation.ts (1)
21-21: LGTM: Addition of the new SWAP_PENDING statusThe new
SWAP_PENDINGstatus has been properly added to theDONATION_STATUSconstant, which will allow tracking of donations that are waiting for a swap transaction to complete.src/repositories/projectUserRecordRepository.ts (1)
56-60: Updated donation status array to include SWAP_PENDING statusThe inclusion of
DONATION_STATUS.SWAP_PENDINGin the status array ensures that donations with pending swaps will be included in the project user record calculations. This is consistent with how other statuses are handled.src/server/bootstrap.ts (2)
69-69: New import for the swap transaction cron jobThe import for
runCheckPendingSwapsCronJobhas been correctly added to implement the new feature.
162-162: Added new cron job for checking pending swapsThe cron job has been properly integrated into the initialization sequence. This will enable periodic verification of pending swap transactions.
src/services/squidService.ts (2)
1-5: LGTM: Service setup and configurationThe imports and configuration retrieval for the Squid service are properly set up. The integrator ID is fetched from the application configuration.
6-30:✅ Verification successful
LGTM: Implementation of the getStatus function with proper error handling
The
getStatusfunction is well-implemented with appropriate error handling. It correctly:
- Makes a request to the Squid API with required parameters
- Includes the integrator ID in the headers
- Returns the response data
- Logs detailed error information when failures occur
Verify the format of the response data by checking the Squid API documentation:
🌐 Web query:
What is the response format for the Squid API status endpoint?💡 Result:
The response format for Squid API status endpoints varies by implementation but generally includes these key elements based on different Squid-related APIs:
Common Status Response Components
System Status (Squid v1 REST API)
{ "model": "SX-DC-8-1224", "serial": "240320200000", "activeState": "Running", "objType": "currentStatus", "temperatureUnits": "F", "firmware": "0.5.25384", "devices": [/* hardware details */] }Includes hardware/software status and operational metrics[3].
Transaction Status (Squid Router)
{ "squidTransactionStatus": "SUCCESS", "id": "<transaction-hash>", "status": "completed", "gasStatus": "paid", "fromChainId": 1, "toChainId": 137 }Tracks cross-chain transaction states with explicit status codes[9].
API Health Check (Giant Squid)
{ squidStatus { height } }Returns blockchain height for endpoint health verification[5].
Key Fields Across Implementations
Field Type Example Values Description Operational State "Running","Disabled"Current system status[3][12] Version Information "firmware": "0.5.25384"Software/hardware versions[3] Network Metrics "height": 1834567Blockchain synchronization status[5] Transaction State "SUCCESS","NEEDS_GAS"Cross-chain operation status[9] Error Codes "status": 403HTTP/API-specific status codes[4][8] For production environments, most Squid APIs require security headers and return HATEOAS-style links for available operations[10][13]. The exact structure depends on the specific Squid implementation (AI proxy, blockchain router, or caching system).
Citations:
- 1: https://getsquid.ai/docs/integrations/api/httpapi/
- 2: https://aws.amazon.com/blogs/security/how-to-add-dns-filtering-to-your-nat-instance-with-squid/
- 3: https://www.ametekesp.de/-/media/ametekesp/downloads/manuals/squid/api-definition-squid-rev-b.pdf?la=de-de&revision=2248aabc-84be-4a50-82f5-cc5d903f553c
- 4: https://solvedevops.com/blog/getting-started-with-squid-proxy-server-in-the-cloud/
- 5: Status React component for Giant Squid APIs subsquid/bounties#8
- 6: https://www.getambassador.io/blog/guide-api-endpoints
- 7: https://getsquid.ai/docs/tutorials/full-stack/http-api
- 8: http://www.websense.com/content/support/library/web/v85/wcg_help/squid.aspx
- 9: https://docs.squidrouter.com/additional-resources/squid-v1-docs/sdk/get-route-status
- 10: https://docs.squidex.io/id-04-next/3.0-compatibility
- 11: https://docs.squidrouter.com/additional-resources/squid-v1-docs/api
- 12: https://wiki.squid-cache.org/SquidFaq/OperatingSquid
- 13: https://docs.squidex.io/id-02-documentation/developer-guides/api-overview
- 14: https://wiki.squid-cache.org/SquidFaq/InnerWorkings
- 15: https://docs.ceph.com/en/latest/releases/squid
- 16: https://docs.ceph.com/en/reef/mgr/ceph_api/
- 17: http://api.squid.link
- 18: https://community.a10networks.com/discussion/1429/squid-proxy-heath-check
- 19: https://squidrouter.readme.io/reference/getting-started-with-your-api-1
- 20: https://docs.squidrouter.com/api-and-sdk-integration/api/get-route-status
LGTM – Confirmed Response Format & Error Handling
The
getStatusfunction is implemented correctly. It makes the appropriate GET request to the Squid API endpoint using the provided parameters, includes the integrator ID in the headers, returns the API response data, and logs errors appropriately. The web query confirms that Squid Transaction Status responses typically include fields likesquidTransactionStatus,id,status,gasStatus,fromChainId, andtoChainId, which aligns with the expectations of this implementation.
- API Request: Uses
axios.getwith the correct endpoint and headers.- Response Handling: Returns
result.data, which should contain the relevant fields as per Squid API documentation.- Error Handling: Logs both detailed API errors (if available) and the request parameters upon failure.
The response format verification from the documentation supports the current implementation. No further changes are required.
src/server/adminJs/tabs/donationTab.ts (1)
603-606: AddSWAP_PENDINGdonation status.This update properly integrates the new
SWAP_PENDINGstatus. Ensure that transitions from/to this status are uniformly handled across the codebase to prevent orphaned states or confusion for administrators.src/repositories/projectRoundRecordRepository.ts (1)
31-35: IncludeSWAP_PENDINGin status filtering.Adding
SWAP_PENDINGto both queries ensures donations with this status are accounted for in project round record calculations. Confirm that this status is valid in all relevant flows (e.g., a donation is never stuck inSWAP_PENDINGincorrectly).Also applies to: 160-164
src/services/cronJobs/syncSwapTransactions.ts (4)
1-16: Imports and Bull queue creation.Imports and queue initialization look fine. Validate that
redisConfigis properly connected and handles reconnections so that the queue operations remain stable under fluctuating network conditions.
28-35: Concurrent jobs configuration and cron expression.The configurable concurrency and cron expression facilitate flexible deployments. Ensure that
NUMBER_OF_VERIFY_SWAP_CONCURRENT_JOBis maintained within safe limits, and that frequent job runs won't cause unintended resource usage spikes.
69-88:processVerifySwapsJobsfunction.The concurrency-based processing structure is good. Ensure exceptions propagating from
verifySwapTransactionare managed as intended, so asynchronous failures don't get silently lost.
119-123:isCompletedStatushelper.Restricting completed statuses to
['success']is explicit. If future statuses indicate completion (e.g.,'partial_success'), remember to extend this list.
| export const updateSwapStatus = async ( | ||
| id: number, | ||
| squidTransactionStatus: string, | ||
| ): Promise<void> => { | ||
| const swap = await SwapTransaction.findOne({ where: { id } }); | ||
| if (!swap) { | ||
| throw new Error(`Swap with id ${id} not found`); | ||
| } | ||
|
|
||
| const metadata = swap.metadata || {}; | ||
| metadata.squidTransactionStatus = squidTransactionStatus; | ||
|
|
||
| await SwapTransaction.update(id, { | ||
| status: squidTransactionStatus, | ||
| metadata, | ||
| }); | ||
| }; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Consider mapping the squidTransactionStatus to a valid SwapTransaction status
The function directly assigns the squidTransactionStatus string to the swap's status field in line 32. If the external Squid API uses different status values than your SWAP_TRANSACTION_STATUS enum, this could potentially introduce invalid status values. Consider mapping the external status to your application's status enum.
🏁 Script executed:
#!/bin/bash
# Check if the external Squid transaction statuses match our internal SWAP_TRANSACTION_STATUS enum values
echo "Checking SWAP_TRANSACTION_STATUS enum values:"
rg -A 10 "enum SWAP_TRANSACTION_STATUS" --type ts
echo -e "\nChecking for any Squid API status mapping:"
rg "squidTransactionStatus" --type ts | grep -v "swapRepository.ts"Length of output: 538
Action Required: Map External Squid Status to a Valid Internal Status
The mapping of squidTransactionStatus to your internal SWAP_TRANSACTION_STATUS enum is currently missing. Without an explicit mapping, you risk saving an external status value that may not align with your application's defined enum. Please introduce a mapping layer (for instance, via a dictionary or function) to translate the external Squid status into one of your valid internal statuses before the update call.
- Location:
src/repositories/swapRepository.ts(lines 19–35) - Recommendation:
- Add a mapping function or lookup table to convert the incoming
squidTransactionStatusinto a validSWAP_TRANSACTION_STATUSvalue. - Review any related usages (e.g., in
src/services/cronJobs/syncSwapTransactions.ts) to ensure consistency in status translations.
- Add a mapping function or lookup table to convert the incoming
src/repositories/swapRepository.ts
Outdated
| if (swap.donation) { | ||
| swap.donation.status = DONATION_STATUS.PENDING; | ||
| swap.donation.transactionId = swapStatus.secondTxHash; | ||
| await swap.donation.save(); | ||
| } |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the correct donation status
According to the AI summary, a new status SWAP_PENDING was added to the DONATION_STATUS enum, but line 78 sets the donation status to PENDING. Verify if you should be using SWAP_PENDING instead.
🌐 Web query:
What's the difference between "PENDING" and "SWAP_PENDING" statuses in donation processing systems?
💡 Result:
The "PENDING" and "SWAP_PENDING" statuses in donation processing systems refer to distinct phases in different transaction contexts:
PENDING Status
- General Meaning: Indicates a donation is awaiting further action before completion. Common reasons include:
- Clearance periods: Donations may take 14 days to clear before funds are transferred to the charity’s account[1].
- Verification: Requires donor confirmation or nonprofit review (e.g., matching gift submissions)[4][7].
- Payment processing delays: ACH transfers or credit card approvals can take 5–7 business days[13].
- Minimum transfer thresholds: Funds remain pending until the balance meets the currency’s transfer limit[1].
SWAP_PENDING Status
- Blockchain/Crypto Context: Specific to cryptocurrency or token swaps, such as cross-chain transfers (e.g., Neo X blockchain transactions)[3][15]. It signifies:
- A token exchange (e.g., N3 to Neo X) is initiated but awaiting validation or relay between networks.
- Requires time for validators to confirm the swap via smart contracts or bridging protocols[3][15].
Key Differences
| Aspect | PENDING | SWAP_PENDING |
|---|---|---|
| Environment | Traditional fiat payment systems | Blockchain/cryptocurrency networks |
| Primary Cause | Banking delays, verification, limits | Cross-chain validation or token swaps |
| Resolution | Automatic after set periods | Relies on blockchain validators |
| Examples | ACH delays[13], matching gift holds[4] | Neo X bridge transfers[3], crypto swaps[15] |
In summary, "PENDING" is a broad status in traditional donation systems, while "SWAP_PENDING" applies narrowly to cryptocurrency swaps awaiting blockchain confirmation.
Citations:
- 1: https://support.givengain.com/hc/en-us/articles/205243781-Transfer-schedules-and-donations-with-Pending-status
- 2: https://resource1.personifycorp.com/personifyonlinehelp/7.7.0/mergedprojects/fundraising/Fundraising_System_Types_and_Codes.htm
- 3: https://neonewstoday.com/category/development/feed/
- 4: https://support.doublethedonation.com/knowledge/what-do-donor-the-different-donor-statuses-mean
- 5: https://knowledgebase.givingdata.com/payment-statuses
- 6: https://www.worldradiohistory.com/Archive-All-Music/Archive-RandR/1990s/1993/RR-1993-09-17.pdf
- 7: https://help.essentials.cdmplus.com/ce/process-pending-donations
- 8: https://www.donorperfect.com/video/payment-processing-101/
- 9: https://www.worldradiohistory.com/Archive-BC/BC-1995/BC-1995-04-03.pdf
- 10: https://www.aplos.com/support/articles/online-donation-status/
- 11: https://kindful.com/blog/best-nonprofit-payment-processors/
- 12: https://www.acenrenewables.com/wp-content/uploads/2020/03/ACEPH-Definitive-Information-Statement-ANNEXES-A-to-F-26-March-2020-compressed.pdf
- 13: https://www.givelively.org/resources/troubleshoot-donations-made-via-ach-direct-debit
- 14: https://doublethedonation.com/payment-processing-for-nonprofits/
- 15: https://kb.myetherwallet.com/categories/swap/
- 16: https://givewp.com/documentation/core/donations/
- 17: https://www.jitasagroup.com/jitasa_nonprofit_blog/donor-analytics/
- 18: https://www.club3g.com/threads/my-2003-3g-gts-restoration.262065/
- 19: https://www.paypal-community.com/t5/About-Protections-Archive/Donation-Pending/m-p/832606
- 20: https://donorbox.org/nonprofit-blog/nonprofit-donation-processing
Donation Status Correction for Blockchain Swaps
The current implementation sets the donation status to PENDING, which is generally used for fiat or non-swap donations. Since this repository handles cryptocurrency swaps, the donation should instead be marked with the SWAP_PENDING status to correctly reflect that the token exchange is awaiting blockchain validation.
- Action Required: Change the assignment from
DONATION_STATUS.PENDINGtoDONATION_STATUS.SWAP_PENDING. - Example Diff:
if (swap.donation) { - swap.donation.status = DONATION_STATUS.PENDING; + swap.donation.status = DONATION_STATUS.SWAP_PENDING; swap.donation.transactionId = swapStatus.secondTxHash; await swap.donation.save(); }
📝 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.
| if (swap.donation) { | |
| swap.donation.status = DONATION_STATUS.PENDING; | |
| swap.donation.transactionId = swapStatus.secondTxHash; | |
| await swap.donation.save(); | |
| } | |
| if (swap.donation) { | |
| swap.donation.status = DONATION_STATUS.SWAP_PENDING; | |
| swap.donation.transactionId = swapStatus.secondTxHash; | |
| await swap.donation.save(); | |
| } |
src/repositories/swapRepository.ts
Outdated
| export const updateSwapDonationStatus = async ( | ||
| swapId: number, | ||
| swapStatus: any, | ||
| ): Promise<void> => { | ||
| const swap = await getSwapById(swapId); | ||
| if (!swap) { | ||
| throw new Error(`Swap with id ${swapId} not found`); | ||
| } | ||
|
|
||
| swap.secondTxHash = swapStatus.secondTxHash; | ||
| swap.toAmount = swapStatus.toAmount; | ||
| swap.status = swapStatus.squidTransactionStatus; | ||
| await swap.save(); | ||
|
|
||
| if (swap.donation) { | ||
| swap.donation.status = DONATION_STATUS.PENDING; | ||
| swap.donation.transactionId = swapStatus.secondTxHash; | ||
| await swap.donation.save(); | ||
| } | ||
| }; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Improve type safety and add transaction management
The swapStatus parameter is typed as any, which reduces type safety. Consider defining a proper interface for this parameter. Additionally, the function updates both the swap and its associated donation without transaction management. This could lead to inconsistent data if one operation succeeds and the other fails.
+ interface SwapStatus {
+ secondTxHash: string;
+ toAmount: number;
+ squidTransactionStatus: string;
+ }
- export const updateSwapDonationStatus = async (
- swapId: number,
- swapStatus: any,
- ): Promise<void> => {
+ export const updateSwapDonationStatus = async (
+ swapId: number,
+ swapStatus: SwapStatus,
+ ): Promise<void> => {
+ const queryRunner = SwapTransaction.getRepository().manager.connection.createQueryRunner();
+
+ await queryRunner.connect();
+ await queryRunner.startTransaction();
+
+ try {
const swap = await getSwapById(swapId);
if (!swap) {
throw new Error(`Swap with id ${swapId} not found`);
}
swap.secondTxHash = swapStatus.secondTxHash;
swap.toAmount = swapStatus.toAmount;
swap.status = swapStatus.squidTransactionStatus;
await swap.save();
if (swap.donation) {
swap.donation.status = DONATION_STATUS.PENDING;
swap.donation.transactionId = swapStatus.secondTxHash;
await swap.donation.save();
}
+
+ await queryRunner.commitTransaction();
+ } catch (error) {
+ await queryRunner.rollbackTransaction();
+ throw error;
+ } finally {
+ await queryRunner.release();
+ }
};🏁 Script executed:
#!/bin/bash
# Check if SWAP_PENDING is being used in the donation entity as mentioned in the AI summary
echo "Checking DONATION_STATUS enum:"
rg -A 15 "enum DONATION_STATUS" --type tsLength of output: 114
I'll need to verify that the DONATION_STATUS enum (or equivalent) is defined in the codebase since the initial rg command returned no output. To gather more conclusive information, please run the following shell script to search for any reference to DONATION_STATUS in all TypeScript files:
Once we have the output from this search, we can be more confident about the need (or not) to adjust the transaction management and type safety improvements suggested in the review comment.
🏁 Script executed:
#!/bin/bash
# Searching for all occurrences of DONATION_STATUS in the codebase
rg -n "DONATION_STATUS" --type tsLength of output: 27186
Action Required: Enhance Type Safety and Ensure Atomic Updates
Please update the function as follows to address two concerns:
- Type Safety: Replace the
anytype forswapStatusby defining a dedicated interface (e.g.,SwapStatus) that explicitly declares the expected fields. - Transaction Management: Since the function updates both the swap and its associated donation, wrap these operations in a transaction. This ensures that inconsistent data won’t be left in the database if one of the operations fails.
Below is the suggested diff snippet:
+ interface SwapStatus {
+ secondTxHash: string;
+ toAmount: number;
+ squidTransactionStatus: string;
+ }
- export const updateSwapDonationStatus = async (
- swapId: number,
- swapStatus: any,
- ): Promise<void> => {
+ export const updateSwapDonationStatus = async (
+ swapId: number,
+ swapStatus: SwapStatus,
+ ): Promise<void> => {
+ const queryRunner = SwapTransaction.getRepository().manager.connection.createQueryRunner();
+
+ await queryRunner.connect();
+ await queryRunner.startTransaction();
+
+ try {
const swap = await getSwapById(swapId);
if (!swap) {
throw new Error(`Swap with id ${swapId} not found`);
}
swap.secondTxHash = swapStatus.secondTxHash;
swap.toAmount = swapStatus.toAmount;
swap.status = swapStatus.squidTransactionStatus;
await swap.save();
if (swap.donation) {
swap.donation.status = DONATION_STATUS.PENDING;
swap.donation.transactionId = swapStatus.secondTxHash;
await swap.donation.save();
}
+
+ await queryRunner.commitTransaction();
+ } catch (error) {
+ await queryRunner.rollbackTransaction();
+ throw error;
+ } finally {
+ await queryRunner.release();
+ }
};Please ensure that the transaction is created from the correct repository/manager and that all operations inside the transaction behave as expected.
📝 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.
| export const updateSwapDonationStatus = async ( | |
| swapId: number, | |
| swapStatus: any, | |
| ): Promise<void> => { | |
| const swap = await getSwapById(swapId); | |
| if (!swap) { | |
| throw new Error(`Swap with id ${swapId} not found`); | |
| } | |
| swap.secondTxHash = swapStatus.secondTxHash; | |
| swap.toAmount = swapStatus.toAmount; | |
| swap.status = swapStatus.squidTransactionStatus; | |
| await swap.save(); | |
| if (swap.donation) { | |
| swap.donation.status = DONATION_STATUS.PENDING; | |
| swap.donation.transactionId = swapStatus.secondTxHash; | |
| await swap.donation.save(); | |
| } | |
| }; | |
| interface SwapStatus { | |
| secondTxHash: string; | |
| toAmount: number; | |
| squidTransactionStatus: string; | |
| } | |
| export const updateSwapDonationStatus = async ( | |
| swapId: number, | |
| swapStatus: SwapStatus, | |
| ): Promise<void> => { | |
| const queryRunner = SwapTransaction.getRepository().manager.connection.createQueryRunner(); | |
| await queryRunner.connect(); | |
| await queryRunner.startTransaction(); | |
| try { | |
| const swap = await getSwapById(swapId); | |
| if (!swap) { | |
| throw new Error(`Swap with id ${swapId} not found`); | |
| } | |
| swap.secondTxHash = swapStatus.secondTxHash; | |
| swap.toAmount = swapStatus.toAmount; | |
| swap.status = swapStatus.squidTransactionStatus; | |
| await swap.save(); | |
| if (swap.donation) { | |
| swap.donation.status = DONATION_STATUS.PENDING; | |
| swap.donation.transactionId = swapStatus.secondTxHash; | |
| await swap.donation.save(); | |
| } | |
| await queryRunner.commitTransaction(); | |
| } catch (error) { | |
| await queryRunner.rollbackTransaction(); | |
| throw error; | |
| } finally { | |
| await queryRunner.release(); | |
| } | |
| }; |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.env.template (1)
3-4: Clarify DOCKER_IMAGE Tag Usage.
TheDOCKER_IMAGEvariable on line 3 now specifies the staging image (ghcr.io/generalmagicio/qacc-be:staging) and includes a comment with the production image tag. Please ensure that the staging value is intentional and that deployment scripts or environments are configured accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
src/repositories/swapRepository.ts(1 hunks)src/services/cronJobs/syncSwapTransactions.ts(1 hunks)src/services/squidService.ts(1 hunks).env.template(1 hunks)src/repositories/swapRepository.ts(1 hunks)src/services/cronJobs/syncSwapTransactions.ts(1 hunks)src/services/squidService.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- src/services/cronJobs/syncSwapTransactions.ts
- src/services/squidService.ts
- src/services/cronJobs/syncSwapTransactions.ts
- src/repositories/swapRepository.ts
- src/repositories/swapRepository.ts
🔇 Additional comments (3)
.env.template (1)
5-5: Addition of SQUID_INTEGRATOR_ID.
The new environment variableSQUID_INTEGRATOR_ID="1234567890"is clearly added with an explanatory comment. Verify that the placeholder value is updated appropriately for production or testing environments as needed.src/services/squidService.ts (2)
6-91: Good addition of type definitions for improved type safety!The addition of these interfaces (
ChainData,ChainInfo,TimeSpent, andSquidStatusResponse) brings much-needed type safety to the Squid API integration. This will help catch type-related issues at compile time rather than runtime.Small suggestions:
- Consider adding JSDoc comments to these interfaces to document their purpose and usage
- The
errorfield inSquidStatusResponseusesRecord<string, any>which is very permissive - if the error structure is predictable, consider defining a more specific interface
98-100: Great improvement to the function signature!Adding the return type
Promise<SquidStatusResponse>to thegetStatusfunction and properly typing the axios request improves type safety and makes the code more self-documenting.
Summary by CodeRabbit
New Features
Chores