@namehash/ens-referrals 1.11.0 → 1.11.1

package/dist/index.d.cts

@@ -1,5 +1,6 @@
-import { NormalizedAddress, UnixTimestamp, AccountId, Duration, Address } from 'enssdk';
-import { PriceUsdc, PriceEth, SerializedPriceEth, SerializedPriceUsdc } from '@ensnode/ensnode-sdk';
+import { NormalizedAddress, UnixTimestamp, AccountId, Duration, InterpretedName, Address } from 'enssdk';
+import { PriceUsdc, PriceEth, RegistrarActionType, SerializedPriceEth, SerializedPriceUsdc, EnsIndexerPublicConfig, PrerequisiteResult, OmnichainIndexingStatusId } from '@ensnode/ensnode-sdk';
+import { Hash } from 'viem';
 
 declare const validateNormalizedAddress: (address: NormalizedAddress) => void;
 
@@ -802,7 +803,22 @@ interface ReferrerLeaderboardPieSplit {
      */
     accurateAsOf: UnixTimestamp;
 }
-declare const buildReferrerLeaderboardPieSplit: (allReferrers: ReferrerMetrics[], rules: ReferralProgramRulesPieSplit, accurateAsOf: UnixTimestamp) => ReferrerLeaderboardPieSplit;
+/**
+ * A point-in-time snapshot of everything computed for a `pie-split` referral program edition.
+ */
+interface ReferralEditionSnapshotPieSplit {
+    /**
+     * Discriminant identifying this as a pie-split snapshot.
+     *
+     * @invariant Equals `leaderboard.awardModel` and `leaderboard.rules.awardModel`.
+     */
+    awardModel: typeof ReferralProgramAwardModels.PieSplit;
+    /**
+     * The {@link ReferrerLeaderboardPieSplit} computed for this edition.
+     */
+    leaderboard: ReferrerLeaderboardPieSplit;
+}
+declare const buildReferralEditionSnapshotPieSplit: (allReferrers: ReferrerMetrics[], rules: ReferralProgramRulesPieSplit, accurateAsOf: UnixTimestamp) => ReferralEditionSnapshotPieSplit;
 
 /**
  * Edition summary for a `pie-split` referral program edition.
@@ -826,6 +842,115 @@ declare const validateEditionSummaryPieSplit: (summary: ReferralProgramEditionSu
  */
 declare function buildEditionSummaryPieSplit(slug: ReferralProgramEditionSlug, displayName: string, rules: ReferralProgramRulesPieSplit, leaderboard: ReferrerLeaderboardPieSplit): ReferralProgramEditionSummaryPieSplit;
 
+/**
+ * Per-event accounting math for a single referral under a rev-share-cap edition.
+ */
+interface TentativeReferralAwardRevShareCap {
+    /**
+     * Revenue contribution in ETH from this single referral event.
+     */
+    incrementalRevenueContribution: PriceEth;
+    /**
+     * Running total of the referrer's revenue contribution in ETH, through and including this event.
+     */
+    accumulatedRevenueContribution: PriceEth;
+    /**
+     * Base revenue contribution in USDC attributable to this single referral event's duration.
+     */
+    incrementalBaseRevenueContribution: PriceUsdc;
+    /**
+     * The referrer's accumulated base revenue contribution in USDC, through and including this event.
+     */
+    accumulatedBaseRevenueContribution: PriceUsdc;
+    /**
+     * The award pool in USDC remaining.
+     *
+     * @invariant Reflects the pool state *before* this event was processed.
+     */
+    awardPoolRemaining: PriceUsdc;
+    /**
+     * `true` if and only if the referrer has an admin-disqualification action for this edition.
+     *
+     * @invariant Reflects admin disqualification only; NOT set when the referrer has simply not
+     *            yet met the minimum-base-revenue threshold.
+     */
+    disqualified: boolean;
+    /**
+     * The admin-disqualification reason string, verbatim from the admin action.
+     *
+     * @invariant Defined if and only if `disqualified === true`.
+     */
+    disqualificationReason?: string;
+    /**
+     * A copy of `rules.maxBaseRevenueShare` at the time of this event.
+     */
+    maxRevShare: number;
+    /**
+     * The effective fraction of base revenue that was awarded for this event. Derived as
+     * `incrementalTentativeAward.amount / incrementalBaseRevenueContribution.amount`.
+     * Useful for diagnosing partial-pool truncation and first-time-qualification catch-up awards.
+     *
+     * @invariant Equals `0` when `incrementalBaseRevenueContribution.amount === 0n`.
+     * @invariant `<= maxRevShare` for the already-qualified branch. May exceed `maxRevShare` on
+     *            the event that triggers first-time qualification, because accumulated uncapped
+     *            award from prior events is claimed against this event's base revenue.
+     */
+    effectiveBaseRevShare: number;
+    /**
+     * The tentative USDC award attributed to this single referral event.
+     *
+     * On the event that triggers first-time qualification, this includes the accumulated uncapped
+     * award from prior events in which the referrer had not yet qualified (capped by the remaining
+     * award pool). On subsequent events, it is the per-event uncapped award capped by the pool.
+     *
+     * @invariant `amount === 0n` when the referrer is admin-disqualified OR has not yet qualified
+     *            as of this event. Also zero when the pool is empty.
+     * @invariant `amount <= awardPoolRemaining.amount`.
+     */
+    incrementalTentativeAward: PriceUsdc;
+}
+/**
+ * A single per-event accounting record for a referral under a rev-share-cap edition.
+ */
+interface ReferralAccountingRecordRevShareCap {
+    /**
+     * The registrar-action identifier.
+     */
+    registrarActionId: string;
+    /**
+     * Block timestamp of the referral event.
+     */
+    timestamp: UnixTimestamp;
+    /**
+     * FQDN of the name the referral applies to.
+     */
+    name: InterpretedName;
+    /**
+     * Type of registrar action.
+     */
+    actionType: RegistrarActionType;
+    /**
+     * Transaction hash of the referral.
+     */
+    transactionHash: Hash;
+    /**
+     * Registrant that paid for / performed the action.
+     */
+    registrant: Address;
+    /**
+     * Referrer that received credit.
+     */
+    referrer: NormalizedAddress;
+    /**
+     * Incremental duration (seconds) contributed by this referral.
+     */
+    incrementalDuration: Duration;
+    /**
+     * Per-event accounting math from the rev-share-cap race.
+     */
+    tentativeAward: TentativeReferralAwardRevShareCap;
+}
+
 /**
  * Extends {@link ReferrerMetrics} with computed base revenue contribution.
  */
