[PART-1] Add transaction tax report #380
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Release version to master
This was referenced Jul 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the main structure for
Transaction Tax ReportIt's a 1-part of the feature, the main idea taken from these PRs: #373, #378, #379
Basic changes:
getTransactionTaxReportendpointgetTransactionTaxReportFileendpointmakeTrxTaxReportInBackgroundendpointgetTransactionTaxReportrequest example{ "auth": { "token": "user_token" }, "method": "getTransactionTaxReport", "params": { "start": 1706861968714, "end": 1712042359302, "strategy": "LIFO" // or "FIFO" } }getTransactionTaxReportresponse example{ "jsonrpc": "2.0", "result": [ { "asset": "LTC", "amount": 1.43796106, "mtsAcquired": 1712042016000, "mtsSold": 1712042359302, "proceeds": 142.64861307412, "cost": 142.41853930451998, "gainOrLoss": 0.23007376960001125 }, { "asset": "BTC", "amount": 0.001342, "mtsAcquired": 1649771737942, "mtsSold": 1709584808125, "proceeds": 90.838638, "cost": 54.303808778059306, "gainOrLoss": 36.5348292219407 }, { "asset": "LTC", "amount": 1e-8, "mtsAcquired": 1706858241000, "mtsSold": 1706861968714, "proceeds": 6.7707e-7, "cost": 6.7876e-7, "gainOrLoss": -1.6900000000000634e-9 } ], "id": null }getTransactionTaxReportFilerequest example{ "auth": { "token": "user_token" }, "method": "getTransactionTaxReportFile", "params": { "start": 1706861968714, "end": 1712042359302, "strategy": "LIFO" } }getTransactionTaxReportFileresponse example{ "jsonrpc": "2.0", "result": { "isSaveLocaly": true, "localReportFolderPath": "/home/user/docs/bitfinex/report-files", "remoteReportUrn": null, "localCsvFolderPath": "/home/user/docs/bitfinex/report-files", "remoteCsvUrn": null }, "id": null }makeTrxTaxReportInBackgroundrequest example{ "auth": { "token": "user_token" }, "method": "makeTrxTaxReportInBackground", "params": { "start": 1706861968714, "end": 1712042359302, "strategy": "LIFO" } }makeTrxTaxReportInBackgroundresponse example{ "jsonrpc": "2.0", "result": true, "id": null }The idea of the
makeTrxTaxReportInBackgroundendpoint is the following:the big users may have a lot of trades for a certain year
to convert currencies to USD are used the public trades endpoint of the BFX API with 15reqs/min rate limit
it can lead to significant time in report generation
to fight HTTP timeout for this case, it is necessary to send
makeTrxTaxReportInBackgroundHTTP request to schedule generationand when the report generation is successful the data of the tax report will be responded via WebSocket
emitTrxTaxReportGenerationInBackgroundToOneWS event example:{ "jsonrpc": "2.0", "result": [ { "asset": "LTC", "amount": 1.43796106, "mtsAcquired": 1712042016000, "mtsSold": 1712042359302, "proceeds": 142.64861307412, "cost": 142.41853930451998, "gainOrLoss": 0.23007376960001125 }, { "asset": "BTC", "amount": 0.001342, "mtsAcquired": 1649771737942, "mtsSold": 1709584808125, "proceeds": 90.838638, "cost": 54.303808778059306, "gainOrLoss": 36.5348292219407 }, { "asset": "LTC", "amount": 1e-8, "mtsAcquired": 1706858241000, "mtsSold": 1706861968714, "proceeds": 6.7707e-7, "cost": 6.7876e-7, "gainOrLoss": -1.6900000000000634e-9 } ], "id": null, "action": "emitTrxTaxReportGenerationInBackgroundToOne" }emitTrxTaxReportGenerationInBackgroundToOneWS event example in case anerror{ "jsonrpc": "2.0", "error": { "code": 500, "message": "Internal Server Error", "data": null }, "id": null, "action": "emitTrxTaxReportGenerationInBackgroundToOne" }