-
Notifications
You must be signed in to change notification settings - Fork 15
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
[PART-3] Add transaction tax report #382
Merged
ezewer
merged 6 commits into
bitfinexcom:staging
from
ZIMkaRU:feature/add-transaction-tax-report-v2
May 24, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d39d0b9
Add ability to return exactUsdValue and _id for movements
ZIMkaRU 4a06bed
Add helper to remap movements
ZIMkaRU 3ee7a6d
Add helper to remap trades
ZIMkaRU ce89422
Add ability to fetch transactions
ZIMkaRU 2a30f18
Add collection flags to trx entries
ZIMkaRU 3753a31
Improve pair price naming in usd
ZIMkaRU File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
'use strict' | ||
|
||
const TRX_TAX_STRATEGIES = require('./trx.tax.strategies') | ||
const remapTrades = require('./remap-trades') | ||
const remapMovements = require('./remap-movements') | ||
|
||
module.exports = { | ||
TRX_TAX_STRATEGIES | ||
TRX_TAX_STRATEGIES, | ||
remapTrades, | ||
remapMovements | ||
} |
69 changes: 69 additions & 0 deletions
69
workers/loc.api/sync/transaction.tax.report/helpers/remap-movements.js
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
'use strict' | ||
|
||
const { | ||
isForexSymb | ||
} = require('../../helpers') | ||
|
||
module.exports = (movements, params) => { | ||
const { | ||
remappedTrxs, | ||
remappedTrxsForConvToUsd | ||
} = params | ||
|
||
for (const movement of movements) { | ||
if ( | ||
!movement?.currency || | ||
isForexSymb(movement.currency) || | ||
!Number.isFinite(movement?.amount) || | ||
movement.amount === 0 || | ||
!Number.isFinite(movement?.mtsUpdated) | ||
) { | ||
continue | ||
} | ||
|
||
const firstSymb = movement.currency | ||
const lastSymb = 'USD' | ||
const symbSeparator = firstSymb.length > 3 | ||
? ':' | ||
: '' | ||
|
||
const remappedMovement = { | ||
_id: movement._id, | ||
// NOTE: it means entries are not taken form trades table | ||
isAdditionalTrxMovements: true, | ||
// NOTE: movements can have sub-account transfer entries from ledgers table | ||
isMovements: !movement.isLedgers, | ||
isLedgers: !!movement.isLedgers, | ||
isTrades: false, | ||
symbol: `t${firstSymb}${symbSeparator}${lastSymb}`, | ||
mtsCreate: movement.mtsUpdated, | ||
firstSymb, | ||
lastSymb, | ||
firstSymbPriceUsd: null, | ||
lastSymbPriceUsd: 1, | ||
execAmount: movement.amount, | ||
// NOTE: execPrice = firstSymbPriceUsd and should be set when converting currencies | ||
execPrice: 0, | ||
// NOTE: exactUsdValue can be null on the first launch, for warm-up it's filling from pub-trades | ||
exactUsdValue: movement.exactUsdValue | ||
} | ||
|
||
remappedTrxs.push(remappedMovement) | ||
|
||
if ( | ||
Number.isFinite(movement.exactUsdValue) && | ||
movement.exactUsdValue > 0 | ||
) { | ||
const price = movement.exactUsdValue / movement.amount | ||
|
||
remappedMovement.firstSymbPriceUsd = price | ||
remappedMovement.execPrice = price | ||
|
||
continue | ||
} | ||
|
||
remappedTrxsForConvToUsd.push(remappedMovement) | ||
} | ||
|
||
return params | ||
} |
57 changes: 57 additions & 0 deletions
57
workers/loc.api/sync/transaction.tax.report/helpers/remap-trades.js
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
'use strict' | ||
|
||
const splitSymbolPairs = require( | ||
'bfx-report/workers/loc.api/helpers/split-symbol-pairs' | ||
) | ||
|
||
module.exports = (trades, params) => { | ||
const { | ||
remappedTrxs, | ||
remappedTrxsForConvToUsd | ||
} = params | ||
|
||
for (const trade of trades) { | ||
if ( | ||
!trade?.symbol || | ||
!Number.isFinite(trade?.execAmount) || | ||
trade.execAmount === 0 || | ||
!Number.isFinite(trade?.execPrice) || | ||
trade.execPrice === 0 || | ||
!Number.isFinite(trade?.mtsCreate) | ||
) { | ||
continue | ||
} | ||
|
||
const [firstSymb, lastSymb] = splitSymbolPairs(trade.symbol) | ||
trade.firstSymb = firstSymb | ||
trade.lastSymb = lastSymb | ||
trade.firstSymbPriceUsd = null | ||
trade.lastSymbPriceUsd = null | ||
trade.isAdditionalTrxMovements = false | ||
trade.isMovements = false | ||
trade.isLedgers = false | ||
trade.isTrades = true | ||
|
||
remappedTrxs.push(trade) | ||
|
||
if (lastSymb === 'USD') { | ||
trade.firstSymbPriceUsd = trade.execPrice | ||
trade.lastSymbPriceUsd = 1 | ||
|
||
continue | ||
} | ||
if ( | ||
Number.isFinite(trade.exactUsdValue) && | ||
trade.exactUsdValue > 0 | ||
) { | ||
trade.firstSymbPriceUsd = trade.exactUsdValue / trade.execAmount | ||
trade.lastSymbPriceUsd = trade.exactUsdValue / trade.execPrice | ||
|
||
continue | ||
} | ||
|
||
remappedTrxsForConvToUsd.push(trade) | ||
} | ||
|
||
return params | ||
} |
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't get this logic.
Is not the exact usd what we are trying to get.
Why would we need the first and last symbol price mapped to usd?
We should add the USD reference, lastSymbPriceUsd etc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to simplify tax calc I would like to have a distinct data structure: just have firstSymbPrice and lastSymbPrice for pairs eg tETHBTC
At the same time, we can have movements eg BTC deposits, and should consider it like tBTCUSD
exactUsdValue - is the amount in transaction in USD (the logic would be as we planned) that can be used for calc prices of pairs eg tETHBTC
In other words, in tables, have one additional field exactUsdValue
when have exactUsdValue -> calc firstSymbPrice, lastSymbPrice
if don't have exactUsdValue -> get from pub-trades, set exactUsdValue to appropriate tables -> calc firstSymbPrice, lastSymbPrice
having firstSymbPrice, lastSymbPrice can calc tax report
the idea is to not calculate everything in one place