@merkl/api 0.9.15

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

@@ -0,0 +1,149 @@
+import { HttpError, NotFoundError } from "@/errors";
+import { BackOfficeGuard } from "@/guards/BackOffice.guard";
+import { AuthorizationHeadersDto, EngineGuard } from "@/guards/Engine.guard";
+import { ChainUniqueDto } from "@/modules/v4/chain/chain.model";
+import { Campaign } from "@sdk";
+import Elysia, { t } from "elysia";
+import { throwOnUnsupportedChainId } from "src/utils/throw";
+import { DynamicDataService } from "../dynamicData/dynamicData.service";
+import { CampaignResourceDto, CreateCampaignDto, GetCampaignQueryDto, RemoveManualOverrideDto, UpdateCampaignCreatorDto, UpdateCampaignDto, UpdateMetaDataCampaignDto, } from "./campaign.model";
+import { CampaignService } from "./campaign.service";
+// ─── Campaigns Controller ────────────────────────────────────────────────────
+export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { tags: ["Campaigns"] } })
+    // ─── Create A Campaign ───────────────────────────────────────────────
+    .post("/engine", async ({ body }) => await CampaignService.create(body), {
+    beforeHandle: EngineGuard,
+    headers: AuthorizationHeadersDto,
+    body: CreateCampaignDto,
+    detail: { hide: true },
+})
+    .patch("/opportunity", async ({ body }) => await CampaignService.moveToOpportunity(body), {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    body: UpdateCampaignDto,
+    detail: { hide: true },
+})
+    .patch("/creator", async ({ body }) => await CampaignService.updateCreator(body), {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    body: UpdateCampaignCreatorDto,
+    detail: { hide: true },
+})
+    .patch("/remove-override", async ({ body }) => await CampaignService.removeManualOverride({
+    distributionChain: body.distributionChain,
+    campaignId: body.campaignId,
+}, body.field), {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    body: RemoveManualOverrideDto,
+    detail: { hide: true },
+})
+    .patch("/metadata", async ({ body }) => await CampaignService.updateMetaData(body), {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    body: UpdateMetaDataCampaignDto,
+    detail: { hide: true },
+})
+    .put("/:campaignId/dynamic-data", async ({ params }) => {
+    const id = (await CampaignService.findMany({ campaignId: params.campaignId, test: true }))[0].id;
+    if (!id)
+        throw new NotFoundError();
+    const campaign = await CampaignService.findUniqueOrThrow(id, true);
+    const campaignV3 = {
+        amount: campaign.amount,
+        campaignId: campaign.campaignId,
+        mainParameter: campaign.Opportunity.identifier,
+        campaignParameters: campaign.params,
+        campaignSubType: campaign.subType,
+        campaignType: Campaign[campaign.type],
+        chainId: campaign.distributionChainId,
+        computeChainId: campaign.computeChainId,
+        creator: campaign.creatorAddress,
+        endTimestamp: Number(campaign.endTimestamp),
+        rewardToken: campaign.RewardToken.address,
+        startTimestamp: Number(campaign.startTimestamp),
+        index: 0,
+    };
+    return await DynamicDataService.updateForCampaigns([campaignV3]);
+}, { beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto, detail: { hide: true } })
+    // ─── Get One Campaign ────────────────────────────────────────────────
+    .get("/:id", async ({ params }) => {
+    try {
+        if (!params.id.includes("-"))
+            return CampaignService.format(await CampaignService.findUniqueOrThrow(params.id));
+        const [distributionChain, campaignId] = params.id.split("-");
+        return CampaignService.format(await CampaignService.findUniqueOrThrow({ distributionChain: +distributionChain, campaignId }));
+    }
+    catch (err) {
+        console.log(err);
+        throw new NotFoundError("Campaign not found.");
+    }
+}, {
+    params: t.Object({ id: t.String() }),
+    response: CampaignResourceDto,
+    detail: {
+        description: `**Retrieve A Campaign**
+      <p>This endpoint enables you to retrieve a campaign by providing its unique identifier.</p>`,
+    },
+})
+    .group("/campaigns-to-process", app => {
+    return (app
+        // ─── Get The List Of Campaigns To Process ────
+        .get("/", async ({ query }) => await CampaignService.findCampaignsToProcess(query.chainId), {
+        query: ChainUniqueDto,
+        beforeHandle: ({ query }) => {
+            throwOnUnsupportedChainId(query.chainId);
+        },
+        detail: { hide: true },
+    })
+        // ─── Get Count Of CampaignsToProcess ─────────
+        .get("/count", async ({ query }) => (await CampaignService.findCampaignsToProcess(query.chainId)).length, {
+        query: ChainUniqueDto,
+        beforeHandle: ({ query }) => {
+            throwOnUnsupportedChainId(query.chainId);
+        },
+        detail: { hide: true },
+    })
+        .get("/next", async ({ query }) => await CampaignService.findNextCampaignToProcess(query.chainId), {
+        query: ChainUniqueDto,
+        beforeHandle: ({ query }) => {
+            throwOnUnsupportedChainId(query.chainId);
+        },
+        detail: { hide: true },
+    })
+        // ─── Marks A Campaignid As Processing ────────
+        .post("/engine", async ({ query }) => await CampaignService.pickCampaignToProcess(query.chainId), {
+        query: ChainUniqueDto,
+        beforeHandle: async ({ query, headers }) => {
+            await EngineGuard({ headers });
+            throwOnUnsupportedChainId(query.chainId);
+        },
+        headers: AuthorizationHeadersDto,
+        detail: { hide: true },
+    }));
+})
+    // ─── Get Many Campaigns ──────────────────────────────────────────────
+    .guard({ query: GetCampaignQueryDto })
+    .get("/", async ({ query }) => {
+    if (query.items === 0)
+        throw new HttpError("Bad Request: Cannot retrieve 0 items", 400);
+    return await CampaignService.findMany(query);
+}, {
+    response: t.Array(CampaignResourceDto),
+    detail: {
+        description: `**Retrieve Multiple Campaigns**
+      <p>This endpoint enables you to search for campaigns by providing specific criteria through query parameters.</p>`,
+    },
+})
+    // ─── Get Total Campaigns Count ───────────────────────────────────────
+    .get("/count", async ({ query }) => await CampaignService.countMany(query), {
+    response: t.Number(),
+    detail: {
+        description: `**Count Campaigns**
+    <p>This endpoint enables you to count campaigns corresponding to filters specified in the query params.</p>`,
+    },
+})
+    .guard({ response: t.Record(t.String(), t.Number()) })
+    .get("count/by-chains", async ({ query }) => await CampaignService.countByChains(query))
+    .get("/count/by-type", async ({ query }) => await CampaignService.countByType(query))
+    .get("/count/by-protocol", async ({ query }) => await CampaignService.countByProtocol(query));

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

