Developer Hub
🔮 For applications
SDK
Azuro Waves
useWaveLeaderBoard

Hook is used to get the Wave Total Leaderboard data or Wave Leaderboard for Specific Period.

ℹ️

This hook is a wrapper around getWaveLeaderBoard function.

Usage

import { useWaveLeaderBoard } from '@azuro-org/sdk'
 
const { data } = useWaveLeaderBoard()

Props

{
  waveId?: WaveId
  account?: Address
  startsAt?: number // startsAt of specific period
  enabled?: boolean
}
type WaveId = number | 'active'

Return Value

UseQueryResult<WaveLeaderBoardItem[]>
import { type UseQueryResult } from '@tanstack/react-query'
 
type WaveLeaderBoardItem = {
  position: number
  address: Address
  points: string
  bonusPoints: string | null
  totalMultipliedPoints: string
  bonusMultiplier: number | null
  level: number | null
  levelDescription: WaveLevelData | null
}