@merkl/api 0.9.15

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

@@ -0,0 +1,357 @@
+import { type AprRecord } from "@/modules/v4/apr/apr.model";
+import { type Campaign } from "@/modules/v4/campaign/campaign.model";
+import type { Resource } from "@/modules/v4/prisma";
+import { type Protocol } from "@/modules/v4/protocol/protocol.model";
+import { type DailyRewardsRecord } from "@/modules/v4/reward/reward.model";
+import { type Token } from "@/modules/v4/token/token.model";
+import { type TvlRecord } from "@/modules/v4/tvl/tvl.model";
+import type { ChainId } from "@sdk";
+import { type Chain } from "../chain/chain.model";
+import type { OpportunityRepository } from "./opportunity.repository";
+/**
+ * Opportunity
+ * @description Target description of rewards campaigns
+ * @see {@link Resource}
+ */
+export type Opportunity = Resource<"Opportunity", "mainProtocolId", {
+    depositUrl?: string;
+    chain: Chain["model"];
+    tokens: Token["model"][];
+    protocol?: Protocol["model"];
+    aprRecord?: AprRecord["model"];
+    tvlRecord?: TvlRecord["model"];
+    rewardsRecord?: DailyRewardsRecord["model"];
+    campaigns?: Omit<Campaign["model"], "manualOverrides">[];
+}>;
+export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
+export type OpportunityUnique = {
+    chainId: ChainId;
+    type: string;
+    identifier: string;
+};
+export declare const OpportunityResourceDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    type: import("@sinclair/typebox").TString;
+    identifier: import("@sinclair/typebox").TString;
+    name: import("@sinclair/typebox").TString;
+    status: import("@sinclair/typebox").TString;
+    action: import("@sinclair/typebox").TString;
+    tvl: import("@sinclair/typebox").TNumber;
+    apr: import("@sinclair/typebox").TNumber;
+    dailyRewards: import("@sinclair/typebox").TNumber;
+    depositUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tags: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    id: import("@sinclair/typebox").TString;
+    tokens: import("@sinclair/typebox").TArray<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;
+    }>>;
+    chain: import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TNumber;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+    }>;
+    aprRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        cumulated: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            type: import("@sinclair/typebox").TEnum<{
+                CAMPAIGN: "CAMPAIGN";
+                TOKEN: "TOKEN";
+                PROTOCOL: "PROTOCOL";
+            }>;
+            identifier: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            aprRecordId: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+    tvlRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        total: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            type: import("@sinclair/typebox").TEnum<{
+                TOKEN: "TOKEN";
+                PROTOCOL: "PROTOCOL";
+            }>;
+            identifier: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            tvlRecordId: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+    rewardsRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        total: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            campaignId: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            dailyRewardsRecordId: import("@sinclair/typebox").TString;
+            token: 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;
+            }>;
+            amount: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        }>>;
+    }>>;
+    protocol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+        tags: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+        description: import("@sinclair/typebox").TString;
+        url: import("@sinclair/typebox").TString;
+    }>, import("@sinclair/typebox").TNull]>>;
+}>;
+export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    name: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TString;
+    status: import("@sinclair/typebox").TString;
+    protocol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+        tags: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+        description: import("@sinclair/typebox").TString;
+        url: import("@sinclair/typebox").TString;
+    }>, import("@sinclair/typebox").TNull]>>;
+    tokens: import("@sinclair/typebox").TArray<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;
+    }>>;
+    tags: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    identifier: import("@sinclair/typebox").TString;
+    chain: import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TNumber;
+        name: import("@sinclair/typebox").TString;
+        icon: import("@sinclair/typebox").TString;
+    }>;
+    action: import("@sinclair/typebox").TString;
+    chainId: import("@sinclair/typebox").TNumber;
+    depositUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tvl: import("@sinclair/typebox").TNumber;
+    apr: import("@sinclair/typebox").TNumber;
+    dailyRewards: import("@sinclair/typebox").TNumber;
+    aprRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        cumulated: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            type: import("@sinclair/typebox").TEnum<{
+                CAMPAIGN: "CAMPAIGN";
+                TOKEN: "TOKEN";
+                PROTOCOL: "PROTOCOL";
+            }>;
+            identifier: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            aprRecordId: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+    tvlRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        total: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            type: import("@sinclair/typebox").TEnum<{
+                TOKEN: "TOKEN";
+                PROTOCOL: "PROTOCOL";
+            }>;
+            identifier: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            tvlRecordId: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+    rewardsRecord: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        total: import("@sinclair/typebox").TNumber;
+        timestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            id: import("@sinclair/typebox").TNumber;
+            campaignId: import("@sinclair/typebox").TString;
+            value: import("@sinclair/typebox").TNumber;
+            dailyRewardsRecordId: import("@sinclair/typebox").TString;
+            token: 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;
+            }>;
+            amount: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBigInt, import("@sinclair/typebox").TString]>;
+        }>>;
+    }>>;
+    campaigns: import("@sinclair/typebox").TArray<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 OpportunityUniqueDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const OpportunityUniqueUpdateDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    campaignId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const AggregationResourceDto: import("@sinclair/typebox").TObject<{
+    sum: import("@sinclair/typebox").TNumber;
+}>;
+export declare const GetOpportunitiesQueryDto: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    action: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    creatorAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tags: 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>;
+    minimumTvl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    campaigns: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    tokens: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    rewardTokenSymbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    sort: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    order: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    mainProtocolId: 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 declare const GetOpportunityQueryDto: import("@sinclair/typebox").TObject<{
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    point: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+}>;
+export declare const CreateOpportunityDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    type: import("@sinclair/typebox").TString;
+    identifier: import("@sinclair/typebox").TString;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    status: import("@sinclair/typebox").TEnum<{
+        NONE: "NONE";
+        PAST: "PAST";
+        LIVE: "LIVE";
+        SOON: "SOON";
+    }>;
+    action: import("@sinclair/typebox").TEnum<{
+        POOL: "POOL";
+        HOLD: "HOLD";
+        DROP: "DROP";
+        LEND: "LEND";
+        BORROW: "BORROW";
+        LONG: "LONG";
+        SHORT: "SHORT";
+        SWAP: "SWAP";
+        INVALID: "INVALID";
+    }>;
+    tokens: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        address: import("@sinclair/typebox").TString;
+        chainId: import("@sinclair/typebox").TNumber;
+    }>>;
+    protocols: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    mainProtocol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    depositUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>;
+export declare const OpportunityAggregateFieldDto: import("@sinclair/typebox").TObject<{
+    field: import("@sinclair/typebox").TUnion<import("@sinclair/typebox").TLiteral<"tvl" | "apr" | "dailyRewards">[]>;
+}>;
+export declare const OpportunityIdDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const UpdateOpportunityDto: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
+        NONE: "NONE";
+        PAST: "PAST";
+        LIVE: "LIVE";
+        SOON: "SOON";
+    }>>;
+}>;
+export type GetOpportunitiesQueryModel = typeof GetOpportunitiesQueryDto.static;
+export type GetOpportunityQueryModel = typeof GetOpportunityQueryDto.static;
+export type CreateOpportunityModel = typeof CreateOpportunityDto.static & {
+    id: string;
+};
+export type OpportunityAggregateField = typeof OpportunityAggregateFieldDto.static;
+export type UpdateOpportunityModel = typeof UpdateOpportunityDto.static;
+export type OpportunityResourceModel = typeof OpportunityResourceDto.static;
+export type OpportunityWithCampaignsResourceModel = typeof OpportunityWithCampaignsResourceDto.static;

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

@@ -0,0 +1,112 @@
+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 { OpportunityAction, 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(),
+    status: t.String(),
+    action: t.String(),
+    tvl: t.Number(),
+    apr: t.Number(),
+    dailyRewards: t.Number(),
+    depositUrl: t.Optional(t.String()),
+    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),
+    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" })),
+    //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/)",
+    })),
+    //TODO: find a systemic way of handling query param arrays
+    action: t.Optional(t.RegExp(/^(POOL|HOLD|DROP|LEND|BORROW)(,(POOL|HOLD|DROP|LEND|BORROW)){0,4}$/, {
+        description: "A comma seprated list actions. Legal values are: `POOL`, `HOLD`, `DROP`, `LEND`, `BORROW`",
+    })),
+    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)/, { description: "Sort by `apr`, `tvl` or `rewards`" })),
+    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 })),
+});
+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),
+    tokens: t.Array(TokenDto),
+    protocols: t.Optional(t.Array(t.String())),
+    mainProtocol: t.Optional(t.String()),
+    depositUrl: 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 UpdateOpportunityDto = t.Object({
+    name: t.Optional(t.String()),
+    tags: t.Optional(t.Array(t.String())),
+    status: t.Optional(t.Enum(Status)),
+});