@@ -997,6 +1122,22 @@ interface ReferralEvent {
      * Revenue contribution in ETH from this single referral event.
      */
     incrementalRevenueContribution: PriceEth;
+    /**
+     * FQDN of the name the referral applies to.
+     */
+    name: InterpretedName;
+    /**
+     * Type of registrar action.
+     */
+    actionType: RegistrarActionType;
+    /**
+     * Transaction hash of the onchain registrar action that produced this referral.
+     */
+    transactionHash: Hash;
+    /**
+     * Ethereum address of the registrant that paid for / performed the action.
+     */
+    registrant: Address;
 }
 
 /**
@@ -1037,7 +1178,28 @@ interface ReferrerLeaderboardRevShareCap {
     accurateAsOf: UnixTimestamp;
 }
 /**
- * Builds a {@link ReferrerLeaderboardRevShareCap} using a sequential "first-come, first-served"
+ * A point-in-time snapshot of everything computed for a `rev-share-cap` referral program edition.
+ */
+interface ReferralEditionSnapshotRevShareCap {
+    /**
+     * Discriminant identifying this as a rev-share-cap snapshot.
+     *
+     * @invariant Equals `leaderboard.awardModel` and `leaderboard.rules.awardModel`.
+     */
+    awardModel: typeof ReferralProgramAwardModels.RevShareCap;
+    /**
+     * The {@link ReferrerLeaderboardRevShareCap} computed from `accountingRecords`.
+     */
+    leaderboard: ReferrerLeaderboardRevShareCap;
+    /**
+     * Per-event accounting trace.
+     *
+     * @invariant One entry per processed onchain event, in chronological order.
+     */
+    accountingRecords: ReferralAccountingRecordRevShareCap[];
+}
+/**
+ * Builds a {@link ReferralEditionSnapshotRevShareCap} using a sequential "first-come, first-served"
  * race algorithm over individual referral events.
  *
  * Events are processed in chronological order. When a referrer first crosses the qualification
@@ -1049,7 +1211,7 @@ interface ReferrerLeaderboardRevShareCap {
  * @param rules - The {@link ReferralProgramRulesRevShareCap} defining the program parameters.
  * @param accurateAsOf - Timestamp indicating data freshness.
  */
-declare const buildReferrerLeaderboardRevShareCap: (events: ReferralEvent[], rules: ReferralProgramRulesRevShareCap, accurateAsOf: UnixTimestamp) => ReferrerLeaderboardRevShareCap;
+declare const buildReferralEditionSnapshotRevShareCap: (events: ReferralEvent[], rules: ReferralProgramRulesRevShareCap, accurateAsOf: UnixTimestamp) => ReferralEditionSnapshotRevShareCap;
 
 /**
  * Represents a leaderboard for any number of referrers.
@@ -1057,6 +1219,12 @@ declare const buildReferrerLeaderboardRevShareCap: (events: ReferralEvent[], rul
  * Use `awardModel` to narrow the specific variant at runtime.
  */
 type ReferrerLeaderboard = ReferrerLeaderboardPieSplit | ReferrerLeaderboardRevShareCap;
+/**
+ * A point-in-time snapshot of everything computed for a referral program edition.
+ *
+ * Use `awardModel` to narrow the specific variant at runtime.
+ */
+type ReferralEditionSnapshot = ReferralEditionSnapshotPieSplit | ReferralEditionSnapshotRevShareCap;
 
 /**
  * The default number of referrers per leaderboard page.
@@ -1785,6 +1953,15 @@ declare function deserializeReferralProgramEditionConfigSetArray(maybeArray: unk
  */
 declare function deserializeReferralProgramEditionSummariesResponse(maybeResponse: SerializedReferralProgramEditionSummariesResponse, valueLabel?: string): ReferralProgramEditionSummariesResponse;
 
