@merkl/api 0.9.15

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

@@ -0,0 +1,360 @@
+import Elysia from "elysia";
+export declare const TokenController: Elysia<"/tokens", false, {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    type: {};
+    error: {};
+}, {
+    schema: {};
+    macro: {};
+    macroFn: {};
+}, {
+    tokens: {
+        ":id": {
+            get: {
+                body: unknown;
+                params: {
+                    id: string;
+                };
+                query: unknown;
+                headers: unknown;
+                response: {
+                    200: {
+                        symbol: string;
+                        id: string;
+                        name: string | null;
+                        icon: string;
+                        address: string;
+                        chainId: number;
+                        decimals: number;
+                        verified: boolean;
+                        isTest: boolean;
+                        isPoint: boolean;
+                        isNative: boolean;
+                        price?: number | null | undefined;
+                    } | undefined;
+                };
+            };
+        };
+    } & {
+        ":id": {
+            allowance: {
+                ":owner": {
+                    ":spender": {
+                        get: {
+                            body: unknown;
+                            params: {
+                                id: string;
+                                owner: string;
+                                spender: string;
+                            };
+                            query: unknown;
+                            headers: unknown;
+                            response: {
+                                200: {
+                                    allowance: bigint;
+                                    symbol: string;
+                                    id: string;
+                                    name: string | null;
+                                    icon: string;
+                                    address: string;
+                                    chainId: number;
+                                    decimals: number;
+                                    verified: boolean;
+                                    isTest: boolean;
+                                    isPoint: boolean;
+                                    isNative: boolean;
+                                    price?: number | null | undefined;
+                                } | undefined;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        reward: {
+            ":chainId": {
+                get: {
+                    body: unknown;
+                    params: {
+                        chainId: number;
+                    };
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: {
+                            minimumAmountPerHour: any;
+                            symbol: string;
+                            id: string;
+                            name: string | null;
+                            icon: string;
+                            address: string;
+                            chainId: number;
+                            decimals: number;
+                            displaySymbol: string;
+                            verified: boolean;
+                            isTest: boolean;
+                            isPoint: boolean;
+                            isNative: boolean;
+                            price: number | null;
+                        }[];
+                    };
+                };
+            };
+        };
+    } & {
+        balances: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    verified?: boolean | undefined;
+                    tokenAddress?: string | undefined;
+                    additionalTokenAddresses?: string[] | undefined;
+                    chainId: number;
+                    userAddress: string;
+                };
+                headers: unknown;
+                response: {
+                    200: ({
+                        symbol: string;
+                        id: string;
+                        name: string | null;
+                        icon: string;
+                        address: string;
+                        chainId: number;
+                        decimals: number;
+                        verified: boolean;
+                        isTest: boolean;
+                        isPoint: boolean;
+                        isNative: boolean;
+                    } & {
+                        price?: number | null | undefined;
+                    } & {
+                        balance: bigint;
+                    })[];
+                };
+            };
+        };
+    } & {
+        index: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    symbol?: string | undefined;
+                    id?: string[] | undefined;
+                    name?: string | undefined;
+                    address?: string | undefined;
+                    chainId?: number | undefined;
+                    displaySymbol?: string | undefined;
+                    verified?: boolean | undefined;
+                    isNative?: boolean | undefined;
+                    test?: boolean | undefined;
+                    missingIcons?: boolean | undefined;
+                };
+                headers: unknown;
+                response: {
+                    200: ({
+                        symbol: string;
+                        id: string;
+                        name: string | null;
+                        icon: string;
+                        address: string;
+                        chainId: number;
+                        decimals: number;
+                        verified: boolean;
+                        isTest: boolean;
+                        isPoint: boolean;
+                        isNative: boolean;
+                    } & {
+                        price?: number | null | undefined;
+                    })[];
+                };
+            };
+        };
+    } & {
+        count: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    symbol?: string | undefined;
+                    id?: string[] | undefined;
+                    name?: string | undefined;
+                    address?: string | undefined;
+                    chainId?: number | undefined;
+                    displaySymbol?: string | undefined;
+                    verified?: boolean | undefined;
+                    isNative?: boolean | undefined;
+                    test?: boolean | undefined;
+                    missingIcons?: boolean | undefined;
+                };
+                headers: unknown;
+                response: {
+                    200: number;
+                };
+            };
+        };
+    } & {
+        index: {
+            post: {
+                body: {
+                    isTest?: boolean | undefined;
+                    icon: string;
+                    address: string;
+                    chainId: number;
+                    verified: boolean;
+                };
+                params: {};
+                query: unknown;
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: {
+                        symbol: string;
+                        id: string;
+                        name: string | null;
+                        icon: string;
+                        address: string;
+                        chainId: number;
+                        decimals: number;
+                        displaySymbol: string;
+                        verified: boolean;
+                        isTest: boolean;
+                        isPoint: boolean;
+                        isNative: boolean;
+                        price: number | null;
+                    } | undefined;
+                };
+            };
+        };
+    } & {
+        ":id": {
+            patch: {
+                body: {
+                    name?: string | undefined;
+                    icon?: string | undefined;
+                    displaySymbol?: string | undefined;
+                    verified?: boolean | undefined;
+                    isTest?: boolean | undefined;
+                    isPoint?: boolean | undefined;
+                };
+                params: {
+                    id: string;
+                };
+                query: unknown;
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: {
+                        symbol: string;
+                        id: string;
+                        name: string | null;
+                        icon: string;
+                        address: string;
+                        chainId: number;
+                        decimals: number;
+                        displaySymbol: string;
+                        verified: boolean;
+                        isTest: boolean;
+                        isPoint: boolean;
+                        isNative: boolean;
+                        price: number | null;
+                    };
+                };
+            };
+        };
+    } & {
+        icons: {
+            post: {
+                body: unknown;
+                params: {};
+                query: unknown;
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: void;
+                };
+            };
+        };
+    } & {
+        webhooks: {
+            notion: {
+                post: {
+                    body: {
+                        data: {
+                            properties: {
+                                Symbol: {
+                                    rich_text: {
+                                        plain_text: string;
+                                    }[];
+                                };
+                                Icon: {
+                                    files: {
+                                        file: {
+                                            url: string;
+                                        };
+                                    }[];
+                                };
+                                Address: {
+                                    rich_text: {
+                                        plain_text: string;
+                                    }[];
+                                };
+                                "Chain ID": {
+                                    number: number;
+                                };
+                                Verified: {
+                                    checkbox: boolean;
+                                };
+                                "CoinGecko API ID": {
+                                    rich_text: {
+                                        plain_text: string;
+                                    }[];
+                                };
+                            };
+                        };
+                    };
+                    params: {};
+                    query: unknown;
+                    headers: {
+                        authorization: string;
+                    };
+                    response: {
+                        200: {
+                            symbol: string;
+                            id: string;
+                            name: string | null;
+                            icon: string;
+                            address: string;
+                            chainId: number;
+                            decimals: number;
+                            displaySymbol: string;
+                            verified: boolean;
+                            isTest: boolean;
+                            isPoint: boolean;
+                            isNative: boolean;
+                            price: number | null;
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}>;

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

@@ -0,0 +1,108 @@
+import { NotFoundError } from "@/errors/NotFound.error";
+import { AuthorizationHeadersDto, BackOfficeGuard } from "@/guards/BackOffice.guard";
+import { getUserAllowance } from "@/libs/tokens/allowances";
+import { throwOnInvalidRequiredAddress, throwOnUnsupportedChainId } from "@/utils/throw";
+import Elysia from "elysia";
+import { ChainDto } from "../accounting";
+import { CreateTokenDto, FindUniqueTokenAllowanceDto, FindUniqueTokenDto, GetTokenBalanceDto, GetTokenQueryDto, NotionWebhookDto, TokenIdDto, UpdateTokenDto, } from "./token.model";
+import { TokenService } from "./token.service";
+// ─── Tokens Controller ───────────────────────────────────────────────────────
+export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: ["Tokens"] } })
+    // ─── Get A Token By Id ───────────────────────────────────────────────
+    .get("/:id", async ({ params }) => {
+    try {
+        const [chainId, address] = params.id.split("-");
+        return await TokenService.findUniqueOrThrow({ chainId: +chainId, address });
+    }
+    catch (err) {
+        if (err.code && err.code === "P2025")
+            throw new NotFoundError();
+    }
+}, {
+    params: FindUniqueTokenDto,
+    detail: {
+        hide: true,
+    },
+})
+    .get("/:id/allowance/:owner/:spender", async ({ params: { id, owner, spender } }) => {
+    try {
+        const [chainId, address] = id.split("-");
+        const token = await TokenService.findUniqueOrThrow({ chainId: +chainId, address });
+        const allowance = await getUserAllowance(token.chainId, token.address, owner, spender);
+        return { ...token, allowance };
+    }
+    catch (err) {
+        if (err.code && err.code === "P2025")
+            throw new NotFoundError();
+    }
+}, {
+    params: FindUniqueTokenAllowanceDto,
+    detail: {
+        hide: true,
+    },
+})
+    // ─── Get Valid Reward Token ───────────────────────────────────────────
+    .get("/reward/:chainId", async ({ params }) => TokenService.getValidRewardTokens(params.chainId), {
+    params: ChainDto,
+    beforeHandle: ({ params }) => throwOnUnsupportedChainId(params.chainId),
+    detail: {
+        description: "Get the list of tokens that are accept as reward tokens on a given chain",
+    },
+})
+    // ─── Get Tokens With Balances ────────────────────────────────────────
+    .get("/balances", async ({ query: { chainId, userAddress, tokenAddress, additionalTokenAddresses } }) => {
+    if (tokenAddress)
+        return await TokenService.fetchTokensAndBalances(chainId, userAddress, [tokenAddress].concat(additionalTokenAddresses ?? []));
+    return await TokenService.fetchVerifiedAndNativeBalances(chainId, userAddress, additionalTokenAddresses);
+}, {
+    query: GetTokenBalanceDto,
+    detail: {
+        hide: true,
+    },
+})
+    // ─── Get Many Tokens ─────────────────────────────────────────────────
+    .get("/", async ({ query }) => await TokenService.findMany(query), {
+    query: GetTokenQueryDto,
+    detail: {
+        hide: true,
+    },
+})
+    // ─── Count Tokens ────────────────────────────────────────────────────
+    .get("/count", async ({ query }) => await TokenService.countMany(query), {
+    query: GetTokenQueryDto,
+    detail: {
+        hide: true,
+    },
+})
+    // ─── Create a new Token entity ────────────────────────────────────────────
+    .post("/", async ({ body }) => await TokenService.fillAndCreate(body), {
+    body: CreateTokenDto,
+    headers: AuthorizationHeadersDto,
+    beforeHandle: async ({ headers, body }) => {
+        await BackOfficeGuard({ headers });
+        body.address = throwOnInvalidRequiredAddress(body.address);
+        throwOnUnsupportedChainId(body.chainId);
+    },
+    detail: { hide: true },
+})
+    // ─── Update token fields Status ────────────────────────────────────────────
+    .patch("/:id", async ({ params, body }) => await TokenService.update(params.id, body), {
+    params: TokenIdDto,
+    body: UpdateTokenDto,
+    headers: AuthorizationHeadersDto,
+    beforeHandle: BackOfficeGuard,
+    detail: { hide: true },
+})
+    .post("/icons", async () => await TokenService.tryToFillWithCoingeckoIcons(), {
+    headers: AuthorizationHeadersDto,
+    beforeHandle: BackOfficeGuard,
+    detail: { hide: true },
+})
+    .group("/webhooks", app => {
+    return app.post("/notion", async ({ body }) => TokenService.notionWebhook(body), {
+        body: NotionWebhookDto,
+        headers: AuthorizationHeadersDto,
+        beforeHandle: BackOfficeGuard,
+        detail: { hide: true },
+    });
+});

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

@@ -0,0 +1,113 @@
+import type { Resource } from "@/modules/v4/prisma";
+/**
+ * Token
+ * @description Data of an onchain asset
+ * @see {@link Resource}
+ */
+export type Token = Resource<"Token", "displaySymbol", {
+    price?: number | null;
+}>;
+export type TokenUnique = {
+    chainId: number;
+    address: string;
+};
+export declare const TokenResourceDto: 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;
+}>;
+export declare const FindUniqueTokenDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const FindUniqueTokenAllowanceDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    owner: import("@sinclair/typebox").TString;
+    spender: import("@sinclair/typebox").TString;
+}>;
+export declare const GetTokenQueryDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    symbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    displaySymbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    isNative: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    address: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    verified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    missingIcons: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+}>;
+export declare const TokenDto: import("@sinclair/typebox").TObject<{
+    address: import("@sinclair/typebox").TString;
+    chainId: import("@sinclair/typebox").TNumber;
+}>;
+export declare const GetTokenBalanceDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    userAddress: import("@sinclair/typebox").TString;
+    verified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    tokenAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    additionalTokenAddresses: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>;
+export declare const TokenIdDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+}>;
+export declare const UpdateTokenDto: import("@sinclair/typebox").TObject<{
+    isTest: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    isPoint: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    verified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    icon: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    displaySymbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const CreateTokenDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    address: import("@sinclair/typebox").TString;
+    icon: import("@sinclair/typebox").TString;
+    verified: import("@sinclair/typebox").TBoolean;
+    isTest: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+}>;
+export declare const NotionWebhookDto: import("@sinclair/typebox").TObject<{
+    data: import("@sinclair/typebox").TObject<{
+        properties: import("@sinclair/typebox").TObject<{
+            Icon: import("@sinclair/typebox").TObject<{
+                files: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    file: import("@sinclair/typebox").TObject<{
+                        url: import("@sinclair/typebox").TString;
+                    }>;
+                }>>;
+            }>;
+            Address: import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+            "Chain ID": import("@sinclair/typebox").TObject<{
+                number: import("@sinclair/typebox").TNumber;
+            }>;
+            Symbol: import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+            Verified: import("@sinclair/typebox").TObject<{
+                checkbox: import("@sinclair/typebox").TBoolean;
+            }>;
+            "CoinGecko API ID": import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+        }>;
+    }>;
+}>;
+export type TokenModel = typeof TokenDto.static;
+export type GetTokenQueryModel = typeof GetTokenQueryDto.static;
+export type UpdateTokenModel = typeof UpdateTokenDto.static;
+export type CreateTokenModel = typeof CreateTokenDto.static;
+export type NotionWebhookModel = typeof NotionWebhookDto.static;

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

