@merkl/api 0.10.198 → 0.10.200

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

@@ -1,9 +1,9 @@
 import type { Resource } from "../prisma";
-import type { Token } from "../token";
+import { type Token } from "../token";
 import { CampaignType } from "../../../../database/api/.generated";
 import { type CampaignParameters } from "@sdk";
-import type { Chain } from "../chain";
-import type { Status } from "../status";
+import { type Chain } from "../chain";
+import { type Status } from "../status";
 /**
  * Campaign
  * @description Target description of rewards campaigns
@@ -39,6 +39,51 @@ export declare const CampaignUniqueDto: import("@sinclair/typebox").TObject<{
     distributionChain: import("@sinclair/typebox").TNumber;
     campaignId: import("@sinclair/typebox").TString;
 }>;
+export declare const CampaignResourceDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    computeChainId: import("@sinclair/typebox").TNumber;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TString;
+    subType: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>;
+    rewardTokenId: import("@sinclair/typebox").TString;
+    amount: import("@sinclair/typebox").TString;
+    opportunityId: import("@sinclair/typebox").TString;
+    startTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+    endTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+    creatorAddress: import("@sinclair/typebox").TString;
+    params: import("@sinclair/typebox").TAny;
+    chain: import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TNumber;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+    }>;
+    rewardToken: import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        name: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
+        chainId: import("@sinclair/typebox").TNumber;
+        address: import("@sinclair/typebox").TString;
+        decimals: import("@sinclair/typebox").TNumber;
+        icon: import("@sinclair/typebox").TString;
+        verified: import("@sinclair/typebox").TBoolean;
+        isTest: import("@sinclair/typebox").TBoolean;
+        price: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>>;
+        symbol: import("@sinclair/typebox").TString;
+    }>;
+    distributionChain: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TNumber;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+    }>>;
+    campaignStatus: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        campaignId: import("@sinclair/typebox").TString;
+        computedUntil: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        processingStarted: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        status: import("@sinclair/typebox").TString;
+        error: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
+    }>>;
+}>;
 export declare const CreateCampaignDto: import("@sinclair/typebox").TObject<{
     computeChainId: import("@sinclair/typebox").TNumber;
     chainId: import("@sinclair/typebox").TNumber;
@@ -55,8 +100,6 @@ export declare const CreateCampaignDto: import("@sinclair/typebox").TObject<{
     params: import("@sinclair/typebox").TString;
 }>;
 export declare const GetCampaignQueryDto: import("@sinclair/typebox").TObject<{
-    page: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
-    items: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
     chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
     type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
         INVALID: "INVALID";
@@ -83,6 +126,8 @@ export declare const GetCampaignQueryDto: import("@sinclair/typebox").TObject<{
     opportunityId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     startTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     endTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    page: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    items: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
 }>;
 export type CampaignUnique = typeof CampaignUniqueDto.static;
 export type CreateCampaignModel = typeof CreateCampaignDto.static & {

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

@@ -1,6 +1,9 @@
+import { TokenResourceDto } from "../token";
 import { CampaignType } from "../../../../database/api/.generated";
 import { Campaign as CampaignTypeEnum } from "@sdk";
 import { t } from "elysia";
+import { ChainResourceDto } from "../chain";
+import { CampaignStatusResourceDto } from "../status";
 // ─── Utils ───────────────────────────────────────────────────────────────────
 export const campaignTypeToEnumMap = {
     INVALID: CampaignTypeEnum.INVALID,
@@ -23,6 +26,25 @@ export const CampaignUniqueDto = t.Object({
     distributionChain: t.Numeric(),
     campaignId: t.String(),
 });
+export const CampaignResourceDto = t.Object({
+    id: t.String(),
+    computeChainId: t.Number(),
+    distributionChainId: t.Number(),
+    campaignId: t.String(),
+    type: t.String(),
+    subType: t.Union([t.Number(), t.Null()]),
+    rewardTokenId: t.String(),
+    amount: t.String(),
+    opportunityId: t.String(),
+    startTimestamp: t.Union([t.BigInt(), t.String()]),
+    endTimestamp: t.Union([t.BigInt(), t.String()]),
+    creatorAddress: t.String(),
+    params: t.Any(),
+    chain: ChainResourceDto,
+    rewardToken: TokenResourceDto,
+    distributionChain: t.Optional(ChainResourceDto),
+    campaignStatus: t.Optional(CampaignStatusResourceDto),
+});
 export const CreateCampaignDto = t.Object({
     computeChainId: t.Number(),
     chainId: t.Number(),
@@ -39,17 +61,29 @@ export const CreateCampaignDto = t.Object({
     params: t.String(),
 });
 export const GetCampaignQueryDto = t.Object({
-    page: t.Optional(t.Numeric()),
-    items: t.Optional(t.Numeric()),
-    chainId: t.Optional(t.Numeric()),
-    type: t.Optional(t.Enum(CampaignType)),
-    subType: t.Optional(t.Number()),
-    campaignId: t.Optional(t.String()),
-    mainParameter: t.Optional(t.String()),
-    tokenSymbol: t.Optional(t.String()),
-    tokenAddress: t.Optional(t.String()),
-    test: t.Optional(t.Boolean()),
-    opportunityId: t.Optional(t.String()),
-    startTimestamp: t.Optional(t.String({ pattern: "[0-9].*" })),
-    endTimestamp: t.Optional(t.String({ pattern: "[0-9].*" })),
+    chainId: t.Optional(t.Numeric({
+        description: "Filter by chain.<br>You can get the list of all supported chains by calling [GET /v4/chains](#tag/chains/GET/v4/chains/)",
+    })),
+    type: t.Optional(t.Enum(CampaignType, { description: "Filter by type of campaign" })),
+    subType: t.Optional(t.Number({
+        description: "Silo, Radiant, Morpho, Dolomite, Compound, Ajna and Euler campaigns have a subtype attribute you can filter on",
+    })),
+    campaignId: t.Optional(t.String({
+        description: "Filter campaigns by campaignId. Some campaigns take place on different blockchains, one resource per chain will be returned, sharing the same campaignId",
+    })),
+    mainParameter: t.Optional(t.String({
+        description: "the mainParameter represents the address of the contract targeted by a campaign (e.g. a Uniswap pool)",
+    })),
+    tokenSymbol: t.Optional(t.String({ description: "Filter by reward token symbol (e.g. USDC for campaigns rewarding in USDC)" })),
+    tokenAddress: t.Optional(t.String({
+        description: "Filter results by the reward token address. Use in combination with chainId for accuracy",
+    })),
+    test: t.Optional(t.Boolean({ description: "Return campaigns rewarding in test tokens", default: false })),
+    opportunityId: t.Optional(t.String({
+        description: "Filter by opportunity. You can find opportunity ids by calling [GET /v4/opportunities](#tag/opportunities/GET/v4/opportunities)",
+    })),
+    startTimestamp: t.Optional(t.String({ pattern: "[0-9].*", description: "Returns campaigns starting *after* the given unix timestamp" })),
+    endTimestamp: t.Optional(t.String({ pattern: "[0-9].*", description: "Returns campaigns ending *after* the given unix timestamp" })),
+    page: t.Optional(t.Numeric({ description: "0-indexed page number", default: 0 })),
+    items: t.Optional(t.Numeric({ description: "Number of items returned by page", default: 20 })), // items per page
 });

package/dist/src/modules/v4/campaign/campaign.repository.d.ts

@@ -32,6 +32,7 @@ export declare abstract class CampaignRepository {
     static getFromEngineDb(chainId: number, timestamp: number): Promise<CampaignParameters<CampaignV3>[]>;
     static getFromEngineDbWithId(campaignIds: CampaignUnique[]): Promise<{
         index: number;
+        creator: string;
         chainId: number;
         startTimestamp: number;
         endTimestamp: number;
@@ -40,7 +41,6 @@ export declare abstract class CampaignRepository {
         campaignId: string;
         amount: string;
         rewardToken: string;
-        creator: string;
         campaignType: number;
         campaignSubType: number;
         campaignParameters: import("database/engine/.generated/runtime/library").JsonValue;
@@ -98,9 +98,9 @@ export declare abstract class CampaignRepository {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             displaySymbol: string;
             verified: boolean;

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

@@ -39,9 +39,9 @@ export declare abstract class CampaignService {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             verified: boolean;
             isTest: boolean;
@@ -173,9 +173,9 @@ export declare abstract class CampaignService {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             verified: boolean;
             isTest: boolean;

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

@@ -42,7 +42,7 @@ export declare const ChainController: Elysia<"/chains", false, {
                 body: unknown;
                 params: {};
                 query: {
-                    search?: string | undefined;
+                    name?: string | undefined;
                 };
                 headers: unknown;
                 response: {
@@ -66,7 +66,7 @@ export declare const ChainController: Elysia<"/chains", false, {
                 body: unknown;
                 params: {};
                 query: {
-                    search?: string | undefined;
+                    name?: string | undefined;
                 };
                 headers: unknown;
                 response: {

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

@@ -1,8 +1,8 @@
 import { AuthorizationHeadersDto, BackOfficeGuard } from "../../../guards/BackOffice.guard";
 import { TokenAuthGuard } from "../../../guards/TokenAuth.guard";
-import Elysia from "elysia";
+import Elysia, { t } from "elysia";
 import { ExplorerService } from "../explorer";
-import { ChainUniqueDto, CreateChainExplorerDto, GetChainQueryDto, UpdateChainDto } from "./chain.model";
+import { ChainResourceDto, ChainUniqueDto, CreateChainExplorerDto, GetChainQueryDto, UpdateChainDto, } from "./chain.model";
 import { ChainService } from "./chain.service";
 // ─── Chains Controller ───────────────────────────────────────────────────────
 export const ChainController = new Elysia({ prefix: "/chains", detail: { tags: ["Chains"] } })
@@ -15,6 +15,7 @@ export const ChainController = new Elysia({ prefix: "/chains", detail: { tags: [
     return { explorers: chain.Explorer, ...rest };
 }, {
     params: ChainUniqueDto,
+    detail: { hide: true },
 })
     // ─── Get All Supported Chains ────────────────────────────────────────
     .get("/", async ({ query }) => {
@@ -22,10 +23,13 @@ export const ChainController = new Elysia({ prefix: "/chains", detail: { tags: [
     return chains.map(({ Explorer, ...chain }) => ({ explorers: Explorer, ...chain }));
 }, {
     query: GetChainQueryDto,
+    response: t.Array(ChainResourceDto),
+    detail: { description: "List chains supported and integrated by Merkl." },
 })
     // ─── Count Chains ────────────────────────────────────────
     .get("/count", async ({ query }) => await ChainService.countMany(query), {
     query: GetChainQueryDto,
+    detail: { hide: true },
 })
     .group("/explorers", app => {
     // ─── Create An Explorer ──────────────────────────────────────
@@ -41,4 +45,5 @@ export const ChainController = new Elysia({ prefix: "/chains", detail: { tags: [
     body: UpdateChainDto,
     headers: AuthorizationHeadersDto,
     beforeHandle: BackOfficeGuard,
+    detail: { hide: true },
 });

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

@@ -5,8 +5,13 @@ import type { Resource } from "../prisma";
  * @see {@link Resource}
  */
 export type Chain = Resource<"Chain">;
