@merkl/api 1.0.78 → 1.0.80

package/dist/src/modules/v4/reward/reward.controller.d.ts

@@ -0,0 +1,598 @@
+import Elysia from "elysia";
+export declare const RewardController: Elysia<"/rewards", {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+}, {
+    rewards: {
+        get: {
+            body: unknown;
+            params: {};
+            query: {
+                items?: number | undefined;
+                page?: number | undefined;
+                campaignId: string;
+                chainId: number;
+            };
+            headers: unknown;
+            response: {
+                200: import("./reward.model").BreakdownForCampaignsRaw[];
+                422: {
+                    type: "validation";
+                    on: string;
+                    summary?: string;
+                    message?: string;
+                    found?: unknown;
+                    property?: string;
+                    expected?: string;
+                };
+            };
+        };
+    } & {
+        total: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    items?: number | undefined;
+                    page?: number | undefined;
+                    campaignId: string;
+                    chainId: number;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        campaignId: string;
+                        amount: bigint;
+                    };
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    } & {
+        count: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    items?: number | undefined;
+                    page?: number | undefined;
+                    campaignId: string;
+                    chainId: number;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        count: number;
+                    };
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    } & {
+        campaign: {
+            ":campaignId": {
+                get: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {
+                        campaignId: string;
+                    };
+                    query: {
+                        items?: number | undefined;
+                        page?: number | undefined;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: {
+                            amount: string;
+                            claimed: string;
+                            pending: string;
+                            recipient: string;
+                        }[];
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        campaign: {
+            ":campaignId": {
+                total: {
+                    get: {
+                        body: unknown;
+                        params: {
+                            campaignId: string;
+                        } & {
+                            campaignId: string;
+                        };
+                        query: {
+                            items?: number | undefined;
+                            page?: number | undefined;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: {
+                                tokenId: string;
+                                amount: bigint;
+                            };
+                            422: {
+                                type: "validation";
+                                on: string;
+                                summary?: string;
+                                message?: string;
+                                found?: unknown;
+                                property?: string;
+                                expected?: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        campaign: {
+            ":campaignId": {
+                count: {
+                    get: {
+                        body: unknown;
+                        params: {
+                            campaignId: string;
+                        } & {
+                            campaignId: string;
+                        };
+                        query: {
+                            items?: number | undefined;
+                            page?: number | undefined;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: {
+                                count: number;
+                            };
+                            422: {
+                                type: "validation";
+                                on: string;
+                                summary?: string;
+                                message?: string;
+                                found?: unknown;
+                                property?: string;
+                                expected?: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        token: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    recipient?: string | undefined;
+                    items?: number | undefined;
+                    page?: number | undefined;
+                    campaignIds?: string[] | undefined;
+                    address: string;
+                    chainId: number;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        amount: string;
+                        claimed: string;
+                        pending: string;
+                        recipient: string;
+                    }[];
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    } & {
+        token: {
+            total: {
+                get: {
+                    body: unknown;
+                    params: {};
+                    query: {
+                        recipient?: string | undefined;
+                        items?: number | undefined;
+                        page?: number | undefined;
+                        campaignIds?: string[] | undefined;
+                        address: string;
+                        chainId: number;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: {
+                            tokenId: string;
+                            amount: bigint;
+                        };
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        token: {
+            count: {
+                get: {
+                    body: unknown;
+                    params: {};
+                    query: {
+                        recipient?: string | undefined;
+                        items?: number | undefined;
+                        page?: number | undefined;
+                        campaignIds?: string[] | undefined;
+                        address: string;
+                        chainId: number;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: {
+                            count: number;
+                        };
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        engine: {
+            post: {
+                body: {
+                    rewardToken: string;
+                    claimed: string;
+                    recipient: string;
+                    amount: string;
+                    root: string;
+                    proofs: string[];
+                    pending: string;
+                    distributionChainId: number;
+                }[];
+                params: {};
+                query: unknown;
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: {
+                        count: number;
+                    };
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    } & {
+        engine: {
+            breakdowns: {
+                post: {
+                    body: {
+                        rewardToken: string;
+                        campaignId: string;
+                        root: string;
+                        distributionChainId: number;
+                        breakdowns: {
+                            protocolId?: string | undefined;
+                            claimed: string;
+                            recipient: string;
+                            amount: string;
+                            reason: string;
+                            pending: string;
+                        }[];
+                    }[];
+                    params: {};
+                    query: unknown;
+                    headers: {
+                        authorization: string;
+                    };
+                    response: {
+                        200: {
+                            count: number;
+                        } | undefined;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        engine: {
+            claims: {
+                post: {
+                    body: {
+                        token: string;
+                        recipient: string;
+                        root: string;
+                        chainId: number;
+                    }[];
+                    params: {};
+                    query: unknown;
+                    headers: {
+                        authorization: string;
+                    };
+                    response: {
+                        200: void;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        count: {
+            chain: {
+                get: {
+                    body: unknown;
+                    params: {};
+                    query: {
+                        chainId: number;
+                    };
+                    headers: {
+                        authorization: string;
+                    };
+                    response: {
+                        200: {
+                            [x: string]: {
+                                rewardCount: number;
+                                breakdownCount: number;
+                            };
+                        };
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        unclaim: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    chainId: number;
+                    campaignIds: string[];
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        [x: string]: string;
+                    };
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    };
+} & {
+    rewards: {
+        total: {
+            distributed: {
+                get: {
+                    body: unknown;
+                    params: {};
+                    query: {
+                        since: Date;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: number;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    rewards: {
+        total: {
+            distributed: {
+                "by-chains": {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            since: Date;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: number;
+                            422: {
+                                type: "validation";
+                                on: string;
+                                summary?: string;
+                                message?: string;
+                                found?: unknown;
+                                property?: string;
+                                expected?: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    rewards: {
+        total: {
+            distributed: {
+                "by-types": {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            since: Date;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: number;
+                            422: {
+                                type: "validation";
+                                on: string;
+                                summary?: string;
+                                message?: string;
+                                found?: unknown;
+                                property?: string;
+                                expected?: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    rewards: {
+        total: {
+            distributed: {
+                "by-protocols": {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            since: Date;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: number;
+                            422: {
+                                type: "validation";
+                                on: string;
+                                summary?: string;
+                                message?: string;
+                                found?: unknown;
+                                property?: string;
+                                expected?: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {
+        body: unknown;
+        headers: unknown;
+        query: {
+            since: Date;
+        };
+        params: {};
+        cookie: unknown;
+        response: {
+            200: number;
+        };
+    };
+    standaloneSchema: {};
+}>;

package/dist/src/modules/v4/reward/reward.converter.d.ts

@@ -0,0 +1,14 @@
+import type { MerklAPIType, MerklChainId } from "@angleprotocol/sdk/ts";
+import type { RewardV3Model, UserRewardV3Model } from "./reward.model";
+import { RewardService } from "./reward.service";
+export declare class RewardConvertorService {
+    /**
+     * Convert the v4 reward data to the v3 model used in the v3/userRewards route
+     */
+    static convertV4toUserRewardV3(data: Awaited<ReturnType<(typeof RewardService)["getUserRewardsByChain"]>>, includeProofs?: boolean): UserRewardV3Model;
+    /**
+     * Convert the v4 reward data to the v3 model used in the v3/rewards route
+     */
+    static convertV4toRewardV3(data: Awaited<ReturnType<(typeof RewardService)["getUserRewardsByChain"]>>): RewardV3Model;
+    static convertV4toMerklV2(user: string, chainId: MerklChainId, data: MerklAPIType[number]): Promise<MerklAPIType[number]>;
+}