@@ -0,0 +1,74 @@
+import { t } from "elysia";
+// ─── Dtos ────────────────────────────────────────────────────────────────────
+export const TokenResourceDto = t.Object({
+    id: t.String(),
+    name: t.Union([t.String(), t.Null()]),
+    chainId: t.Number(),
+    address: t.String(),
+    decimals: t.Number(),
+    icon: t.String(),
+    verified: t.Boolean(),
+    isTest: t.Boolean(),
+    price: t.Optional(t.Union([t.Union([t.Number(), t.Null()])])),
+    symbol: t.String(),
+});
+export const FindUniqueTokenDto = t.Object({
+    id: t.String(),
+});
+export const FindUniqueTokenAllowanceDto = t.Object({
+    id: t.String(),
+    owner: t.String(),
+    spender: t.String(),
+});
+export const GetTokenQueryDto = t.Object({
+    id: t.Optional(t.Array(t.String())),
+    symbol: t.Optional(t.String()),
+    displaySymbol: t.Optional(t.String()), // To filter by displaySymbol or if null symbol
+    chainId: t.Optional(t.Numeric()),
+    isNative: t.Optional(t.Boolean()),
+    address: t.Optional(t.String()),
+    name: t.Optional(t.String()),
+    verified: t.Optional(t.Boolean()),
+    test: t.Optional(t.Boolean()),
+    missingIcons: t.Optional(t.Boolean()),
+});
+export const TokenDto = t.Object({
+    address: t.String(),
+    chainId: t.Numeric(),
+});
+export const GetTokenBalanceDto = t.Object({
+    chainId: t.Numeric(),
+    userAddress: t.String(),
+    verified: t.Optional(t.Boolean()),
+    tokenAddress: t.Optional(t.String({ description: "If provided, the default verified token balances won't be included" })),
+    additionalTokenAddresses: t.Optional(t.Array(t.String())),
+});
+export const TokenIdDto = t.Object({ id: t.String() });
+export const UpdateTokenDto = t.Object({
+    isTest: t.Optional(t.Boolean()),
+    isPoint: t.Optional(t.Boolean()),
+    verified: t.Optional(t.Boolean()),
+    icon: t.Optional(t.String({ format: "uri" })),
+    // iconFile: t.Optional(t.File()),
+    displaySymbol: t.Optional(t.String()),
+    name: t.Optional(t.String()),
+});
+export const CreateTokenDto = t.Object({
+    chainId: t.Numeric(),
+    address: t.String(),
+    icon: t.String(),
+    verified: t.Boolean(),
+    isTest: t.Optional(t.Boolean()),
+});
+export const NotionWebhookDto = t.Object({
+    data: t.Object({
+        properties: t.Object({
+            Icon: t.Object({ files: t.Array(t.Object({ file: t.Object({ url: t.String() }) })) }),
+            Address: t.Object({ rich_text: t.Array(t.Object({ plain_text: t.String() })) }),
+            "Chain ID": t.Object({ number: t.Numeric() }),
+            Symbol: t.Object({ rich_text: t.Array(t.Object({ plain_text: t.String() })) }),
+            Verified: t.Object({ checkbox: t.Boolean() }),
+            "CoinGecko API ID": t.Object({ rich_text: t.Array(t.Object({ plain_text: t.String() })) }),
+        }),
+    }),
+}, { additionalProperties: true });