@merkl/api 0.16.13 → 0.16.15

package/dist/src/modules/v4/opportunity/opportunity.service.d.ts

@@ -34,7 +34,7 @@ export declare abstract class OpportunityService {
         name: string;
         status: "SOON";
         action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | undefined;
+        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | undefined;
         depositUrl: any;
         tags: string[];
     }>;
@@ -46,20 +46,8 @@ export declare abstract class OpportunityService {
         name: string;
         status: "PAST" | "LIVE" | "SOON";
         action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
-        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | undefined;
+        tokens: any[];
+        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | undefined;
         depositUrl: any;
         tags: string[];
     }>;
@@ -83,7 +71,7 @@ export declare abstract class OpportunityService {
             verified: boolean;
             isTest: boolean;
         }[];
-        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | undefined;
+        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | undefined;
         depositUrl: string | undefined;
         tags: string[];
     }>;
@@ -98,20 +86,8 @@ export declare abstract class OpportunityService {
         name: string;
         status: "PAST" | "LIVE" | "SOON";
         action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
-        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | undefined;
+        tokens: any[];
+        mainProtocol: "morpho" | "euler" | "ambient" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswapv4" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | undefined;
         depositUrl: any;
         tags: string[];
     }>;
@@ -214,19 +190,7 @@ export declare abstract class OpportunityService {
                 id: number;
                 icon: string;
             };
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                id: string;
-                icon: string;
-                chainId: number;
-                address: string;
-                decimals: number;
-                verified: boolean;
-                isTest: boolean;
-            } & {
-                price?: number | null | undefined;
-            };
+            rewardToken: Token;
             distributionChain: {
                 name: string;
                 id: number;
@@ -318,19 +282,7 @@ export declare abstract class OpportunityService {
         };
         id: string;
         depositUrl: string | undefined;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
+        tokens: Token[];
         chain: {
             name: string;
             id: number;
@@ -406,19 +358,7 @@ export declare abstract class OpportunityService {
         };
         id: string;
         depositUrl: string | undefined;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
+        tokens: Token[];
         chain: {
             name: string;
             id: number;
@@ -449,19 +389,7 @@ export declare abstract class OpportunityService {
                 id: number;
                 icon: string;
             };
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                id: string;
-                icon: string;
-                chainId: number;
-                address: string;
-                decimals: number;
-                verified: boolean;
-                isTest: boolean;
-            } & {
-                price?: number | null | undefined;
-            };
+            rewardToken: Token;
             distributionChain: {
                 name: string;
                 id: number;
@@ -556,19 +484,7 @@ export declare abstract class OpportunityService {
         };
         id: string;
         depositUrl: string | undefined;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
+        tokens: Token[];
         chain: {
             name: string;
             id: number;
@@ -595,19 +511,7 @@ export declare abstract class OpportunityService {
     static formatResponseBase(opportunity: LightOpportunityFromDB): {
         id: string;
         depositUrl: string | undefined;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[];
+        tokens: Token[];
         chain: {
             name: string;
             id: number;

package/dist/src/modules/v4/opportunity/opportunity.service.js

@@ -1,15 +1,15 @@
 import { NotFoundError } from "../../../errors";
+import { TTLPresets } from "../cache/cache.model";
+import { CacheService } from "../cache/cache.service";
 import { CampaignService } from "../campaign";
+import { CampaignRepository } from "../campaign/campaign.repository";
+import { TokenService } from "../token/token.service";
+import { UserService } from "../user/user.service";
 import { log } from "../../../utils/logger";
 import { OpportunityAction, Prisma, Status } from "../../../../database/api/.generated";
 import { record } from "@elysiajs/opentelemetry";
 import { Campaign as CampaignEnum } from "@sdk";
 import moment from "moment";
-import { CacheService } from "../cache";
-import { TTLPresets } from "../cache/cache.model";
-import { CampaignRepository } from "../campaign/campaign.repository";
-import { TokenService } from "../token";
-import { UserService } from "../user";
 import { OpportunityRepository } from "./opportunity.repository";
 import { getAjnaMetadata } from "./subservices/getAjnaMetadata.service";
 import { getAmbientMetadata } from "./subservices/getAmbientMetadata.service";
@@ -18,6 +18,7 @@ import { getClammMetadata } from "./subservices/getClammMetadata.service";
 import { getCompoundMetadata } from "./subservices/getCompoundMetadata.service";
 import { getDolomiteMetadata } from "./subservices/getDolomiteMetadata.service";
 import { getEigenLayerMetadata } from "./subservices/getEigenLayerMetadata.service";
+import { getEncompassingMetadata } from "./subservices/getEncompassingMetadata.service";
 import { getErc20Metadata } from "./subservices/getErc20Metadata.service";
 import { getErc20SnapshotMetadata } from "./subservices/getErc20SnapshotMetadata.service";
 import { getEulerMetadata } from "./subservices/getEulerMetadata.service";
@@ -96,6 +97,8 @@ export class OpportunityService {
                 return getAmbientMetadata(chainId, campaignParams);
             case "UNISWAP_V4":
                 return getUniswapV4Metadata(chainId, campaignParams);
+            case "ENCOMPASSING":
+                return getEncompassingMetadata(chainId, campaign.rewardTokenAddress, campaignParams);
             case "INVALID":
                 return {
                     name: "Invalid Campaigns",

package/dist/src/modules/v4/opportunity/subservices/getAjnaMetadata.service.js

@@ -1,5 +1,5 @@
+import { TokenService } from "../../token/token.service";
 import { OpportunityAction } from "../../../../../database/api/.generated";
-import { TokenService } from "../../token";
 export const getAjnaMetadata = async (chainId, campaignSubType, params) => {
     try {
         const [collateral, quote] = await TokenService.getManyOrCreate([

package/dist/src/modules/v4/opportunity/subservices/getBadgerMetadata.service.js

@@ -1,5 +1,5 @@
+import { TokenService } from "../../token/token.service";
 import { OpportunityAction } from "../../../../../database/api/.generated";
-import { TokenService } from "../../token";
 export const getBadgerMetadata = async (chainId, params) => {
     try {
         const [token] = await TokenService.getManyOrCreate([{ chainId, address: params.targetToken }]);

package/dist/src/modules/v4/opportunity/subservices/getEncompassingMetadata.service.d.ts

@@ -0,0 +1,3 @@
+import type { ChainId, EncompassingCampaign } from "@sdk";
+import type { OpportunityMetadata } from "../opportunity.model";
+export declare const getEncompassingMetadata: (chainId: ChainId, rewardTokenAddress: string, params: EncompassingCampaign["campaignParameters"]) => Promise<OpportunityMetadata>;

package/dist/src/modules/v4/opportunity/subservices/getEncompassingMetadata.service.js

@@ -0,0 +1,35 @@
+import { log } from "../../../../utils/logger";
+import { OpportunityAction } from "../../../../../database/api/.generated";
+export const getEncompassingMetadata = async (chainId, rewardTokenAddress, params) => {
+    try {
+        const dataResponse = await fetch(params.dataUrl);
+        if (!dataResponse.ok)
+            throw new Error(`Response status: ${dataResponse.status}`);
+        const data = await dataResponse.json();
+        return {
+            action: OpportunityAction.DROP,
+            name: data.opportunityName ?? `Distribution of ${params.symbolRewardToken}`,
+            tokens: [
+                {
+                    chainId,
+                    address: rewardTokenAddress,
+                },
+            ],
+            mainProtocol: data.mainProtocol ?? undefined,
+        };
+    }
+    catch (err) {
+        log.error("failed to fetch data from dataUrl", err);
+        return {
+            action: OpportunityAction.DROP,
+            name: `Distribution of ${params.symbolRewardToken}`,
+            tokens: [
+                {
+                    chainId,
+                    address: rewardTokenAddress,
+                },
+            ],
+            mainProtocol: undefined,
+        };
+    }
+};

package/dist/src/modules/v4/protocol/protocol.model.d.ts

@@ -9,7 +9,7 @@ export type Protocol = Resource<"Protocol", undefined, {
     numberOfLiveCampaigns?: number;
     opportunityLiveTags?: string[];
 }>;
-declare const protocolTypes: readonly ["ambient", "arthswap", "baseswap", "camelot", "crust", "fenix", "horiza", "izumi", "kim", "pancakeswap-v3", "quickswap-algebra", "quickswap-uni", "ramses", "retro", "stryke", "stryke-pcs", "stryke-sushi", "sushiswap-v3", "swapr", "thruster", "uniswap-v3", "voltage", "zero", "koi", "supswap-v3", "zkswap", "thirdtrade", "uniswapv4", "uniswap-v2", "velodrome", "aerodrome", "balancer", "curve", "cross_curve", "curveNPool", "aura", "akron", "beefy", "dragonswap", "poolside", "koi", "syncswap-v3", "neptune", "zkSwapThreePool", "syncswap", "rfx", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "venus", "woofi", "reactor_fusion", "eigenlayer", "vest", "zerolend", "hyperdrive", "gamma", "oku", "hourglass", "veda"];
+declare const protocolTypes: readonly ["ambient", "arthswap", "baseswap", "camelot", "crust", "fenix", "horiza", "izumi", "kim", "pancakeswap-v3", "quickswap-algebra", "quickswap-uni", "ramses", "retro", "stryke", "stryke-pcs", "stryke-sushi", "sushiswap-v3", "swapr", "thruster", "uniswap-v3", "voltage", "zero", "koi", "supswap-v3", "zkswap", "thirdtrade", "uniswapv4", "uniswap-v2", "velodrome", "aerodrome", "balancer", "curve", "cross_curve", "curveNPool", "aura", "akron", "beefy", "dragonswap", "poolside", "koi", "syncswap-v3", "neptune", "zkSwapThreePool", "syncswap", "rfx", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "venus", "woofi", "reactor_fusion", "eigenlayer", "vest", "zerolend", "hyperdrive", "gamma", "oku", "hourglass", "veda", "kyo", "sonex", "quickswap-algebra", "velodrome"];
 export type ProtocolId = (typeof protocolTypes)[number];
 export declare const ProtocolResourceDto: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;

package/dist/src/modules/v4/protocol/protocol.model.js

@@ -78,6 +78,10 @@ const protocolTypes = [
     "oku",
     "hourglass",
     "veda",
+    "kyo",
+    "sonex",
+    "quickswap-algebra",
+    "velodrome",
 ];
 // ─── DTOs ────────────────────────────────────────────────────────────────────
 export const ProtocolResourceDto = t.Object({

package/dist/src/modules/v4/protocol/protocol.service.js

@@ -1,7 +1,7 @@
+import { ChainService } from "../chain/chain.service";
+import { TokenService } from "../token/token.service";
 import { log } from "../../../utils/logger";
 import { AMM as AMMV3 } from "@sdk";
-import { ChainService } from "../chain";
-import { TokenService } from "../token";
 import { ProtocolRepository } from "./protocol.repository";
 // ─── Protocols Services ──────────────────────────────────────────────────────
 export class ProtocolService {
@@ -36,6 +36,10 @@ export class ProtocolService {
             [AMMV3.ThirdTrade]: "thirdtrade",
             [AMMV3.SyncswapV3]: "syncswap",
             [AMMV3.Neptune]: "neptune",
+            [AMMV3.KYO]: "kyo",
+            [AMMV3.Sonex]: "sonex",
+            [AMMV3.QuickswapAlgebraV1_2]: "quickswap-algebra",
+            [AMMV3.Velodrome]: "velodrome",
         }[amm];
     }
     static async findMany(query) {

package/dist/src/modules/v4/referral/referral.controller.d.ts

@@ -0,0 +1,82 @@
+import Elysia from "elysia";
+export declare const ReferralController: Elysia<"/referral", false, {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    type: {};
+    error: {};
+}, {
+    schema: {};
+    macro: {};
+    macroFn: {};
+}, {
+    referral: {
+        code: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    chainId: number;
+                    address: string;
+                    referralKey: string;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        code: string;
+                        referrer: boolean;
+                        referredUsers: never[];
+                        transaction: {
+                            to: string;
+                            data: `0x${string}`;
+                        };
+                    } | {
+                        code: any;
+                        referrer: boolean;
+                        referredUsers: any;
+                        transaction?: undefined;
+                    };
+                };
+            };
+        };
+    };
+} & {
+    referral: {
+        redeem: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    code: string;
+                    chainId: number;
+                    referralKey: string;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        code: string;
+                        referrer: any;
+                        transaction?: undefined;
+                    } | {
+                        code: string;
+                        referrer: any;
+                        transaction: {
+                            to: string;
+                            data: `0x${string}`;
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}>;

package/dist/src/modules/v4/referral/referral.controller.js

@@ -0,0 +1,25 @@
+import { throwOnUnsupportedChainId } from "../../../utils/throw";
+import Elysia from "elysia";
+import { ReferralCodeDto, ReferralRedeemCodeDto } from "./referral.model";
+import { ReferralService } from "./referral.service";
+// ─── Rewards Controller ──────────────────────────────────────────────────────
+export const ReferralController = new Elysia({ prefix: "/referral", detail: { tags: ["Referral"] } })
+    // ─── Get Reward Breakdowns For Campaign Ids ──────────────────────────
+    .get("/code", async ({ query: { chainId, referralKey, address } }) => await ReferralService.getCodeOrTransaction(chainId, referralKey, address), {
+    query: ReferralCodeDto,
+    beforeHandle: ({ query: { chainId } }) => {
+        throwOnUnsupportedChainId(chainId);
+    },
+    detail: {
+        description: "Returns the transaction to register user as a referrer on-chain and some additional state",
+    },
+})
+    .get("/redeem", async ({ query: { chainId, referralKey, code } }) => await ReferralService.getReferralTransaction(chainId, referralKey, code), {
+    query: ReferralRedeemCodeDto,
+    beforeHandle: ({ query: { chainId } }) => {
+        throwOnUnsupportedChainId(chainId);
+    },
+    detail: {
+        description: "Returns the transaction to redeem a referral code on-chain and some additional state",
+    },
+});

package/dist/src/modules/v4/referral/referral.model.d.ts

@@ -0,0 +1,10 @@
+export declare const ReferralCodeDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    referralKey: import("@sinclair/typebox").TString;
+    address: import("@sinclair/typebox").TString;
+}>;
+export declare const ReferralRedeemCodeDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    referralKey: import("@sinclair/typebox").TString;
+    code: import("@sinclair/typebox").TString;
+}>;

package/dist/src/modules/v4/referral/referral.model.js

@@ -0,0 +1,12 @@
+import { t } from "elysia";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+export const ReferralCodeDto = t.Object({
+    chainId: t.Number(),
+    referralKey: t.String(),
+    address: t.String(),
+});
+export const ReferralRedeemCodeDto = t.Object({
+    chainId: t.Number(),
+    referralKey: t.String(),
+    code: t.String(),
+});