+/**
+ * Check if provided EnsIndexerPublicConfig supports the ENSAnalytics API.
+ */
+declare function hasEnsAnalyticsConfigSupport(config: EnsIndexerPublicConfig): PrerequisiteResult;
+/**
+ * Check if provided indexing status supports the ENSAnalytics API.
+ */
+declare function hasEnsAnalyticsIndexingStatusSupport(omnichainIndexingStatusId: OmnichainIndexingStatusId): PrerequisiteResult;
+
 /**
  * Serializes a {@link ReferralProgramRules} object.
  *
@@ -2128,4 +2305,4 @@ declare const SECONDS_PER_YEAR: Duration;
 declare function isValidDuration(duration: Duration): boolean;
 declare function validateDuration(duration: Duration): void;
 
-export { type AdminAction, type AdminActionDisqualification, type AdminActionType, AdminActionTypes, type AdminActionWarning, type AggregatedReferrerMetricsPieSplit, type AggregatedReferrerMetricsRevShareCap, type AwardedReferrerMetricsPieSplit, type AwardedReferrerMetricsRevShareCap, type BaseReferralProgramEditionConfig, type BaseReferralProgramEditionSummary, type BaseReferralProgramRules, type BaseReferrerLeaderboardPage, type ClientOptions, DEFAULT_ENSNODE_API_URL, ENSReferralsClient, MAX_EDITIONS_PER_REQUEST, REFERRAL_PROGRAM_EDITION_SLUG_PATTERN, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetricsPieSplit, type RankedReferrerMetricsRevShareCap, type ReferralEvent, type ReferralProgramAwardModel, ReferralProgramAwardModels, type ReferralProgramEditionConfig, type ReferralProgramEditionConfigSet, type ReferralProgramEditionSlug, type ReferralProgramEditionStatusId, ReferralProgramEditionStatuses, type ReferralProgramEditionSummariesData, type ReferralProgramEditionSummariesResponse, type ReferralProgramEditionSummariesResponseCode, ReferralProgramEditionSummariesResponseCodes, type ReferralProgramEditionSummariesResponseError, type ReferralProgramEditionSummariesResponseOk, type ReferralProgramEditionSummary, type ReferralProgramEditionSummaryPieSplit, type ReferralProgramEditionSummaryRevShareCap, type ReferralProgramEditionSummaryUnrecognized, type ReferralProgramRules, type ReferralProgramRulesPieSplit, type ReferralProgramRulesRevShareCap, type ReferralProgramRulesUnrecognized, type ReferrerEditionMetrics, type ReferrerEditionMetricsPieSplit, type ReferrerEditionMetricsRankedPieSplit, type ReferrerEditionMetricsRankedRevShareCap, type ReferrerEditionMetricsRevShareCap, type ReferrerEditionMetricsTypeId, ReferrerEditionMetricsTypeIds, type ReferrerEditionMetricsUnrankedPieSplit, type ReferrerEditionMetricsUnrankedRevShareCap, type ReferrerEditionMetricsUnrecognized, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerLeaderboardPagePieSplit, type ReferrerLeaderboardPageRequest, type ReferrerLeaderboardPageResponse, type ReferrerLeaderboardPageResponseCode, ReferrerLeaderboardPageResponseCodes, type ReferrerLeaderboardPageResponseError, type ReferrerLeaderboardPageResponseOk, type ReferrerLeaderboardPageRevShareCap, type ReferrerLeaderboardPageUnrecognized, type ReferrerLeaderboardPieSplit, type ReferrerLeaderboardRevShareCap, type ReferrerMetrics, type ReferrerMetricsEditionsData, type ReferrerMetricsEditionsRequest, type ReferrerMetricsEditionsResponse, type ReferrerMetricsEditionsResponseCode, ReferrerMetricsEditionsResponseCodes, type ReferrerMetricsEditionsResponseError, type ReferrerMetricsEditionsResponseOk, type ReferrerMetricsForComparison, type ReferrerMetricsRevShareCap, type ReferrerRank, type ReferrerScore, SECONDS_PER_YEAR, type ScoredReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsRevShareCap, type SerializedAwardedReferrerMetricsPieSplit, type SerializedAwardedReferrerMetricsRevShareCap, type SerializedReferralProgramEditionSummariesData, type SerializedReferralProgramEditionSummariesResponse, type SerializedReferralProgramEditionSummariesResponseError, type SerializedReferralProgramEditionSummariesResponseOk, type SerializedReferralProgramEditionSummary, type SerializedReferralProgramEditionSummaryPieSplit, type SerializedReferralProgramEditionSummaryRevShareCap, type SerializedReferralProgramRules, type SerializedReferralProgramRulesPieSplit, type SerializedReferralProgramRulesRevShareCap, type SerializedReferrerEditionMetrics, type SerializedReferrerEditionMetricsPieSplit, type SerializedReferrerEditionMetricsRankedPieSplit, type SerializedReferrerEditionMetricsRankedRevShareCap, type SerializedReferrerEditionMetricsRevShareCap, type SerializedReferrerEditionMetricsUnrankedPieSplit, type SerializedReferrerEditionMetricsUnrankedRevShareCap, type SerializedReferrerLeaderboardPage, type SerializedReferrerLeaderboardPagePieSplit, type SerializedReferrerLeaderboardPageResponse, type SerializedReferrerLeaderboardPageResponseError, type SerializedReferrerLeaderboardPageResponseOk, type SerializedReferrerLeaderboardPageRevShareCap, type SerializedReferrerMetricsEditionsData, type SerializedReferrerMetricsEditionsResponse, type SerializedReferrerMetricsEditionsResponseError, type SerializedReferrerMetricsEditionsResponseOk, type SerializedUnrankedReferrerMetricsPieSplit, type SerializedUnrankedReferrerMetricsRevShareCap, type UnrankedReferrerMetricsPieSplit, type UnrankedReferrerMetricsRevShareCap, buildAggregatedReferrerMetricsPieSplit, buildAggregatedReferrerMetricsRevShareCap, buildAwardedReferrerMetricsPieSplit, buildAwardedReferrerMetricsRevShareCap, buildEditionSummary, buildEditionSummaryPieSplit, buildEditionSummaryRevShareCap, buildEnsReferralUrl, buildLeaderboardPagePieSplit, buildLeaderboardPageRevShareCap, buildRankedReferrerMetricsPieSplit, buildRankedReferrerMetricsRevShareCap, buildReferralProgramEditionConfigSet, buildReferralProgramRulesPieSplit, buildReferralProgramRulesRevShareCap, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerLeaderboardPieSplit, buildReferrerLeaderboardRevShareCap, buildReferrerMetrics, buildReferrerMetricsRevShareCap, buildScoredReferrerMetricsPieSplit, buildUnrankedReferrerMetricsPieSplit, buildUnrankedReferrerMetricsRevShareCap, calcBaseReferralProgramEditionStatus, calcBaseRevenueContribution, calcReferralProgramEditionStatusPieSplit, calcReferralProgramEditionStatusRevShareCap, calcReferrerAwardPoolSharePieSplit, calcReferrerScorePieSplit, compareReferrerMetrics, deserializeReferralProgramEditionConfigSetArray, deserializeReferralProgramEditionSummariesResponse, deserializeReferrerLeaderboardPageResponse, deserializeReferrerMetricsEditionsResponse, findOverlappingEditionPair, getReferrerEditionMetrics, getReferrerLeaderboardPage, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualifiedRevShareCap, isValidDuration, isValidReferrerScore, serializeReferralProgramEditionSummariesResponse, serializeReferralProgramEditionSummary, serializeReferralProgramRules, serializeReferrerLeaderboardPageResponse, serializeReferrerMetricsEditionsResponse, sliceReferrers, sortReferrerMetrics, validateAggregatedReferrerMetricsPieSplit, validateAggregatedReferrerMetricsRevShareCap, validateAwardedReferrerMetricsPieSplit, validateAwardedReferrerMetricsRevShareCap, validateBaseReferralProgramEditionSummary, validateBaseReferralProgramRules, validateDuration, validateEditionSummaryPieSplit, validateEditionSummaryRevShareCap, validateNonNegativeInteger, validateNormalizedAddress, validateRankedReferrerMetricsPieSplit, validateRankedReferrerMetricsRevShareCap, validateReferralProgramEditionConfigSet, validateReferralProgramRulesPieSplit, validateReferralProgramRulesRevShareCap, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerMetricsRevShareCap, validateReferrerRank, validateReferrerScore, validateScoredReferrerMetricsPieSplit, validateUnixTimestamp, validateUnrankedReferrerMetricsPieSplit, validateUnrankedReferrerMetricsRevShareCap };
+export { type AdminAction, type AdminActionDisqualification, type AdminActionType, AdminActionTypes, type AdminActionWarning, type AggregatedReferrerMetricsPieSplit, type AggregatedReferrerMetricsRevShareCap, type AwardedReferrerMetricsPieSplit, type AwardedReferrerMetricsRevShareCap, type BaseReferralProgramEditionConfig, type BaseReferralProgramEditionSummary, type BaseReferralProgramRules, type BaseReferrerLeaderboardPage, type ClientOptions, DEFAULT_ENSNODE_API_URL, ENSReferralsClient, MAX_EDITIONS_PER_REQUEST, REFERRAL_PROGRAM_EDITION_SLUG_PATTERN, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetricsPieSplit, type RankedReferrerMetricsRevShareCap, type ReferralAccountingRecordRevShareCap, type ReferralEditionSnapshot, type ReferralEditionSnapshotPieSplit, type ReferralEditionSnapshotRevShareCap, type ReferralEvent, type ReferralProgramAwardModel, ReferralProgramAwardModels, type ReferralProgramEditionConfig, type ReferralProgramEditionConfigSet, type ReferralProgramEditionSlug, type ReferralProgramEditionStatusId, ReferralProgramEditionStatuses, type ReferralProgramEditionSummariesData, type ReferralProgramEditionSummariesResponse, type ReferralProgramEditionSummariesResponseCode, ReferralProgramEditionSummariesResponseCodes, type ReferralProgramEditionSummariesResponseError, type ReferralProgramEditionSummariesResponseOk, type ReferralProgramEditionSummary, type ReferralProgramEditionSummaryPieSplit, type ReferralProgramEditionSummaryRevShareCap, type ReferralProgramEditionSummaryUnrecognized, type ReferralProgramRules, type ReferralProgramRulesPieSplit, type ReferralProgramRulesRevShareCap, type ReferralProgramRulesUnrecognized, type ReferrerEditionMetrics, type ReferrerEditionMetricsPieSplit, type ReferrerEditionMetricsRankedPieSplit, type ReferrerEditionMetricsRankedRevShareCap, type ReferrerEditionMetricsRevShareCap, type ReferrerEditionMetricsTypeId, ReferrerEditionMetricsTypeIds, type ReferrerEditionMetricsUnrankedPieSplit, type ReferrerEditionMetricsUnrankedRevShareCap, type ReferrerEditionMetricsUnrecognized, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerLeaderboardPagePieSplit, type ReferrerLeaderboardPageRequest, type ReferrerLeaderboardPageResponse, type ReferrerLeaderboardPageResponseCode, ReferrerLeaderboardPageResponseCodes, type ReferrerLeaderboardPageResponseError, type ReferrerLeaderboardPageResponseOk, type ReferrerLeaderboardPageRevShareCap, type ReferrerLeaderboardPageUnrecognized, type ReferrerLeaderboardPieSplit, type ReferrerLeaderboardRevShareCap, type ReferrerMetrics, type ReferrerMetricsEditionsData, type ReferrerMetricsEditionsRequest, type ReferrerMetricsEditionsResponse, type ReferrerMetricsEditionsResponseCode, ReferrerMetricsEditionsResponseCodes, type ReferrerMetricsEditionsResponseError, type ReferrerMetricsEditionsResponseOk, type ReferrerMetricsForComparison, type ReferrerMetricsRevShareCap, type ReferrerRank, type ReferrerScore, SECONDS_PER_YEAR, type ScoredReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsRevShareCap, type SerializedAwardedReferrerMetricsPieSplit, type SerializedAwardedReferrerMetricsRevShareCap, type SerializedReferralProgramEditionSummariesData, type SerializedReferralProgramEditionSummariesResponse, type SerializedReferralProgramEditionSummariesResponseError, type SerializedReferralProgramEditionSummariesResponseOk, type SerializedReferralProgramEditionSummary, type SerializedReferralProgramEditionSummaryPieSplit, type SerializedReferralProgramEditionSummaryRevShareCap, type SerializedReferralProgramRules, type SerializedReferralProgramRulesPieSplit, type SerializedReferralProgramRulesRevShareCap, type SerializedReferrerEditionMetrics, type SerializedReferrerEditionMetricsPieSplit, type SerializedReferrerEditionMetricsRankedPieSplit, type SerializedReferrerEditionMetricsRankedRevShareCap, type SerializedReferrerEditionMetricsRevShareCap, type SerializedReferrerEditionMetricsUnrankedPieSplit, type SerializedReferrerEditionMetricsUnrankedRevShareCap, type SerializedReferrerLeaderboardPage, type SerializedReferrerLeaderboardPagePieSplit, type SerializedReferrerLeaderboardPageResponse, type SerializedReferrerLeaderboardPageResponseError, type SerializedReferrerLeaderboardPageResponseOk, type SerializedReferrerLeaderboardPageRevShareCap, type SerializedReferrerMetricsEditionsData, type SerializedReferrerMetricsEditionsResponse, type SerializedReferrerMetricsEditionsResponseError, type SerializedReferrerMetricsEditionsResponseOk, type SerializedUnrankedReferrerMetricsPieSplit, type SerializedUnrankedReferrerMetricsRevShareCap, type TentativeReferralAwardRevShareCap, type UnrankedReferrerMetricsPieSplit, type UnrankedReferrerMetricsRevShareCap, buildAggregatedReferrerMetricsPieSplit, buildAggregatedReferrerMetricsRevShareCap, buildAwardedReferrerMetricsPieSplit, buildAwardedReferrerMetricsRevShareCap, buildEditionSummary, buildEditionSummaryPieSplit, buildEditionSummaryRevShareCap, buildEnsReferralUrl, buildLeaderboardPagePieSplit, buildLeaderboardPageRevShareCap, buildRankedReferrerMetricsPieSplit, buildRankedReferrerMetricsRevShareCap, buildReferralEditionSnapshotPieSplit, buildReferralEditionSnapshotRevShareCap, buildReferralProgramEditionConfigSet, buildReferralProgramRulesPieSplit, buildReferralProgramRulesRevShareCap, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerMetrics, buildReferrerMetricsRevShareCap, buildScoredReferrerMetricsPieSplit, buildUnrankedReferrerMetricsPieSplit, buildUnrankedReferrerMetricsRevShareCap, calcBaseReferralProgramEditionStatus, calcBaseRevenueContribution, calcReferralProgramEditionStatusPieSplit, calcReferralProgramEditionStatusRevShareCap, calcReferrerAwardPoolSharePieSplit, calcReferrerScorePieSplit, compareReferrerMetrics, deserializeReferralProgramEditionConfigSetArray, deserializeReferralProgramEditionSummariesResponse, deserializeReferrerLeaderboardPageResponse, deserializeReferrerMetricsEditionsResponse, findOverlappingEditionPair, getReferrerEditionMetrics, getReferrerLeaderboardPage, hasEnsAnalyticsConfigSupport, hasEnsAnalyticsIndexingStatusSupport, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualifiedRevShareCap, isValidDuration, isValidReferrerScore, serializeReferralProgramEditionSummariesResponse, serializeReferralProgramEditionSummary, serializeReferralProgramRules, serializeReferrerLeaderboardPageResponse, serializeReferrerMetricsEditionsResponse, sliceReferrers, sortReferrerMetrics, validateAggregatedReferrerMetricsPieSplit, validateAggregatedReferrerMetricsRevShareCap, validateAwardedReferrerMetricsPieSplit, validateAwardedReferrerMetricsRevShareCap, validateBaseReferralProgramEditionSummary, validateBaseReferralProgramRules, validateDuration, validateEditionSummaryPieSplit, validateEditionSummaryRevShareCap, validateNonNegativeInteger, validateNormalizedAddress, validateRankedReferrerMetricsPieSplit, validateRankedReferrerMetricsRevShareCap, validateReferralProgramEditionConfigSet, validateReferralProgramRulesPieSplit, validateReferralProgramRulesRevShareCap, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerMetricsRevShareCap, validateReferrerRank, validateReferrerScore, validateScoredReferrerMetricsPieSplit, validateUnixTimestamp, validateUnrankedReferrerMetricsPieSplit, validateUnrankedReferrerMetricsRevShareCap };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { NormalizedAddress, UnixTimestamp, AccountId, Duration, Address } from 'enssdk';
-import { PriceUsdc, PriceEth, SerializedPriceEth, SerializedPriceUsdc } from '@ensnode/ensnode-sdk';
+import { NormalizedAddress, UnixTimestamp, AccountId, Duration, InterpretedName, Address } from 'enssdk';
+import { PriceUsdc, PriceEth, RegistrarActionType, SerializedPriceEth, SerializedPriceUsdc, EnsIndexerPublicConfig, PrerequisiteResult, OmnichainIndexingStatusId } from '@ensnode/ensnode-sdk';
+import { Hash } from 'viem';
 
 declare const validateNormalizedAddress: (address: NormalizedAddress) => void;
 
@@ -802,7 +803,22 @@ interface ReferrerLeaderboardPieSplit {
      */
     accurateAsOf: UnixTimestamp;
 }
