@namehash/ens-referrals 1.11.0 → 1.12.0

package/dist/index.js

@@ -490,6 +490,34 @@ var makeAccountIdSchema = (valueLabel = "AccountId") => z.strictObject({
   address: makeNormalizedAddressSchema(`${valueLabel} address`)
 });
 
+// ../ensnode-sdk/src/indexing-status/omnichain-indexing-status-snapshot.ts
+var OmnichainIndexingStatusIds = {
+  /**
+   * Represents that omnichain indexing is not ready to begin yet because
+   * ENSIndexer is in its initialization phase and the data to build a "true"
+   * {@link OmnichainIndexingStatusSnapshot} is still being loaded.
+   */
+  Unstarted: "omnichain-unstarted",
+  /**
+   * Represents that omnichain indexing is in an overall "backfill" status because
+   * - At least one indexed chain has a `chainStatus` of
+   *   {@link ChainIndexingStatusIds.Backfill}; and
+   * - No indexed chain has a `chainStatus` of {@link ChainIndexingStatusIds.Following}.
+   */
+  Backfill: "omnichain-backfill",
+  /**
+   * Represents that omnichain indexing is in an overall "following" status because
+   * at least one indexed chain has a `chainStatus` of
+   * {@link ChainIndexingStatusIds.Following}.
+   */
+  Following: "omnichain-following",
+  /**
+   * Represents that omnichain indexing has completed because all indexed chains have
+   * a `chainStatus` of {@link ChainIndexingStatusIds.Completed}.
+   */
+  Completed: "omnichain-completed"
+};
+
 // ../ensnode-sdk/src/shared/serialize.ts
 function serializePrice(price) {
   return {
@@ -1580,6 +1608,36 @@ ${prettifyError(parsed.error)}
   return parsed.data;
 }
 
+// src/api/prerequisites.ts
+var ensAnalyticsRequiredPlugins = [
+  "subgraph" /* Subgraph */,
+  "basenames" /* Basenames */,
+  "lineanames" /* Lineanames */,
+  "registrars" /* Registrars */
+];
+function hasEnsAnalyticsConfigSupport(config) {
+  const supported = ensAnalyticsRequiredPlugins.every((plugin) => config.plugins.includes(plugin));
+  if (supported) return { supported };
+  return {
+    supported: false,
+    reason: `The ENSAnalytics API requires all of the following plugins to be activated in the connected ENSNode's Config: ${ensAnalyticsRequiredPlugins.map((plugin) => `'${plugin}'`).join(", ")}.`
+  };
+}
+var ensAnalyticsSupportedIndexingStatusIds = [
+  OmnichainIndexingStatusIds.Completed,
+  OmnichainIndexingStatusIds.Following
+];
+function hasEnsAnalyticsIndexingStatusSupport(omnichainIndexingStatusId) {
+  const supported = ensAnalyticsSupportedIndexingStatusIds.some(
+    (supportedIndexingStatusId) => supportedIndexingStatusId === omnichainIndexingStatusId
+  );
+  if (supported) return { supported };
+  return {
+    supported: false,
+    reason: `The ENSAnalytics API requires the connected ENSNode's Indexing Status to be one of the following: ${ensAnalyticsSupportedIndexingStatusIds.join(", ")}.`
+  };
+}
+
 // src/award-models/pie-split/api/serialize.ts
 function serializeReferralProgramRulesPieSplit(rules) {
   return {
@@ -2289,7 +2347,7 @@ var buildUnrankedReferrerMetricsPieSplit = (referrer) => {
 };
 
 // src/award-models/pie-split/leaderboard.ts
-var buildReferrerLeaderboardPieSplit = (allReferrers, rules, accurateAsOf) => {
+var buildReferralEditionSnapshotPieSplit = (allReferrers, rules, accurateAsOf) => {
   assertLeaderboardInputs(allReferrers, rules, accurateAsOf);
   const sortedReferrers = sortReferrerMetrics(allReferrers);
   const scoredReferrers = sortedReferrers.map((r) => buildScoredReferrerMetricsPieSplit(r));
@@ -2301,7 +2359,14 @@ var buildReferrerLeaderboardPieSplit = (allReferrers, rules, accurateAsOf) => {
     (r) => buildAwardedReferrerMetricsPieSplit(r, aggregatedMetrics, rules)
   );
   const referrers = new Map(awardedReferrers.map((r) => [r.referrer, r]));
-  return { awardModel: rules.awardModel, rules, aggregatedMetrics, referrers, accurateAsOf };
+  const leaderboard = {
+    awardModel: rules.awardModel,
+    rules,
+    aggregatedMetrics,
+    referrers,
+    accurateAsOf
+  };
+  return { awardModel: rules.awardModel, leaderboard };
 };
 
 // src/award-models/pie-split/leaderboard-page.ts
@@ -2579,9 +2644,14 @@ function sortReferralEvents(events) {
 }
 
 // src/award-models/rev-share-cap/leaderboard.ts
-var buildReferrerLeaderboardRevShareCap = (events, rules, accurateAsOf) => {
+var buildReferralEditionSnapshotRevShareCap = (events, rules, accurateAsOf) => {
   const sortedEvents = sortReferralEvents(events);
+  const adminActionByReferrer = /* @__PURE__ */ new Map();
+  for (const action of rules.adminActions) {
+    adminActionByReferrer.set(action.referrer, action);
+  }
   const referrerStates = /* @__PURE__ */ new Map();
+  const accountingRecords = [];
   let awardPoolRemaining = rules.awardPool;
   for (const event of sortedEvents) {
     const referrerId = event.referrer;
@@ -2602,27 +2672,65 @@ var buildReferrerLeaderboardRevShareCap = (events, rules, accurateAsOf) => {
       referrerState.totalRevenueContribution,
       event.incrementalRevenueContribution
     );
-    const totalBaseRevenue = calcBaseRevenueContribution(
+    const hasQualifiedBefore = referrerState.hasQualified;
+    const awardPoolRemainingBefore = awardPoolRemaining;
+    const adminAction = adminActionByReferrer.get(referrerId);
+    const adminDisqualification = adminAction?.actionType === AdminActionTypes.Disqualification ? adminAction : null;
+    const accumulatedBaseRevenueContribution = calcBaseRevenueContribution(
       rules,
       referrerState.totalIncrementalDuration
     );
-    const isNowQualified = isReferrerQualifiedRevShareCap(referrerId, totalBaseRevenue, rules);
-    if (isNowQualified && !referrerState.hasQualified) {
-      const accumulatedUncappedAward = scalePrice(totalBaseRevenue, rules.maxBaseRevenueShare);
-      const incrementalCappedAward = minPrice(accumulatedUncappedAward, awardPoolRemaining);
-      referrerState.cappedAward = addPrices(referrerState.cappedAward, incrementalCappedAward);
-      awardPoolRemaining = subtractPrice(awardPoolRemaining, incrementalCappedAward);
+    const incrementalBaseRevenueContribution = calcBaseRevenueContribution(
+      rules,
+      event.incrementalDuration
+    );
+    const isNowQualified = isReferrerQualifiedRevShareCap(
+      referrerId,
+      accumulatedBaseRevenueContribution,
+      rules
+    );
+    let incrementalTentativeAward = priceUsdc(0n);
+    if (isNowQualified && !hasQualifiedBefore) {
+      const accumulatedUncappedAward = scalePrice(
+        accumulatedBaseRevenueContribution,
+        rules.maxBaseRevenueShare
+      );
+      incrementalTentativeAward = minPrice(accumulatedUncappedAward, awardPoolRemainingBefore);
       referrerState.hasQualified = true;
-    } else if (referrerState.hasQualified) {
-      const incrementalBaseRevenue = calcBaseRevenueContribution(rules, event.incrementalDuration);
+    } else if (hasQualifiedBefore) {
       const incrementalUncappedAward = scalePrice(
-        incrementalBaseRevenue,
+        incrementalBaseRevenueContribution,
         rules.maxBaseRevenueShare
       );
-      const incrementalCappedAward = minPrice(incrementalUncappedAward, awardPoolRemaining);
-      referrerState.cappedAward = addPrices(referrerState.cappedAward, incrementalCappedAward);
-      awardPoolRemaining = subtractPrice(awardPoolRemaining, incrementalCappedAward);
-    }
+      incrementalTentativeAward = minPrice(incrementalUncappedAward, awardPoolRemainingBefore);
+    }
+    referrerState.cappedAward = addPrices(referrerState.cappedAward, incrementalTentativeAward);
+    awardPoolRemaining = subtractPrice(awardPoolRemaining, incrementalTentativeAward);
+    const tentativeAward = {
+      incrementalRevenueContribution: event.incrementalRevenueContribution,
+      accumulatedRevenueContribution: referrerState.totalRevenueContribution,
+      incrementalBaseRevenueContribution,
+      accumulatedBaseRevenueContribution,
+      awardPoolRemaining: awardPoolRemainingBefore,
+      disqualified: adminDisqualification !== null,
+      ...adminDisqualification !== null && {
+        disqualificationReason: adminDisqualification.reason
+      },
+      maxRevShare: rules.maxBaseRevenueShare,
+      effectiveBaseRevShare: incrementalBaseRevenueContribution.amount === 0n ? 0 : Number(incrementalTentativeAward.amount) / Number(incrementalBaseRevenueContribution.amount),
+      incrementalTentativeAward
+    };
+    accountingRecords.push({
+      registrarActionId: event.id,
+      timestamp: event.timestamp,
+      name: event.name,
+      actionType: event.actionType,
+      transactionHash: event.transactionHash,
+      registrant: event.registrant,
+      referrer: referrerId,
+      incrementalDuration: event.incrementalDuration,
+      tentativeAward
+    });
   }
   const sortedEntries = [...referrerStates.entries()].sort(
     ([referrerIdA, referrerStateA], [referrerIdB, referrerStateB]) => {
@@ -2668,7 +2776,17 @@ var buildReferrerLeaderboardRevShareCap = (events, rules, accurateAsOf) => {
     awardPoolRemaining
   );
   const referrers = new Map(awardedReferrers.map((r) => [r.referrer, r]));
-  return { awardModel: rules.awardModel, rules, aggregatedMetrics, referrers, accurateAsOf };
+  return {
+    awardModel: rules.awardModel,
+    leaderboard: {
+      awardModel: rules.awardModel,
+      rules,
+      aggregatedMetrics,
+      referrers,
+      accurateAsOf
+    },
+    accountingRecords
+  };
 };
 
 // src/award-models/rev-share-cap/leaderboard-page.ts
@@ -3117,13 +3235,13 @@ export {
   buildLeaderboardPageRevShareCap,
   buildRankedReferrerMetricsPieSplit,
   buildRankedReferrerMetricsRevShareCap,
+  buildReferralEditionSnapshotPieSplit,
+  buildReferralEditionSnapshotRevShareCap,
   buildReferralProgramEditionConfigSet,
   buildReferralProgramRulesPieSplit,
   buildReferralProgramRulesRevShareCap,
   buildReferrerLeaderboardPageContext,
   buildReferrerLeaderboardPageParams,
-  buildReferrerLeaderboardPieSplit,
-  buildReferrerLeaderboardRevShareCap,
   buildReferrerMetrics,
   buildReferrerMetricsRevShareCap,
   buildScoredReferrerMetricsPieSplit,
@@ -3143,6 +3261,8 @@ export {
   findOverlappingEditionPair,
   getReferrerEditionMetrics,
   getReferrerLeaderboardPage,
+  hasEnsAnalyticsConfigSupport,
+  hasEnsAnalyticsIndexingStatusSupport,
   isFiniteNonNegativeNumber,
   isInteger,
   isNonNegativeInteger,