@merkl/api 0.10.199 → 0.10.200

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

@@ -1,13 +1,13 @@
-import type { AprRecord } from "../apr/apr.model";
+import { type AprRecord } from "../apr/apr.model";
 import type { Resource } from "../prisma";
-import type { Protocol, ProtocolId } from "../protocol/protocol.model";
-import type { DailyRewardsRecord } from "../reward";
+import { type Protocol, type ProtocolId } from "../protocol/protocol.model";
+import { type DailyRewardsRecord } from "../reward";
 import { type Token } from "../token/token.model";
-import type { TvlRecord } from "../tvl/tvl.model";
+import { type TvlRecord } from "../tvl/tvl.model";
 import { CampaignType, OpportunityAction } from "../../../../database/api/.generated";
 import type { ChainId } from "@sdk";
-import type { Campaign } from "../campaign";
-import type { Chain } from "../chain/chain.model";
+import { type Campaign } from "../campaign";
+import { type Chain } from "../chain/chain.model";
 import type { OpportunityRepository } from "./opportunity.repository";
 /**
  * Opportunity
@@ -38,32 +38,260 @@ export type OpportunityUnique = {
     type: CampaignType;
     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;
+    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").TEnum<{
+            AMM: "AMM";
+            ALM: "ALM";
+            DEX: "DEX";
+            LENDING: "LENDING";
+        }>>;
+        description: import("@sinclair/typebox").TString;
+        url: import("@sinclair/typebox").TString;
+    }>, import("@sinclair/typebox").TNull]>>;
+}>;
+export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/typebox").TObject<{
+    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").TEnum<{
+            AMM: "AMM";
+            ALM: "ALM";
+            DEX: "DEX";
+            LENDING: "LENDING";
+        }>>;
+        description: import("@sinclair/typebox").TString;
+        url: import("@sinclair/typebox").TString;
+    }>, import("@sinclair/typebox").TNull]>>;
+    name: import("@sinclair/typebox").TString;
+    type: 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;
+    }>>;
+    id: import("@sinclair/typebox").TString;
+    status: 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;
+    }>;
+    chainId: import("@sinclair/typebox").TNumber;
+    action: 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").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 OpportunityUniqueDto: import("@sinclair/typebox").TObject<{
     id: 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").TUnion<[import("@sinclair/typebox").TEnum<{
-        POOL: "POOL";
-        HOLD: "HOLD";
-        DROP: "DROP";
-        LEND: "LEND";
-        BORROW: "BORROW";
-        INVALID: "INVALID";
-    }>, import("@sinclair/typebox").TRegExp]>>;
+    action: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
     tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     test: 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>;
     tokens: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
-    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TEnum<{
-        NONE: "NONE";
-        PAST: "PAST";
-        LIVE: "LIVE";
-        SOON: "SOON";
-    }>, import("@sinclair/typebox").TRegExp]>>;
-    sort: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"apr">, import("@sinclair/typebox").TLiteral<"tvl">, import("@sinclair/typebox").TLiteral<"rewards">]>>;
-    order: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"asc">, import("@sinclair/typebox").TLiteral<"desc">]>>;
+    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>;
@@ -125,3 +353,5 @@ export type CreateOpportunityModel = typeof CreateOpportunityDto.static & {
 };
 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

@@ -1,29 +1,72 @@
-import { TokenDto } from "../token/token.model";
+import { AprRecordResourceDto } from "../apr/apr.model";
+import { ProtocolResourceDto } from "../protocol/protocol.model";
+import { DailyRewardsRecordResourceDto } from "../reward";
+import { TokenDto, TokenResourceDto } from "../token/token.model";
+import { TvlRecordResourceDto } from "../tvl/tvl.model";
 import { CampaignType, OpportunityAction, Status } from "../../../../database/api/.generated";
 import { t } from "elysia";
+import { CampaignResourceDto } from "../campaign";
+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(),
+    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})",
-        default: undefined,
+        description: "The id of the opportunity. You can find opportunities including their id at [GET /v4/opportunities](#tag/opportunities/GET/v4/opportunities/)",
     }),
 });
+export const AggregationResourceDto = t.Object({
+    sum: t.Number(),
+});
 export const GetOpportunitiesQueryDto = t.Object({
-    name: t.Optional(t.String()),
+    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+)*$/)),
+    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.Union([t.Enum(OpportunityAction), t.RegExp(/^(POOL|HOLD|DROP|LEND|BORROW)+(,(POOL|HOLD|DROP|LEND|BORROW)+)*$/)])),
-    tags: t.Optional(t.String()),
-    test: t.Optional(t.Boolean()),
-    minimumTvl: t.Optional(t.Number()),
-    tokens: t.Optional(t.String({ title: "Symbol" })),
-    status: t.Optional(t.Union([t.Enum(Status), t.RegExp(/^(LIVE|PAST|SOON)+(,(LIVE|PAST|SOON)+)*$/)])),
-    sort: t.Optional(t.Union([t.Literal("apr"), t.Literal("tvl"), t.Literal("rewards")])),
-    order: t.Optional(t.Union([t.Literal("asc"), t.Literal("desc")])),
-    mainProtocolId: t.Optional(t.String()),
-    page: t.Optional(t.Numeric()), // 0-indexed
-    items: t.Optional(t.Numeric()), // items per page
+    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`",
+    })),
+    tags: t.Optional(t.String({ description: "Filter by tag" })),
+    test: t.Optional(t.Boolean({ description: "Include opportunities with test campaigns" })),
+    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`",
+    })),
+    tokens: t.Optional(t.String({ description: "A comma separated list of token symbol. Use to filter by token" })),
+    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 CreateOpportunityDto = t.Object({
     chainId: t.Number(),

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

@@ -17,9 +17,9 @@ export declare abstract class OpportunityRepository {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             displaySymbol: string;
             verified: boolean;
@@ -80,9 +80,9 @@ export declare abstract class OpportunityRepository {
                         symbol: string;
                         name: string | null;
                         id: string;
+                        icon: string;
                         chainId: number;
                         address: string;
-                        icon: string;
                         decimals: number;
                         displaySymbol: string;
                         verified: boolean;
@@ -145,9 +145,9 @@ export declare abstract class OpportunityRepository {
                 symbol: string;
                 name: string | null;
                 id: string;
+                icon: string;
                 chainId: number;
                 address: string;
-                icon: string;
                 decimals: number;
                 displaySymbol: string;
                 verified: boolean;
@@ -181,9 +181,9 @@ export declare abstract class OpportunityRepository {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             displaySymbol: string;
             verified: boolean;
@@ -244,9 +244,9 @@ export declare abstract class OpportunityRepository {
                         symbol: string;
                         name: string | null;
                         id: string;
+                        icon: string;
                         chainId: number;
                         address: string;
-                        icon: string;
                         decimals: number;
                         displaySymbol: string;
                         verified: boolean;
@@ -294,9 +294,9 @@ export declare abstract class OpportunityRepository {
                 symbol: string;
                 name: string | null;
                 id: string;
+                icon: string;
                 chainId: number;
                 address: string;
-                icon: string;
                 decimals: number;
                 displaySymbol: string;
                 verified: boolean;
@@ -342,9 +342,9 @@ export declare abstract class OpportunityRepository {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             displaySymbol: string;
             verified: boolean;
@@ -405,9 +405,9 @@ export declare abstract class OpportunityRepository {
                         symbol: string;
                         name: string | null;
                         id: string;
+                        icon: string;
                         chainId: number;
                         address: string;
-                        icon: string;
                         decimals: number;
                         displaySymbol: string;
                         verified: boolean;
@@ -470,9 +470,9 @@ export declare abstract class OpportunityRepository {
                 symbol: string;
                 name: string | null;
                 id: string;
+                icon: string;
                 chainId: number;
                 address: string;
-                icon: string;
                 decimals: number;
                 displaySymbol: string;
                 verified: boolean;
@@ -506,9 +506,9 @@ export declare abstract class OpportunityRepository {
             symbol: string;
             name: string | null;
             id: string;
+            icon: string;
             chainId: number;
             address: string;
-            icon: string;
             decimals: number;
             displaySymbol: string;
             verified: boolean;
@@ -569,9 +569,9 @@ export declare abstract class OpportunityRepository {
                         symbol: string;
                         name: string | null;
                         id: string;
+                        icon: string;
                         chainId: number;
                         address: string;
-                        icon: string;
                         decimals: number;
                         displaySymbol: string;
                         verified: boolean;