npm - @merkl/api - Versions diffs - 0.20.0 → 0.20.2 - Mend

@merkl/api 0.20.0 → 0.20.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

package/dist/src/modules/v4/opportunity/opportunity.controller.d.ts CHANGED Viewed

@@ -19,6 +19,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     name?: string | undefined;
                     tags?: string[] | undefined;
                     depositUrl?: string | undefined;
+                    explorerAddress?: string | undefined;
                     protocols?: string[] | undefined;
                     mainProtocol?: string | undefined;
                     type: string;
@@ -47,6 +48,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         action: import("@db/api").$Enums.OpportunityAction;
                         chainId: number;
                         depositUrl: string | null;
+                        explorerAddress: string | null;
                         mainProtocolId: string | null;
                         tvl: number;
                         apr: number;
@@ -95,6 +97,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         })[];
                         mainProtocol: "splice" | "morpho" | "euler" | "ambient" | "uniswap" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quick-swap" | "ramses" | "retro" | "stryke" | "sushiswap" | "swapr" | "thruster" | "voltage" | "zero" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "fraxlend" | "ironclad" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "satlayer" | undefined;
                         depositUrl: any;
+                        explorerAddress: string | undefined;
                         tags: string[];
                     };
                 };
@@ -131,44 +134,136 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                 };
                 headers: unknown;
                 response: {
-                    200: {
-                        apr: number;
-                        aprRecord: {
+                    200: ({
+                        protocol?: {
+                            id: string;
+                            name: string;
+                            url: string;
+                            description: string;
+                            tags: string[];
+                            icon: string;
+                        } | null | undefined;
+                        depositUrl?: string | undefined;
+                        explorerAddress?: string | undefined;
+                        aprRecord?: {
+                            timestamp: string | bigint;
                             cumulated: number;
-                            timestamp: bigint;
                             breakdowns: {
                                 id: number;
-                                type: import("@db/api").$Enums.AprType;
-                                uuid: string;
+                                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
                                 identifier: string;
                                 value: number;
                                 aprRecordId: string;
                             }[];
-                        };
-                        tvlRecord: {
-                            id: string;
+                        } | undefined;
+                        tvlRecord?: {
                             total: number;
-                            timestamp: bigint;
+                            timestamp: string | bigint;
                             breakdowns: {
                                 id: number;
-                                type: import("@db/api").$Enums.TvlType;
-                                uuid: string;
+                                type: "TOKEN" | "PROTOCOL";
                                 identifier: string;
                                 value: number;
                                 tvlRecordId: string;
                             }[];
-                        };
-                        rewardsRecord: {
+                        } | undefined;
+                        rewardsRecord?: {
                             id: string;
                             total: number;
-                            timestamp: bigint;
+                            timestamp: string | bigint;
                             breakdowns: {
                                 id: number;
-                                uuid: string;
+                                token: {
+                                    price?: number | null | undefined;
+                                    symbol: string;
+                                    id: string;
+                                    name: string | null;
+                                    icon: string;
+                                    address: string;
+                                    chainId: number;
+                                    decimals: number;
+                                    verified: boolean;
+                                    isTest: boolean;
+                                };
                                 value: number;
                                 campaignId: string;
+                                amount: string | bigint;
                                 dailyRewardsRecordId: string;
+                            }[];
+                        } | undefined;
+                        id: string;
+                        name: string;
+                        type: string;
+                        status: string;
+                        tokens: {
+                            price?: number | null | undefined;
+                            symbol: string;
+                            id: string;
+                            name: string | null;
+                            icon: string;
+                            address: string;
+                            chainId: number;
+                            decimals: number;
+                            verified: boolean;
+                            isTest: boolean;
+                        }[];
+                        tags: string[];
+                        identifier: string;
+                        chain: {
+                            id: number;
+                            name: string;
+                            icon: string;
+                        };
+                        action: string;
+                        chainId: number;
+                        tvl: number;
+                        apr: number;
+                        dailyRewards: number;
+                    } | null)[];
+                } | {
+                    200: never;
+                } | {
+                    200: (Response | ({
+                        protocol?: {
+                            id: string;
+                            name: string;
+                            url: string;
+                            description: string;
+                            tags: string[];
+                            icon: string;
+                        } | null | undefined;
+                        depositUrl?: string | undefined;
+                        explorerAddress?: string | undefined;
+                        aprRecord?: {
+                            timestamp: string | bigint;
+                            cumulated: number;
+                            breakdowns: {
+                                id: number;
+                                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                                identifier: string;
+                                value: number;
+                                aprRecordId: string;
+                            }[];
+                        } | undefined;
+                        tvlRecord?: {
+                            total: number;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                id: number;
+                                type: "TOKEN" | "PROTOCOL";
+                                identifier: string;
+                                value: number;
+                                tvlRecordId: string;
+                            }[];
+                        } | undefined;
+                        rewardsRecord?: {
+                            id: string;
+                            total: number;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                id: number;
                                 token: {
+                                    price?: number | null | undefined;
                                     symbol: string;
                                     id: string;
                                     name: string | null;
@@ -176,26 +271,107 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                     address: string;
                                     chainId: number;
                                     decimals: number;
-                                    displaySymbol: string;
                                     verified: boolean;
                                     isTest: boolean;
-                                    isPoint: boolean;
-                                    isNative: boolean;
-                                    price: number | null;
                                 };
-                                amount: bigint;
+                                value: number;
+                                campaignId: string;
+                                amount: string | bigint;
+                                dailyRewardsRecordId: string;
                             }[];
+                        } | undefined;
+                        id: string;
+                        name: string;
+                        type: string;
+                        status: string;
+                        tokens: {
+                            price?: number | null | undefined;
+                            symbol: string;
+                            id: string;
+                            name: string | null;
+                            icon: string;
+                            address: string;
+                            chainId: number;
+                            decimals: number;
+                            verified: boolean;
+                            isTest: boolean;
+                        }[];
+                        tags: string[];
+                        identifier: string;
+                        chain: {
+                            id: number;
+                            name: string;
+                            icon: string;
                         };
-                        campaigns: {
-                            params: any;
-                            chain: {
-                                id: number;
+                        action: string;
+                        chainId: number;
+                        tvl: number;
+                        apr: number;
+                        dailyRewards: number;
+                    } | null)[] | {
+                        200: ({
+                            protocol?: {
+                                id: string;
                                 name: string;
+                                url: string;
+                                description: string;
+                                tags: string[];
                                 icon: string;
-                            };
-                            endTimestamp: number;
-                            startTimestamp: number;
-                            rewardToken: {
+                            } | null | undefined;
+                            depositUrl?: string | undefined;
+                            explorerAddress?: string | undefined;
+                            aprRecord?: {
+                                timestamp: string | bigint;
+                                cumulated: number;
+                                breakdowns: {
+                                    id: number;
+                                    type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                                    identifier: string;
+                                    value: number;
+                                    aprRecordId: string;
+                                }[];
+                            } | undefined;
+                            tvlRecord?: {
+                                total: number;
+                                timestamp: string | bigint;
+                                breakdowns: {
+                                    id: number;
+                                    type: "TOKEN" | "PROTOCOL";
+                                    identifier: string;
+                                    value: number;
+                                    tvlRecordId: string;
+                                }[];
+                            } | undefined;
+                            rewardsRecord?: {
+                                id: string;
+                                total: number;
+                                timestamp: string | bigint;
+                                breakdowns: {
+                                    id: number;
+                                    token: {
+                                        price?: number | null | undefined;
+                                        symbol: string;
+                                        id: string;
+                                        name: string | null;
+                                        icon: string;
+                                        address: string;
+                                        chainId: number;
+                                        decimals: number;
+                                        verified: boolean;
+                                        isTest: boolean;
+                                    };
+                                    value: number;
+                                    campaignId: string;
+                                    amount: string | bigint;
+                                    dailyRewardsRecordId: string;
+                                }[];
+                            } | undefined;
+                            id: string;
+                            name: string;
+                            type: string;
+                            status: string;
+                            tokens: {
+                                price?: number | null | undefined;
                                 symbol: string;
                                 id: string;
                                 name: string | null;
@@ -205,59 +381,83 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                 decimals: number;
                                 verified: boolean;
                                 isTest: boolean;
-                                isPoint: boolean;
-                                isNative: boolean;
-                            } & {
-                                price?: number | null | undefined;
-                            };
-                            distributionChain: {
+                            }[];
+                            tags: string[];
+                            identifier: string;
+                            chain: {
                                 id: number;
                                 name: string;
                                 icon: string;
-                            } | undefined;
-                            campaignStatus: {
-                                computedUntil: number;
-                                processingStarted: number;
-                                error: string;
-                                status: import("@db/api").$Enums.RunStatus;
-                                details: import("database/api/.generated/runtime/library").JsonValue;
-                                campaignId: string;
-                            } | undefined;
-                            creatorAddress: string;
-                            creator: {
-                                tags: string[];
-                                address: string;
-                                creatorId: string | null;
                             };
-                            createdAt: string;
-                            Opportunity: {
-                                id: string;
-                                name: string;
-                                type: string;
-                                status: import("@db/api").$Enums.Status;
-                                tags: string[];
+                            action: string;
+                            chainId: number;
+                            tvl: number;
+                            apr: number;
+                            dailyRewards: number;
+                        } | null)[];
+                    }) & ({
+                        protocol?: {
+                            id: string;
+                            name: string;
+                            url: string;
+                            description: string;
+                            tags: string[];
+                            icon: string;
+                        } | null | undefined;
+                        depositUrl?: string | undefined;
+                        explorerAddress?: string | undefined;
+                        aprRecord?: {
+                            timestamp: string | bigint;
+                            cumulated: number;
+                            breakdowns: {
+                                id: number;
+                                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
                                 identifier: string;
-                                action: import("@db/api").$Enums.OpportunityAction;
-                                chainId: number;
-                                depositUrl: string | null;
-                                mainProtocolId: string | null;
-                                tvl: number;
-                                apr: number;
-                                dailyRewards: number;
-                            };
+                                value: number;
+                                aprRecordId: string;
+                            }[];
+                        } | undefined;
+                        tvlRecord?: {
+                            total: number;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                id: number;
+                                type: "TOKEN" | "PROTOCOL";
+                                identifier: string;
+                                value: number;
+                                tvlRecordId: string;
+                            }[];
+                        } | undefined;
+                        rewardsRecord?: {
                             id: string;
-                            type: string;
-                            subType: number | null;
-                            computeChainId: number;
-                            distributionChainId: number;
-                            campaignId: string;
-                            rewardTokenId: string;
-                            amount: string;
-                            opportunityId: string;
-                        }[] | undefined;
+                            total: number;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                id: number;
+                                token: {
+                                    price?: number | null | undefined;
+                                    symbol: string;
+                                    id: string;
+                                    name: string | null;
+                                    icon: string;
+                                    address: string;
+                                    chainId: number;
+                                    decimals: number;
+                                    verified: boolean;
+                                    isTest: boolean;
+                                };
+                                value: number;
+                                campaignId: string;
+                                amount: string | bigint;
+                                dailyRewardsRecordId: string;
+                            }[];
+                        } | undefined;
                         id: string;
-                        depositUrl: string | undefined;
-                        tokens: ({
+                        name: string;
+                        type: string;
+                        status: string;
+                        tokens: {
+                            price?: number | null | undefined;
                             symbol: string;
                             id: string;
                             name: string | null;
@@ -267,34 +467,109 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             decimals: number;
                             verified: boolean;
                             isTest: boolean;
-                            isPoint: boolean;
-                            isNative: boolean;
-                        } & {
-                            price?: number | null | undefined;
-                        })[];
+                        }[];
+                        tags: string[];
+                        identifier: string;
                         chain: {
                             id: number;
                             name: string;
                             icon: string;
                         };
-                        protocol: {
-                            id: string;
-                            name: string;
-                            url: string;
-                            description: string;
-                            tags: string[];
-                            icon: string;
-                        } | undefined;
-                        name: string;
-                        type: string;
-                        status: import("@db/api").$Enums.Status;
-                        tags: string[];
-                        identifier: string;
-                        action: import("@db/api").$Enums.OpportunityAction;
+                        action: string;
                         chainId: number;
                         tvl: number;
+                        apr: number;
                         dailyRewards: number;
-                    }[];
+                    } | null)[];
+                } | {
+                    200: {
+                        200: ({
+                            protocol?: {
+                                id: string;
+                                name: string;
+                                url: string;
+                                description: string;
+                                tags: string[];
+                                icon: string;
+                            } | null | undefined;
+                            depositUrl?: string | undefined;
+                            explorerAddress?: string | undefined;
+                            aprRecord?: {
+                                timestamp: string | bigint;
+                                cumulated: number;
+                                breakdowns: {
+                                    id: number;
+                                    type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                                    identifier: string;
+                                    value: number;
+                                    aprRecordId: string;
+                                }[];
+                            } | undefined;
+                            tvlRecord?: {
+                                total: number;
+                                timestamp: string | bigint;
+                                breakdowns: {
+                                    id: number;
+                                    type: "TOKEN" | "PROTOCOL";
+                                    identifier: string;
+                                    value: number;
+                                    tvlRecordId: string;
+                                }[];
+                            } | undefined;
+                            rewardsRecord?: {
+                                id: string;
+                                total: number;
+                                timestamp: string | bigint;
+                                breakdowns: {
+                                    id: number;
+                                    token: {
+                                        price?: number | null | undefined;
+                                        symbol: string;
+                                        id: string;
+                                        name: string | null;
+                                        icon: string;
+                                        address: string;
+                                        chainId: number;
+                                        decimals: number;
+                                        verified: boolean;
+                                        isTest: boolean;
+                                    };
+                                    value: number;
+                                    campaignId: string;
+                                    amount: string | bigint;
+                                    dailyRewardsRecordId: string;
+                                }[];
+                            } | undefined;
+                            id: string;
+                            name: string;
+                            type: string;
+                            status: string;
+                            tokens: {
+                                price?: number | null | undefined;
+                                symbol: string;
+                                id: string;
+                                name: string | null;
+                                icon: string;
+                                address: string;
+                                chainId: number;
+                                decimals: number;
+                                verified: boolean;
+                                isTest: boolean;
+                            }[];
+                            tags: string[];
+                            identifier: string;
+                            chain: {
+                                id: number;
+                                name: string;
+                                icon: string;
+                            };
+                            action: string;
+                            chainId: number;
+                            tvl: number;
+                            apr: number;
+                            dailyRewards: number;
+                        } | null)[];
+                    };
                 };
             };
         };
