aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface ApiRewardsExpectedRewardsBody

    Request body for previewing a single account's expected rewards for an epoch.

    Provide exactly one of address or accountId. When epoch is omitted the current epoch is used. All remaining fields are optional what-if overrides of the epoch's reward configuration.

    interface ApiRewardsExpectedRewardsBody {
        accountId?: string;
        address?: string;
        aflpPointsBudget?: number;
        calculationVariables?: RewardsExpectedCalculationVariables;
        epoch?: number;
        refereeRateHigh?: number;
        refereeRateLow?: number;
        referralVolumeThreshold?: number;
        referrerRateHigh?: number;
        referrerRateLow?: number;
        totalMakerRewards?: number;
        totalTakerRewards?: number;
        tradingPointsBudget?: number;
    }
    Index
    accountId? address? aflpPointsBudget? calculationVariables? epoch? refereeRateHigh? refereeRateLow? referralVolumeThreshold? referrerRateHigh? referrerRateLow? totalMakerRewards? totalTakerRewards? tradingPointsBudget?
    accountId?: string

    Account ID to preview rewards for.

    address?: string

    Sui wallet address to preview rewards for.

    aflpPointsBudget?: number

    Override for the AFLP points budget.

    calculationVariables?: RewardsExpectedCalculationVariables

    Overrides for the Q-score / taker-share coefficients.

    epoch?: number

    Epoch number to preview. Defaults to the current epoch when omitted.

    refereeRateHigh?: number

    Override for the referee rate at or above the volume threshold.

    refereeRateLow?: number

    Override for the referee rate below the volume threshold.

    referralVolumeThreshold?: number

    Override for the referral volume threshold.

    referrerRateHigh?: number

    Override for the referrer rate at or above the volume threshold.

    referrerRateLow?: number

    Override for the referrer rate below the volume threshold.

    totalMakerRewards?: number

    Override for the total maker reward pool.

    totalTakerRewards?: number

    Override for the total taker reward pool.

    tradingPointsBudget?: number

    Override for the trading points budget.

    Settings
    Member Visibility

    On This Page
    Properties