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

explore page: data rendering #254

Merged
merged 3 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions src/shared/api/server/summary/all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { DurationWindow, durationWindows, isDurationWindow } from '@/shared/util
import { adaptSummary, SummaryData } from '@/shared/api/server/summary/types.ts';
import { AssetId, Metadata } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
import { serialize, Serialized } from '@/shared/utils/serializer';
import { getStablecoins } from '@/shared/utils/stables';
import { getFormattedAmtFromValueView } from '@penumbra-zone/types/value-view';

interface GetPairsParams {
window: DurationWindow;
Expand All @@ -31,8 +33,7 @@ export const getAllSummaries = async (
const registry = await registryClient.remote.get(chainId);
const allAssets = registry.getAllAssets();

const stablecoins = allAssets.filter(asset => ['USDT', 'USDC', 'USDY'].includes(asset.symbol));
const usdc = stablecoins.find(asset => asset.symbol === 'USDC');
const { stablecoins, usdc } = getStablecoins(allAssets, 'USDC');

const results = await pindexer.summaries({
...params,
Expand Down Expand Up @@ -66,11 +67,24 @@ export const getAllSummaries = async (
return;
}

return serialize(data);
return data;
}),
);

return summaries.filter(Boolean) as Serialized<SummaryData>[];
// Sorting by decreasing liquidity in the pool
// TODO: sort directly in SQL to avoid breaking server-side pagination
const sortedSummaries = summaries.filter(Boolean).sort((a, b) => {
if (!a || !b) {
return 0;
}

const aLiquidity = Number(getFormattedAmtFromValueView(a.liquidity)) || 0;
const bLiquidity = Number(getFormattedAmtFromValueView(b.liquidity)) || 0;

return bLiquidity - aLiquidity;
});

return sortedSummaries.map(data => serialize(data)) as Serialized<SummaryData>[];
};

export type SummariesResponse = Serialized<SummaryData>[] | { error: string };
Expand Down
17 changes: 5 additions & 12 deletions src/shared/api/server/summary/pairs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import {
} from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
import { ChainRegistryClient } from '@penumbra-labs/registry';
import { toValueView } from '@/shared/utils/value-view';
import { getDisplayDenomExponent } from '@penumbra-zone/getters/metadata';
import { getStablecoins } from '@/shared/utils/stables';
import { calculateEquivalentInUSDC } from '@/shared/utils/price-conversion';

const getAssetById = (allAssets: Metadata[], id: Buffer): Metadata | undefined => {
return allAssets.find(asset => {
Expand All @@ -34,8 +35,7 @@ export async function GET(): Promise<NextResponse<PairsResponse>> {
const registry = await registryClient.remote.get(chainId);
const allAssets = registry.getAllAssets();

const stablecoins = allAssets.filter(asset => ['USDT', 'USDC', 'USDY'].includes(asset.symbol));
const usdc = stablecoins.find(asset => asset.symbol === 'USDC');
const { stablecoins, usdc } = getStablecoins(allAssets, 'USDC');

const results = await pindexer.pairs({
// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style -- usdc is defined
Expand All @@ -58,15 +58,8 @@ export async function GET(): Promise<NextResponse<PairsResponse>> {
});

// Converts liquidity and trading volume to their equivalent USDC prices if `usdc_price` is available
if (summary.usdc_price) {
const expDiff = Math.abs(
getDisplayDenomExponent(quoteAsset) - getDisplayDenomExponent(usdc),
);
const result = summary.liquidity * summary.usdc_price * 10 ** expDiff;
volume = toValueView({
amount: Math.floor(result),
metadata: quoteAsset,
});
if (summary.usdc_price && usdc) {
volume = calculateEquivalentInUSDC(summary.liquidity, summary.usdc_price, quoteAsset, usdc);
}

return serialize({
Expand Down
5 changes: 3 additions & 2 deletions src/shared/api/server/summary/single.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { ChainRegistryClient } from '@penumbra-labs/registry';
import { durationWindows, isDurationWindow } from '@/shared/utils/duration.ts';
import { adaptSummary, SummaryResponse } from '@/shared/api/server/summary/types.ts';
import { serialize, Serialized } from '@/shared/utils/serializer';
import { getStablecoins } from '@/shared/utils/stables';

export async function GET(req: NextRequest): Promise<NextResponse<Serialized<SummaryResponse>>> {
const chainId = process.env['PENUMBRA_CHAIN_ID'];
Expand Down Expand Up @@ -34,8 +35,8 @@ export async function GET(req: NextRequest): Promise<NextResponse<Serialized<Sum

// TODO: Add getMetadataBySymbol() helper to registry npm package
const allAssets = registry.getAllAssets();
const stablecoins = allAssets.filter(asset => ['USDT', 'USDC', 'USDY'].includes(asset.symbol));
const usdc = stablecoins.find(asset => asset.symbol === 'USDC');

const { usdc } = getStablecoins(allAssets, 'USDC');

const baseAssetMetadata = allAssets.find(
a => a.symbol.toLowerCase() === baseAssetSymbol.toLowerCase(),
Expand Down
13 changes: 13 additions & 0 deletions src/shared/utils/stables.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { Metadata } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';

/**
* Utility for retrieving stablecoin metadata
*/
export const getStablecoins = (
allAssets: Metadata[],
stablecoin: string,
): { stablecoins: Metadata[]; usdc?: Metadata } => {
const stablecoins = allAssets.filter(asset => ['USDT', 'USDC', 'USDY'].includes(asset.symbol));
const usdc = stablecoins.find(asset => asset.symbol === stablecoin);
return { stablecoins, usdc };
};