+export declare const ChainResourceDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TNumber;
+    name: import("@sinclair/typebox").TString;
+    icon: import("@sinclair/typebox").TString;
+}>;
 export declare const GetChainQueryDto: import("@sinclair/typebox").TObject<{
-    search: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
 export declare const ChainUniqueDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;

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

@@ -1,8 +1,13 @@
 import { ExplorerType } from "../../../../database/api/.generated";
 import { t } from "elysia";
 // ─── DTOs ────────────────────────────────────────────────────────────────────
+export const ChainResourceDto = t.Object({
+    id: t.Number(),
+    name: t.String(),
+    icon: t.String(),
+});
 export const GetChainQueryDto = t.Object({
-    search: t.Optional(t.String()),
+    name: t.Optional(t.String({ description: "Search by blockchain name" })),
 });
 export const ChainUniqueDto = t.Object({
     chainId: t.Numeric(),
@@ -12,6 +17,8 @@ export const ChainArrayDto = t.Object({
         .Transform(t.Union([t.String(), t.Array(t.Numeric())]))
         .Decode(value => (typeof value === "string" ? value.split(",").map(v => Number.parseInt(v)) : value))
         .Encode(value => [...value]),
+}, {
+    description: "A required comma separated list of chain ids.<br>You can get the list of all supported chains by calling [GET /v4/chains](#tag/chains/GET/v4/chains/)",
 });
 export const CreateChainExplorerDto = t.Object({
     type: t.Enum(ExplorerType),

package/dist/src/modules/v4/chain/chain.repository.js

@@ -12,7 +12,7 @@ export class ChainRepository {
     }
     static #transformQueryToPrismaFilters(query) {
         return {
-            where: { name: { contains: query.search, mode: "insensitive" } },
+            where: { name: { contains: query.name, mode: "insensitive" } },
         };
     }
     /** Returns many chains based on query

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

@@ -3,7 +3,7 @@ import Elysia from "elysia";
 import { UserUniqueDto } from "../user";
 import { ClaimService } from "./claims.service";
 // ─── Claim Controller ───────────────────────────────────────────────────────
-export const ClaimController = new Elysia({ prefix: "/claims", detail: { tags: ["Claims"] } })
+export const ClaimController = new Elysia({ prefix: "/claims", detail: { tags: ["Claims"], hide: true } })
     // ─── Get Historical Claims ────────────────────────────────────────────
     .get("/:address", async ({ params }) => await ClaimService.getHistoricalClaims(params), {
     params: UserUniqueDto,

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

@@ -4,7 +4,10 @@ import { throwOnUnsupportedChainId } from "src/utils/throw";
 import { DynamicDataSourceIdentifier } from "./dynamicData.model";
 import { DynamicDataService } from "./dynamicData.service";
 // ─── DynamicDatas Controller ───────────────────────────────────────────────────────
-export const DynamicDataController = new Elysia({ prefix: "/dynamic-data", detail: { tags: ["DynamicData"] } })
+export const DynamicDataController = new Elysia({
+    prefix: "/dynamic-data",
+    detail: { tags: ["DynamicData"], hide: true },
+})
     // ─── Get type Info By Token Address ───────────────────────────────────────
     .get("/", async ({ query }) => await DynamicDataService.queryERC20DynamicData(query.chainId, query.tokenAddress), {
     query: DynamicDataSourceIdentifier,

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

@@ -11,7 +11,7 @@ export declare const slugToProtocolId: {
     readonly "aura-lp": "aura";
     readonly aura: "aura";
     readonly beefy: "beefy";
-    readonly "compound-v3": "compound";
+    readonly venus: "compound";
     readonly "curve-gauge": "curve";
     readonly "euler-v2": "euler";
     readonly fluid: "fluid";

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

@@ -12,7 +12,8 @@ export const slugToProtocolId = {
     "aura-lp": "aura",
     aura: "aura",
     beefy: "beefy",
-    "compound-v3": "compound",
+    venus: "compound",
+    // "compound-v3": "compound",
     "curve-gauge": "curve",
     "euler-v2": "euler",
     fluid: "fluid",

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

@@ -44,5 +44,4 @@ export declare abstract class EnsoService {
             to: string;
         };
     }>;
-    static getDepositSchema(protocolId: ProtocolId): void;
 }

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

@@ -9,9 +9,10 @@ export class EnsoService {
                 "Content-Type": "application/json",
             }),
         });
-        if (res?.status !== 200)
-            throw "Unsucessful call";
-        return (await res.json());
+        const json = await res.json();
+        if (res.status !== 200)
+            throw new Error(json?.message);
+        return json;
     }
     static getSlug(protocolId) {
         const slug = Object.entries(slugToProtocolId).find(([_slug, id]) => id === protocolId)?.[0];
@@ -42,5 +43,4 @@ export class EnsoService {
     static async getTransaction(query) {
         return await EnsoService.#fetch("/v1/shortcuts/route", { query });
     }
-    static getDepositSchema(protocolId) { }
 }

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

@@ -18,13 +18,13 @@ export declare const InteractionController: Elysia<"/interaction", false, {
                 body: unknown;
                 params: {};
                 query: {
-                    identifier?: string | undefined;
+                    protocolId?: string | undefined;
+                    identifier: string;
                     chainId: number;
-                    protocolId: string;
                 };
                 headers: unknown;
                 response: {
-                    200: import("./interaction.model").InteractionTarget[] | undefined;
+                    200: import("./interaction.model").InteractionTarget[];
                 };
             };
         };
@@ -54,7 +54,7 @@ export declare const InteractionController: Elysia<"/interaction", false, {
     };
 } & {
     interaction: {
-        quote: {
+        transaction: {
             get: {
                 body: unknown;
                 params: {};
@@ -69,10 +69,11 @@ export declare const InteractionController: Elysia<"/interaction", false, {
                 headers: unknown;
                 response: {
                     200: {
-                        amountOut: {};
-                        gas: string;
-                        feeAmount: string[];
-                        priceImpact: number;
+                        amountIn: bigint;
+                        allowance: bigint;
+                        approved: boolean;
+                        transaction: import("./interaction.model").UserTransaction;
+                        approval: import("./interaction.model").UserTransaction;
                     } | undefined;
                 };
             };
@@ -80,7 +81,7 @@ export declare const InteractionController: Elysia<"/interaction", false, {
     };
 } & {
     interaction: {
-        transaction: {
+        sponsored: {
             get: {
                 body: unknown;
                 params: {};
@@ -95,17 +96,25 @@ export declare const InteractionController: Elysia<"/interaction", false, {
                 headers: unknown;
                 response: {
                     200: {
-                        amountOut: string;
-                        gas: string;
-                        feeAmount: string[];
-                        priceImpact: number;
-                        createAt: number;
-                        tx: {
-                            data: string;
+                        expirationTime: string;
+                        expiresIn: string;
+                        feeTokenAmount: string;
+                        feeTokendecimals: string;
+                        feeUSD: string;
+                        gasLimit: string;
+                        gasPrice: string;
+                        markup: string;
+                        maxNonce: string;
+                        protocolAddress: string;
+                        sponsorshipRatio: string;
+                        tokenAddress: string;
+                        tokenPrice: string;
+                        txData: {
                             from: string;
-                            value: string;
                             to: string;
+                            data: string;
                         };
+                        warnings: string[];
                     } | undefined;
                 };
             };

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

@@ -1,13 +1,16 @@
+import { ChainId } from "@sdk";
 import Elysia from "elysia";
 import { EnsoService } from "../enso/enso.service";
+import { ZyfiService } from "../zyfi/zyfi.service";
 import { GetInteractionProtocolsQueryDto, GetInteractionQuoteQueryDto, GetInteractionTargetsQueryDto, } from "./interaction.model";
 import { InteractionService } from "./interaction.service";
 // ─── Interaction Controller ──────────────────────────────────────────────────
-export const InteractionController = new Elysia({ prefix: "/interaction", detail: { tags: ["Interaction"] } })
+export const InteractionController = new Elysia({
+    prefix: "/interaction",
+    detail: { tags: ["Interaction"], hide: true },
+})
     .get("/targets", async ({ query: { protocolId, chainId, identifier } }) => {
-    if (identifier)
-        return await InteractionService.getTarget(chainId, protocolId, identifier);
-    return await InteractionService.getTargets(chainId, protocolId);
+    return await InteractionService.getTargets(chainId, protocolId, identifier);
 }, {
     query: GetInteractionTargetsQueryDto,
     detail: {
@@ -23,45 +26,33 @@ export const InteractionController = new Elysia({ prefix: "/interaction", detail
         description: "Retrieves protocols integrated by merkl which supports being interacted with",
     },
 })
-    // ─── Get Quote ───────────────────────────────────────────────────────
-    .get("/quote", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
-    const [target] = (await InteractionService.getTarget(chainId, protocolId, identifier)) ?? [];
+    // ─── Get Transaction ─────────────────────────────────────────────────
+    .get("/transaction", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
+    const [target] = await InteractionService.getTargets(chainId, protocolId, identifier);
     //TODO: throw error
     if (!target)
         return;
-    return await EnsoService.getQuote({
-        fromAddress: userAddress,
-        tokenIn: [fromTokenAddress],
-        tokenOut: [target.identifier],
-        amountIn: [fromAmount],
-        routingStrategy: "router",
-        chainId,
-    });
+    return await InteractionService.getTransaction(target.provider, chainId, protocolId, identifier, userAddress, fromTokenAddress, BigInt(fromAmount));
 }, {
     query: GetInteractionQuoteQueryDto,
     detail: {
-        summary: "Preview participate transaction",
+        summary: "Get participate transaction",
         description: "",
     },
 })
-    // ─── Get Transaction ─────────────────────────────────────────────────
-    .get("/transaction", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
-    const [target] = (await InteractionService.getTarget(chainId, protocolId, identifier)) ?? [];
+    .get("/sponsored", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
+    if (chainId !== ChainId.ZKSYNC)
+        return;
+    const [target] = await InteractionService.getTargets(chainId, protocolId, identifier);
     //TODO: throw error
     if (!target)
         return;
-    return await EnsoService.getTransaction({
-        fromAddress: userAddress,
-        tokenIn: [fromTokenAddress],
-        tokenOut: [target.identifier],
-        amountIn: [fromAmount],
-        routingStrategy: "router",
-        chainId,
-    });
+    const { transaction: tx } = await InteractionService.getTransaction(target.provider, chainId, protocolId, identifier, userAddress, fromTokenAddress, BigInt(fromAmount));
+    return ZyfiService.wrapTx({ data: tx.data, to: tx.to, from: userAddress });
 }, {
     query: GetInteractionQuoteQueryDto,
     detail: {
-        summary: "Get participate transaction",
+        summary: "Get participate transaction wrapped by paymaster",
         description: "",
     },
 });

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

@@ -1,4 +1,3 @@
-import type { Token } from "../token";
 export declare const participateInputTypes: readonly ["tokenAmount", "token"];
 export type InteractionInputType = (typeof participateInputTypes)[number];
 export type InteractionInput<T extends InteractionInputType = InteractionInputType> = {
@@ -25,17 +24,30 @@ export type InteractionSchema<T extends InteractionType> = {
     };
 }[T];
 export type InteractionTarget = {
+    provider: "enso" | "zap";
     identifier: string;
-    name: string;
-    tokens: Token["model"][];
+    chainId: number;
 };
 export type InteractionSchemas = {
     [T in InteractionType]?: InteractionSchema<T>;
 };
+export type UserTransaction = {
+    data: string;
+    to: string;
+    from?: string;
+    value?: bigint;
+};
+export type InteractionQuote = {
+    amountIn: bigint;
+    allowance: bigint;
+    approved: boolean;
+    transaction: UserTransaction;
+    approval: UserTransaction;
+};
 export declare const GetInteractionTargetsQueryDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;
-    protocolId: import("@sinclair/typebox").TString;
-    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    protocolId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    identifier: import("@sinclair/typebox").TString;
 }>;
 export declare const GetInteractionQuoteQueryDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;

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

@@ -4,10 +4,10 @@ export const participateInputTypes = ["tokenAmount", "token"];
 export const participateTypes = ["link", "deposit", "withdraw"];
 export const GetInteractionTargetsQueryDto = t.Object({
     chainId: t.Numeric(),
-    protocolId: t.String({
+    protocolId: t.Optional(t.String({
         examples: Object.values(protocol).reduce((obj, i) => Object.assign(obj, { [i.name]: { value: i.id } }), {}),
-    }),
-    identifier: t.Optional(t.String()),
+    })),
+    identifier: t.String(),
 });
 export const GetInteractionQuoteQueryDto = t.Object({
     chainId: t.Numeric(),

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

@@ -1,8 +1,23 @@
 import { EnsoService } from "../enso/enso.service";
 import type { ProtocolId } from "../protocol";
-import type { InteractionTarget } from "./interaction.model";
+import type { InteractionQuote, InteractionTarget } from "./interaction.model";
 export declare abstract class InteractionService {
-    static getTarget(chainId: number, protocolId: ProtocolId, identifier: string): Promise<InteractionTarget[] | undefined>;
+    static getTarget(chainId: number, protocolId: ProtocolId, identifier: string): Promise<InteractionTarget[]>;
+    static getTargetFromKyberZap(chainId: number, protocolId: ProtocolId, identifier: string): InteractionTarget | undefined;
+    static getTargetFromEnso(chainId: number, protocolId: ProtocolId, identifier: string): Promise<InteractionTarget | undefined>;
     static getTargetsFromEnsoTokens(tokens: Awaited<ReturnType<typeof EnsoService.getTokens>>): Promise<InteractionTarget[]>;
-    static getTargets(chainId: number, protocolId: ProtocolId): Promise<InteractionTarget[] | undefined>;
+    static getTargets(chainId: number, protocolId: ProtocolId, identifier: string): Promise<InteractionTarget[]>;
+    /**
+     * Gets approval information onchain
+     * @returns approved?, approval tx & allowance amount
+     */
+    static getApproval(chainId: number, owner: string, spender: string, tokenAddress: string, amount: bigint): Promise<{
+        approved: boolean;
+        allowance: any;
+        approval: {
+            to: string;
+            data: `0x${string}`;
+        };
+    }>;
+    static getTransaction(provider: InteractionTarget["provider"], chainId: number, protocolId: ProtocolId, identifier: string, userAddress: string, fromTokenAddress: string, fromTokenAmount: bigint): Promise<InteractionQuote>;
 }