Interface MarketMakerRewardsEpochDetailedWithWallet

When querying an epoch using the RestRequestGetMarketMakerRewardsEpoch endpoint and providing the wallet parameter, the response will include the wallet-specific details from the response.

Provide the wallet parameter to include the following details:

See

interface MarketMakerRewardsEpochDetailedWithWallet {
    epochId: string;
    startsAt: number;
    endsAt: number;
    reviewEndsAt: number;
    totalRewardQuantity: string;
    alpha: string;
    beta: string;
    walletScorePercent: string;
    walletRewardQuantity: string;
    walletRewardVolumePercent: string;
    walletEligibilityVolumePercent: string;
    markets: MarketMakerRewardsEpochMarketWithWallet[];
    previousEpochReviewEndsAt?: number;
    eligibilityVolumeRequirementPercent?: string;
    nextEpochEligibilityVolumeRequirementPercent?: string;
    isWalletEligibleInEpoch?: boolean;
}

Hierarchy (view full)

Properties

epochId startsAt endsAt reviewEndsAt totalRewardQuantity alpha beta walletScorePercent walletRewardQuantity walletRewardVolumePercent walletEligibilityVolumePercent markets previousEpochReviewEndsAt? eligibilityVolumeRequirementPercent? nextEpochEligibilityVolumeRequirementPercent? isWalletEligibleInEpoch?

Properties

epochId

epochId: string

Epoch identifier

startsAt

startsAt: number

Timestamp of the epoch start.

endsAt

endsAt: number

Timestamp of the epoch end.

reviewEndsAt

reviewEndsAt: number

Timestamp of the epoch review period completion.

totalRewardQuantity

totalRewardQuantity: string

Total token reward quantity

alpha

alpha: string

Score parameter

beta

beta: string

Score parameter

walletScorePercent

walletScorePercent: string

Epoch’s wallet score as a percent.

  • For currently active epochs, this is the wallet’s estimated score at last cache time.
  • Only provided if the request includes a wallet parameter.
  • All percents are expressed as standard decimal value with pip resolution. E.g. 18.5% is "0.18500000"

walletRewardQuantity

walletRewardQuantity: string

Epoch’s wallet token reward quantity.

  • For currently active epochs, this is the wallet’s estimated token reward quantity at last cache time.
  • Only provided if the request includes a wallet parameter.

walletRewardVolumePercent

walletRewardVolumePercent: string

Epoch’s wallet qualified maker volume percent relative to eligible wallet qualified maker volume.

  • This value is used as part of the current epoch’s reward calculation.
  • All percents are expressed as standard decimal value with pip resolution. E.g. 18.5% is "0.18500000"

walletEligibilityVolumePercent

walletEligibilityVolumePercent: string

Current epoch’s wallet qualified maker volume percent relative to total qualified maker volume.

markets

markets: MarketMakerRewardsEpochMarketWithWallet[]

See

MarketMakerRewardsEpochMarket

Optional previousEpochReviewEndsAt

previousEpochReviewEndsAt?: number

Timestamp of the previous epoch’s review period end.

  • Only present if the value is in the future (ie the system is currently awaiting the previous epoch end)

Optional eligibilityVolumeRequirementPercent

eligibilityVolumeRequirementPercent?: string

Qualified volume percent setting for the current epoch, if defined.

  • Wallet qualified maker volume for the prior epoch must meet or exceed this value as a percent of overall qualified maker volume to be eligible for the current epoch’s rewards
  • Not present if no eligibility percent is defined for the epoch
  • All percents are expressed as standard decimal value with pip resolution. E.g. 18.5% is "0.18500000"

Optional nextEpochEligibilityVolumeRequirementPercent

nextEpochEligibilityVolumeRequirementPercent?: string

Qualified volume percent setting for the next epoch, if defined.

  • All percents are expressed as standard decimal value with pip resolution. E.g. 18.5% is "0.18500000"

Optional isWalletEligibleInEpoch

isWalletEligibleInEpoch?: boolean

Indicates whether the wallet is eligible to earn market maker rewards in the requested epoch, based on the wallet's performance in the previous epoch.

See

walletEligibilityVolumePercent

  • Only provided if the request includes a wallet parameter, and when requesting the current or past epochs

Settings

Member Visibility

Theme

On This Page

epochIdstartsAtendsAtreviewEndsAttotalRewardQuantityalphabetawalletScorePercentwalletRewardQuantitywalletRewardVolumePercentwalletEligibilityVolumePercentmarketspreviousEpochReviewEndsAteligibilityVolumeRequirementPercentnextEpochEligibilityVolumeRequirementPercentisWalletEligibleInEpoch