diff --git a/.changeset/loose-news-sin.md b/.changeset/loose-news-sin.md new file mode 100644 index 000000000..256ae3342 --- /dev/null +++ b/.changeset/loose-news-sin.md @@ -0,0 +1,5 @@ +--- +"@namehash/ens-referrals": minor +--- + +Added a README section showcasing a working example of defining referral program edition configs via JSON files. diff --git a/packages/ens-referrals/README.md b/packages/ens-referrals/README.md index b1d724a58..81e3b8d40 100644 --- a/packages/ens-referrals/README.md +++ b/packages/ens-referrals/README.md @@ -118,7 +118,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) { @@ -154,6 +154,11 @@ if (response.responseCode === ReferrerMetricsEditionsResponseCodes.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). +## 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.