@merkl/api 0.21.47 → 1.0.0

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

@@ -1,189 +0,0 @@
-import { HttpErrorDto, NotFoundError, NotFoundErrorDto } from "@/errors";
-import { BackOfficeGuard } from "@/guards/BackOffice.guard";
-import { AuthorizationHeadersDto } from "@/guards/TokenAuth.guard";
-import { GetCampaignQueryDto } from "@/modules/v4/campaign/campaign.model";
-import { log } from "@/utils/logger";
-import { throwOnUnsupportedActionList } from "@/utils/throw";
-import { ChainId } from "@sdk";
-import Elysia, { t } from "elysia";
-import { CreateOpportunityDto, GetOpportunitiesQueryDto, GetOpportunityQueryDto, OpportunityAggregateFieldDto, OpportunityDeleteOverrideDto, OpportunityOverrideDto, OpportunityResourceDto, OpportunityUniqueDto, OpportunityUniqueUpdateDto, OpportunityWithCampaignsResourceDto, UpdateOpportunityDto, } from "./opportunity.model";
-import { OpportunityService } from "./opportunity.service";
-import { transformId } from "./transform-id.pipe";
-import { validateId } from "./validate-id.pipe";
-// ─── Opportunities Controller ────────────────────────────────────────────────
-export const OpportunityController = new Elysia({
-    prefix: "/opportunities",
-    detail: { tags: ["Opportunities"] },
-})
-    // ─── Get All Opportunities ───────────────────────────────────────────
-    .get("/", async ({ query }) => OpportunityService.findMany(query), {
-    query: GetOpportunitiesQueryDto,
-    detail: {
-        description: `**Retrieve Multiple Opportunities**
-      <p>This endpoint enables you to search for opportunities by providing specific criteria through query parameters.</p>`,
-    },
-    beforeHandle: ({ query }) => {
-        if (!!query.action)
-            throwOnUnsupportedActionList(query.action);
-    },
-    response: t.Array(t.Union([OpportunityResourceDto, t.Null()])),
-})
-    // ─── Get Opportunities Count ─────────────────────────────────────────
-    .get("/count", async ({ query }) => await OpportunityService.countMany(query), {
-    query: GetOpportunitiesQueryDto,
-    beforeHandle: ({ query }) => {
-        if (!!query.action)
-            throwOnUnsupportedActionList(query.action);
-    },
-    detail: { description: "Get the count of opportunities corresponding to the query." },
-    response: { 200: t.Number() },
-})
-    .get("/bins/apr", async ({ query }) => await OpportunityService.getAprBins(query), {
-    query: GetOpportunitiesQueryDto,
-})
-    .get("/bins/tvl", async ({ query }) => await OpportunityService.getTvlBins(query), {
-    query: GetOpportunitiesQueryDto,
-})
-    // ─── Get An Opportunity By Id ────────────────────────────────────────
-    .get("/:id", async ({ params, query }) => {
-    try {
-        if (!params.id.includes("-"))
-            return await OpportunityService.findUniqueOrThrow(params.id, query.campaigns ?? false, query.test ?? false, query.point ?? false);
-        const [chainId, type, identifier] = params.id.split("-");
-        return await OpportunityService.findUniqueOrThrow({
-            chainId: +chainId,
-            type: type,
-            identifier,
-        }, query.campaigns ?? false, query.test ?? false, query.point ?? false);
-    }
-    catch (err) {
-        if (err.code && err.code === "P2025")
-            throw new NotFoundError();
-        throw err;
-    }
-}, {
-    params: OpportunityUniqueDto,
-    query: GetOpportunityQueryDto,
-    transform: transformId,
-    beforeHandle: validateId,
-    response: {
-        200: OpportunityResourceDto,
-        404: NotFoundErrorDto,
-        500: HttpErrorDto,
-    },
-    detail: { description: "Get a unique opportunity." },
-})
-    .get("/campaigns", async ({ query }) => OpportunityService.findManyByCampaigns(query), {
-    query: GetCampaignQueryDto,
-    response: {
-        200: t.Array(OpportunityWithCampaignsResourceDto),
-        404: NotFoundErrorDto,
-        500: HttpErrorDto,
-    },
-    detail: {
-        description: "Get many opportunities, including related [campaigns](#tag/campaigns/).",
-    },
-})
-    // ─── Get An Opportunity By Id With Related Campaigns ─────────────────
-    .get("/:id/campaigns", async ({ query, params }) => {
-    try {
-        if (!params.id.includes("-"))
-            return await OpportunityService.getUniqueWithCampaignsOrThrow(params.id, query.test ?? false, query.point ?? false);
-        const [chainId, type, identifier] = params.id.split("-");
-        const response = await OpportunityService.getUniqueWithCampaignsOrThrow({
-            chainId: +chainId,
-            type: type,
-            identifier,
-        }, query.test ?? false, query.point ?? false);
-        if (response.chainId === ChainId.ETHERLINK) {
-            const campaigns = response.campaigns;
-            for (let campaign of Object.values(campaigns)) {
-                const updatedParams = campaign.params;
-                updatedParams.blacklist = [];
-                campaign = {
-                    ...campaign,
-                    params: updatedParams,
-                };
-            }
-        }
-        return response;
-    }
-    catch (err) {
-        if (err.code && err.code === "P2025")
-            throw new NotFoundError();
-        throw err;
-    }
-}, {
-    query: GetOpportunityQueryDto,
-    params: OpportunityUniqueDto,
-    transform: transformId,
-    beforeHandle: validateId,
-    response: {
-        200: OpportunityWithCampaignsResourceDto,
-        404: NotFoundErrorDto,
-        500: HttpErrorDto,
-    },
-    detail: {
-        description: "Get a unique opportunity, including related [campaigns](#tag/campaigns/).",
-    },
-})
-    // ─── Get Aggregate Fields ────────────────────────────────────────────
-    .get("/aggregate/:field", async ({ query, params }) => await OpportunityService.aggregate(query, params.field), {
-    params: OpportunityAggregateFieldDto,
-    query: GetOpportunitiesQueryDto,
-    beforeHandle: ({ query }) => {
-        if (!!query.action)
-            throwOnUnsupportedActionList(query.action);
-    },
-})
-    // ─── Get Aggregate Fields ────────────────────────────────────────────
-    .get("/aggregate/max/:field", async ({ query, params }) => await OpportunityService.aggregateMax(query, params.field), {
-    params: OpportunityAggregateFieldDto,
-    query: GetOpportunitiesQueryDto,
-    beforeHandle: ({ query }) => {
-        if (!!query.action)
-            throwOnUnsupportedActionList(query.action);
-    },
-})
-    // ─── Get Aggregate Fields ────────────────────────────────────────────
-    .get("/aggregate/min/:field", async ({ query, params }) => await OpportunityService.aggregateMin(query, params.field), {
-    params: OpportunityAggregateFieldDto,
-    query: GetOpportunitiesQueryDto,
-    beforeHandle: ({ query }) => {
-        if (!!query.action)
-            throwOnUnsupportedActionList(query.action);
-    },
-})
-    .guard({ detail: { hide: true }, beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto })
-    // ─── Create An Opportunity ───────────────────────────────────────────
-    .post("/", async ({ body }) => await OpportunityService.create(body), { body: CreateOpportunityDto })
-    // ─── Tries to reparse An Opportunity ─────────────────────────────────
-    .post("/:id", async ({ params }) => {
-    try {
-        if (!params.id.includes("-"))
-            return await OpportunityService.recreate(params.id);
-        const [chainId, type, identifier] = params.id.split("-");
-        return await OpportunityService.recreate(OpportunityService.hashId({
-            chainId: +chainId,
-            type: type,
-            identifier,
-        }));
-    }
-    catch (err) {
-        log.error("error recreating opportunity", err);
-        if (err.code && err.code === "P2025")
-            throw new NotFoundError();
-        throw err;
-    }
-}, { params: OpportunityUniqueUpdateDto })
-    // ─── Override An Opportunity Field ───────────────────────────────────
-    .guard({ params: OpportunityUniqueDto })
-    .patch("/:id", async ({ params, body }) => await OpportunityService.update(params.id, body), {
-    body: UpdateOpportunityDto,
-})
-    .patch("/:id/override", async ({ params, body }) => await OpportunityService.override(params.id, body), {
-    body: OpportunityOverrideDto,
-})
-    .delete("/:id/override", async ({ params, body }) => await OpportunityService.deleteOverrides(params.id, body), {
-    body: OpportunityDeleteOverrideDto,
-});

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

