@namehash/ens-referrals 0.0.0-next-20260116185203 → 0.0.0-next-20260119132859

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { Address, Hex } from 'viem';
+import { Address } from 'viem';
+import { UnixTimestamp, AccountId, Duration } from '@ensnode/ensnode-sdk';
 
 declare const validateLowercaseAddress: (address: Address) => void;
 declare const normalizeAddress: (address: Address) => Address;
@@ -12,35 +13,6 @@ type USDQuantity = number;
 declare function isValidUSDQuantity(value: USDQuantity): boolean;
 declare function validateUSDQuantity(value: USDQuantity): void;
 
-/**
- * Unix timestamp value
- *
- * Represents the number of seconds that have elapsed
- * since January 1, 1970 (midnight UTC/GMT). May be zero or negative to represent a time at or
- * before Jan 1, 1970.
- *
- * @invariant Guaranteed to be an integer.
- */
-type UnixTimestamp = number;
-declare const validateUnixTimestamp: (timestamp: UnixTimestamp) => void;
-/**
- * Duration
- *
- * Represents a duration in seconds.
- *
- * Guaranteed to be a non-negative integer.
- */
-type Duration = number;
-/**
- * The number of seconds in a year.
- *
- * (60 seconds per minute * 60 minutes per hour *
- *  24 hours per day * 365.2425 days on average per year).
- */
-declare const SECONDS_PER_YEAR: Duration;
-declare function isValidDuration(duration: Duration): boolean;
-declare function validateDuration(duration: Duration): void;
-
 /**
  * Start date for the ENS Holiday Awards referral program.
  * 2025-12-01T00:00:00Z (December 1, 2025 at 00:00:00 UTC)
@@ -59,22 +31,6 @@ declare const ENS_HOLIDAY_AWARDS_MAX_QUALIFIED_REFERRERS = 10;
  * The total value of the award pool in USD.
  */
 declare const ENS_HOLIDAY_AWARDS_TOTAL_AWARD_POOL_VALUE: USDQuantity;
