@namehash/ens-referrals 0.0.0-next-20260117070300 → 0.0.0-next-20260119200329

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -122,49 +122,467 @@ var buildAggregatedReferrerMetrics = (referrers, rules) => {
122
122
  return result;
123
123
  };
124
124
 
125
- // src/currency.ts
126
- function isValidUSDQuantity(value) {
127
- return isFiniteNonNegativeNumber(value);
125
+ // src/api/deserialize.ts
126
+ import { prettifyError } from "zod/v4";
127
+
128
+ // src/api/zod-schemas.ts
129
+ import z2 from "zod/v4";
130
+
131
+ // ../ensnode-sdk/src/shared/address.ts
132
+ function asLowerCaseAddress(address) {
133
+ return address.toLowerCase();
128
134
  }
129
- function validateUSDQuantity(value) {
130
- if (!isValidUSDQuantity(value)) {
131
- throw new Error(`Invalid USD quantity: ${value}.`);
135
+
136
+ // ../../node_modules/.pnpm/caip@1.1.1/node_modules/caip/dist/index.mjs
137
+ function _extends() {
138
+ _extends = Object.assign || function(target) {
139
+ for (var i = 1; i < arguments.length; i++) {
140
+ var source = arguments[i];
141
+ for (var key in source) {
142
+ if (Object.prototype.hasOwnProperty.call(source, key)) {
143
+ target[key] = source[key];
144
+ }
145
+ }
146
+ }
147
+ return target;
148
+ };
149
+ return _extends.apply(this, arguments);
150
+ }
151
+ var CAIP2 = {
152
+ name: "chainId",
153
+ regex: "[-:a-zA-Z0-9]{5,41}",
154
+ parameters: {
155
+ delimiter: ":",
156
+ values: {
157
+ 0: {
158
+ name: "namespace",
159
+ regex: "[-a-z0-9]{3,8}"
160
+ },
161
+ 1: {
162
+ name: "reference",
163
+ regex: "[-a-zA-Z0-9]{1,32}"
164
+ }
165
+ }
166
+ }
167
+ };
168
+ var CAIP10 = {
169
+ name: "accountId",
170
+ regex: "[-:a-zA-Z0-9]{7,106}",
171
+ parameters: {
172
+ delimiter: ":",
173
+ values: {
174
+ 0: {
175
+ name: "namespace",
176
+ regex: "[-a-z0-9]{3,8}"
177
+ },
178
+ 1: {
179
+ name: "reference",
180
+ regex: "[-a-zA-Z0-9]{1,32}"
181
+ },
182
+ 2: {
183
+ name: "address",
184
+ regex: "[a-zA-Z0-9]{1,64}"
185
+ }
186
+ }
187
+ }
188
+ };
189
+ var AssetName$1 = {
190
+ name: "assetName",
191
+ regex: "[-:a-zA-Z0-9]{5,73}",
192
+ parameters: {
193
+ delimiter: ":",
194
+ values: {
195
+ 0: {
196
+ name: "namespace",
197
+ regex: "[-a-z0-9]{3,8}"
198
+ },
199
+ 1: {
200
+ name: "reference",
201
+ regex: "[-a-zA-Z0-9]{1,64}"
202
+ }
203
+ }
204
+ }
205
+ };
206
+ var CAIP19AssetType = {
207
+ name: "assetType",
208
+ regex: "[-:a-zA-Z0-9]{11,115}",
209
+ parameters: {
210
+ delimiter: "/",
211
+ values: {
212
+ 0: CAIP2,
213
+ 1: AssetName$1
214
+ }
215
+ }
216
+ };
217
+ var CAIP19AssetId = {
218
+ name: "assetId",
219
+ regex: "[-:a-zA-Z0-9]{13,148}",
220
+ parameters: {
221
+ delimiter: "/",
222
+ values: {
223
+ 0: CAIP2,
224
+ 1: AssetName$1,
225
+ 2: {
226
+ name: "tokenId",
227
+ regex: "[-a-zA-Z0-9]{1,32}"
228
+ }
229
+ }
132
230
  }
231
+ };
232
+ var CAIP = {
233
+ "2": CAIP2,
234
+ "10": CAIP10,
235
+ "19": {
236
+ assetName: AssetName$1,
237
+ assetType: CAIP19AssetType,
238
+ assetId: CAIP19AssetId
239
+ }
240
+ };
241
+ function splitParams(id, spec) {
242
+ return id.split(spec.parameters.delimiter);
243
+ }
244
+ function getParams(id, spec) {
245
+ var arr = splitParams(id, spec);
246
+ var params = {};
247
+ arr.forEach(function(value, index) {
248
+ params[spec.parameters.values[index].name] = value;
249
+ });
250
+ return params;
251
+ }
252
+ function joinParams(params, spec) {
253
+ return Object.values(spec.parameters.values).map(function(parameter) {
254
+ var param = params[parameter.name];
255
+ return typeof param === "string" ? param : joinParams(param, parameter);
256
+ }).join(spec.parameters.delimiter);
257
+ }
258
+ function isValidId(id, spec) {
259
+ if (!new RegExp(spec.regex).test(id)) return false;
260
+ var params = splitParams(id, spec);
261
+ if (params.length !== Object.keys(spec.parameters.values).length) return false;
262
+ var matches = params.map(function(param, index) {
263
+ return new RegExp(spec.parameters.values[index].regex).test(param);
264
+ }).filter(function(x) {
265
+ return !!x;
266
+ });
267
+ if (matches.length !== params.length) return false;
268
+ return true;
133
269
  }
270
+ var ChainId = /* @__PURE__ */ (function() {
271
+ function ChainId2(params) {
272
+ if (typeof params === "string") {
273
+ params = ChainId2.parse(params);
274
+ }
275
+ this.namespace = params.namespace;
276
+ this.reference = params.reference;
277
+ }
278
+ ChainId2.parse = function parse(id) {
279
+ if (!isValidId(id, this.spec)) {
280
+ throw new Error("Invalid " + this.spec.name + " provided: " + id);
281
+ }
282
+ return new ChainId2(getParams(id, this.spec)).toJSON();
283
+ };
284
+ ChainId2.format = function format(params) {
285
+ return joinParams(params, this.spec);
286
+ };
287
+ var _proto = ChainId2.prototype;
288
+ _proto.toString = function toString() {
289
+ return ChainId2.format(this.toJSON());
290
+ };
291
+ _proto.toJSON = function toJSON() {
292
+ return {
293
+ namespace: this.namespace,
294
+ reference: this.reference
295
+ };
296
+ };
297
+ return ChainId2;
298
+ })();
299
+ ChainId.spec = CAIP["2"];
300
+ var AccountId = /* @__PURE__ */ (function() {
301
+ function AccountId2(params) {
302
+ if (typeof params === "string") {
303
+ params = AccountId2.parse(params);
304
+ }
305
+ this.chainId = new ChainId(params.chainId);
306
+ this.address = params.address;
307
+ }
308
+ AccountId2.parse = function parse(id) {
309
+ if (!isValidId(id, this.spec)) {
310
+ throw new Error("Invalid " + this.spec.name + " provided: " + id);
311
+ }
312
+ var _getParams = getParams(id, this.spec), namespace = _getParams.namespace, reference = _getParams.reference, address = _getParams.address;
313
+ var chainId = new ChainId({
314
+ namespace,
315
+ reference
316
+ });
317
+ return new AccountId2({
318
+ chainId,
319
+ address
320
+ }).toJSON();
321
+ };
322
+ AccountId2.format = function format(params) {
323
+ var chainId = new ChainId(params.chainId);
324
+ var splitParams2 = _extends({}, chainId.toJSON(), {
325
+ address: params.address
326
+ });
327
+ return joinParams(splitParams2, this.spec);
328
+ };
329
+ var _proto = AccountId2.prototype;
330
+ _proto.toString = function toString() {
331
+ return AccountId2.format(this.toJSON());
332
+ };
333
+ _proto.toJSON = function toJSON() {
334
+ return {
335
+ chainId: this.chainId.toJSON(),
336
+ address: this.address
337
+ };
338
+ };
339
+ return AccountId2;
340
+ })();
341
+ AccountId.spec = CAIP["10"];
342
+ var AssetName = /* @__PURE__ */ (function() {
343
+ function AssetName2(params) {
344
+ if (typeof params === "string") {
345
+ params = AssetName2.parse(params);
346
+ }
347
+ this.namespace = params.namespace;
348
+ this.reference = params.reference;
349
+ }
350
+ AssetName2.parse = function parse(id) {
351
+ if (!isValidId(id, this.spec)) {
352
+ throw new Error("Invalid " + this.spec.name + " provided: " + id);
353
+ }
354
+ return new AssetName2(getParams(id, this.spec)).toJSON();
355
+ };
356
+ AssetName2.format = function format(params) {
357
+ return joinParams(params, this.spec);
358
+ };
359
+ var _proto = AssetName2.prototype;
360
+ _proto.toString = function toString() {
361
+ return AssetName2.format(this.toJSON());
362
+ };
363
+ _proto.toJSON = function toJSON() {
364
+ return {
365
+ namespace: this.namespace,
366
+ reference: this.reference
367
+ };
368
+ };
369
+ return AssetName2;
370
+ })();
371
+ AssetName.spec = CAIP["19"].assetName;
372
+ var AssetType = /* @__PURE__ */ (function() {
373
+ function AssetType2(params) {
374
+ if (typeof params === "string") {
375
+ params = AssetType2.parse(params);
376
+ }
377
+ this.chainId = new ChainId(params.chainId);
378
+ this.assetName = new AssetName(params.assetName);
379
+ }
380
+ AssetType2.parse = function parse(id) {
381
+ if (!isValidId(id, this.spec)) {
382
+ throw new Error("Invalid " + this.spec.name + " provided: " + id);
383
+ }
384
+ return new AssetType2(getParams(id, this.spec)).toJSON();
385
+ };
386
+ AssetType2.format = function format(params) {
387
+ return joinParams(params, this.spec);
388
+ };
389
+ var _proto = AssetType2.prototype;
390
+ _proto.toString = function toString() {
391
+ return AssetType2.format(this.toJSON());
392
+ };
393
+ _proto.toJSON = function toJSON() {
394
+ return {
395
+ chainId: this.chainId.toJSON(),
396
+ assetName: this.assetName
397
+ };
398
+ };
399
+ return AssetType2;
400
+ })();
401
+ AssetType.spec = CAIP["19"].assetType;
402
+ var AssetId = /* @__PURE__ */ (function() {
403
+ function AssetId2(params) {
404
+ if (typeof params === "string") {
405
+ params = AssetId2.parse(params);
406
+ }
407
+ this.chainId = new ChainId(params.chainId);
408
+ this.assetName = new AssetName(params.assetName);
409
+ this.tokenId = params.tokenId;
410
+ }
411
+ AssetId2.parse = function parse(id) {
412
+ if (!isValidId(id, this.spec)) {
413
+ throw new Error("Invalid " + this.spec.name + " provided: " + id);
414
+ }
415
+ return new AssetId2(getParams(id, this.spec)).toJSON();
416
+ };
417
+ AssetId2.format = function format(params) {
418
+ return joinParams(params, this.spec);
419
+ };
420
+ var _proto = AssetId2.prototype;
421
+ _proto.toString = function toString() {
422
+ return AssetId2.format(this.toJSON());
423
+ };
424
+ _proto.toJSON = function toJSON() {
425
+ return {
426
+ chainId: this.chainId.toJSON(),
427
+ assetName: this.assetName.toJSON(),
428
+ tokenId: this.tokenId
429
+ };
430
+ };
431
+ return AssetId2;
432
+ })();
433
+ AssetId.spec = CAIP["19"].assetId;
134
434
 
135
- // src/encoding.ts
136
- import { getAddress, pad, size, slice, zeroAddress } from "viem";
137
- var ENCODED_REFERRER_BYTE_OFFSET = 12;
138
- var ENCODED_REFERRER_BYTE_LENGTH = 32;
139
- var EXPECTED_ENCODED_REFERRER_PADDING = pad("0x", {
140
- size: ENCODED_REFERRER_BYTE_OFFSET,
141
- dir: "left"
435
+ // ../ensnode-sdk/src/shared/zod-schemas.ts
436
+ import { isAddress as isAddress2, isHex, size } from "viem";
437
+ import { z } from "zod/v4";
438
+ var makeFiniteNonNegativeNumberSchema = (valueLabel = "Value") => z.number({
439
+ // NOTE: Zod's implementation of `number` automatically rejects NaN and Infinity values.
440
+ // and therefore the finite check is implicit.
441
+ error: `${valueLabel} must be a finite number.`
442
+ }).nonnegative({
443
+ error: `${valueLabel} must be a non-negative number (>=0).`
142
444
  });
143
- var ZERO_ENCODED_REFERRER = pad("0x", {
144
- size: ENCODED_REFERRER_BYTE_LENGTH,
145
- dir: "left"
445
+ var makeIntegerSchema = (valueLabel = "Value") => z.int({
446
+ error: `${valueLabel} must be an integer.`
146
447
  });
147
- function buildEncodedReferrer(address) {
148
- const lowercaseAddress = address.toLowerCase();
149
- return pad(lowercaseAddress, { size: ENCODED_REFERRER_BYTE_LENGTH, dir: "left" });
150
- }
151
- function decodeEncodedReferrer(encodedReferrer) {
152
- if (size(encodedReferrer) !== ENCODED_REFERRER_BYTE_LENGTH) {
448
+ var makePositiveIntegerSchema = (valueLabel = "Value") => makeIntegerSchema(valueLabel).positive({
449
+ error: `${valueLabel} must be a positive integer (>0).`
450
+ });
451
+ var makeNonNegativeIntegerSchema = (valueLabel = "Value") => makeIntegerSchema(valueLabel).nonnegative({
452
+ error: `${valueLabel} must be a non-negative integer (>=0).`
453
+ });
454
+ var makeDurationSchema = (valueLabel = "Value") => z.coerce.number({
455
+ error: `${valueLabel} must be a number.`
456
+ }).pipe(makeNonNegativeIntegerSchema(valueLabel));
457
+ var makeChainIdSchema = (valueLabel = "Chain ID") => makePositiveIntegerSchema(valueLabel).transform((val) => val);
458
+ var makeLowercaseAddressSchema = (valueLabel = "EVM address") => z.string().check((ctx) => {
459
+ if (!isAddress2(ctx.value)) {
460
+ ctx.issues.push({
461
+ code: "custom",
462
+ message: `${valueLabel} must be a valid EVM address`,
463
+ input: ctx.value
464
+ });
465
+ }
466
+ }).transform((val) => asLowerCaseAddress(val));
467
+ var makeUnixTimestampSchema = (valueLabel = "Timestamp") => makeIntegerSchema(valueLabel);
468
+ var makeAccountIdSchema = (valueLabel = "AccountId") => z.strictObject({
469
+ chainId: makeChainIdSchema(`${valueLabel} chain ID`),
470
+ address: makeLowercaseAddressSchema(`${valueLabel} address`)
471
+ });
472
+
473
+ // src/leaderboard-page.ts
474
+ var REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT = 25;
475
+ var REFERRERS_PER_LEADERBOARD_PAGE_MAX = 100;
476
+ var validateReferrerLeaderboardPageParams = (params) => {
477
+ if (params.page !== void 0 && !isPositiveInteger(params.page)) {
153
478
  throw new Error(
154
- `Encoded referrer value must be represented by ${ENCODED_REFERRER_BYTE_LENGTH} bytes.`
479
+ `Invalid ReferrerLeaderboardPageParams: ${params.page}. page must be a positive integer.`
155
480
  );
156
481
  }
157
- const padding = slice(encodedReferrer, 0, ENCODED_REFERRER_BYTE_OFFSET);
158
- if (padding !== EXPECTED_ENCODED_REFERRER_PADDING) {
159
- return zeroAddress;
482
+ if (params.recordsPerPage !== void 0 && !isPositiveInteger(params.recordsPerPage)) {
483
+ throw new Error(
484
+ `Invalid ReferrerLeaderboardPageParams: ${params.recordsPerPage}. recordsPerPage must be a positive integer.`
485
+ );
160
486
  }
161
- const decodedReferrer = slice(encodedReferrer, ENCODED_REFERRER_BYTE_OFFSET);
162
- try {
163
- return getAddress(decodedReferrer);
164
- } catch {
165
- throw new Error(`Decoded referrer value must be a valid EVM address.`);
487
+ if (params.recordsPerPage !== void 0 && params.recordsPerPage > REFERRERS_PER_LEADERBOARD_PAGE_MAX) {
488
+ throw new Error(
489
+ `Invalid ReferrerLeaderboardPageParams: ${params.recordsPerPage}. recordsPerPage must be less than or equal to ${REFERRERS_PER_LEADERBOARD_PAGE_MAX}.`
490
+ );
166
491
  }
167
- }
492
+ };
493
+ var buildReferrerLeaderboardPageParams = (params) => {
494
+ const result = {
495
+ page: params.page ?? 1,
496
+ recordsPerPage: params.recordsPerPage ?? REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT
497
+ };
498
+ validateReferrerLeaderboardPageParams(result);
499
+ return result;
500
+ };
501
+ var validateReferrerLeaderboardPageContext = (context) => {
502
+ validateReferrerLeaderboardPageParams(context);
503
+ if (!isNonNegativeInteger(context.totalRecords)) {
504
+ throw new Error(
505
+ `Invalid ReferrerLeaderboardPageContext: total must be a non-negative integer but is ${context.totalRecords}.`
506
+ );
507
+ }
508
+ const startIndex = (context.page - 1) * context.recordsPerPage;
509
+ const endIndex = startIndex + context.recordsPerPage;
510
+ if (!context.hasNext && endIndex < context.totalRecords) {
511
+ throw new Error(
512
+ `Invalid ReferrerLeaderboardPageContext: if hasNext is false, endIndex (${endIndex}) must be greater than or equal to total (${context.totalRecords}).`
513
+ );
514
+ } else if (context.hasNext && context.page * context.recordsPerPage >= context.totalRecords) {
515
+ throw new Error(
516
+ `Invalid ReferrerLeaderboardPageContext: if hasNext is true, endIndex (${endIndex}) must be less than total (${context.totalRecords}).`
517
+ );
518
+ }
519
+ if (!context.hasPrev && context.page !== 1) {
520
+ throw new Error(
521
+ `Invalid ReferrerLeaderboardPageContext: if hasPrev is false, page must be the first page (1) but is ${context.page}.`
522
+ );
523
+ } else if (context.hasPrev && context.page === 1) {
524
+ throw new Error(
525
+ `Invalid ReferrerLeaderboardPageContext: if hasPrev is true, page must not be the first page (1) but is ${context.page}.`
526
+ );
527
+ }
528
+ };
529
+ var buildReferrerLeaderboardPageContext = (optionalParams, leaderboard) => {
530
+ const materializedParams = buildReferrerLeaderboardPageParams(optionalParams);
531
+ const totalRecords = leaderboard.referrers.size;
532
+ const totalPages = Math.max(1, Math.ceil(totalRecords / materializedParams.recordsPerPage));
533
+ if (materializedParams.page > totalPages) {
534
+ throw new Error(
535
+ `Invalid ReferrerLeaderboardPageContext: page ${materializedParams.page} exceeds total pages ${totalPages}.`
536
+ );
537
+ }
538
+ if (totalRecords === 0) {
539
+ return {
540
+ ...materializedParams,
541
+ totalRecords: 0,
542
+ totalPages: 1,
543
+ hasNext: false,
544
+ hasPrev: false,
545
+ startIndex: void 0,
546
+ endIndex: void 0
547
+ };
548
+ }
549
+ const startIndex = (materializedParams.page - 1) * materializedParams.recordsPerPage;
550
+ const maxTheoreticalIndexOnPage = startIndex + (materializedParams.recordsPerPage - 1);
551
+ const endIndex = Math.min(maxTheoreticalIndexOnPage, totalRecords - 1);
552
+ const hasNext = maxTheoreticalIndexOnPage < totalRecords - 1;
553
+ const hasPrev = materializedParams.page > 1;
554
+ const result = {
555
+ ...materializedParams,
556
+ totalRecords,
557
+ totalPages,
558
+ hasNext,
559
+ hasPrev,
560
+ startIndex,
561
+ endIndex
562
+ };
563
+ validateReferrerLeaderboardPageContext(result);
564
+ return result;
565
+ };
566
+ var getReferrerLeaderboardPage = (pageParams, leaderboard) => {
567
+ const pageContext = buildReferrerLeaderboardPageContext(pageParams, leaderboard);
568
+ let referrers;
569
+ if (pageContext.totalRecords > 0 && typeof pageContext.startIndex !== "undefined" && typeof pageContext.endIndex !== "undefined") {
570
+ referrers = Array.from(leaderboard.referrers.values()).slice(
571
+ pageContext.startIndex,
572
+ pageContext.endIndex + 1
573
+ // For `slice`, this is exclusive of the element at the index 'end'. We need it to be inclusive, hence plus one.
574
+ );
575
+ } else {
576
+ referrers = [];
577
+ }
578
+ return {
579
+ rules: leaderboard.rules,
580
+ referrers,
581
+ aggregatedMetrics: leaderboard.aggregatedMetrics,
582
+ pageContext,
583
+ accurateAsOf: leaderboard.accurateAsOf
584
+ };
585
+ };
168
586
 
169
587
  // src/rank.ts
170
588
  var validateReferrerRank = (rank) => {
@@ -366,6 +784,624 @@ var buildUnrankedReferrerMetrics = (referrer) => {
366
784
  return result;
367
785
  };
368
786
 
787
+ // src/referrer-detail.ts
788
+ var ReferrerDetailTypeIds = {
789
+ /**
790
+ * Represents a referrer who is ranked on the leaderboard.
791
+ */
792
+ Ranked: "ranked",
793
+ /**
794
+ * Represents a referrer who is not ranked on the leaderboard.
795
+ */
796
+ Unranked: "unranked"
797
+ };
798
+ var getReferrerDetail = (referrer, leaderboard) => {
799
+ const awardedReferrerMetrics = leaderboard.referrers.get(referrer);
800
+ if (awardedReferrerMetrics) {
801
+ return {
802
+ type: ReferrerDetailTypeIds.Ranked,
803
+ rules: leaderboard.rules,
804
+ referrer: awardedReferrerMetrics,
805
+ aggregatedMetrics: leaderboard.aggregatedMetrics,
806
+ accurateAsOf: leaderboard.accurateAsOf
807
+ };
808
+ }
809
+ return {
810
+ type: ReferrerDetailTypeIds.Unranked,
811
+ rules: leaderboard.rules,
812
+ referrer: buildUnrankedReferrerMetrics(referrer),
813
+ aggregatedMetrics: leaderboard.aggregatedMetrics,
814
+ accurateAsOf: leaderboard.accurateAsOf
815
+ };
816
+ };
817
+
818
+ // src/api/types.ts
819
+ var ReferrerLeaderboardPageResponseCodes = {
820
+ /**
821
+ * Represents that the requested referrer leaderboard page is available.
822
+ */
823
+ Ok: "ok",
824
+ /**
825
+ * Represents that the referrer leaderboard data is not available.
826
+ */
827
+ Error: "error"
828
+ };
829
+ var ReferrerDetailResponseCodes = {
830
+ /**
831
+ * Represents that the referrer detail data is available.
832
+ */
833
+ Ok: "ok",
834
+ /**
835
+ * Represents that an error occurred while fetching the data.
836
+ */
837
+ Error: "error"
838
+ };
839
+
840
+ // src/api/zod-schemas.ts
841
+ var makeRevenueContributionSchema = (valueLabel = "RevenueContribution") => z2.coerce.bigint({
842
+ error: `${valueLabel} must represent a bigint.`
843
+ }).nonnegative({
844
+ error: `${valueLabel} must not be negative.`
845
+ });
846
+ var makeReferralProgramRulesSchema = (valueLabel = "ReferralProgramRules") => z2.object({
847
+ totalAwardPoolValue: makeFiniteNonNegativeNumberSchema(`${valueLabel}.totalAwardPoolValue`),
848
+ maxQualifiedReferrers: makeNonNegativeIntegerSchema(`${valueLabel}.maxQualifiedReferrers`),
849
+ startTime: makeUnixTimestampSchema(`${valueLabel}.startTime`),
850
+ endTime: makeUnixTimestampSchema(`${valueLabel}.endTime`),
851
+ subregistryId: makeAccountIdSchema(`${valueLabel}.subregistryId`)
852
+ });
853
+ var makeAwardedReferrerMetricsSchema = (valueLabel = "AwardedReferrerMetrics") => z2.object({
854
+ referrer: makeLowercaseAddressSchema(`${valueLabel}.referrer`),
855
+ totalReferrals: makeNonNegativeIntegerSchema(`${valueLabel}.totalReferrals`),
856
+ totalIncrementalDuration: makeDurationSchema(`${valueLabel}.totalIncrementalDuration`),
857
+ totalRevenueContribution: makeRevenueContributionSchema(
858
+ `${valueLabel}.totalRevenueContribution`
859
+ ),
860
+ score: makeFiniteNonNegativeNumberSchema(`${valueLabel}.score`),
861
+ rank: makePositiveIntegerSchema(`${valueLabel}.rank`),
862
+ isQualified: z2.boolean(),
863
+ finalScoreBoost: makeFiniteNonNegativeNumberSchema(`${valueLabel}.finalScoreBoost`).max(
864
+ 1,
865
+ `${valueLabel}.finalScoreBoost must be <= 1`
866
+ ),
867
+ finalScore: makeFiniteNonNegativeNumberSchema(`${valueLabel}.finalScore`),
868
+ awardPoolShare: makeFiniteNonNegativeNumberSchema(`${valueLabel}.awardPoolShare`).max(
869
+ 1,
870
+ `${valueLabel}.awardPoolShare must be <= 1`
871
+ ),
872
+ awardPoolApproxValue: makeFiniteNonNegativeNumberSchema(`${valueLabel}.awardPoolApproxValue`)
873
+ });
874
+ var makeUnrankedReferrerMetricsSchema = (valueLabel = "UnrankedReferrerMetrics") => z2.object({
875
+ referrer: makeLowercaseAddressSchema(`${valueLabel}.referrer`),
876
+ totalReferrals: makeNonNegativeIntegerSchema(`${valueLabel}.totalReferrals`),
877
+ totalIncrementalDuration: makeDurationSchema(`${valueLabel}.totalIncrementalDuration`),
878
+ totalRevenueContribution: makeRevenueContributionSchema(
879
+ `${valueLabel}.totalRevenueContribution`
880
+ ),
881
+ score: makeFiniteNonNegativeNumberSchema(`${valueLabel}.score`),
882
+ rank: z2.null(),
883
+ isQualified: z2.literal(false),
884
+ finalScoreBoost: makeFiniteNonNegativeNumberSchema(`${valueLabel}.finalScoreBoost`).max(
885
+ 1,
886
+ `${valueLabel}.finalScoreBoost must be <= 1`
887
+ ),
888
+ finalScore: makeFiniteNonNegativeNumberSchema(`${valueLabel}.finalScore`),
889
+ awardPoolShare: makeFiniteNonNegativeNumberSchema(`${valueLabel}.awardPoolShare`).max(
890
+ 1,
891
+ `${valueLabel}.awardPoolShare must be <= 1`
892
+ ),
893
+ awardPoolApproxValue: makeFiniteNonNegativeNumberSchema(`${valueLabel}.awardPoolApproxValue`)
894
+ });
895
+ var makeAggregatedReferrerMetricsSchema = (valueLabel = "AggregatedReferrerMetrics") => z2.object({
896
+ grandTotalReferrals: makeNonNegativeIntegerSchema(`${valueLabel}.grandTotalReferrals`),
897
+ grandTotalIncrementalDuration: makeDurationSchema(
898
+ `${valueLabel}.grandTotalIncrementalDuration`
899
+ ),
900
+ grandTotalRevenueContribution: makeRevenueContributionSchema(
901
+ `${valueLabel}.grandTotalRevenueContribution`
902
+ ),
903
+ grandTotalQualifiedReferrersFinalScore: makeFiniteNonNegativeNumberSchema(
904
+ `${valueLabel}.grandTotalQualifiedReferrersFinalScore`
905
+ ),
906
+ minFinalScoreToQualify: makeFiniteNonNegativeNumberSchema(
907
+ `${valueLabel}.minFinalScoreToQualify`
908
+ )
909
+ });
910
+ var makeReferrerLeaderboardPageContextSchema = (valueLabel = "ReferrerLeaderboardPageContext") => z2.object({
911
+ page: makePositiveIntegerSchema(`${valueLabel}.page`),
912
+ recordsPerPage: makePositiveIntegerSchema(`${valueLabel}.recordsPerPage`).max(
913
+ REFERRERS_PER_LEADERBOARD_PAGE_MAX,
914
+ `${valueLabel}.recordsPerPage must not exceed ${REFERRERS_PER_LEADERBOARD_PAGE_MAX}`
915
+ ),
916
+ totalRecords: makeNonNegativeIntegerSchema(`${valueLabel}.totalRecords`),
917
+ totalPages: makePositiveIntegerSchema(`${valueLabel}.totalPages`),
918
+ hasNext: z2.boolean(),
919
+ hasPrev: z2.boolean(),
920
+ startIndex: z2.optional(makeNonNegativeIntegerSchema(`${valueLabel}.startIndex`)),
921
+ endIndex: z2.optional(makeNonNegativeIntegerSchema(`${valueLabel}.endIndex`))
922
+ });
923
+ var makeReferrerLeaderboardPageSchema = (valueLabel = "ReferrerLeaderboardPage") => z2.object({
924
+ rules: makeReferralProgramRulesSchema(`${valueLabel}.rules`),
925
+ referrers: z2.array(makeAwardedReferrerMetricsSchema(`${valueLabel}.referrers[record]`)),
926
+ aggregatedMetrics: makeAggregatedReferrerMetricsSchema(`${valueLabel}.aggregatedMetrics`),
927
+ pageContext: makeReferrerLeaderboardPageContextSchema(`${valueLabel}.pageContext`),
928
+ accurateAsOf: makeUnixTimestampSchema(`${valueLabel}.accurateAsOf`)
929
+ });
930
+ var makeReferrerLeaderboardPageResponseOkSchema = (valueLabel = "ReferrerLeaderboardPageResponseOk") => z2.object({
931
+ responseCode: z2.literal(ReferrerLeaderboardPageResponseCodes.Ok),
932
+ data: makeReferrerLeaderboardPageSchema(`${valueLabel}.data`)
933
+ });
934
+ var makeReferrerLeaderboardPageResponseErrorSchema = (_valueLabel = "ReferrerLeaderboardPageResponseError") => z2.object({
935
+ responseCode: z2.literal(ReferrerLeaderboardPageResponseCodes.Error),
936
+ error: z2.string(),
937
+ errorMessage: z2.string()
938
+ });
939
+ var makeReferrerLeaderboardPageResponseSchema = (valueLabel = "ReferrerLeaderboardPageResponse") => z2.union([
940
+ makeReferrerLeaderboardPageResponseOkSchema(valueLabel),
941
+ makeReferrerLeaderboardPageResponseErrorSchema(valueLabel)
942
+ ]);
943
+ var makeReferrerDetailRankedSchema = (valueLabel = "ReferrerDetailRanked") => z2.object({
944
+ type: z2.literal(ReferrerDetailTypeIds.Ranked),
945
+ rules: makeReferralProgramRulesSchema(`${valueLabel}.rules`),
946
+ referrer: makeAwardedReferrerMetricsSchema(`${valueLabel}.referrer`),
947
+ aggregatedMetrics: makeAggregatedReferrerMetricsSchema(`${valueLabel}.aggregatedMetrics`),
948
+ accurateAsOf: makeUnixTimestampSchema(`${valueLabel}.accurateAsOf`)
949
+ });
950
+ var makeReferrerDetailUnrankedSchema = (valueLabel = "ReferrerDetailUnranked") => z2.object({
951
+ type: z2.literal(ReferrerDetailTypeIds.Unranked),
952
+ rules: makeReferralProgramRulesSchema(`${valueLabel}.rules`),
953
+ referrer: makeUnrankedReferrerMetricsSchema(`${valueLabel}.referrer`),
954
+ aggregatedMetrics: makeAggregatedReferrerMetricsSchema(`${valueLabel}.aggregatedMetrics`),
955
+ accurateAsOf: makeUnixTimestampSchema(`${valueLabel}.accurateAsOf`)
956
+ });
957
+ var makeReferrerDetailResponseOkSchema = (valueLabel = "ReferrerDetailResponse") => z2.object({
958
+ responseCode: z2.literal(ReferrerDetailResponseCodes.Ok),
959
+ data: z2.union([
960
+ makeReferrerDetailRankedSchema(`${valueLabel}.data`),
961
+ makeReferrerDetailUnrankedSchema(`${valueLabel}.data`)
962
+ ])
963
+ });
964
+ var makeReferrerDetailResponseErrorSchema = (_valueLabel = "ReferrerDetailResponse") => z2.object({
965
+ responseCode: z2.literal(ReferrerDetailResponseCodes.Error),
966
+ error: z2.string(),
967
+ errorMessage: z2.string()
968
+ });
969
+ var makeReferrerDetailResponseSchema = (valueLabel = "ReferrerDetailResponse") => z2.union([
970
+ makeReferrerDetailResponseOkSchema(valueLabel),
971
+ makeReferrerDetailResponseErrorSchema(valueLabel)
972
+ ]);
973
+
974
+ // src/api/deserialize.ts
975
+ function deserializeRevenueContribution(value) {
976
+ return BigInt(value);
977
+ }
978
+ function deserializeReferralProgramRules(rules) {
979
+ return rules;
980
+ }
981
+ function deserializeAwardedReferrerMetrics(metrics) {
982
+ return {
983
+ referrer: metrics.referrer,
984
+ totalReferrals: metrics.totalReferrals,
985
+ totalIncrementalDuration: metrics.totalIncrementalDuration,
986
+ totalRevenueContribution: deserializeRevenueContribution(metrics.totalRevenueContribution),
987
+ score: metrics.score,
988
+ rank: metrics.rank,
989
+ isQualified: metrics.isQualified,
990
+ finalScoreBoost: metrics.finalScoreBoost,
991
+ finalScore: metrics.finalScore,
992
+ awardPoolShare: metrics.awardPoolShare,
993
+ awardPoolApproxValue: metrics.awardPoolApproxValue
994
+ };
995
+ }
996
+ function deserializeUnrankedReferrerMetrics(metrics) {
997
+ return {
998
+ referrer: metrics.referrer,
999
+ totalReferrals: metrics.totalReferrals,
1000
+ totalIncrementalDuration: metrics.totalIncrementalDuration,
1001
+ totalRevenueContribution: deserializeRevenueContribution(metrics.totalRevenueContribution),
1002
+ score: metrics.score,
1003
+ rank: metrics.rank,
1004
+ isQualified: metrics.isQualified,
1005
+ finalScoreBoost: metrics.finalScoreBoost,
1006
+ finalScore: metrics.finalScore,
1007
+ awardPoolShare: metrics.awardPoolShare,
1008
+ awardPoolApproxValue: metrics.awardPoolApproxValue
1009
+ };
1010
+ }
1011
+ function deserializeAggregatedReferrerMetrics(metrics) {
1012
+ return {
1013
+ grandTotalReferrals: metrics.grandTotalReferrals,
1014
+ grandTotalIncrementalDuration: metrics.grandTotalIncrementalDuration,
1015
+ grandTotalRevenueContribution: deserializeRevenueContribution(
1016
+ metrics.grandTotalRevenueContribution
1017
+ ),
1018
+ grandTotalQualifiedReferrersFinalScore: metrics.grandTotalQualifiedReferrersFinalScore,
1019
+ minFinalScoreToQualify: metrics.minFinalScoreToQualify
1020
+ };
1021
+ }
1022
+ function deserializeReferrerLeaderboardPage(page) {
1023
+ return {
1024
+ rules: deserializeReferralProgramRules(page.rules),
1025
+ referrers: page.referrers.map(deserializeAwardedReferrerMetrics),
1026
+ aggregatedMetrics: deserializeAggregatedReferrerMetrics(page.aggregatedMetrics),
1027
+ pageContext: page.pageContext,
1028
+ accurateAsOf: page.accurateAsOf
1029
+ };
1030
+ }
1031
+ function deserializeReferrerDetailRanked(detail) {
1032
+ return {
1033
+ type: detail.type,
1034
+ rules: deserializeReferralProgramRules(detail.rules),
1035
+ referrer: deserializeAwardedReferrerMetrics(detail.referrer),
1036
+ aggregatedMetrics: deserializeAggregatedReferrerMetrics(detail.aggregatedMetrics),
1037
+ accurateAsOf: detail.accurateAsOf
1038
+ };
1039
+ }
1040
+ function deserializeReferrerDetailUnranked(detail) {
1041
+ return {
1042
+ type: detail.type,
1043
+ rules: deserializeReferralProgramRules(detail.rules),
1044
+ referrer: deserializeUnrankedReferrerMetrics(detail.referrer),
1045
+ aggregatedMetrics: deserializeAggregatedReferrerMetrics(detail.aggregatedMetrics),
1046
+ accurateAsOf: detail.accurateAsOf
1047
+ };
1048
+ }
1049
+ function deserializeReferrerLeaderboardPageResponse(maybeResponse, valueLabel) {
1050
+ let deserialized;
1051
+ switch (maybeResponse.responseCode) {
1052
+ case "ok": {
1053
+ deserialized = {
1054
+ responseCode: maybeResponse.responseCode,
1055
+ data: deserializeReferrerLeaderboardPage(maybeResponse.data)
1056
+ };
1057
+ break;
1058
+ }
1059
+ case "error":
1060
+ deserialized = maybeResponse;
1061
+ break;
1062
+ }
1063
+ const schema = makeReferrerLeaderboardPageResponseSchema(valueLabel);
1064
+ const parsed = schema.safeParse(deserialized);
1065
+ if (parsed.error) {
1066
+ throw new Error(
1067
+ `Cannot deserialize SerializedReferrerLeaderboardPageResponse:
1068
+ ${prettifyError(parsed.error)}
1069
+ `
1070
+ );
1071
+ }
1072
+ return parsed.data;
1073
+ }
1074
+ function deserializeReferrerDetailResponse(maybeResponse, valueLabel) {
1075
+ let deserialized;
1076
+ switch (maybeResponse.responseCode) {
1077
+ case "ok": {
1078
+ switch (maybeResponse.data.type) {
1079
+ case "ranked":
1080
+ deserialized = {
1081
+ responseCode: maybeResponse.responseCode,
1082
+ data: deserializeReferrerDetailRanked(maybeResponse.data)
1083
+ };
1084
+ break;
1085
+ case "unranked":
1086
+ deserialized = {
1087
+ responseCode: maybeResponse.responseCode,
1088
+ data: deserializeReferrerDetailUnranked(maybeResponse.data)
1089
+ };
1090
+ break;
1091
+ }
1092
+ break;
1093
+ }
1094
+ case "error":
1095
+ deserialized = maybeResponse;
1096
+ break;
1097
+ }
1098
+ const schema = makeReferrerDetailResponseSchema(valueLabel);
1099
+ const parsed = schema.safeParse(deserialized);
1100
+ if (parsed.error) {
1101
+ throw new Error(`Cannot deserialize ReferrerDetailResponse:
1102
+ ${prettifyError(parsed.error)}
1103
+ `);
1104
+ }
1105
+ return parsed.data;
1106
+ }
1107
+
1108
+ // src/api/serialize.ts
1109
+ function serializeRevenueContribution(revenueContribution) {
1110
+ return revenueContribution.toString();
1111
+ }
1112
+ function serializeReferralProgramRules(rules) {
1113
+ return rules;
1114
+ }
1115
+ function serializeAwardedReferrerMetrics(metrics) {
1116
+ return {
1117
+ referrer: metrics.referrer,
1118
+ totalReferrals: metrics.totalReferrals,
1119
+ totalIncrementalDuration: metrics.totalIncrementalDuration,
1120
+ totalRevenueContribution: serializeRevenueContribution(metrics.totalRevenueContribution),
1121
+ score: metrics.score,
1122
+ rank: metrics.rank,
1123
+ isQualified: metrics.isQualified,
1124
+ finalScoreBoost: metrics.finalScoreBoost,
1125
+ finalScore: metrics.finalScore,
1126
+ awardPoolShare: metrics.awardPoolShare,
1127
+ awardPoolApproxValue: metrics.awardPoolApproxValue
1128
+ };
1129
+ }
1130
+ function serializeUnrankedReferrerMetrics(metrics) {
1131
+ return {
1132
+ referrer: metrics.referrer,
1133
+ totalReferrals: metrics.totalReferrals,
1134
+ totalIncrementalDuration: metrics.totalIncrementalDuration,
1135
+ totalRevenueContribution: serializeRevenueContribution(metrics.totalRevenueContribution),
1136
+ score: metrics.score,
1137
+ rank: metrics.rank,
1138
+ isQualified: metrics.isQualified,
1139
+ finalScoreBoost: metrics.finalScoreBoost,
1140
+ finalScore: metrics.finalScore,
1141
+ awardPoolShare: metrics.awardPoolShare,
1142
+ awardPoolApproxValue: metrics.awardPoolApproxValue
1143
+ };
1144
+ }
1145
+ function serializeAggregatedReferrerMetrics(metrics) {
1146
+ return {
1147
+ grandTotalReferrals: metrics.grandTotalReferrals,
1148
+ grandTotalIncrementalDuration: metrics.grandTotalIncrementalDuration,
1149
+ grandTotalRevenueContribution: serializeRevenueContribution(
1150
+ metrics.grandTotalRevenueContribution
1151
+ ),
1152
+ grandTotalQualifiedReferrersFinalScore: metrics.grandTotalQualifiedReferrersFinalScore,
1153
+ minFinalScoreToQualify: metrics.minFinalScoreToQualify
1154
+ };
1155
+ }
1156
+ function serializeReferrerLeaderboardPage(page) {
1157
+ return {
1158
+ rules: serializeReferralProgramRules(page.rules),
1159
+ referrers: page.referrers.map(serializeAwardedReferrerMetrics),
1160
+ aggregatedMetrics: serializeAggregatedReferrerMetrics(page.aggregatedMetrics),
1161
+ pageContext: page.pageContext,
1162
+ accurateAsOf: page.accurateAsOf
1163
+ };
1164
+ }
1165
+ function serializeReferrerDetailRanked(detail) {
1166
+ return {
1167
+ type: detail.type,
1168
+ rules: serializeReferralProgramRules(detail.rules),
1169
+ referrer: serializeAwardedReferrerMetrics(detail.referrer),
1170
+ aggregatedMetrics: serializeAggregatedReferrerMetrics(detail.aggregatedMetrics),
1171
+ accurateAsOf: detail.accurateAsOf
1172
+ };
1173
+ }
1174
+ function serializeReferrerDetailUnranked(detail) {
1175
+ return {
1176
+ type: detail.type,
1177
+ rules: serializeReferralProgramRules(detail.rules),
1178
+ referrer: serializeUnrankedReferrerMetrics(detail.referrer),
1179
+ aggregatedMetrics: serializeAggregatedReferrerMetrics(detail.aggregatedMetrics),
1180
+ accurateAsOf: detail.accurateAsOf
1181
+ };
1182
+ }
1183
+ function serializeReferrerLeaderboardPageResponse(response) {
1184
+ switch (response.responseCode) {
1185
+ case ReferrerLeaderboardPageResponseCodes.Ok:
1186
+ return {
1187
+ responseCode: response.responseCode,
1188
+ data: serializeReferrerLeaderboardPage(response.data)
1189
+ };
1190
+ case ReferrerLeaderboardPageResponseCodes.Error:
1191
+ return response;
1192
+ }
1193
+ }
1194
+ function serializeReferrerDetailResponse(response) {
1195
+ switch (response.responseCode) {
1196
+ case ReferrerDetailResponseCodes.Ok:
1197
+ switch (response.data.type) {
1198
+ case "ranked":
1199
+ return {
1200
+ responseCode: response.responseCode,
1201
+ data: serializeReferrerDetailRanked(response.data)
1202
+ };
1203
+ case "unranked":
1204
+ return {
1205
+ responseCode: response.responseCode,
1206
+ data: serializeReferrerDetailUnranked(response.data)
1207
+ };
1208
+ }
1209
+ break;
1210
+ case ReferrerDetailResponseCodes.Error:
1211
+ return response;
1212
+ }
1213
+ }
1214
+
1215
+ // src/client.ts
1216
+ var DEFAULT_ENSNODE_API_URL = "https://api.alpha.ensnode.io";
1217
+ var ENSReferralsClient = class _ENSReferralsClient {
1218
+ options;
1219
+ static defaultOptions() {
1220
+ return {
1221
+ url: new URL(DEFAULT_ENSNODE_API_URL)
1222
+ };
1223
+ }
1224
+ constructor(options = {}) {
1225
+ this.options = {
1226
+ ..._ENSReferralsClient.defaultOptions(),
1227
+ ...options
1228
+ };
1229
+ }
1230
+ getOptions() {
1231
+ return Object.freeze({
1232
+ url: new URL(this.options.url.href)
1233
+ });
1234
+ }
1235
+ /**
1236
+ * Fetch Referrer Leaderboard Page
1237
+ *
1238
+ * Retrieves a paginated list of referrer leaderboard metrics with contribution percentages.
1239
+ * Each referrer's contribution is calculated as a percentage of the grand totals across all referrers.
1240
+ *
1241
+ * @param request - Pagination parameters
1242
+ * @param request.page - The page number to retrieve (1-indexed, default: 1)
1243
+ * @param request.recordsPerPage - Number of records per page (default: 25, max: 100)
1244
+ * @returns {ReferrerLeaderboardPageResponse}
1245
+ *
1246
+ * @throws if the ENSNode request fails
1247
+ * @throws if the ENSNode API returns an error response
1248
+ * @throws if the ENSNode response breaks required invariants
1249
+ *
1250
+ * @example
1251
+ * ```typescript
1252
+ * // Get first page with default page size (25 records)
1253
+ * const response = await client.getReferrerLeaderboardPage();
1254
+ * if (response.responseCode === ReferrerLeaderboardPageResponseCodes.Ok) {
1255
+ * const {
1256
+ * aggregatedMetrics,
1257
+ * referrers,
1258
+ * rules,
1259
+ * pageContext,
1260
+ * updatedAt
1261
+ * } = response.data;
1262
+ * console.log(aggregatedMetrics);
1263
+ * console.log(referrers);
1264
+ * console.log(rules);
1265
+ * console.log(updatedAt);
1266
+ * console.log(`Page ${pageContext.page} of ${pageContext.totalPages}`);
1267
+ * }
1268
+ * ```
1269
+ *
1270
+ * @example
1271
+ * ```typescript
1272
+ * // Get second page with 50 records per page
1273
+ * const response = await client.getReferrerLeaderboardPage({ page: 2, recordsPerPage: 50 });
1274
+ * ```
1275
+ *
1276
+ * @example
1277
+ * ```typescript
1278
+ * // Handle error response, ie. when Referrer Leaderboard is not currently available.
1279
+ * const response = await client.getReferrerLeaderboardPage();
1280
+ *
1281
+ * if (response.responseCode === ReferrerLeaderboardPageResponseCodes.Error) {
1282
+ * console.error(response.error);
1283
+ * console.error(response.errorMessage);
1284
+ * }
1285
+ * ```
1286
+ */
1287
+ async getReferrerLeaderboardPage(request) {
1288
+ const url = new URL(`/ensanalytics/referrers`, this.options.url);
1289
+ if (request?.page) url.searchParams.set("page", request.page.toString());
1290
+ if (request?.recordsPerPage)
1291
+ url.searchParams.set("recordsPerPage", request.recordsPerPage.toString());
1292
+ const response = await fetch(url);
1293
+ let responseData;
1294
+ try {
1295
+ responseData = await response.json();
1296
+ } catch {
1297
+ throw new Error("Malformed response data: invalid JSON");
1298
+ }
1299
+ return deserializeReferrerLeaderboardPageResponse(
1300
+ responseData
1301
+ );
1302
+ }
1303
+ /**
1304
+ * Fetch Referrer Detail
1305
+ *
1306
+ * Retrieves detailed information about a specific referrer, whether they are on the
1307
+ * leaderboard or not.
1308
+ *
1309
+ * The response data is a discriminated union type with a `type` field:
1310
+ *
1311
+ * **For referrers on the leaderboard** (`ReferrerDetailRanked`):
1312
+ * - `type`: {@link ReferrerDetailTypeIds.Ranked}
1313
+ * - `referrer`: The `AwardedReferrerMetrics` from @namehash/ens-referrals
1314
+ * - `rules`: The referral program rules
1315
+ * - `aggregatedMetrics`: Aggregated metrics for all referrers on the leaderboard
1316
+ * - `accurateAsOf`: Unix timestamp indicating when the data was last updated
1317
+ *
1318
+ * **For referrers NOT on the leaderboard** (`ReferrerDetailUnranked`):
1319
+ * - `type`: {@link ReferrerDetailTypeIds.Unranked}
1320
+ * - `referrer`: The `UnrankedReferrerMetrics` from @namehash/ens-referrals
1321
+ * - `rules`: The referral program rules
1322
+ * - `aggregatedMetrics`: Aggregated metrics for all referrers on the leaderboard
1323
+ * - `accurateAsOf`: Unix timestamp indicating when the data was last updated
1324
+ *
1325
+ * @see {@link https://www.npmjs.com/package/@namehash/ens-referrals|@namehash/ens-referrals} for calculation details
1326
+ *
1327
+ * @param request The referrer address to query
1328
+ * @returns {ReferrerDetailResponse} Returns the referrer detail response
1329
+ *
1330
+ * @throws if the ENSNode request fails
1331
+ * @throws if the response data is malformed
1332
+ *
1333
+ * @example
1334
+ * ```typescript
1335
+ * // Get referrer detail for a specific address
1336
+ * const response = await client.getReferrerDetail({
1337
+ * referrer: "0x1234567890123456789012345678901234567890"
1338
+ * });
1339
+ * if (response.responseCode === ReferrerDetailResponseCodes.Ok) {
1340
+ * const { type, referrer, rules, aggregatedMetrics, accurateAsOf } = response.data;
1341
+ * console.log(type); // ReferrerDetailTypeIds.Ranked or ReferrerDetailTypeIds.Unranked
1342
+ * console.log(referrer);
1343
+ * console.log(accurateAsOf);
1344
+ * }
1345
+ * ```
1346
+ *
1347
+ * @example
1348
+ * ```typescript
1349
+ * // Use discriminated union to check if referrer is ranked
1350
+ * const response = await client.getReferrerDetail({
1351
+ * referrer: "0x1234567890123456789012345678901234567890"
1352
+ * });
1353
+ * if (response.responseCode === ReferrerDetailResponseCodes.Ok) {
1354
+ * if (response.data.type === ReferrerDetailTypeIds.Ranked) {
1355
+ * // TypeScript knows this is ReferrerDetailRanked
1356
+ * console.log(`Rank: ${response.data.referrer.rank}`);
1357
+ * console.log(`Qualified: ${response.data.referrer.isQualified}`);
1358
+ * console.log(`Award Pool Share: ${response.data.referrer.awardPoolShare * 100}%`);
1359
+ * } else {
1360
+ * // TypeScript knows this is ReferrerDetailUnranked
1361
+ * console.log("Referrer is not on the leaderboard (no referrals yet)");
1362
+ * }
1363
+ * }
1364
+ * ```
1365
+ *
1366
+ * @example
1367
+ * ```typescript
1368
+ * // Handle error response, ie. when Referrer Detail is not currently available.
1369
+ * const response = await client.getReferrerDetail({
1370
+ * referrer: "0x1234567890123456789012345678901234567890"
1371
+ * });
1372
+ *
1373
+ * if (response.responseCode === ReferrerDetailResponseCodes.Error) {
1374
+ * console.error(response.error);
1375
+ * console.error(response.errorMessage);
1376
+ * }
1377
+ * ```
1378
+ */
1379
+ async getReferrerDetail(request) {
1380
+ const url = new URL(
1381
+ `/api/ensanalytics/referrers/${encodeURIComponent(request.referrer)}`,
1382
+ this.options.url
1383
+ );
1384
+ const response = await fetch(url);
1385
+ let responseData;
1386
+ try {
1387
+ responseData = await response.json();
1388
+ } catch {
1389
+ throw new Error("Malformed response data: invalid JSON");
1390
+ }
1391
+ return deserializeReferrerDetailResponse(responseData);
1392
+ }
1393
+ };
1394
+
1395
+ // src/currency.ts
1396
+ function isValidUSDQuantity(value) {
1397
+ return isFiniteNonNegativeNumber(value);
1398
+ }
1399
+ function validateUSDQuantity(value) {
1400
+ if (!isValidUSDQuantity(value)) {
1401
+ throw new Error(`Invalid USD quantity: ${value}.`);
1402
+ }
1403
+ }
1404
+
369
1405
  // src/leaderboard.ts
370
1406
  var buildReferrerLeaderboard = (allReferrers, rules, accurateAsOf) => {
371
1407
  const uniqueReferrers = allReferrers.map((referrer) => referrer.referrer);
@@ -401,159 +1437,14 @@ var buildReferrerLeaderboard = (allReferrers, rules, accurateAsOf) => {
401
1437
  };
402
1438
  };
403
1439
 
404
- // src/leaderboard-page.ts
405
- var REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT = 25;
406
- var REFERRERS_PER_LEADERBOARD_PAGE_MAX = 100;
407
- var validateReferrerLeaderboardPageParams = (params) => {
408
- if (params.page !== void 0 && !isPositiveInteger(params.page)) {
409
- throw new Error(
410
- `Invalid ReferrerLeaderboardPageParams: ${params.page}. page must be a positive integer.`
411
- );
412
- }
413
- if (params.recordsPerPage !== void 0 && !isPositiveInteger(params.recordsPerPage)) {
414
- throw new Error(
415
- `Invalid ReferrerLeaderboardPageParams: ${params.recordsPerPage}. recordsPerPage must be a positive integer.`
416
- );
417
- }
418
- if (params.recordsPerPage !== void 0 && params.recordsPerPage > REFERRERS_PER_LEADERBOARD_PAGE_MAX) {
419
- throw new Error(
420
- `Invalid ReferrerLeaderboardPageParams: ${params.recordsPerPage}. recordsPerPage must be less than or equal to ${REFERRERS_PER_LEADERBOARD_PAGE_MAX}.`
421
- );
422
- }
423
- };
424
- var buildReferrerLeaderboardPageParams = (params) => {
425
- const result = {
426
- page: params.page ?? 1,
427
- recordsPerPage: params.recordsPerPage ?? REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT
428
- };
429
- validateReferrerLeaderboardPageParams(result);
430
- return result;
431
- };
432
- var validateReferrerLeaderboardPageContext = (context) => {
433
- validateReferrerLeaderboardPageParams(context);
434
- if (!isNonNegativeInteger(context.totalRecords)) {
435
- throw new Error(
436
- `Invalid ReferrerLeaderboardPageContext: total must be a non-negative integer but is ${context.totalRecords}.`
437
- );
438
- }
439
- const startIndex = (context.page - 1) * context.recordsPerPage;
440
- const endIndex = startIndex + context.recordsPerPage;
441
- if (!context.hasNext && endIndex < context.totalRecords) {
442
- throw new Error(
443
- `Invalid ReferrerLeaderboardPageContext: if hasNext is false, endIndex (${endIndex}) must be greater than or equal to total (${context.totalRecords}).`
444
- );
445
- } else if (context.hasNext && context.page * context.recordsPerPage >= context.totalRecords) {
446
- throw new Error(
447
- `Invalid ReferrerLeaderboardPageContext: if hasNext is true, endIndex (${endIndex}) must be less than total (${context.totalRecords}).`
448
- );
449
- }
450
- if (!context.hasPrev && context.page !== 1) {
451
- throw new Error(
452
- `Invalid ReferrerLeaderboardPageContext: if hasPrev is false, page must be the first page (1) but is ${context.page}.`
453
- );
454
- } else if (context.hasPrev && context.page === 1) {
455
- throw new Error(
456
- `Invalid ReferrerLeaderboardPageContext: if hasPrev is true, page must not be the first page (1) but is ${context.page}.`
457
- );
458
- }
459
- };
460
- var buildReferrerLeaderboardPageContext = (optionalParams, leaderboard) => {
461
- const materializedParams = buildReferrerLeaderboardPageParams(optionalParams);
462
- const totalRecords = leaderboard.referrers.size;
463
- const totalPages = Math.max(1, Math.ceil(totalRecords / materializedParams.recordsPerPage));
464
- if (materializedParams.page > totalPages) {
465
- throw new Error(
466
- `Invalid ReferrerLeaderboardPageContext: page ${materializedParams.page} exceeds total pages ${totalPages}.`
467
- );
468
- }
469
- if (totalRecords === 0) {
470
- return {
471
- ...materializedParams,
472
- totalRecords: 0,
473
- totalPages: 1,
474
- hasNext: false,
475
- hasPrev: false,
476
- startIndex: void 0,
477
- endIndex: void 0
478
- };
479
- }
480
- const startIndex = (materializedParams.page - 1) * materializedParams.recordsPerPage;
481
- const maxTheoreticalIndexOnPage = startIndex + (materializedParams.recordsPerPage - 1);
482
- const endIndex = Math.min(maxTheoreticalIndexOnPage, totalRecords - 1);
483
- const hasNext = maxTheoreticalIndexOnPage < totalRecords - 1;
484
- const hasPrev = materializedParams.page > 1;
485
- const result = {
486
- ...materializedParams,
487
- totalRecords,
488
- totalPages,
489
- hasNext,
490
- hasPrev,
491
- startIndex,
492
- endIndex
493
- };
494
- validateReferrerLeaderboardPageContext(result);
495
- return result;
496
- };
497
- var getReferrerLeaderboardPage = (pageParams, leaderboard) => {
498
- const pageContext = buildReferrerLeaderboardPageContext(pageParams, leaderboard);
499
- let referrers;
500
- if (pageContext.totalRecords > 0 && typeof pageContext.startIndex !== "undefined" && typeof pageContext.endIndex !== "undefined") {
501
- referrers = Array.from(leaderboard.referrers.values()).slice(
502
- pageContext.startIndex,
503
- pageContext.endIndex + 1
504
- // For `slice`, this is exclusive of the element at the index 'end'. We need it to be inclusive, hence plus one.
505
- );
506
- } else {
507
- referrers = [];
508
- }
509
- return {
510
- rules: leaderboard.rules,
511
- referrers,
512
- aggregatedMetrics: leaderboard.aggregatedMetrics,
513
- pageContext,
514
- accurateAsOf: leaderboard.accurateAsOf
515
- };
516
- };
517
-
518
1440
  // src/link.ts
519
- import { getAddress as getAddress2 } from "viem";
1441
+ import { getAddress } from "viem";
520
1442
  function buildEnsReferralUrl(address) {
521
1443
  const ensAppUrl = new URL("https://app.ens.domains");
522
- ensAppUrl.searchParams.set("referrer", getAddress2(address));
1444
+ ensAppUrl.searchParams.set("referrer", getAddress(address));
523
1445
  return ensAppUrl;
524
1446
  }
525
1447
 
526
- // src/referrer-detail.ts
527
- var ReferrerDetailTypeIds = {
528
- /**
529
- * Represents a referrer who is ranked on the leaderboard.
530
- */
531
- Ranked: "ranked",
532
- /**
533
- * Represents a referrer who is not ranked on the leaderboard.
534
- */
535
- Unranked: "unranked"
536
- };
537
- var getReferrerDetail = (referrer, leaderboard) => {
538
- const awardedReferrerMetrics = leaderboard.referrers.get(referrer);
539
- if (awardedReferrerMetrics) {
540
- return {
541
- type: ReferrerDetailTypeIds.Ranked,
542
- rules: leaderboard.rules,
543
- referrer: awardedReferrerMetrics,
544
- aggregatedMetrics: leaderboard.aggregatedMetrics,
545
- accurateAsOf: leaderboard.accurateAsOf
546
- };
547
- }
548
- return {
549
- type: ReferrerDetailTypeIds.Unranked,
550
- rules: leaderboard.rules,
551
- referrer: buildUnrankedReferrerMetrics(referrer),
552
- aggregatedMetrics: leaderboard.aggregatedMetrics,
553
- accurateAsOf: leaderboard.accurateAsOf
554
- };
555
- };
556
-
557
1448
  // src/rules.ts
558
1449
  var ENS_HOLIDAY_AWARDS_START_DATE = 1764547200;
559
1450
  var ENS_HOLIDAY_AWARDS_END_DATE = 1767225599;
@@ -603,22 +1494,21 @@ var calcReferralProgramStatus = (referralProgramRules, now) => {
603
1494
  return ReferralProgramStatuses.Active;
604
1495
  };
605
1496
  export {
606
- ENCODED_REFERRER_BYTE_LENGTH,
607
- ENCODED_REFERRER_BYTE_OFFSET,
1497
+ DEFAULT_ENSNODE_API_URL,
1498
+ ENSReferralsClient,
608
1499
  ENS_HOLIDAY_AWARDS_END_DATE,
609
1500
  ENS_HOLIDAY_AWARDS_MAX_QUALIFIED_REFERRERS,
610
1501
  ENS_HOLIDAY_AWARDS_START_DATE,
611
1502
  ENS_HOLIDAY_AWARDS_TOTAL_AWARD_POOL_VALUE,
612
- EXPECTED_ENCODED_REFERRER_PADDING,
613
1503
  REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT,
614
1504
  REFERRERS_PER_LEADERBOARD_PAGE_MAX,
615
1505
  ReferralProgramStatuses,
1506
+ ReferrerDetailResponseCodes,
616
1507
  ReferrerDetailTypeIds,
1508
+ ReferrerLeaderboardPageResponseCodes,
617
1509
  SECONDS_PER_YEAR,
618
- ZERO_ENCODED_REFERRER,
619
1510
  buildAggregatedReferrerMetrics,
620
1511
  buildAwardedReferrerMetrics,
621
- buildEncodedReferrer,
622
1512
  buildEnsReferralUrl,
623
1513
  buildRankedReferrerMetrics,
624
1514
  buildReferralProgramRules,
@@ -635,7 +1525,8 @@ export {
635
1525
  calcReferrerFinalScoreMultiplier,
636
1526
  calcReferrerScore,
637
1527
  compareReferrerMetrics,
638
- decodeEncodedReferrer,
1528
+ deserializeReferrerDetailResponse,
1529
+ deserializeReferrerLeaderboardPageResponse,
639
1530
  getReferrerDetail,
640
1531
  getReferrerLeaderboardPage,
641
1532
  isFiniteNonNegativeNumber,
@@ -648,6 +1539,8 @@ export {
648
1539
  isValidRevenueContribution,
649
1540
  isValidUSDQuantity,
650
1541
  normalizeAddress,
1542
+ serializeReferrerDetailResponse,
1543
+ serializeReferrerLeaderboardPageResponse,
651
1544
  sortReferrerMetrics,
652
1545
  validateAggregatedReferrerMetrics,
653
1546
  validateAwardedReferrerMetrics,