Skip to content
This repository was archived by the owner on Aug 5, 2026. It is now read-only.

chore(ens-referrals): Update readme #1849

Merged
Y3drk merged 15 commits into from
Apr 9, 2026
Merged

chore(ens-referrals): Update readme #1849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f69570f
Update Referral Program Edition defaults
Y3drk Mar 31, 2026
f02d544
docs(changeset): Updated the Referral Program edition defaults to mat…
Y3drk Mar 31, 2026
1f3e88c
Apply ai assistant's suggestions, pt.1 --> add unit tests and update …
Y3drk Mar 31, 2026
621556e
Fix lint errors
Y3drk Mar 31, 2026
a9af00b
docs(changeset): Added unit tests for Referral Program edition defaults.
Y3drk Mar 31, 2026
03dc906
Apply ai assistant's suggestions, pt.2 --> refine unit tests
Y3drk Mar 31, 2026
08dca2d
Apply ai assistant's suggestions, pt.3
Y3drk Mar 31, 2026
221abd6
Apply ai assistant's suggestions, pt.4
Y3drk Mar 31, 2026
8b750bc
Merge branch 'main' of https://github.com/namehash/ensnode into y3drk…
Y3drk Apr 1, 2026
2091e38
Apply 03/31/26 GitHub review feedback
Y3drk Apr 1, 2026
b350e0f
Apply ai assistant's suggestions, pt.5
Y3drk Apr 1, 2026
b6e1ad3
Merge branch 'main' of https://github.com/namehash/ensnode into y3drk…
Y3drk Apr 8, 2026
1c0d0a8
Change the PR after sync call brainstorming
Y3drk Apr 8, 2026
135832e
Apply ai assistant's suggestions, pt.6
Y3drk Apr 8, 2026
b8f105f
Align the new docs section with requirements more precisely
Y3drk Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/loose-news-sin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 6 additions & 1 deletion packages/ens-referrals/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Comment thread
Y3drk marked this conversation as resolved.
});

if (response.responseCode === ReferrerMetricsEditionsResponseCodes.Ok) {
Expand Down Expand Up @@ -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.
Expand Down
Loading