Get Azuro Waves Leaderboard

export enum WavesLevelName {
  Grey = 'Grey',
  Mist = 'Mist',
  Sky = 'Sky',
  Blue = 'Blue',
  Ultramarine = 'Ultramarine',
  Bright = 'Bright',
  Brilliant = 'Brilliant',
  Royal = 'Royal',
}
 
export type WavesLevelDescription = {
  level: number
  name: WavesLevelName
  /**  e.g. "1.4" */
  boost: `${number}`
  /**  e.g. "50000" */
  pointsNeeded: `${number}`
  comment: string
}
 
export type WavesParticipant = {
  address: `0x${string}`
  waveId: number
  levelActivated: boolean
  initialLevel: number
  level: number
  levelDescription: WavesLevelDescription
 
  /** "2.100000", total user points without level multiplier */
  points: `${number}`
  /** "2.100000", final points with level multiplier ('boost') */
  multipliedPoints: `${number}`
}

const waveId: number | 'active' = 'active'
const baseUrl = `https://api.azuro.org/api/v1/public/waves/${waveId}`
 
// waveId
// e.g.
// https://api.azuro.org/api/v1/public/waves/1
// https://api.azuro.org/api/v1/public/waves/active

const fetchAzuroWavesUserStats = async (userAddress: `0x${string}`) => {
  const url = `https://api.azuro.org/api/v1/public/waves/active/participants/${userAddress.toLowerCase()}/stats`
  const response = await fetch(url)
 
  // 404 means user not found or there is no active wave at this moment
  if (response.status === 404) {
    return null
  }
 
  if (!response.ok) {
    throw new Error(`Status ${response.status}: ${response.statusText}`)
  }
 
  const result: StatsResponse = await response.json()
 
  return result
}
 
type StatsResponse = WavesParticipant

const activateAzuroWavesUser = async (userAddress: `0x${string}`) => {
  const url = `https://api.azuro.org/api/v1/public/waves/active/participants/${userAddress.toLowerCase()}/activate`
  // GET method, not POST
  const response = await fetch(url)
  const result: ActivateResponse = await response.json()
 
  return result
}
 
enum ParticipantActivationResult {
  Activated = 'Activated',
  AlreadyActivated = 'AlreadyActivated',
  InvalidParticipantAddress = 'InvalidParticipantAddress',
  ConcurrencyLockFailed = 'ConcurrencyLockFailed',
  UnknownError = 'UnknownError',
}
 
type ActivateResponse = {
  participant: WavesParticipant
  result: ParticipantActivationResult
}

/**
 * Returns the top 10 Participants, sorted by their position.
 *
 * If `userAddress` is provided and the user exists in the leaderboard (has any score)
 * but their position isn't in the top 10,
 * they will be added to the end of the list with their actual position.
 */
const fetchAzuroWavesTotalLeaderboard = async (userAddress?: `0x${string}`) => {
  const url = userAddress
    ? `https://api.azuro.org/api/v1/public/waves/active/leaderboard?address=${userAddress.toLowerCase()}`
    : 'https://api.azuro.org/api/v1/public/waves/active/leaderboard'
 
  const response = await fetch(url)
 
  // 404 means there is no active wave at this moment
  if (response.status === 404) {
    return null
  }
 
  if (!response.ok) {
    throw new Error(`Status ${response.status}: ${response.statusText}`)
  }
 
  const result: WavesTotalResponse = await response.json()
 
  return result
}
 
type WavesTotalItem = WavesParticipant & {
  position: number
}
 
type WavesTotalResponse = WavesTotalItem[]

/**
  * Returns all periods of the Wave, DESC sorted.
  */
const fetchAzuroWavesPeriods = async () => {
  const response = await fetch('https://api.azuro.org/api/v1/public/waves/active/periods')
 
  // 404 means there is no active wave at this moment
  if (response.status === 404) {
    return null
  }
 
  if (!response.ok) {
    throw new Error(`Status ${response.status}: ${response.statusText}`)
  }
 
  const result: WavesPeriodsResponse = await response.json()
 
  return result
}
 
type WavesPeriod = {
  id: number
  /** ISO String "2024-05-13T00:00:00.000Z" */
  startsAt: string
  /** ISO String "2024-05-20T00:00:00.000Z", actually, it's a startsAt of next period */
  endsAt: string
  /** "123456.56789" */
  totalPoints: `${number}`
  waveId: number
}
 
type WavesPeriodsResponse = WavesPeriod[]

/**
 * Returns the top 10 Participants, sorted by their position.
 *
 * If `userAddress` is provided and the user exists in the leaderboard (has any score)
 * but their position isn't in the top 10,
 * they will be added to the end of the list with their actual position.
 */
const fetchAzuroWavesPeriodLeaderboard = async (periodStartsAt: number, userAddress?: `0x${string}`) => {
  const url = userAddress
    ? `https://api.azuro.org/api/v1/public/waves/active/periods/${periodStartsAt}/leaderboard?address=${userAddress.toLowerCase()}`
    : `https://api.azuro.org/api/v1/public/waves/active/periods/${periodStartsAt}/leaderboard`
 
  const response = await fetch(url)
 
  // 404 means there is no active wave at this moment
  if (response.status === 404) {
    return null
  }
 
  if (!response.ok) {
    throw new Error(`Status ${response.status}: ${response.statusText}`)
  }
 
  const result: WavesPeriodLeaderboardResponse = await response.json()
 
  return result
}
 
type WavesPeriodLeaderboardItem = {
  position: number
  address: `0x${string}`
  /** e.g. "123456.567892" */
  points: `${number}`
  wavePeriodId: number
  /** e.g. "94.224632" */
  sharePercent: `${number}`
  /** e.g. "1.4" */
  expectedPositionMultiplier: `${number}`
}
 
type WavesPeriodLeaderboardResponse = WavesPeriodLeaderboardItem[]

/**
  * Returns all Levels sorted from Grey to Royal.
  */
const fetchAzuroWavesLevels = async () => {
  const url = 'https://api.azuro.org/api/v1/public/waves/active/levels'
  const response = await fetch(url)
 
  // 404 means there is no active wave at this moment
  if (response.status === 404) {
    return null
  }
 
  if (!response.ok) {
    throw new Error(`Status ${response.status}: ${response.statusText}`)
  }
 
  const result: WavesLevelsResponse = await response.json()
 
  return result
}
 
type WavesLevelsResponse = WavesLevelDescription[]