-
Notifications
You must be signed in to change notification settings - Fork 116
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
Improve vault start pnl query. #2664
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import { NodeEnv } from '@dydxprotocol-indexer/base'; | ||
import { | ||
PnlTicksFromDatabase, | ||
PnlTicksTable, | ||
} from '@dydxprotocol-indexer/postgres'; | ||
import _ from 'lodash'; | ||
|
||
import { getVaultMapping, getVaultPnlStartDate } from '../lib/helpers'; | ||
import { VaultMapping } from '../types'; | ||
|
||
let vaultStartPnl: PnlTicksFromDatabase[] = []; | ||
|
||
export async function startVaultStartPnlCache(): Promise<void> { | ||
const vaultMapping: VaultMapping = await getVaultMapping(); | ||
vaultStartPnl = await PnlTicksTable.getLatestPnlTick( | ||
_.keys(vaultMapping), | ||
// Add a buffer of 10 minutes to get the first PnL tick for PnL data as PnL ticks aren't | ||
// created exactly on the hour. | ||
getVaultPnlStartDate().plus({ minutes: 10 }), | ||
); | ||
} | ||
|
||
export function getVaultStartPnl(): PnlTicksFromDatabase[] { | ||
return vaultStartPnl; | ||
} | ||
|
||
export function clearVaultStartPnl(): void { | ||
if (process.env.NODE_ENV !== NodeEnv.TEST) { | ||
throw Error('cannot clear vault start pnl cache outside of test environment'); | ||
} | ||
|
||
vaultStartPnl = []; | ||
} |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -24,6 +24,7 @@ import { | |||||||||||||||||||||||||||||
AssetFromDatabase, | ||||||||||||||||||||||||||||||
AssetColumns, | ||||||||||||||||||||||||||||||
MarketColumns, | ||||||||||||||||||||||||||||||
VaultFromDatabase, VaultTable, perpetualMarketRefresher, | ||||||||||||||||||||||||||||||
} from '@dydxprotocol-indexer/postgres'; | ||||||||||||||||||||||||||||||
import Big from 'big.js'; | ||||||||||||||||||||||||||||||
import express from 'express'; | ||||||||||||||||||||||||||||||
|
@@ -47,6 +48,7 @@ import { | |||||||||||||||||||||||||||||
PerpetualPositionWithFunding, | ||||||||||||||||||||||||||||||
Risk, | ||||||||||||||||||||||||||||||
SubaccountResponseObject, | ||||||||||||||||||||||||||||||
VaultMapping, | ||||||||||||||||||||||||||||||
} from '../types'; | ||||||||||||||||||||||||||||||
import { ZERO, ZERO_USDC_POSITION } from './constants'; | ||||||||||||||||||||||||||||||
import { InvalidParamError, NotFoundError } from './errors'; | ||||||||||||||||||||||||||||||
|
@@ -720,3 +722,42 @@ export function aggregateHourlyPnlTicks( | |||||||||||||||||||||||||||||
}; | ||||||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
/* ------- VAULT HELPERS ------- */ | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
export async function getVaultMapping(): Promise<VaultMapping> { | ||||||||||||||||||||||||||||||
const vaults: VaultFromDatabase[] = await VaultTable.findAll( | ||||||||||||||||||||||||||||||
{}, | ||||||||||||||||||||||||||||||
[], | ||||||||||||||||||||||||||||||
{}, | ||||||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||||||
const vaultMapping: VaultMapping = _.zipObject( | ||||||||||||||||||||||||||||||
vaults.map((vault: VaultFromDatabase): string => { | ||||||||||||||||||||||||||||||
return SubaccountTable.uuid(vault.address, 0); | ||||||||||||||||||||||||||||||
}), | ||||||||||||||||||||||||||||||
vaults, | ||||||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||||||
const validVaultMapping: VaultMapping = {}; | ||||||||||||||||||||||||||||||
for (const subaccountId of _.keys(vaultMapping)) { | ||||||||||||||||||||||||||||||
const perpetual: PerpetualMarketFromDatabase | undefined = perpetualMarketRefresher | ||||||||||||||||||||||||||||||
.getPerpetualMarketFromClobPairId( | ||||||||||||||||||||||||||||||
vaultMapping[subaccountId].clobPairId, | ||||||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||||||
if (perpetual === undefined) { | ||||||||||||||||||||||||||||||
logger.warning({ | ||||||||||||||||||||||||||||||
at: 'VaultController#getVaultPositions', | ||||||||||||||||||||||||||||||
message: `Vault clob pair id ${vaultMapping[subaccountId]} does not correspond to a ` + | ||||||||||||||||||||||||||||||
'perpetual market.', | ||||||||||||||||||||||||||||||
subaccountId, | ||||||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||||||
continue; | ||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||
validVaultMapping[subaccountId] = vaultMapping[subaccountId]; | ||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||
return validVaultMapping; | ||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
export function getVaultPnlStartDate(): DateTime { | ||||||||||||||||||||||||||||||
const startDate: DateTime = DateTime.fromISO(config.VAULT_PNL_START_DATE).toUTC(); | ||||||||||||||||||||||||||||||
return startDate; | ||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||
Comment on lines
+760
to
+763
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Add validation for config value and date format. The function should validate the config value exists and handle invalid date formats. Apply this diff: export function getVaultPnlStartDate(): DateTime {
+ if (!config.VAULT_PNL_START_DATE) {
+ throw new Error('VAULT_PNL_START_DATE is not configured');
+ }
const startDate: DateTime = DateTime.fromISO(config.VAULT_PNL_START_DATE).toUTC();
+ if (!startDate.isValid) {
+ throw new Error(`Invalid date format in VAULT_PNL_START_DATE: ${config.VAULT_PNL_START_DATE}`);
+ }
return startDate;
} 📝 Committable suggestion
Suggested change
|
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.
🛠️ Refactor suggestion
Add error handling and fix logging location.
The function should handle potential database errors. Also, there's a typo in the logging location.
Apply this diff:
📝 Committable suggestion