Skip to content

Commit

Permalink
[WIP]: Validator metrics to canvas (#2418)
Browse files Browse the repository at this point in the history
  • Loading branch information
rossbulat authored Jan 10, 2025
1 parent a5508c4 commit 8bdf926
Show file tree
Hide file tree
Showing 55 changed files with 1,060 additions and 839 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
// SPDX-License-Identifier: GPL-3.0-only

import type { AnyJson } from '@w3ux/types'
import BigNumber from 'bignumber.js'
import {
BarElement,
CategoryScale,
Chart as ChartJS,
Legend,
Expand All @@ -14,61 +16,80 @@ import {
} from 'chart.js'
import { useNetwork } from 'contexts/Network'
import { useTheme } from 'contexts/Themes'
import { format, fromUnixTime } from 'date-fns'
import { DefaultLocale, locales } from 'locales'
import type { ValidatorEraPoints } from 'plugin-staking-api/types'
import { Line } from 'react-chartjs-2'
import { useTranslation } from 'react-i18next'
import graphColors from 'styles/graphs/index.json'
import type { EraPointsProps } from './types'

ChartJS.register(
CategoryScale,
LinearScale,
PointElement,
LineElement,
BarElement,
Title,
Tooltip,
Legend
)

export const EraPoints = ({ items = [], height }: EraPointsProps) => {
const { t } = useTranslation('library')
export const EraPointsLine = ({
entries,
syncing,
width,
height,
}: {
entries: ValidatorEraPoints[]
syncing: boolean
width: string | number
height: string | number
}) => {
const { i18n, t } = useTranslation()
const { mode } = useTheme()
const { colors } = useNetwork().networkData

// Format reward points as an array of strings, or an empty array if syncing
const dataset = syncing
? []
: entries.map((entry) => new BigNumber(entry.points).toString())

// Use primary color for line
const color = colors.primary[mode]

const options = {
responsive: true,
maintainAspectRatio: false,
barPercentage: 0.3,
maxBarThickness: 13,
scales: {
x: {
border: {
display: false,
},
stacked: true,
grid: {
color: 'rgba(0,0,0,0)',
display: false,
},
ticks: {
display: true,
maxTicksLimit: 30,
autoSkip: true,
},
title: {
display: true,
text: 'Era',
color: graphColors.canvas.axis[mode],
font: {
size: 10,
},
autoSkip: true,
},
},
y: {
stacked: true,
beginAtZero: true,
ticks: {
color: graphColors.canvas.axis[mode],
font: {
size: 10,
},
},
border: {
display: false,
},
grid: {
color: graphColors.grid[mode],
},
min: 0,
ticks: {
display: true,
beginAtZero: false,
color: graphColors.canvas.grid[mode],
},
},
},
Expand All @@ -78,7 +99,6 @@ export const EraPoints = ({ items = [], height }: EraPointsProps) => {
},
title: {
display: false,
text: t('eraPoints'),
},
tooltip: {
displayColors: false,
Expand All @@ -90,7 +110,8 @@ export const EraPoints = ({ items = [], height }: EraPointsProps) => {
},
callbacks: {
title: () => [],
label: (context: AnyJson) => `${context.parsed.y}`,
label: (context: AnyJson) =>
`${new BigNumber(context.parsed.y).decimalPlaces(0).toFormat()} ${t('eraPoints', { ns: 'library' })}`,
},
intersect: false,
interaction: {
Expand All @@ -101,24 +122,30 @@ export const EraPoints = ({ items = [], height }: EraPointsProps) => {
}

const data = {
labels: items.map(({ era }) => era),
labels: entries.map(({ start }: { start: number }) => {
const dateObj = format(fromUnixTime(start), 'do MMM', {
locale: locales[i18n.resolvedLanguage ?? DefaultLocale].dateFormat,
})
return `${dateObj}`
}),
datasets: [
{
label: t('points'),
data: items.map(({ points }) => points),
borderColor: colors.primary[mode],
backgroundColor: colors.primary[mode],
pointStyle: undefined,
label: t('era', { ns: 'library' }),
data: dataset,
borderColor: color,
backgroundColor: color,
pointRadius: 0,
borderWidth: 2,
borderRadius: 3,
},
],
}

return (
<div
className="inner"
style={{
height: height || 'auto',
width,
height,
}}
>
<Line options={options} data={data} />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Copyright 2024 @polkadot-cloud/polkadot-staking-dashboard authors & contributors
// SPDX-License-Identifier: GPL-3.0-only

import { useSize } from '@w3ux/hooks'
import type { AnyJson } from '@w3ux/types'
import BigNumber from 'bignumber.js'
import {
Expand All @@ -15,19 +14,12 @@ import {
Title,
Tooltip,
} from 'chart.js'
import { useHelp } from 'contexts/Help'
import { useNetwork } from 'contexts/Network'
import { usePoolPerformance } from 'contexts/Pools/PoolPerformance'
import { useTheme } from 'contexts/Themes'
import { useUi } from 'contexts/UI'
import { formatSize } from 'library/Graphs/Utils'
import { useRef } from 'react'
import { Line } from 'react-chartjs-2'
import { useTranslation } from 'react-i18next'
import graphColors from 'styles/graphs/index.json'
import { ButtonHelp } from 'ui-buttons'
import type { OverviewSectionProps } from '../types'
import { GraphWrapper, HeadingWrapper } from '../Wrappers'
import type { PointsByEra } from 'types'

ChartJS.register(
CategoryScale,
Expand All @@ -40,56 +32,45 @@ ChartJS.register(
Legend
)

export const PerformanceGraph = ({
bondedPool,
performanceKey,
graphSyncing,
}: OverviewSectionProps) => {
export const LegacyEraPoints = ({
pointsByEra,
syncing,
width,
height,
}: {
pointsByEra: PointsByEra
syncing: boolean
width: string | number
height: string | number
}) => {
const { t } = useTranslation()
const { mode } = useTheme()
const { openHelp } = useHelp()
const { containerRefs } = useUi()
const { colors } = useNetwork().networkData
const { getPoolRewardPoints } = usePoolPerformance()

const poolRewardPoints = getPoolRewardPoints(performanceKey)
const rawEraRewardPoints = poolRewardPoints[bondedPool.addresses.stash] || {}

// Ref to the graph container.
const graphInnerRef = useRef<HTMLDivElement>(null)

// Get the size of the graph container.
const size = useSize(graphInnerRef, {
outerElement: containerRefs?.mainInterface,
})
const { width, height } = formatSize(size, 150)

// Format reward points as an array of strings, or an empty array if syncing.
const dataset = graphSyncing
// Format reward points as an array of strings, or an empty array if syncing
const dataset = syncing
? []
: Object.values(
Object.fromEntries(
Object.entries(rawEraRewardPoints).map(([k, v]: AnyJson) => [
Object.entries(pointsByEra).map(([k, v]) => [
k,
new BigNumber(v).toString(),
])
)
)

// Format labels, only displaying the first and last era.
const labels = Object.keys(rawEraRewardPoints).map(() => '')

const firstEra = Object.keys(rawEraRewardPoints)[0]
// Format labels, only displaying the first and last era
const labels = Object.keys(pointsByEra).map(() => '')
const firstEra = Object.keys(pointsByEra)[0]
labels[0] = firstEra
? `${t('era', { ns: 'library' })} ${Object.keys(rawEraRewardPoints)[0]}`
? `${t('era', { ns: 'library' })} ${Object.keys(pointsByEra)[0]}`
: ''

const lastEra = Object.keys(rawEraRewardPoints)[labels.length - 1]
const lastEra = Object.keys(pointsByEra)[labels.length - 1]
labels[labels.length - 1] = lastEra
? `${t('era', { ns: 'library' })} ${Object.keys(rawEraRewardPoints)[labels.length - 1]}`
? `${t('era', { ns: 'library' })} ${Object.keys(pointsByEra)[labels.length - 1]}`
: ''

// Use primary color for bars.
// Use primary color for line
const color = colors.primary[mode]

const options = {
Expand All @@ -104,6 +85,7 @@ export const PerformanceGraph = ({
display: false,
},
ticks: {
color: graphColors.canvas.axis[mode],
font: {
size: 10,
},
Expand All @@ -114,6 +96,7 @@ export const PerformanceGraph = ({
stacked: true,
beginAtZero: true,
ticks: {
color: graphColors.canvas.axis[mode],
font: {
size: 10,
},
Expand All @@ -122,7 +105,7 @@ export const PerformanceGraph = ({
display: false,
},
grid: {
color: graphColors.grid[mode],
color: graphColors.canvas.grid[mode],
},
},
},
Expand Down Expand Up @@ -169,29 +152,14 @@ export const PerformanceGraph = ({
}

return (
<div>
<HeadingWrapper>
<h3>
{t('recentPerformance', { ns: 'library' })}
<ButtonHelp
outline
marginLeft
onClick={() => openHelp('Era Points')}
/>
</h3>
</HeadingWrapper>

<GraphWrapper ref={graphInnerRef} style={{ height }}>
<div
className="inner"
style={{
width,
height,
}}
>
<Line options={options} data={data} />
</div>
</GraphWrapper>
<div
className="inner"
style={{
width,
height,
}}
>
<Line options={options} data={data} />
</div>
)
}
7 changes: 4 additions & 3 deletions packages/app/src/library/ListItem/Labels/Metrics.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ import { useOverlay } from 'ui-overlay'
import type { MetricsProps } from '../types'

export const Metrics = ({ display, address }: MetricsProps) => {
const { openModal } = useOverlay().modal
const { openCanvas } = useOverlay().canvas

return (
<div className="label">
<button
type="button"
onClick={() =>
openModal({
openCanvas({
key: 'ValidatorMetrics',
options: {
address,
validator: address,
identity: display,
},
size: 'xl',
})
}
>
Expand Down
36 changes: 0 additions & 36 deletions packages/app/src/library/PoolSync/Bar.tsx

This file was deleted.

Loading

0 comments on commit 8bdf926

Please sign in to comment.