Skip to main content
Version: testnet (v0.73)

ReferralProgram

Referral program information

type ReferralProgram {
  id: ID!
  version: Int!
  benefitTiers: [BenefitTier!]!
  endOfProgramTimestamp: Timestamp!
  windowLength: Int!
  stakingTiers: [StakingTier!]!
  endedAt: Timestamp
}

Fields​

ReferralProgram.id ● ID! non-null scalar​

Unique ID generated from the proposal that created this program.

ReferralProgram.version ● Int! non-null scalar​

Incremental version of the program. It is incremented each time the referral program is edited.

ReferralProgram.benefitTiers ● [BenefitTier!]! non-null object​

Defined tiers in increasing order. First element will give Tier 1, second element will give Tier 2, etc.

ReferralProgram.endOfProgramTimestamp ● Timestamp! non-null scalar​

Timestamp as RFC3339Nano, after which when the current epoch ends, the programs status will become STATE_CLOSED and benefits will be disabled.

ReferralProgram.windowLength ● Int! non-null scalar​

Number of epochs over which to evaluate a referral set's running volume.

ReferralProgram.stakingTiers ● [StakingTier!]! non-null object​

Defined staking tiers in increasing order. First element will give Tier 1, second element will give Tier 2, and so on. Determines the level of benefit a party can expect based on their staking.

ReferralProgram.endedAt ● Timestamp scalar​

Timestamp as RFC3339Nano when the program ended. If present, the current program has ended and no program is currently running.

Returned by​

currentReferralProgram query