-/**
- * Chain ID
- *
- * Represents a unique identifier for a chain.
- * Guaranteed to be a positive integer.
- **/
-type ChainId = number;
-/**
- * Represents an account (contract or EOA) at `address` on chain `chainId`.
- *
- * @see https://chainagnostic.org/CAIPs/caip-10
- */
-interface AccountId {
-    chainId: ChainId;
-    address: Address;
-}
 interface ReferralProgramRules {
     /**
      * The total value of the award pool in USD.
@@ -381,57 +337,6 @@ interface AggregatedReferrerMetrics {
 declare const validateAggregatedReferrerMetrics: (metrics: AggregatedReferrerMetrics) => void;
 declare const buildAggregatedReferrerMetrics: (referrers: RankedReferrerMetrics[], rules: ReferralProgramRules) => AggregatedReferrerMetrics;
 
-/**
- * Encoded Referrer
- *
- * Represents a "raw" ENS referrer value.
- *
- * Guaranteed to be a hex string representation of a 32-byte value.
- * For ENS Holiday Awards a correctly encoded referrer is
- * a left-padded lowercase EVM address.
- */
-type EncodedReferrer = Hex;
-/**
- * Encoded Referrer byte offset for ENS Holiday Awards.
- *
- * The count of left-padded bytes in an {@link EncodedReferrer} value for ENS Holiday Awards.
- */
-declare const ENCODED_REFERRER_BYTE_OFFSET = 12;
-/**
- * Encoded Referrer byte length
- *
- * The count of bytes the {@link EncodedReferrer} value consists of.
- */
-declare const ENCODED_REFERRER_BYTE_LENGTH = 32;
-/**
- * Encoded Referrer Padding for ENS Holiday Awards
- *
- * The initial bytes of correctly encoded referrer value for ENS Holiday Awards.
- */
-declare const EXPECTED_ENCODED_REFERRER_PADDING: Hex;
-/**
- * Zero Encoded Referrer
- *
- * Guaranteed to be a hex string representation of a 32-byte zero value.
- */
-declare const ZERO_ENCODED_REFERRER: EncodedReferrer;
-/**
- * Build an {@link EncodedReferrer} value for the given {@link Address}
- * according to the subjective referrer encoding used for ENS Holiday Awards.
- */
-declare function buildEncodedReferrer(address: Address): EncodedReferrer;
-/**
- * Decode an {@link EncodedReferrer} value into a checksummed {@link Address}
- * according to the subjective referrer encoding used for ENS Holiday Awards.
- *
- * @param encodedReferrer - The "raw" {@link EncodedReferrer} value to decode.
- * @returns The decoded referrer checksummed address.
- * @throws when encodedReferrer value is not represented by
- *         {@link ENCODED_REFERRER_BYTE_LENGTH} bytes.
- * @throws when decodedReferrer is not a valid EVM address.
- */
-declare function decodeEncodedReferrer(encodedReferrer: EncodedReferrer): Address;
-
 /**
  * Represents a leaderboard for any number of referrers.
  */
@@ -567,18 +472,6 @@ interface ReferrerLeaderboardPage {
 }
 declare const getReferrerLeaderboardPage: (pageParams: ReferrerLeaderboardPageParams, leaderboard: ReferrerLeaderboard) => ReferrerLeaderboardPage;
 
-/**
- * Build a URL to the official ENS manager app
- * where the given {@link Address} is set as the referrer.
- */
-declare function buildEnsReferralUrl(address: Address): URL;
-
-declare const isInteger: (value: number) => boolean;
-declare const isNonNegativeInteger: (value: number) => boolean;
-declare const isPositiveInteger: (value: number) => boolean;
-declare const validateNonNegativeInteger: (value: number) => void;
-declare const isFiniteNonNegativeNumber: (value: number) => boolean;
-
 /**
  * The type of referrer detail data.
  */
@@ -684,6 +577,396 @@ type ReferrerDetail = ReferrerDetailRanked | ReferrerDetailUnranked;
  */
 declare const getReferrerDetail: (referrer: Address, leaderboard: ReferrerLeaderboard) => ReferrerDetail;
 
+/**
+ * Request parameters for a referrer leaderboard page query.
+ */
+interface ReferrerLeaderboardPageRequest extends ReferrerLeaderboardPageParams {
+}
+/**
+ * A status code for a referrer leaderboard page API response.
+ */
+declare const ReferrerLeaderboardPageResponseCodes: {
+    /**
+     * Represents that the requested referrer leaderboard page is available.
+     */
+    readonly Ok: "ok";
+    /**
+     * Represents that the referrer leaderboard data is not available.
+     */
+    readonly Error: "error";
+};
+/**
+ * The derived string union of possible {@link ReferrerLeaderboardPageResponseCodes}.
+ */
+type ReferrerLeaderboardPageResponseCode = (typeof ReferrerLeaderboardPageResponseCodes)[keyof typeof ReferrerLeaderboardPageResponseCodes];
+/**
+ * A referrer leaderboard page response when the data is available.
+ */
+type ReferrerLeaderboardPageResponseOk = {
+    responseCode: typeof ReferrerLeaderboardPageResponseCodes.Ok;
+    data: ReferrerLeaderboardPage;
+};
+/**
+ * A referrer leaderboard page response when the data is not available.
+ */
+type ReferrerLeaderboardPageResponseError = {
+    responseCode: typeof ReferrerLeaderboardPageResponseCodes.Error;
+    error: string;
+    errorMessage: string;
+};
+/**
+ * A referrer leaderboard page API response.
+ *
+ * Use the `responseCode` field to determine the specific type interpretation
+ * at runtime.
+ */
+type ReferrerLeaderboardPageResponse = ReferrerLeaderboardPageResponseOk | ReferrerLeaderboardPageResponseError;
+/**
+ * Request parameters for referrer detail query.
+ */
+interface ReferrerDetailRequest {
+    /** The Ethereum address of the referrer to query */
+    referrer: Address;
+}
+/**
+ * A status code for referrer detail API responses.
+ */
+declare const ReferrerDetailResponseCodes: {
+    /**
+     * Represents that the referrer detail data is available.
+     */
+    readonly Ok: "ok";
+    /**
+     * Represents that an error occurred while fetching the data.
+     */
+    readonly Error: "error";
+};
+/**
+ * The derived string union of possible {@link ReferrerDetailResponseCodes}.
+ */
+type ReferrerDetailResponseCode = (typeof ReferrerDetailResponseCodes)[keyof typeof ReferrerDetailResponseCodes];
+/**
+ * A referrer detail response when the data is available for a referrer on the leaderboard.
+ */
+type ReferrerDetailResponseOk = {
+    responseCode: typeof ReferrerDetailResponseCodes.Ok;
+    data: ReferrerDetail;
+};
+/**
+ * A referrer detail response when an error occurs.
+ */
+type ReferrerDetailResponseError = {
+    responseCode: typeof ReferrerDetailResponseCodes.Error;
+    error: string;
+    errorMessage: string;
+};
+/**
+ * A referrer detail API response.
+ *
+ * Use the `responseCode` field to determine the specific type interpretation
+ * at runtime.
+ */
+type ReferrerDetailResponse = ReferrerDetailResponseOk | ReferrerDetailResponseError;
+
+/**
+ * Serialized representation of {@link RevenueContribution}.
+ *
+ * RevenueContribution is a bigint, which is serialized as a string for JSON compatibility.
+ */
+type SerializedRevenueContribution = string;
+/**
+ * Serialized representation of {@link ReferralProgramRules}.
+ *
+ * Note: All fields are already serializable primitives, so this type is identical to the source type.
+ */
+type SerializedReferralProgramRules = ReferralProgramRules;
+/**
+ * Serialized representation of {@link AwardedReferrerMetrics}.
+ */
+interface SerializedAwardedReferrerMetrics extends Omit<AwardedReferrerMetrics, "totalRevenueContribution"> {
+    totalRevenueContribution: SerializedRevenueContribution;
+}
+/**
+ * Serialized representation of {@link UnrankedReferrerMetrics}.
+ */
+interface SerializedUnrankedReferrerMetrics extends Omit<UnrankedReferrerMetrics, "totalRevenueContribution"> {
+    totalRevenueContribution: SerializedRevenueContribution;
+}
+/**
+ * Serialized representation of {@link AggregatedReferrerMetrics}.
+ */
+interface SerializedAggregatedReferrerMetrics extends Omit<AggregatedReferrerMetrics, "grandTotalRevenueContribution"> {
+    grandTotalRevenueContribution: SerializedRevenueContribution;
+}
+/**
+ * Serialized representation of {@link ReferrerLeaderboardPage}.
+ */
+interface SerializedReferrerLeaderboardPage extends Omit<ReferrerLeaderboardPage, "referrers" | "aggregatedMetrics"> {
+    referrers: SerializedAwardedReferrerMetrics[];
+    aggregatedMetrics: SerializedAggregatedReferrerMetrics;
+}
+/**
+ * Serialized representation of {@link ReferrerDetailRanked}.
+ */
+interface SerializedReferrerDetailRanked extends Omit<ReferrerDetailRanked, "referrer" | "aggregatedMetrics"> {
+    referrer: SerializedAwardedReferrerMetrics;
+    aggregatedMetrics: SerializedAggregatedReferrerMetrics;
+}
+/**
+ * Serialized representation of {@link ReferrerDetailUnranked}.
+ */
+interface SerializedReferrerDetailUnranked extends Omit<ReferrerDetailUnranked, "referrer" | "aggregatedMetrics"> {
+    referrer: SerializedUnrankedReferrerMetrics;
+    aggregatedMetrics: SerializedAggregatedReferrerMetrics;
+}
+/**
+ * Serialized representation of {@link ReferrerDetail} (union of ranked and unranked).
+ */
+type SerializedReferrerDetail = SerializedReferrerDetailRanked | SerializedReferrerDetailUnranked;
+/**
+ * Serialized representation of {@link ReferrerLeaderboardPageResponseError}.
+ *
+ * Note: All fields are already serializable, so this type is identical to the source type.
+ */
+type SerializedReferrerLeaderboardPageResponseError = ReferrerLeaderboardPageResponseError;
+/**
+ * Serialized representation of {@link ReferrerLeaderboardPageResponseOk}.
+ */
+interface SerializedReferrerLeaderboardPageResponseOk extends Omit<ReferrerLeaderboardPageResponseOk, "data"> {
+    data: SerializedReferrerLeaderboardPage;
+}
+/**
+ * Serialized representation of {@link ReferrerLeaderboardPageResponse}.
+ */
+type SerializedReferrerLeaderboardPageResponse = SerializedReferrerLeaderboardPageResponseOk | SerializedReferrerLeaderboardPageResponseError;
+/**
+ * Serialized representation of {@link ReferrerDetailResponseError}.
+ *
+ * Note: All fields are already serializable, so this type is identical to the source type.
+ */
+type SerializedReferrerDetailResponseError = ReferrerDetailResponseError;
+/**
+ * Serialized representation of {@link ReferrerDetailResponseOk}.
+ */
+interface SerializedReferrerDetailResponseOk extends Omit<ReferrerDetailResponseOk, "data"> {
+    data: SerializedReferrerDetail;
+}
+/**
+ * Serialized representation of {@link ReferrerDetailResponse}.
+ */
+type SerializedReferrerDetailResponse = SerializedReferrerDetailResponseOk | SerializedReferrerDetailResponseError;
+
+/**
+ * Deserialize a {@link ReferrerLeaderboardPageResponse} object.
+ *
+ * Note: This function explicitly deserializes each subobject to convert string
+ * RevenueContribution values back to bigint, then validates using Zod schemas
+ * to enforce invariants on the data.
+ */
+declare function deserializeReferrerLeaderboardPageResponse(maybeResponse: SerializedReferrerLeaderboardPageResponse, valueLabel?: string): ReferrerLeaderboardPageResponse;
+/**
+ * Deserialize a {@link ReferrerDetailResponse} object.
+ *
+ * Note: This function explicitly deserializes each subobject to convert string
+ * RevenueContribution values back to bigint, then validates using Zod schemas
+ * to enforce invariants on the data.
+ */
+declare function deserializeReferrerDetailResponse(maybeResponse: SerializedReferrerDetailResponse, valueLabel?: string): ReferrerDetailResponse;
+
+/**
+ * Serialize a {@link ReferrerLeaderboardPageResponse} object.
+ */
+declare function serializeReferrerLeaderboardPageResponse(response: ReferrerLeaderboardPageResponse): SerializedReferrerLeaderboardPageResponse;
+/**
+ * Serialize a {@link ReferrerDetailResponse} object.
+ */
+declare function serializeReferrerDetailResponse(response: ReferrerDetailResponse): SerializedReferrerDetailResponse;
+
+/**
+ * Default ENSNode API endpoint URL
+ */
+declare const DEFAULT_ENSNODE_API_URL: "https://api.alpha.ensnode.io";
+/**
+ * Configuration options for ENS Referrals API client
+ */
+interface ClientOptions {
+    /** The ENSNode API URL */
+    url: URL;
+}
+/**
+ * ENS Referrals API Client
+ *
+ * Provides access to ENS Referrals data and leaderboard information.
+ *
+ * @example
+ * ```typescript
+ * // Create client with default options
+ * const client = new ENSReferralsClient();
+ *
+ * // Get referrer leaderboard
+ * const leaderboardPage = await client.getReferrerLeaderboardPage({
+ *   page: 1,
+ *   recordsPerPage: 25
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Custom configuration
+ * const client = new ENSReferralsClient({
+ *   url: new URL("https://my-ensnode-instance.com"),
+ * });
+ * ```
+ */
+declare class ENSReferralsClient {
+    private readonly options;
+    static defaultOptions(): ClientOptions;
+    constructor(options?: Partial<ClientOptions>);
+    getOptions(): Readonly<ClientOptions>;
+    /**
+     * Fetch Referrer Leaderboard Page
+     *
+     * Retrieves a paginated list of referrer leaderboard metrics with contribution percentages.
+     * Each referrer's contribution is calculated as a percentage of the grand totals across all referrers.
+     *
+     * @param request - Pagination parameters
+     * @param request.page - The page number to retrieve (1-indexed, default: 1)
+     * @param request.recordsPerPage - Number of records per page (default: 25, max: 100)
+     * @returns {ReferrerLeaderboardPageResponse}
+     *
+     * @throws if the ENSNode request fails
+     * @throws if the ENSNode API returns an error response
+     * @throws if the ENSNode response breaks required invariants
+     *
+     * @example
+     * ```typescript
+     * // Get first page with default page size (25 records)
+     * const response = await client.getReferrerLeaderboardPage();
+     * if (response.responseCode === ReferrerLeaderboardPageResponseCodes.Ok) {
+     *   const {
+     *     aggregatedMetrics,
+     *     referrers,
+     *     rules,
+     *     pageContext,
+     *     updatedAt
+     *   } = response.data;
+     *   console.log(aggregatedMetrics);
+     *   console.log(referrers);
+     *   console.log(rules);
+     *   console.log(updatedAt);
+     *   console.log(`Page ${pageContext.page} of ${pageContext.totalPages}`);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Get second page with 50 records per page
+     * const response = await client.getReferrerLeaderboardPage({ page: 2, recordsPerPage: 50 });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Handle error response, ie. when Referrer Leaderboard is not currently available.
+     * const response = await client.getReferrerLeaderboardPage();
+     *
+     * if (response.responseCode === ReferrerLeaderboardPageResponseCodes.Error) {
+     *   console.error(response.error);
+     *   console.error(response.errorMessage);
+     * }
+     * ```
+     */
+    getReferrerLeaderboardPage(request?: ReferrerLeaderboardPageRequest): Promise<ReferrerLeaderboardPageResponse>;
+    /**
+     * Fetch Referrer Detail
+     *
+     * Retrieves detailed information about a specific referrer, whether they are on the
+     * leaderboard or not.
+     *
+     * The response data is a discriminated union type with a `type` field:
+     *
+     * **For referrers on the leaderboard** (`ReferrerDetailRanked`):
+     * - `type`: {@link ReferrerDetailTypeIds.Ranked}
+     * - `referrer`: The `AwardedReferrerMetrics` from @namehash/ens-referrals
+     * - `rules`: The referral program rules
+     * - `aggregatedMetrics`: Aggregated metrics for all referrers on the leaderboard
+     * - `accurateAsOf`: Unix timestamp indicating when the data was last updated
+     *
+     * **For referrers NOT on the leaderboard** (`ReferrerDetailUnranked`):
+     * - `type`: {@link ReferrerDetailTypeIds.Unranked}
+     * - `referrer`: The `UnrankedReferrerMetrics` from @namehash/ens-referrals
+     * - `rules`: The referral program rules
+     * - `aggregatedMetrics`: Aggregated metrics for all referrers on the leaderboard
+     * - `accurateAsOf`: Unix timestamp indicating when the data was last updated
+     *
+     * @see {@link https://www.npmjs.com/package/@namehash/ens-referrals|@namehash/ens-referrals} for calculation details
+     *
+     * @param request The referrer address to query
+     * @returns {ReferrerDetailResponse} Returns the referrer detail response
+     *
+     * @throws if the ENSNode request fails
+     * @throws if the response data is malformed
+     *
+     * @example
+     * ```typescript
+     * // Get referrer detail for a specific address
+     * const response = await client.getReferrerDetail({
+     *   referrer: "0x1234567890123456789012345678901234567890"
+     * });
+     * if (response.responseCode === ReferrerDetailResponseCodes.Ok) {
+     *   const { type, referrer, rules, aggregatedMetrics, accurateAsOf } = response.data;
+     *   console.log(type); // ReferrerDetailTypeIds.Ranked or ReferrerDetailTypeIds.Unranked
+     *   console.log(referrer);
+     *   console.log(accurateAsOf);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Use discriminated union to check if referrer is ranked
+     * const response = await client.getReferrerDetail({
+     *   referrer: "0x1234567890123456789012345678901234567890"
+     * });
+     * if (response.responseCode === ReferrerDetailResponseCodes.Ok) {
+     *   if (response.data.type === ReferrerDetailTypeIds.Ranked) {
+     *     // TypeScript knows this is ReferrerDetailRanked
+     *     console.log(`Rank: ${response.data.referrer.rank}`);
+     *     console.log(`Qualified: ${response.data.referrer.isQualified}`);
+     *     console.log(`Award Pool Share: ${response.data.referrer.awardPoolShare * 100}%`);
+     *   } else {
+     *     // TypeScript knows this is ReferrerDetailUnranked
+     *     console.log("Referrer is not on the leaderboard (no referrals yet)");
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Handle error response, ie. when Referrer Detail is not currently available.
+     * const response = await client.getReferrerDetail({
+     *   referrer: "0x1234567890123456789012345678901234567890"
+     * });
+     *
+     * if (response.responseCode === ReferrerDetailResponseCodes.Error) {
+     *   console.error(response.error);
+     *   console.error(response.errorMessage);
+     * }
+     * ```
+     */
+    getReferrerDetail(request: ReferrerDetailRequest): Promise<ReferrerDetailResponse>;
+}
+
+/**
+ * Build a URL to the official ENS manager app
+ * where the given {@link Address} is set as the referrer.
+ */
+declare function buildEnsReferralUrl(address: Address): URL;
+
+declare const isInteger: (value: number) => boolean;
+declare const isNonNegativeInteger: (value: number) => boolean;
+declare const isPositiveInteger: (value: number) => boolean;
+declare const validateNonNegativeInteger: (value: number) => void;
+declare const isFiniteNonNegativeNumber: (value: number) => boolean;
+
 /**
  * The type of referral program's status.
  */
@@ -716,4 +999,15 @@ type ReferralProgramStatusId = (typeof ReferralProgramStatuses)[keyof typeof Ref
  */
 declare const calcReferralProgramStatus: (referralProgramRules: ReferralProgramRules, now: UnixTimestamp) => ReferralProgramStatusId;
 
-export { type AccountId, type AggregatedReferrerMetrics, type AwardedReferrerMetrics, type ChainId, type Duration, ENCODED_REFERRER_BYTE_LENGTH, ENCODED_REFERRER_BYTE_OFFSET, ENS_HOLIDAY_AWARDS_END_DATE, ENS_HOLIDAY_AWARDS_MAX_QUALIFIED_REFERRERS, ENS_HOLIDAY_AWARDS_START_DATE, ENS_HOLIDAY_AWARDS_TOTAL_AWARD_POOL_VALUE, EXPECTED_ENCODED_REFERRER_PADDING, type EncodedReferrer, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetrics, type ReferralProgramRules, type ReferralProgramStatusId, ReferralProgramStatuses, type ReferrerDetail, type ReferrerDetailRanked, type ReferrerDetailTypeId, ReferrerDetailTypeIds, type ReferrerDetailUnranked, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerMetrics, type ReferrerMetricsForComparison, type ReferrerRank, type ReferrerScore, type RevenueContribution, SECONDS_PER_YEAR, type ScoredReferrerMetrics, type USDQuantity, type UnixTimestamp, type UnrankedReferrerMetrics, ZERO_ENCODED_REFERRER, buildAggregatedReferrerMetrics, buildAwardedReferrerMetrics, buildEncodedReferrer, buildEnsReferralUrl, buildRankedReferrerMetrics, buildReferralProgramRules, buildReferrerLeaderboard, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerMetrics, buildScoredReferrerMetrics, buildUnrankedReferrerMetrics, calcReferralProgramStatus, calcReferrerAwardPoolShare, calcReferrerFinalScore, calcReferrerFinalScoreBoost, calcReferrerFinalScoreMultiplier, calcReferrerScore, compareReferrerMetrics, decodeEncodedReferrer, getReferrerDetail, getReferrerLeaderboardPage, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualified, isValidDuration, isValidReferrerScore, isValidRevenueContribution, isValidUSDQuantity, normalizeAddress, sortReferrerMetrics, validateAggregatedReferrerMetrics, validateAwardedReferrerMetrics, validateDuration, validateLowercaseAddress, validateNonNegativeInteger, validateRankedReferrerMetrics, validateReferralProgramRules, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerRank, validateReferrerScore, validateRevenueContribution, validateScoredReferrerMetrics, validateUSDQuantity, validateUnixTimestamp, validateUnrankedReferrerMetrics };
+declare const validateUnixTimestamp: (timestamp: UnixTimestamp) => void;
+/**
+ * The number of seconds in a year.
+ *
+ * (60 seconds per minute * 60 minutes per hour *
+ *  24 hours per day * 365.2425 days on average per year).
+ */
+declare const SECONDS_PER_YEAR: Duration;
+declare function isValidDuration(duration: Duration): boolean;
+declare function validateDuration(duration: Duration): void;
+
+export { type AggregatedReferrerMetrics, type AwardedReferrerMetrics, type ClientOptions, DEFAULT_ENSNODE_API_URL, ENSReferralsClient, ENS_HOLIDAY_AWARDS_END_DATE, ENS_HOLIDAY_AWARDS_MAX_QUALIFIED_REFERRERS, ENS_HOLIDAY_AWARDS_START_DATE, ENS_HOLIDAY_AWARDS_TOTAL_AWARD_POOL_VALUE, REFERRERS_PER_LEADERBOARD_PAGE_DEFAULT, REFERRERS_PER_LEADERBOARD_PAGE_MAX, type RankedReferrerMetrics, type ReferralProgramRules, type ReferralProgramStatusId, ReferralProgramStatuses, type ReferrerDetail, type ReferrerDetailRanked, type ReferrerDetailRequest, type ReferrerDetailResponse, type ReferrerDetailResponseCode, ReferrerDetailResponseCodes, type ReferrerDetailResponseError, type ReferrerDetailResponseOk, type ReferrerDetailTypeId, ReferrerDetailTypeIds, type ReferrerDetailUnranked, type ReferrerLeaderboard, type ReferrerLeaderboardPage, type ReferrerLeaderboardPageContext, type ReferrerLeaderboardPageParams, type ReferrerLeaderboardPageRequest, type ReferrerLeaderboardPageResponse, type ReferrerLeaderboardPageResponseCode, ReferrerLeaderboardPageResponseCodes, type ReferrerLeaderboardPageResponseError, type ReferrerLeaderboardPageResponseOk, type ReferrerMetrics, type ReferrerMetricsForComparison, type ReferrerRank, type ReferrerScore, type RevenueContribution, SECONDS_PER_YEAR, type ScoredReferrerMetrics, type SerializedAggregatedReferrerMetrics, type SerializedAwardedReferrerMetrics, type SerializedReferralProgramRules, type SerializedReferrerDetail, type SerializedReferrerDetailRanked, type SerializedReferrerDetailResponse, type SerializedReferrerDetailResponseError, type SerializedReferrerDetailResponseOk, type SerializedReferrerDetailUnranked, type SerializedReferrerLeaderboardPage, type SerializedReferrerLeaderboardPageResponse, type SerializedReferrerLeaderboardPageResponseError, type SerializedReferrerLeaderboardPageResponseOk, type SerializedRevenueContribution, type SerializedUnrankedReferrerMetrics, type USDQuantity, type UnrankedReferrerMetrics, buildAggregatedReferrerMetrics, buildAwardedReferrerMetrics, buildEnsReferralUrl, buildRankedReferrerMetrics, buildReferralProgramRules, buildReferrerLeaderboard, buildReferrerLeaderboardPageContext, buildReferrerLeaderboardPageParams, buildReferrerMetrics, buildScoredReferrerMetrics, buildUnrankedReferrerMetrics, calcReferralProgramStatus, calcReferrerAwardPoolShare, calcReferrerFinalScore, calcReferrerFinalScoreBoost, calcReferrerFinalScoreMultiplier, calcReferrerScore, compareReferrerMetrics, deserializeReferrerDetailResponse, deserializeReferrerLeaderboardPageResponse, getReferrerDetail, getReferrerLeaderboardPage, isFiniteNonNegativeNumber, isInteger, isNonNegativeInteger, isPositiveInteger, isReferrerQualified, isValidDuration, isValidReferrerScore, isValidRevenueContribution, isValidUSDQuantity, normalizeAddress, serializeReferrerDetailResponse, serializeReferrerLeaderboardPageResponse, sortReferrerMetrics, validateAggregatedReferrerMetrics, validateAwardedReferrerMetrics, validateDuration, validateLowercaseAddress, validateNonNegativeInteger, validateRankedReferrerMetrics, validateReferralProgramRules, validateReferrerLeaderboardPageContext, validateReferrerMetrics, validateReferrerRank, validateReferrerScore, validateRevenueContribution, validateScoredReferrerMetrics, validateUSDQuantity, validateUnixTimestamp, validateUnrankedReferrerMetrics };