⚠️
Important! We’ve moved to V3! This documentation is for V2 only and will be updated in May.
Developer Hub
🔮 For applications
Toolkit
Azuro Waves
getWaveLeaderBoard

Returns the Wave Total Leaderboard or the Wave Leaderboard for Specific Period.

Usage

import { getWaveLeaderBoard } from '@azuro-org/toolkit'
 
const periods = await getWaveLeaderBoard()

Props

{
  waveId?: WaveId
  account?: Address
  startsAt?: number
  chainId?: ChainId
}
type WaveId = number | 'active'
 
type ChainId = 
  | 100     // Gnosis
  | 137     // Polygon
  | 80002   // Polygon Amoy
  | 88888   // Chiliz
  | 88882   // Chiliz Spicy
  | 8453    // Base
  | 84532   // Base Sepolia

Return Value

Array<{
  position: number
  address: Address
  points: string
  bonusPoints: string | null
  totalMultipliedPoints: string
  bonusMultiplier: number | null
  level: number | null
  levelDescription: WaveLevelData | null
}> | null
type WaveLevelData = {
  level: number
  name: WaveLevelName
  boost: string
  pointsNeeded: string
  comment: string
}