-declare const buildReferrerLeaderboardPieSplit: (allReferrers: ReferrerMetrics[], rules: ReferralProgramRulesPieSplit, accurateAsOf: UnixTimestamp) => ReferrerLeaderboardPieSplit;
+/**
+ * A point-in-time snapshot of everything computed for a `pie-split` referral program edition.
+ */
+interface ReferralEditionSnapshotPieSplit {
+    /**
+     * Discriminant identifying this as a pie-split snapshot.
+     *
+     * @invariant Equals `leaderboard.awardModel` and `leaderboard.rules.awardModel`.
+     */
+    awardModel: typeof ReferralProgramAwardModels.PieSplit;
+    /**
+     * The {@link ReferrerLeaderboardPieSplit} computed for this edition.
+     */
+    leaderboard: ReferrerLeaderboardPieSplit;
+}
+declare const buildReferralEditionSnapshotPieSplit: (allReferrers: ReferrerMetrics[], rules: ReferralProgramRulesPieSplit, accurateAsOf: UnixTimestamp) => ReferralEditionSnapshotPieSplit;
 
 /**
  * Edition summary for a `pie-split` referral program edition.
@@ -826,6 +842,115 @@ declare const validateEditionSummaryPieSplit: (summary: ReferralProgramEditionSu
  */
 declare function buildEditionSummaryPieSplit(slug: ReferralProgramEditionSlug, displayName: string, rules: ReferralProgramRulesPieSplit, leaderboard: ReferrerLeaderboardPieSplit): ReferralProgramEditionSummaryPieSplit;
 