@@ -0,0 +1,165 @@
+import type { Resource } from "@/modules/v4/prisma";
+import { type Token } from "@/modules/v4/token/token.model";
+import type { Campaign as CampaignEnum, CampaignParameters } from "@sdk";
+import { type Chain } from "../chain/chain.model";
+import { type Status as StatusModel } from "../status/status.model";
+/**
+ * Campaign
+ * @description Target description of rewards campaigns
+ * @see {@link Resource}
+ */
+export type Campaign = Resource<"Campaign", "opportunityId" | "rewardTokenId", {
+    chain: Chain["model"];
+    rewardToken: Token["model"];
+    distributionChain?: Chain["model"];
+    campaignStatus?: StatusModel["model"];
+    creator?: {
+        address: string;
+        tags?: string[];
+        creatorId: string | null;
+    };
+    endTimestamp: number;
+    startTimestamp: number;
+    createdAt: string;
+}>;
+export type CampaignWithParams<C extends CampaignEnum = CampaignEnum> = Campaign["model"] & {
+    params: CampaignParameters<C>["campaignParameters"];
+};
+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").TString, import("@sinclair/typebox").TNumber]>;
+    endTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+    creatorAddress: import("@sinclair/typebox").TString;
+    creator: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        address: import("@sinclair/typebox").TString;
+        tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+        creatorId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>>;
+    }>>;
+    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").TString, import("@sinclair/typebox").TNumber]>;
+        processingStarted: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+        status: import("@sinclair/typebox").TString;
+        error: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TAny>;
+    }>>;
+    createdAt: import("@sinclair/typebox").TString;
+}>;
+export declare const CreateCampaignDto: import("@sinclair/typebox").TObject<{
+    computeChainId: import("@sinclair/typebox").TNumber;
+    chainId: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    creator: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TNumber;
+    subType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    rewardTokenAddress: import("@sinclair/typebox").TString;
+    amount: import("@sinclair/typebox").TString;
+    opportunityIdentifier: import("@sinclair/typebox").TString;
+    startTimestamp: import("@sinclair/typebox").TString;
+    endTimestamp: import("@sinclair/typebox").TString;
+    params: import("@sinclair/typebox").TString;
+    tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>;
+export declare const UpdateCampaignDto: import("@sinclair/typebox").TObject<{
+    distributionChain: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    opportunityIdentifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const UpdateCampaignCreatorDto: import("@sinclair/typebox").TObject<{
+    distributionChain: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    creatorAddress: import("@sinclair/typebox").TString;
+}>;
+export declare const RemoveManualOverrideDto: import("@sinclair/typebox").TObject<{
+    distributionChain: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    field: import("@sinclair/typebox").TEnum<{
+        opportunityId: "opportunityId";
+        creatorAddress: "creatorAddress";
+    }>;
+}>;
+export declare const UpdateMetaDataCampaignDto: import("@sinclair/typebox").TObject<{
+    distributionChain: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    url: import("@sinclair/typebox").TString;
+}>;
+export declare const GetCampaignQueryDto: import("@sinclair/typebox").TObject<{
+    creatorTag: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    creatorAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    creatorId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    distributionChainIds: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    subType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    campaignId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    mainParameter: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tokenSymbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tokenAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    point: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    opportunityId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
+        NONE: "NONE";
+        PAST: "PAST";
+        LIVE: "LIVE";
+        SOON: "SOON";
+    }>>;
+    startTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    endTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    withOpportunity: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    createdAfter: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TDate, import("@sinclair/typebox").TNull]>>;
+    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 & {
+    id: string;
+};
+export type UpdateCampaignModel = typeof UpdateCampaignDto.static & {
+    id: string;
+};
+export type UpdateCampaignCreatorModel = typeof UpdateCampaignCreatorDto.static;
+export type UpdateMetaDataCampaignModel = typeof UpdateMetaDataCampaignDto.static & {
+    url: string;
+};
+export type extendedUpdateCampaignModel = UpdateCampaignModel & {
+    opportunityId: string;
+};
+export type GetCampaignQueryModel = typeof GetCampaignQueryDto.static;

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

@@ -0,0 +1,113 @@
+import { TokenResourceDto } from "@/modules/v4/token/token.model";
+import { CampaignManualOverride, Status } from "@db/api";
+import { t } from "elysia";
+import { ChainResourceDto } from "../chain/chain.model";
+import { CampaignStatusResourceDto } from "../status/status.model";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+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.String(), t.Numeric()]),
+    endTimestamp: t.Union([t.String(), t.Numeric()]),
+    creatorAddress: t.String(),
+    creator: t.Optional(t.Object({
+        address: t.String(),
+        tags: t.Optional(t.Array(t.String())),
+        creatorId: t.Optional(t.Nullable(t.String())),
+    })),
+    params: t.Any(),
+    chain: ChainResourceDto,
+    rewardToken: TokenResourceDto,
+    distributionChain: t.Optional(ChainResourceDto),
+    campaignStatus: t.Optional(CampaignStatusResourceDto),
+    createdAt: t.String({ format: "date" }),
+});
+export const CreateCampaignDto = t.Object({
+    computeChainId: t.Number(),
+    chainId: t.Number(),
+    campaignId: t.String(),
+    identifier: t.Optional(t.String()),
+    creator: t.String(),
+    type: t.Numeric(),
+    subType: t.Optional(t.Number()),
+    rewardTokenAddress: t.String(),
+    amount: t.String(),
+    opportunityIdentifier: t.String(),
+    startTimestamp: t.String(),
+    endTimestamp: t.String(),
+    params: t.String(),
+    tags: t.Optional(t.Array(t.String())),
+});
+export const UpdateCampaignDto = t.Object({
+    distributionChain: t.Numeric(),
+    campaignId: t.String(),
+    opportunityIdentifier: t.Optional(t.String()),
+});
+export const UpdateCampaignCreatorDto = t.Object({
+    distributionChain: t.Numeric(),
+    campaignId: t.String(),
+    creatorAddress: t.String(),
+});
+export const RemoveManualOverrideDto = t.Object({
+    distributionChain: t.Numeric(),
+    campaignId: t.String(),
+    field: t.Enum(CampaignManualOverride),
+});
+export const UpdateMetaDataCampaignDto = t.Object({
+    distributionChain: t.Numeric(),
+    campaignId: t.String(),
+    url: t.String(),
+});
+export const GetCampaignQueryDto = t.Object({
+    creatorTag: t.Optional(t.String({ description: "Filter campaigns created by a user who has a specific tag" })),
+    creatorAddress: t.Optional(t.String()),
+    creatorId: t.Optional(t.String({ description: "Filter campaigns created by a user who is registered as a merkl creator" })),
+    chainId: t.Optional(t.Numeric({
+        description: "Filter by compute chain.<br>You can get the list of all supported chains by calling [GET /v4/chains](#tag/chains/GET/v4/chains/)",
+    })),
+    distributionChainIds: t.Optional(t.Array(t.Numeric({
+        description: "Filter by distribution 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.String({ description: "Filter by type of campaign" })),
+    types: t.Optional(t.Array(t.String({ description: "Filter by type of campaign using an array. The `type` entry has priority." }))),
+    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 })),
+    point: t.Optional(t.Boolean({ description: "Return campaigns rewarding in points", 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)",
+    })),
+    status: t.Optional(t.Enum(Status, {
+        description: "Get only live, past or future campaigns. Has precendence over timestamp filters",
+    })),
+    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" })),
+    withOpportunity: t.Optional(t.Boolean({
+        description: "Include opportunity data. Will slow down the request. Default: false",
+    })),
+    createdAfter: t.Optional(t.Union([t.Date({ description: "Return campaigns created after the given date. Format: YYYY-MM-DD" }), t.Null()])),
+    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
+});