@@ -358,6 +633,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             icon: string;
                         } | null | undefined;
                         depositUrl?: string | undefined;
+                        explorerAddress?: string | undefined;
                         aprRecord?: {
                             timestamp: string | bigint;
                             cumulated: number;
@@ -488,6 +764,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             icon: string;
                         } | null | undefined;
                         depositUrl?: string | undefined;
+                        explorerAddress?: string | undefined;
                         aprRecord?: {
                             timestamp: string | bigint;
                             cumulated: number;
@@ -652,6 +929,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                 icon: string;
                             } | null | undefined;
                             depositUrl?: string | undefined;
+                            explorerAddress?: string | undefined;
                             aprRecord?: {
                                 timestamp: string | bigint;
                                 cumulated: number;
@@ -946,6 +1224,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         action: import("@db/api").$Enums.OpportunityAction;
                         chainId: number;
                         depositUrl: string | null;
+                        explorerAddress: string | null;
                         mainProtocolId: string | null;
                         tvl: number;
                         apr: number;

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

@@ -40,6 +40,7 @@ export declare const OpportunityResourceDto: import("@sinclair/typebox").TObject
     apr: import("@sinclair/typebox").TNumber;
     dailyRewards: import("@sinclair/typebox").TNumber;
     depositUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    explorerAddress: 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<{
@@ -156,6 +157,7 @@ export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/type
     action: import("@sinclair/typebox").TString;
     chainId: import("@sinclair/typebox").TNumber;
     depositUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    explorerAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     tvl: import("@sinclair/typebox").TNumber;
     apr: import("@sinclair/typebox").TNumber;
     dailyRewards: import("@sinclair/typebox").TNumber;
@@ -329,6 +331,7 @@ export declare const CreateOpportunityDto: import("@sinclair/typebox").TObject<{
     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>;
+    explorerAddress: 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<{

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

@@ -19,6 +19,7 @@ export const OpportunityResourceDto = t.Object({
     apr: t.Number(),
     dailyRewards: t.Number(),
     depositUrl: t.Optional(t.String()),
+    explorerAddress: t.Optional(t.String()),
     tags: t.Array(t.String()),
     id: t.String(),
     tokens: t.Array(TokenResourceDto),
@@ -100,6 +101,7 @@ export const CreateOpportunityDto = t.Object({
     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({