+/**
+ * Per-event accounting math for a single referral under a rev-share-cap edition.
+ */
+interface TentativeReferralAwardRevShareCap {
+    /**
+     * Revenue contribution in ETH from this single referral event.
+     */
+    incrementalRevenueContribution: PriceEth;
+    /**
+     * Running total of the referrer's revenue contribution in ETH, through and including this event.
+     */
+    accumulatedRevenueContribution: PriceEth;
+    /**
+     * Base revenue contribution in USDC attributable to this single referral event's duration.
+     */
+    incrementalBaseRevenueContribution: PriceUsdc;
+    /**
+     * The referrer's accumulated base revenue contribution in USDC, through and including this event.
+     */
+    accumulatedBaseRevenueContribution: PriceUsdc;
+    /**
+     * The award pool in USDC remaining.
+     *
+     * @invariant Reflects the pool state *before* this event was processed.
+     */
+    awardPoolRemaining: PriceUsdc;
+    /**
+     * `true` if and only if the referrer has an admin-disqualification action for this edition.
+     *
+     * @invariant Reflects admin disqualification only; NOT set when the referrer has simply not
+     *            yet met the minimum-base-revenue threshold.
+     */
+    disqualified: boolean;
+    /**
+     * The admin-disqualification reason string, verbatim from the admin action.
+     *
+     * @invariant Defined if and only if `disqualified === true`.
+     */
+    disqualificationReason?: string;
+    /**
+     * A copy of `rules.maxBaseRevenueShare` at the time of this event.
+     */
+    maxRevShare: number;
+    /**
+     * The effective fraction of base revenue that was awarded for this event. Derived as
+     * `incrementalTentativeAward.amount / incrementalBaseRevenueContribution.amount`.
+     * Useful for diagnosing partial-pool truncation and first-time-qualification catch-up awards.
+     *
+     * @invariant Equals `0` when `incrementalBaseRevenueContribution.amount === 0n`.
+     * @invariant `<= maxRevShare` for the already-qualified branch. May exceed `maxRevShare` on
+     *            the event that triggers first-time qualification, because accumulated uncapped
+     *            award from prior events is claimed against this event's base revenue.
+     */
+    effectiveBaseRevShare: number;
+    /**
+     * The tentative USDC award attributed to this single referral event.
+     *
+     * On the event that triggers first-time qualification, this includes the accumulated uncapped
+     * award from prior events in which the referrer had not yet qualified (capped by the remaining
+     * award pool). On subsequent events, it is the per-event uncapped award capped by the pool.
+     *
+     * @invariant `amount === 0n` when the referrer is admin-disqualified OR has not yet qualified
+     *            as of this event. Also zero when the pool is empty.
+     * @invariant `amount <= awardPoolRemaining.amount`.
+     */
+    incrementalTentativeAward: PriceUsdc;
+}
+/**
+ * A single per-event accounting record for a referral under a rev-share-cap edition.
+ */
+interface ReferralAccountingRecordRevShareCap {
+    /**
+     * The registrar-action identifier.
+     */
+    registrarActionId: string;
+    /**
+     * Block timestamp of the referral event.
+     */
+    timestamp: UnixTimestamp;
+    /**
+     * FQDN of the name the referral applies to.
+     */
+    name: InterpretedName;
+    /**
+     * Type of registrar action.
+     */
+    actionType: RegistrarActionType;
+    /**
+     * Transaction hash of the referral.
+     */
+    transactionHash: Hash;
+    /**
+     * Registrant that paid for / performed the action.
+     */
+    registrant: Address;
+    /**
+     * Referrer that received credit.
+     */
+    referrer: NormalizedAddress;
+    /**
+     * Incremental duration (seconds) contributed by this referral.
+     */
+    incrementalDuration: Duration;
+    /**
+     * Per-event accounting math from the rev-share-cap race.
+     */
+    tentativeAward: TentativeReferralAwardRevShareCap;
+}
+
 /**
  * Extends {@link ReferrerMetrics} with computed base revenue contribution.
  */