@@ -1,174 +0,0 @@
-import { TTLPresets } from "@/modules/v4/cache/cache.model";
-import { CacheService } from "@/modules/v4/cache/cache.service";
-import { OpportunityService } from "@/modules/v4/opportunity/opportunity.service";
-import { kebabToPascalCase } from "@/utils/caseChanges";
-import { log } from "@/utils/logger";
-import { Campaign as CampaignType, EAprBreakdownType, opportunityActions, } from "@sdk";
-import moment from "moment";
-export class OpportunityConvertorService {
-    static convertV4CampaignToV3(campaignType, campaign, opportunityIdentifier) {
-        return {
-            amount: campaign.amount.toString(),
-            campaignId: campaign.campaignId,
-            computeChainId: campaign.computeChainId,
-            campaignParameters: campaign.params,
-            campaignSubType: campaign.subType ?? 0,
-            campaignType,
-            chainId: campaign.distributionChain?.id ?? 0,
-            creator: campaign.creatorAddress,
-            index: 0, // DEPRECATED
-            mainParameter: opportunityIdentifier,
-            endTimestamp: Number(campaign.endTimestamp),
-            startTimestamp: Number(campaign.startTimestamp),
-            rewardToken: campaign.rewardToken.address,
-            amm: campaign.params?.amm,
-        };
-    }
-    static convertV4toV3(opportunity, withCampaigns = false) {
-        const now = moment().unix();
-        const id = `${CampaignType[opportunity.type]}_${opportunity.identifier}`; // V3 id
-        // Convert v4 actions to old type
-        let action = opportunity.action.toLowerCase();
-        if (!opportunityActions.includes(action)) {
-            action = "hold";
-        }
-        const tvlBreakdownTokens = [];
-        const tvlBreakdownDetails = {};
-        if (!!opportunity?.tvlRecord?.breakdowns) {
-            for (const breakdown of opportunity.tvlRecord.breakdowns) {
-                if (breakdown.type === "TOKEN") {
-                    const token = opportunity.tokens.find(token => token.address === breakdown.identifier);
-                    if (!!token)
-                        tvlBreakdownTokens.push({
-                            symbol: token?.symbol,
-                            amount: breakdown.value,
-                        });
-                }
-                else {
-                    tvlBreakdownDetails[breakdown.identifier] = {
-                        value: breakdown.value,
-                        address: breakdown.identifier.split(" ")[breakdown.identifier.split(" ").length - 1],
-                        label: breakdown.identifier.split(" ")[0],
-                    };
-                }
-            }
-        }
-        const aprBreakdown = {};
-        const aprBreakdown2 = [];
-        if (!!opportunity?.aprRecord?.breakdowns) {
-            for (const breakdown of opportunity.aprRecord.breakdowns) {
-                if (breakdown.type === "CAMPAIGN") {
-                    aprBreakdown2.push({
-                        value: breakdown.value,
-                        label: `Campaign ${breakdown.identifier.slice(0, 8)}`,
-                        type: EAprBreakdownType.CAMPAIGN,
-                        address: breakdown.identifier,
-                    });
-                }
-                else if (breakdown.type === "PROTOCOL") {
-                    const address = breakdown.identifier.split(" ")[breakdown.identifier.split(" ").length - 1];
-                    const detail = {
-                        value: breakdown.value,
-                        label: breakdown.identifier.replace(address, "").trim(),
-                        type: EAprBreakdownType.FORWARDER,
-                        address,
-                    };
-                    aprBreakdown[breakdown.identifier] = detail;
-                    aprBreakdown2.push(detail);
-                }
-                else {
-                    console.log(breakdown);
-                }
-            }
-        }
-        return {
-            id,
-            chainId: opportunity.chainId,
-            name: opportunity.name,
-            status: opportunity.status.toLowerCase(),
-            action,
-            tokenIcons: opportunity.tokens?.filter(token => token.icon?.length > 0).map(token => token.symbol), // Do not return tokens without icons,
-            tvl: opportunity?.tvlRecord?.total,
-            tvlBreakdown: tvlBreakdownTokens.length > 0 || Object.keys(tvlBreakdownDetails).length > 0
-                ? {
-                    tokens: tvlBreakdownTokens,
-                    details: tvlBreakdownDetails,
-                }
-                : undefined,
-            platform: kebabToPascalCase(opportunity.protocol?.id ?? ""),
-            apr: opportunity.apr,
-            aprBreakdown: Object.keys(aprBreakdown).length > 0 ? aprBreakdown : undefined,
-            aprBreakdown2: aprBreakdown2.length > 0 ? aprBreakdown2 : undefined,
-            dailyrewards: opportunity.dailyRewards,
-            dailyRewardTokens: !!opportunity?.rewardsRecord?.breakdowns
-                ? opportunity.rewardsRecord.breakdowns.map(reward => ({
-                    symbol: reward.token.symbol,
-                    amount: reward.amount.toString(),
-                    address: reward.token.address,
-                }))
-                : undefined,
-            tags: opportunity.tags,
-            rewardTokenIcons: opportunity.campaigns
-                ?.filter(campaign => campaign.rewardToken.icon?.length > 0) // Do not return tokens without icons
-                ?.map(campaign => campaign.rewardToken.symbol)
-                .reduce((acc, curr) => {
-                if (!acc.includes(curr))
-                    acc.push(curr);
-                return acc;
-            }, []) ?? [],
-            campaigns: {
-                type: CampaignType[opportunity.type],
-                ids: opportunity.campaigns?.map(campaign => campaign.campaignId) ?? [],
-                active: withCampaigns
-                    ? opportunity.campaigns
-                        ?.filter(campaign => campaign.startTimestamp < BigInt(now) && BigInt(now) < campaign.endTimestamp)
-                        .map(campaign => OpportunityConvertorService.convertV4CampaignToV3(CampaignType[campaign.type], campaign, opportunity.identifier))
-                    : undefined,
-                inactive: withCampaigns
-                    ? opportunity.campaigns
-                        ?.filter(campaign => !(campaign.startTimestamp < BigInt(now) && BigInt(now) < campaign.endTimestamp))
-                        .map(campaign => OpportunityConvertorService.convertV4CampaignToV3(CampaignType[campaign.type], campaign, opportunity.identifier))
-                    : undefined,
-            },
-        };
-    }
-    static async #extractV3Opportunities(showCampaigns, test, identifier, chainId) {
-        let opportunities = [];
-        let page = 0;
-        while (true) {
-            try {
-                const opportunitiesPage = await OpportunityService.findMany({
-                    items: 100, // HARDCODED LIMIT
-                    page,
-                    test,
-                    identifier,
-                    chainId,
-                    campaigns: true,
-                });
-                opportunities = opportunities.concat(opportunitiesPage);
-                if (opportunitiesPage.length === 0)
-                    break;
-            }
-            catch {
-                break;
-            }
-            page++;
-        }
-        const res = {};
-        for (const opportunity of opportunities) {
-            const opportunityV3 = OpportunityConvertorService.convertV4toV3(opportunity, showCampaigns);
-            res[opportunityV3.id] = opportunityV3;
-        }
-        return res;
-    }
-    static async setV3Opportunities(showCampaigns, test, identifier, chainId) {
-        return await CacheService.set(TTLPresets.HOUR_4, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
-    }
-    static async logKeyAndTTLV3Opportunities(showCampaigns, test, identifier, chainId) {
-        const [key, ttl] = await CacheService.keyAndTTL(OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
-        log.info(`Args: ${showCampaigns}, ${test}, ${identifier}, ${chainId}, Key: ${key}, TTL: ${ttl}`);
-    }
-    static async wrapV3Opportunities(showCampaigns, test, identifier, chainId) {
-        return await CacheService.wrap(TTLPresets.MIN_10, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
-    }
-}

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

@@ -1,132 +0,0 @@
-import { AprRecordResourceDto } from "@/modules/v4/apr/apr.model";
-import { CampaignResourceDto } from "@/modules/v4/campaign/campaign.model";
-import { ProtocolResourceDto } from "@/modules/v4/protocol/protocol.model";
-import { DailyRewardsRecordResourceDto } from "@/modules/v4/reward/reward.model";
-import { TokenDto, TokenResourceDto } from "@/modules/v4/token/token.model";
-import { TvlRecordResourceDto } from "@/modules/v4/tvl/tvl.model";
-import { DistributionType, OpportunityAction, OpportunityManualOverride, Status } from "@db/api";
-import { t } from "elysia";
-import { ChainResourceDto } from "../chain/chain.model";
-// ─── DTOs ────────────────────────────────────────────────────────────────────
-export const OpportunityResourceDto = t.Object({
-    chainId: t.Number(),
-    type: t.String(),
-    identifier: t.String(),
-    name: t.String(),
-    description: t.String(),
-    howToSteps: t.Array(t.String()),
-    status: t.String(),
-    action: t.String(),
-    tvl: t.Number(),
-    apr: t.Number(),
-    dailyRewards: t.Number(),
-    depositUrl: t.Optional(t.String()),
-    explorerAddress: t.Optional(t.String()),
-    distributionType: t.Optional(t.Enum(DistributionType)),
-    tags: t.Array(t.String()),
-    id: t.String(),
-    tokens: t.Array(TokenResourceDto),
-    chain: ChainResourceDto,
-    aprRecord: t.Optional(AprRecordResourceDto),
-    tvlRecord: t.Optional(TvlRecordResourceDto),
-    rewardsRecord: t.Optional(DailyRewardsRecordResourceDto),
-    lastCampaignCreatedAt: t.String({ format: "date" }),
-    protocol: t.Optional(t.Union([ProtocolResourceDto, t.Null()])),
-});
-export const OpportunityWithCampaignsResourceDto = t.Composite([
-    OpportunityResourceDto,
-    t.Object({ campaigns: t.Array(CampaignResourceDto) }),
-]);
-export const OpportunityUniqueDto = t.Object({
-    id: t.String({
-        pattern: "(([0-9]*)-([0-9A-Z]*)-(0x([0-9A-Za-z])*))|([0-9]{1,20})",
-        description: "The id of the opportunity. You can find opportunities including their id at [GET /v4/opportunities](#tag/opportunities/GET/v4/opportunities/)",
-    }),
-});
-export const OpportunityUniqueUpdateDto = t.Object({
-    id: t.String({
-        pattern: "(([0-9]*)-([0-9A-Z]*)-(0x([0-9A-Za-z])*))|([0-9]{1,20})",
-        description: "The id of the opportunity. You can find opportunities including their id at [GET /v4/opportunities](#tag/opportunities/GET/v4/opportunities/)",
-    }),
-    campaignId: t.Optional(t.String({ description: "The id of the campaign you want to reparse with" })),
-});
-export const AggregationResourceDto = t.Object({
-    sum: t.Number(),
-});
-export const GetOpportunitiesQueryDto = t.Object({
-    name: t.Optional(t.String({ description: "Filter by name" })),
-    search: t.Optional(t.String({ description: "Search amongst multiple values (token, protocols, tags, campaigns)" })),
-    campaignId: t.Optional(t.String({ description: "Search the opportunity linked to a given campaignId" })),
-    //TODO: find a systemic way of handling query param arrays
-    chainId: t.Optional(t.RegExp(/^\d+(,\d+)*$/, {
-        description: "A comma separated list of chain ids. Example: ?chainId=1,42161<br>You can get the list of all supported chains by calling [GET /v4/chains](#tag/chains/GET/v4/chains/)",
-    })),
-    action: t.Optional(t.String({
-        description: `A comma seprated list actions. Legal values are: ${Object.values(OpportunityAction).join(", ")}`,
-    })),
-    type: t.Optional(t.String({ description: "A comma separated list of Opportunity type" })),
-    creatorAddress: t.Optional(t.String({ description: "Filter by creator address" })),
-    tags: t.Optional(t.String({ description: "Filter by tag" })),
-    test: t.Optional(t.Boolean({ description: "Include opportunities with test campaigns" })),
-    point: t.Optional(t.Boolean({ description: "Include opportunities with point campaigns", default: false })),
-    minimumTvl: t.Optional(t.Number({ description: "Minimum TVL threshhold in USD" })),
-    status: t.Optional(t.RegExp(/^(LIVE|PAST|SOON)(,(LIVE|PAST|SOON)){0,2}$/, {
-        description: "A comma separeted list of status. Legal values are: `LIVE`, `PAST`, `SOON`",
-    })),
-    identifier: t.Optional(t.String({ description: "Filter by identifier (mainParameter)." })),
-    campaigns: t.Optional(t.Boolean({ description: "Include campaign data. Will slow down the request. Default: false" })),
-    tokens: t.Optional(t.String({ description: "A comma separated list of token symbol. Use to filter by token" })),
-    rewardTokenSymbol: t.Optional(t.String({
-        description: "Filter by opportunity that have at least 1 campaigns where the reward token has this symbol",
-    })),
-    sort: t.Optional(t.RegExp(/(apr|tvl|rewards|lastCampaignCreatedAt)/, {
-        description: "Sort by `apr`, `tvl`, `rewards` or last campaign creation date",
-    })),
-    order: t.Optional(t.RegExp(/desc|asc/, {
-        description: "`asc` to sort in ascending order or `desc` to sort in descending order.",
-        default: "desc",
-    })),
-    mainProtocolId: t.Optional(t.String({
-        description: "A comma separated list of protocol ids. You can get the list of all supported protocols by calling [GET /v4/protocols](#tag/protocols/GET/v4/protocols/)",
-    })),
-    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
-});
-export const GetOpportunityQueryDto = t.Object({
-    test: t.Optional(t.Boolean({ description: "Include test campaigns" })),
-    point: t.Optional(t.Boolean({ description: "Include point campaigns", default: false })),
-    campaigns: t.Optional(t.Boolean({ description: "Include campaign data. Will slow down the request. Default: false" })),
-});
-export const CreateOpportunityDto = t.Object({
-    chainId: t.Number(),
-    type: t.String(),
-    identifier: t.String(),
-    name: t.Optional(t.String()),
-    status: t.Enum(Status),
-    action: t.Enum(OpportunityAction),
-    description: t.Optional(t.String()),
-    howToSteps: t.Optional(t.Array(t.String())),
-    tokens: t.Array(TokenDto),
-    protocols: t.Optional(t.Array(t.String())),
-    mainProtocol: t.Optional(t.String()),
-    depositUrl: t.Optional(t.String()),
-    explorerAddress: t.Optional(t.String()),
-    tags: t.Optional(t.Array(t.String())),
-});
-export const OpportunityAggregateFieldDto = t.Object({
-    field: t.Union(["dailyRewards", "tvl", "apr"].map(v => t.Literal(v))),
-});
-export const OpportunityIdDto = t.Object({ id: t.String() });
-export const OpportunityOverrideDto = t.Object({
-    name: t.Optional(t.String()),
-    description: t.Optional(t.String()),
-    howToSteps: t.Optional(t.Array(t.String())),
-    depositUrl: t.Optional(t.String({ format: "uri" })),
-    explorerAddress: t.Optional(t.String({ format: "uri" })),
-    action: t.Optional(t.Enum(OpportunityAction)),
-    mainProtocolId: t.Optional(t.String()),
-});
-export const OpportunityDeleteOverrideDto = t.Array(t.Enum(OpportunityManualOverride));
-export const UpdateOpportunityDto = t.Object({
-    tags: t.Optional(t.Array(t.String())),
-});