@namehash/ens-referrals 1.9.0 → 1.10.0

package/README.md

@@ -2,8 +2,6 @@
 
 Utilities for working with ENS Referrals data. This package is intended for developers who want to build referral dashboards, stats pages, or other integrations on top of ENS Referrals APIs.
 
-The main entry point today is [`v1`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/v1), which includes the current client and response types for the latest ENS Referrals program format.
-
 ## Installation
 
 ```bash
@@ -12,19 +10,14 @@ npm install @namehash/ens-referrals viem
 
 ## Quick Start
 
-`v1` is the recommended version for new integrations.
-
-- [`v1`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/v1) is the actively supported version that reflects the current ENS Referrals program rules and awards.
-- The root [`@namehash/ens-referrals`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/client.ts) import is deprecated and is planned to be removed soon.
-
 ### Set up `ENSReferralsClient`
 
 `ENSReferralsClient` is the main way to read referral data from ENSNode.
 
 ```typescript
-import { ENSReferralsClient } from "@namehash/ens-referrals/v1";
+import { ENSReferralsClient } from "@namehash/ens-referrals";
 
-// Create a client with the default ENSNode API URL
+// Create a client with the default ENSNode URL
 const client = new ENSReferralsClient();
 ```
 
@@ -36,7 +29,7 @@ const client = new ENSReferralsClient({
 });
 ```
 
-## Use ENS Referrals API (`v1`)
+## Use ENS Referrals API
 
 ### Get all referral program editions → `getEditionSummaries()`
 
@@ -56,7 +49,7 @@ if (response.responseCode === ReferralProgramEditionSummariesResponseCodes.Ok) {
 }
 ```
 
-More examples are available in [`packages/ens-referrals/src/v1/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/v1/client.ts).
+More examples are available in [`packages/ens-referrals/src/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/client.ts).
 
 ### Get a referrer leaderboard page → `getReferrerLeaderboardPage()`
 
@@ -96,20 +89,20 @@ if (response.responseCode === ReferrerLeaderboardPageResponseCodes.Ok) {
       );
     }
 
-    if (leaderboardPage.awardModel === ReferralProgramAwardModels.RevShareLimit) {
+    if (leaderboardPage.awardModel === ReferralProgramAwardModels.RevShareCap) {
       console.log(
-        `Min Qualified Revenue Contribution: ${leaderboardPage.rules.minQualifiedRevenueContribution}`,
+        `Min Base Revenue Contribution: ${leaderboardPage.rules.minBaseRevenueContribution}`,
       );
-      console.log(`Qualified Revenue Share: ${leaderboardPage.rules.qualifiedRevenueShare}`);
+      console.log(`Max Base Revenue Share: ${leaderboardPage.rules.maxBaseRevenueShare}`);
       console.log(
-        `Tentative award for the best referrer: ${firstReferrer !== null ? firstReferrer.awardPoolApproxValue : noReferrersFallback}`,
+        `Tentative award for the top ranked referrer: ${firstReferrer !== null ? firstReferrer.cappedAward : noReferrersFallback}`,
       );
     }
   }
 }
 ```
 
-More examples are available in [`packages/ens-referrals/src/v1/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/v1/client.ts).
+More examples are available in [`packages/ens-referrals/src/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/client.ts).
 
 ### Get a referrer's metrics across editions → `getReferrerMetricsEditions()`
 
@@ -118,7 +111,7 @@ Returns referrer metrics for a specified referrer across one or more editions.
 ```typescript
 const response = await client.getReferrerMetricsEditions({
   referrer: "0x1234567890123456789012345678901234567890",
-  editions: ["2025-12", "2026-01"],
+  editions: ["2025-12", "2026-04"],
 });
 
 if (response.responseCode === ReferrerMetricsEditionsResponseCodes.Ok) {
@@ -142,25 +135,30 @@ if (response.responseCode === ReferrerMetricsEditionsResponseCodes.Ok) {
       console.log(`Referrer's Award Pool Share: ${detail.referrer.awardPoolShare * 100}%`);
     }
 
-    if (detail.awardModel === ReferralProgramAwardModels.RevShareLimit) {
+    if (detail.awardModel === ReferralProgramAwardModels.RevShareCap) {
       console.log(
         `Referrer's total base revenue contribution: ${detail.referrer.totalBaseRevenueContribution}`,
       );
-      console.log(`Referrer's standard award value: ${detail.referrer.standardAwardValue}`);
+      console.log(`Referrer's uncapped award value: ${detail.referrer.uncappedAward}`);
     }
   }
 }
 ```
 
-More examples are available in [`packages/ens-referrals/src/v1/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/v1/client.ts).
+More examples are available in [`packages/ens-referrals/src/client.ts`](https://github.com/namehash/ensnode/tree/main/packages/ens-referrals/src/client.ts).
+
+## See how current Referral Program Editions are configured
+
+Check out [`production-editions.json`](https://ensawards.org/production-editions.json) — the live config file powering our production deployment.
+
 
 ## Other Utilities
 
 The package also includes helpers for building referral links.
 
 ```typescript
-import { buildEnsReferralUrl } from "@namehash/ens-referrals/v1";
-import type { Address } from "viem";
+import { buildEnsReferralUrl } from "@namehash/ens-referrals";
+import type { Address } from "enssdk";
 
 const referrerAddress: Address = "0xd8da6bf26964af9d7eed9e03e53415d37aa96045";