@@ -997,6 +1122,22 @@ interface ReferralEvent {
      * Revenue contribution in ETH from this single referral event.
      */
     incrementalRevenueContribution: PriceEth;
+    /**
+     * FQDN of the name the referral applies to.
+     */
+    name: InterpretedName;
+    /**
+     * Type of registrar action.
+     */
+    actionType: RegistrarActionType;
+    /**
+     * Transaction hash of the onchain registrar action that produced this referral.
+     */
+    transactionHash: Hash;
+    /**
+     * Ethereum address of the registrant that paid for / performed the action.
+     */
+    registrant: Address;
 }
 
 /**
@@ -1037,7 +1178,28 @@ interface ReferrerLeaderboardRevShareCap {
     accurateAsOf: UnixTimestamp;
 }
 /**
- * Builds a {@link ReferrerLeaderboardRevShareCap} using a sequential "first-come, first-served"
+ * A point-in-time snapshot of everything computed for a `rev-share-cap` referral program edition.
+ */
+interface ReferralEditionSnapshotRevShareCap {
+    /**
+     * Discriminant identifying this as a rev-share-cap snapshot.
+     *
+     * @invariant Equals `leaderboard.awardModel` and `leaderboard.rules.awardModel`.
+     */
+    awardModel: typeof ReferralProgramAwardModels.RevShareCap;
+    /**
+     * The {@link ReferrerLeaderboardRevShareCap} computed from `accountingRecords`.
+     */
+    leaderboard: ReferrerLeaderboardRevShareCap;
+    /**
+     * Per-event accounting trace.
+     *
+     * @invariant One entry per processed onchain event, in chronological order.
+     */
+    accountingRecords: ReferralAccountingRecordRevShareCap[];
+}
+/**
+ * Builds a {@link ReferralEditionSnapshotRevShareCap} using a sequential "first-come, first-served"
  * race algorithm over individual referral events.
  *
  * Events are processed in chronological order. When a referrer first crosses the qualification
@@ -1049,7 +1211,7 @@ interface ReferrerLeaderboardRevShareCap {
  * @param rules - The {@link ReferralProgramRulesRevShareCap} defining the program parameters.
  * @param accurateAsOf - Timestamp indicating data freshness.
  */
-declare const buildReferrerLeaderboardRevShareCap: (events: ReferralEvent[], rules: ReferralProgramRulesRevShareCap, accurateAsOf: UnixTimestamp) => ReferrerLeaderboardRevShareCap;
+declare const buildReferralEditionSnapshotRevShareCap: (events: ReferralEvent[], rules: ReferralProgramRulesRevShareCap, accurateAsOf: UnixTimestamp) => ReferralEditionSnapshotRevShareCap;
 
 /**
  * Represents a leaderboard for any number of referrers.
@@ -1057,6 +1219,12 @@ declare const buildReferrerLeaderboardRevShareCap: (events: ReferralEvent[], rul
  * Use `awardModel` to narrow the specific variant at runtime.
  */
 type ReferrerLeaderboard = ReferrerLeaderboardPieSplit | ReferrerLeaderboardRevShareCap;
+/**
+ * A point-in-time snapshot of everything computed for a referral program edition.
+ *
+ * Use `awardModel` to narrow the specific variant at runtime.
+ */
+type ReferralEditionSnapshot = ReferralEditionSnapshotPieSplit | ReferralEditionSnapshotRevShareCap;
 
 /**
  * The default number of referrers per leaderboard page.
@@ -1785,6 +1953,15 @@ declare function deserializeReferralProgramEditionConfigSetArray(maybeArray: unk
  */
 declare function deserializeReferralProgramEditionSummariesResponse(maybeResponse: SerializedReferralProgramEditionSummariesResponse, valueLabel?: string): ReferralProgramEditionSummariesResponse;
 
