Skip to Content
Developer HubToolkitUtilsisOutcomeSettled

isOutcomeSettled

Tells whether an outcome has reached a final state and can no longer be bet on.

Returns true for Won, Lost and Canceled (voided) outcomes, and false for Active and Stopped ones.

Usage

import { isOutcomeSettled, OutcomeState } from '@azuro-org/toolkit'
 
isOutcomeSettled(OutcomeState.Won)      // true
isOutcomeSettled(OutcomeState.Lost)     // true
isOutcomeSettled(OutcomeState.Canceled) // true  - voided, stake refunded
isOutcomeSettled(OutcomeState.Active)   // false
isOutcomeSettled(OutcomeState.Stopped)  // false - temporarily not offered, not settled

Props

(state: OutcomeState) => boolean
enum OutcomeState {
  Active = 'Active',
  Canceled = 'Canceled',
  Stopped = 'Stopped',
  Won = 'Won',
  Lost = 'Lost'
}

Return Value

boolean

ℹ️

Settlement is per-outcome. A Condition is only ever Active or Stopped — it never carries a result of its own. Within a single condition, one outcome can be Won, another Lost, a third Canceled, and a fourth still Active. So “is this settled?” is always a question about an outcome, never about its condition.

Rendering a market grid

The typical use is a market grid that stays in place after a game ends: instead of swapping the whole grid for a results view, render each outcome according to its own state.

import { isOutcomeSettled, OutcomeState, type MarketOutcome } from '@azuro-org/toolkit'
 
const Outcome: React.FC<{ outcome: MarketOutcome }> = ({ outcome }) => {
  if (!isOutcomeSettled(outcome.state)) {
    // Active or Stopped - still a betting button (disabled while Stopped)
    return (
      <button disabled={outcome.state === OutcomeState.Stopped}>
        {outcome.selectionName} {outcome.odds}
      </button>
    )
  }
 
  // settled: Won, Lost or Canceled
  let label = 'Lost'
 
  if (outcome.state === OutcomeState.Won) {
    label = 'Won'
  }
  else if (outcome.state === OutcomeState.Canceled) {
    label = 'Refunded'
  }
 
  return <div>{outcome.selectionName} — {label}</div>
}
⚠️

Canceled means voided, not “missing”. A canceled outcome is one the protocol voided: bets on it are refunded. It is not a placeholder for “this outcome isn’t in the feed” — when an outcome is absent from the feed, the SDK’s useOutcomeState / useOutcomesState fall back to OutcomeState.Stopped.

getIsPendingResolutiongetBonuses