+/**
+ * Check if provided EnsIndexerPublicConfig supports the ENSAnalytics API.
+ */
+declare function hasEnsAnalyticsConfigSupport(config: EnsIndexerPublicConfig): PrerequisiteResult;
+/**
+ * Check if provided indexing status supports the ENSAnalytics API.
+ */
+declare function hasEnsAnalyticsIndexingStatusSupport(omnichainIndexingStatusId: OmnichainIndexingStatusId): PrerequisiteResult;
+
 /**
  * Serializes a {@link ReferralProgramRules} object.
  *
@@ -2128,4 +2305,4 @@ declare const SECONDS_PER_YEAR: Duration;
 declare function isValidDuration(duration: Duration): boolean;
 declare function validateDuration(duration: Duration): void;
 
-export { type AdminAction, type AdminActionDisqualification, type AdminActionType, AdminActionTypes, type AdminActionWarning, type AggregatedReferrerMetricsPieSplit, type AggregatedReferrerMetricsRevShareCap, type AwardedReferrerMetricsPieSplit, type AwardedReferrerMetricsRevShareCap, type BaseReferralProgramEditionConfig, type BaseReferralProgramEditionSummary, type BaseReferralProgramRules, type BaseReferrerLeaderboardPage, type ClientOptions, DEFAULT_ENSNODE_API_URL, ENSReferralsClient, MAX_EDITIONS_PER_REQUEST, REFERRAL_PROGRAM_EDITION_SLUG_PATTERN, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetricsPieSplit, type RankedReferrerMetricsRevShareCap, type ReferralEvent, type ReferralProgramAwardModel, ReferralProgramAwardModels, type ReferralProgramEditionConfig, type ReferralProgramEditionConfigSet, type ReferralProgramEditionSlug, type ReferralProgramEditionStatusId, ReferralProgramEditionStatuses, type ReferralProgramEditionSummariesData, type ReferralProgramEditionSummariesResponse, type ReferralProgramEditionSummariesResponseCode, ReferralProgramEditionSummariesResponseCodes, type ReferralProgramEditionSummariesResponseError, type ReferralProgramEditionSummariesResponseOk, type ReferralProgramEditionSummary, type ReferralProgramEditionSummaryPieSplit, type ReferralProgramEditionSummaryRevShareCap, type ReferralProgramEditionSummaryUnrecognized, type ReferralProgramRules, type ReferralProgramRulesPieSplit, type ReferralProgramRulesRevShareCap, type ReferralProgramRulesUnrecognized, type ReferrerEditionMetrics, type ReferrerEditionMetricsPieSplit, type ReferrerEditionMetricsRankedPieSplit, type ReferrerEditionMetricsRankedRevShareCap, type ReferrerEditionMetricsRevShareCap, type ReferrerEditionMetricsTypeId, ReferrerEditionMetricsTypeIds, type ReferrerEditionMetricsUnrankedPieSplit, type ReferrerEditionMetricsUnrankedRevShareCap, type ReferrerEditionMetricsUnrecognized, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerLeaderboardPagePieSplit, type ReferrerLeaderboardPageRequest, type ReferrerLeaderboardPageResponse, type ReferrerLeaderboardPageResponseCode, ReferrerLeaderboardPageResponseCodes, type ReferrerLeaderboardPageResponseError, type ReferrerLeaderboardPageResponseOk, type ReferrerLeaderboardPageRevShareCap, type ReferrerLeaderboardPageUnrecognized, type ReferrerLeaderboardPieSplit, type ReferrerLeaderboardRevShareCap, type ReferrerMetrics, type ReferrerMetricsEditionsData, type ReferrerMetricsEditionsRequest, type ReferrerMetricsEditionsResponse, type ReferrerMetricsEditionsResponseCode, ReferrerMetricsEditionsResponseCodes, type ReferrerMetricsEditionsResponseError, type ReferrerMetricsEditionsResponseOk, type ReferrerMetricsForComparison, type ReferrerMetricsRevShareCap, type ReferrerRank, type ReferrerScore, SECONDS_PER_YEAR, type ScoredReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsRevShareCap, type SerializedAwardedReferrerMetricsPieSplit, type SerializedAwardedReferrerMetricsRevShareCap, type SerializedReferralProgramEditionSummariesData, type SerializedReferralProgramEditionSummariesResponse, type SerializedReferralProgramEditionSummariesResponseError, type SerializedReferralProgramEditionSummariesResponseOk, type SerializedReferralProgramEditionSummary, type SerializedReferralProgramEditionSummaryPieSplit, type SerializedReferralProgramEditionSummaryRevShareCap, type SerializedReferralProgramRules, type SerializedReferralProgramRulesPieSplit, type SerializedReferralProgramRulesRevShareCap, type SerializedReferrerEditionMetrics, type SerializedReferrerEditionMetricsPieSplit, type SerializedReferrerEditionMetricsRankedPieSplit, type SerializedReferrerEditionMetricsRankedRevShareCap, type SerializedReferrerEditionMetricsRevShareCap, type SerializedReferrerEditionMetricsUnrankedPieSplit, type SerializedReferrerEditionMetricsUnrankedRevShareCap, type SerializedReferrerLeaderboardPage, type SerializedReferrerLeaderboardPagePieSplit, type SerializedReferrerLeaderboardPageResponse, type SerializedReferrerLeaderboardPageResponseError, type SerializedReferrerLeaderboardPageResponseOk, type SerializedReferrerLeaderboardPageRevShareCap, type SerializedReferrerMetricsEditionsData, type SerializedReferrerMetricsEditionsResponse, type SerializedReferrerMetricsEditionsResponseError, type SerializedReferrerMetricsEditionsResponseOk, type SerializedUnrankedReferrerMetricsPieSplit, type SerializedUnrankedReferrerMetricsRevShareCap, type UnrankedReferrerMetricsPieSplit, type UnrankedReferrerMetricsRevShareCap, buildAggregatedReferrerMetricsPieSplit, buildAggregatedReferrerMetricsRevShareCap, buildAwardedReferrerMetricsPieSplit, buildAwardedReferrerMetricsRevShareCap, buildEditionSummary, buildEditionSummaryPieSplit, buildEditionSummaryRevShareCap, buildEnsReferralUrl, buildLeaderboardPagePieSplit, buildLeaderboardPageRevShareCap, buildRankedReferrerMetricsPieSplit, buildRankedReferrerMetricsRevShareCap, buildReferralProgramEditionConfigSet, buildReferralProgramRulesPieSplit, buildReferralProgramRulesRevShareCap, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerLeaderboardPieSplit, buildReferrerLeaderboardRevShareCap, buildReferrerMetrics, buildReferrerMetricsRevShareCap, buildScoredReferrerMetricsPieSplit, buildUnrankedReferrerMetricsPieSplit, buildUnrankedReferrerMetricsRevShareCap, calcBaseReferralProgramEditionStatus, calcBaseRevenueContribution, calcReferralProgramEditionStatusPieSplit, calcReferralProgramEditionStatusRevShareCap, calcReferrerAwardPoolSharePieSplit, calcReferrerScorePieSplit, compareReferrerMetrics, deserializeReferralProgramEditionConfigSetArray, deserializeReferralProgramEditionSummariesResponse, deserializeReferrerLeaderboardPageResponse, deserializeReferrerMetricsEditionsResponse, findOverlappingEditionPair, getReferrerEditionMetrics, getReferrerLeaderboardPage, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualifiedRevShareCap, isValidDuration, isValidReferrerScore, serializeReferralProgramEditionSummariesResponse, serializeReferralProgramEditionSummary, serializeReferralProgramRules, serializeReferrerLeaderboardPageResponse, serializeReferrerMetricsEditionsResponse, sliceReferrers, sortReferrerMetrics, validateAggregatedReferrerMetricsPieSplit, validateAggregatedReferrerMetricsRevShareCap, validateAwardedReferrerMetricsPieSplit, validateAwardedReferrerMetricsRevShareCap, validateBaseReferralProgramEditionSummary, validateBaseReferralProgramRules, validateDuration, validateEditionSummaryPieSplit, validateEditionSummaryRevShareCap, validateNonNegativeInteger, validateNormalizedAddress, validateRankedReferrerMetricsPieSplit, validateRankedReferrerMetricsRevShareCap, validateReferralProgramEditionConfigSet, validateReferralProgramRulesPieSplit, validateReferralProgramRulesRevShareCap, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerMetricsRevShareCap, validateReferrerRank, validateReferrerScore, validateScoredReferrerMetricsPieSplit, validateUnixTimestamp, validateUnrankedReferrerMetricsPieSplit, validateUnrankedReferrerMetricsRevShareCap };
+export { type AdminAction, type AdminActionDisqualification, type AdminActionType, AdminActionTypes, type AdminActionWarning, type AggregatedReferrerMetricsPieSplit, type AggregatedReferrerMetricsRevShareCap, type AwardedReferrerMetricsPieSplit, type AwardedReferrerMetricsRevShareCap, type BaseReferralProgramEditionConfig, type BaseReferralProgramEditionSummary, type BaseReferralProgramRules, type BaseReferrerLeaderboardPage, type ClientOptions, DEFAULT_ENSNODE_API_URL, ENSReferralsClient, MAX_EDITIONS_PER_REQUEST, REFERRAL_PROGRAM_EDITION_SLUG_PATTERN, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetricsPieSplit, type RankedReferrerMetricsRevShareCap, type ReferralAccountingRecordRevShareCap, type ReferralEditionSnapshot, type ReferralEditionSnapshotPieSplit, type ReferralEditionSnapshotRevShareCap, type ReferralEvent, type ReferralProgramAwardModel, ReferralProgramAwardModels, type ReferralProgramEditionConfig, type ReferralProgramEditionConfigSet, type ReferralProgramEditionSlug, type ReferralProgramEditionStatusId, ReferralProgramEditionStatuses, type ReferralProgramEditionSummariesData, type ReferralProgramEditionSummariesResponse, type ReferralProgramEditionSummariesResponseCode, ReferralProgramEditionSummariesResponseCodes, type ReferralProgramEditionSummariesResponseError, type ReferralProgramEditionSummariesResponseOk, type ReferralProgramEditionSummary, type ReferralProgramEditionSummaryPieSplit, type ReferralProgramEditionSummaryRevShareCap, type ReferralProgramEditionSummaryUnrecognized, type ReferralProgramRules, type ReferralProgramRulesPieSplit, type ReferralProgramRulesRevShareCap, type ReferralProgramRulesUnrecognized, type ReferrerEditionMetrics, type ReferrerEditionMetricsPieSplit, type ReferrerEditionMetricsRankedPieSplit, type ReferrerEditionMetricsRankedRevShareCap, type ReferrerEditionMetricsRevShareCap, type ReferrerEditionMetricsTypeId, ReferrerEditionMetricsTypeIds, type ReferrerEditionMetricsUnrankedPieSplit, type ReferrerEditionMetricsUnrankedRevShareCap, type ReferrerEditionMetricsUnrecognized, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerLeaderboardPagePieSplit, type ReferrerLeaderboardPageRequest, type ReferrerLeaderboardPageResponse, type ReferrerLeaderboardPageResponseCode, ReferrerLeaderboardPageResponseCodes, type ReferrerLeaderboardPageResponseError, type ReferrerLeaderboardPageResponseOk, type ReferrerLeaderboardPageRevShareCap, type ReferrerLeaderboardPageUnrecognized, type ReferrerLeaderboardPieSplit, type ReferrerLeaderboardRevShareCap, type ReferrerMetrics, type ReferrerMetricsEditionsData, type ReferrerMetricsEditionsRequest, type ReferrerMetricsEditionsResponse, type ReferrerMetricsEditionsResponseCode, ReferrerMetricsEditionsResponseCodes, type ReferrerMetricsEditionsResponseError, type ReferrerMetricsEditionsResponseOk, type ReferrerMetricsForComparison, type ReferrerMetricsRevShareCap, type ReferrerRank, type ReferrerScore, SECONDS_PER_YEAR, type ScoredReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsPieSplit, type SerializedAggregatedReferrerMetricsRevShareCap, type SerializedAwardedReferrerMetricsPieSplit, type SerializedAwardedReferrerMetricsRevShareCap, type SerializedReferralProgramEditionSummariesData, type SerializedReferralProgramEditionSummariesResponse, type SerializedReferralProgramEditionSummariesResponseError, type SerializedReferralProgramEditionSummariesResponseOk, type SerializedReferralProgramEditionSummary, type SerializedReferralProgramEditionSummaryPieSplit, type SerializedReferralProgramEditionSummaryRevShareCap, type SerializedReferralProgramRules, type SerializedReferralProgramRulesPieSplit, type SerializedReferralProgramRulesRevShareCap, type SerializedReferrerEditionMetrics, type SerializedReferrerEditionMetricsPieSplit, type SerializedReferrerEditionMetricsRankedPieSplit, type SerializedReferrerEditionMetricsRankedRevShareCap, type SerializedReferrerEditionMetricsRevShareCap, type SerializedReferrerEditionMetricsUnrankedPieSplit, type SerializedReferrerEditionMetricsUnrankedRevShareCap, type SerializedReferrerLeaderboardPage, type SerializedReferrerLeaderboardPagePieSplit, type SerializedReferrerLeaderboardPageResponse, type SerializedReferrerLeaderboardPageResponseError, type SerializedReferrerLeaderboardPageResponseOk, type SerializedReferrerLeaderboardPageRevShareCap, type SerializedReferrerMetricsEditionsData, type SerializedReferrerMetricsEditionsResponse, type SerializedReferrerMetricsEditionsResponseError, type SerializedReferrerMetricsEditionsResponseOk, type SerializedUnrankedReferrerMetricsPieSplit, type SerializedUnrankedReferrerMetricsRevShareCap, type TentativeReferralAwardRevShareCap, type UnrankedReferrerMetricsPieSplit, type UnrankedReferrerMetricsRevShareCap, buildAggregatedReferrerMetricsPieSplit, buildAggregatedReferrerMetricsRevShareCap, buildAwardedReferrerMetricsPieSplit, buildAwardedReferrerMetricsRevShareCap, buildEditionSummary, buildEditionSummaryPieSplit, buildEditionSummaryRevShareCap, buildEnsReferralUrl, buildLeaderboardPagePieSplit, buildLeaderboardPageRevShareCap, buildRankedReferrerMetricsPieSplit, buildRankedReferrerMetricsRevShareCap, buildReferralEditionSnapshotPieSplit, buildReferralEditionSnapshotRevShareCap, buildReferralProgramEditionConfigSet, buildReferralProgramRulesPieSplit, buildReferralProgramRulesRevShareCap, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerMetrics, buildReferrerMetricsRevShareCap, buildScoredReferrerMetricsPieSplit, buildUnrankedReferrerMetricsPieSplit, buildUnrankedReferrerMetricsRevShareCap, calcBaseReferralProgramEditionStatus, calcBaseRevenueContribution, calcReferralProgramEditionStatusPieSplit, calcReferralProgramEditionStatusRevShareCap, calcReferrerAwardPoolSharePieSplit, calcReferrerScorePieSplit, compareReferrerMetrics, deserializeReferralProgramEditionConfigSetArray, deserializeReferralProgramEditionSummariesResponse, deserializeReferrerLeaderboardPageResponse, deserializeReferrerMetricsEditionsResponse, findOverlappingEditionPair, getReferrerEditionMetrics, getReferrerLeaderboardPage, hasEnsAnalyticsConfigSupport, hasEnsAnalyticsIndexingStatusSupport, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualifiedRevShareCap, isValidDuration, isValidReferrerScore, serializeReferralProgramEditionSummariesResponse, serializeReferralProgramEditionSummary, serializeReferralProgramRules, serializeReferrerLeaderboardPageResponse, serializeReferrerMetricsEditionsResponse, sliceReferrers, sortReferrerMetrics, validateAggregatedReferrerMetricsPieSplit, validateAggregatedReferrerMetricsRevShareCap, validateAwardedReferrerMetricsPieSplit, validateAwardedReferrerMetricsRevShareCap, validateBaseReferralProgramEditionSummary, validateBaseReferralProgramRules, validateDuration, validateEditionSummaryPieSplit, validateEditionSummaryRevShareCap, validateNonNegativeInteger, validateNormalizedAddress, validateRankedReferrerMetricsPieSplit, validateRankedReferrerMetricsRevShareCap, validateReferralProgramEditionConfigSet, validateReferralProgramRulesPieSplit, validateReferralProgramRulesRevShareCap, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerMetricsRevShareCap, validateReferrerRank, validateReferrerScore, validateScoredReferrerMetricsPieSplit, validateUnixTimestamp, validateUnrankedReferrerMetricsPieSplit, validateUnrankedReferrerMetricsRevShareCap };