@merkl/api 1.3.25 → 1.3.27

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

@@ -0,0 +1,139 @@
+import type { ResourceAPI } from "../../../modules/v4/prisma";
+// ─── Schemas ─────────────────────────────────────────────────────────────────
+/**
+ * Token
+ * @description Data of an onchain asset
+ * @see {@link ResourceAPI}
+ */
+export type Token = ResourceAPI<"Token", "displaySymbol", {
+    price?: number | null;
+    isTokenWrapper?: boolean;
+    tokenWrapperAddress?: string;
+}>;
+export type TokenUnique = {
+    chainId: number;
+    address: string;
+};
+// ─── Dtos ────────────────────────────────────────────────────────────────────
+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;
+    isNative: 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;
+    type: import("@sinclair/typebox").TEnum<{
+        readonly TOKEN: "TOKEN";
+        readonly PRETGE: "PRETGE";
+        readonly POINT: "POINT";
+    }>;
+}>;
+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<{
+    page: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    items: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    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>;
+    search: 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>;
+    missingPrice: 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>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
+        readonly TOKEN: "TOKEN";
+        readonly PRETGE: "PRETGE";
+        readonly POINT: "POINT";
+    }>>;
+    verified: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    icon: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    // iconFile: t.Optional(t.File()),
+    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>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
+        readonly TOKEN: "TOKEN";
+        readonly PRETGE: "PRETGE";
+        readonly POINT: "POINT";
+    }>>;
+}>;
+export declare const NotionWebhookAddTokenDto: import("@sinclair/typebox").TObject<{
+    data: import("@sinclair/typebox").TObject<{
+        properties: import("@sinclair/typebox").TObject<{
+            "Icon (Required)": import("@sinclair/typebox").TObject<{
+                files: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+                    file: import("@sinclair/typebox").TObject<{
+                        url: import("@sinclair/typebox").TString;
+                    }>;
+                }>, import("@sinclair/typebox").TObject<{
+                    external: import("@sinclair/typebox").TObject<{
+                        url: import("@sinclair/typebox").TString;
+                    }>;
+                }>]>>;
+            }>;
+            "Address (in checksum format) (Required)": import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+            "Chain ID (Required)": import("@sinclair/typebox").TObject<{
+                number: import("@sinclair/typebox").TNumber;
+            }>;
+            "Symbol (Optional)": import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+            "CoinGecko API ID (Recommended)": import("@sinclair/typebox").TObject<{
+                rich_text: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                    plain_text: import("@sinclair/typebox").TString;
+                }>>;
+            }>;
+        }>;
+    }>;
+}>;
+// ─── Static Types ────────────────────────────────────────────────────────────
+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 NotionWebhookAddTokenDto.static;

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

@@ -0,0 +1 @@
+{"version":3,"file":"token.model.js","sourceRoot":"","sources":["../../../../../../../apps/api/src/modules/v4/token/token.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAiBlE,8NAAgF;AAEhF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,GAAG,qBAAqB,CAAC,EAAE,EAAE,GAAG,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,+CAA+C;IACtF,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7B,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACrC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,YAAY,EAAE,CAAC,CAAC,QAAQ,CACtB,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,oEAAoE,EAAE,CAAC,CAChG;IACD,wBAAwB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAEvD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7C,kCAAkC;IAClC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C;IACE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;gBAC1B,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,CAAC,CAAC,KAAK,CAAC;oBACN,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBACjD,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;iBACtD,CAAC,CACH;aACF,CAAC;YACF,yCAAyC,EAAE,CAAC,CAAC,MAAM,CAAC;gBAClD,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;aACzD,CAAC;YACF,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YACxD,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3F,gCAAgC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;SACzG,CAAC;KACH,CAAC;CACH,EACD,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAC/B,CAAC"}

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

@@ -0,0 +1,134 @@
+import { type ChainId } from "@angleprotocol/sdk/ts";
+import type { TokenType } from "@package/databases/api";
+import type { GetTokenQueryModel, Token, TokenModel, UpdateTokenModel } from "./token.model";
+export declare abstract class TokenRepository {
+    #private;
+    /**
+     * Fetch token metadata from onchain
+     * @param chainId
+     * @param address
+     */
+    static getTokenInfo(token: TokenModel): Promise<{
+        name: string;
+        symbol: string;
+        decimals: number;
+    }>;
+    /**
+     * Read token from database
+     * @param chainId
+     * @param address
+     */
+    static findUnique(id: string): Promise<Token["model"] | undefined>;
+    /**
+     * Read token from database
+     * @param chainId
+     * @param address
+     */
+    static findUniqueOrThrow(id: string): Promise<Token["model"]>;
+    /**
+     * Read token from database by its symbol
+     * @param symbol
+     */
+    static findMany(query: GetTokenQueryModel): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: import("@package/databases").TokenType;
+        isNative: boolean;
+        price: number | null;
+    }[]>;
+    static findFirst(query: Omit<GetTokenQueryModel, "page" | "items">): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: import("@package/databases").TokenType;
+        isNative: boolean;
+        price: number | null;
+    } | null>;
+    static findList(chainId: number, addresses: string[], types?: TokenType[]): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: import("@package/databases").TokenType;
+        isNative: boolean;
+        price: number | null;
+    }[]>;
+    static countMany(query: GetTokenQueryModel): Promise<number>;
+    /**
+     * upsert a token on database
+     * @param token
+     */
+    static upsert(token: Token["model"]): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: import("@package/databases").TokenType;
+        isNative: boolean;
+        price: number | null;
+    }>;
+    /**
+     * Updates price of tokens that share the same symbol
+     * @param symbol
+     * @param price value
+     * @param excludeAddresses to not update even if symbol match
+     */
+    static updateSymbolPrices(symbol: string, price: number, excludeAddresses: string[]): Promise<import("@package/databases").BatchPayload>;
+    /**
+     * Updates price of tokens that share the same address
+     * @param address
+     * @param price value
+     * @param chainId
+     */
+    static updateAddressPrices(address: string, price: number, chainId?: number): Promise<import("@package/databases").BatchPayload>;
+    static updateMissingIconsPerSymbol(symbol: string, icon: string): Promise<import("@package/databases").BatchPayload>;
+    static fetchIconFromCoingeckoTicker(coingeckoTicker: string): Promise<any>;
+    static findChains(): Promise<Record<string, ChainId>>;
+    /**
+     * create a token on database
+     * @param token
+     */
+    static create(token: Token["model"]): Promise<Token["model"] | undefined>;
+    static update(id: string, data: UpdateTokenModel): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: import("@package/databases").TokenType;
+        isNative: boolean;
+        price: number | null;
+    }>;
+}

package/dist/src/modules/v4/token/token.repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.repository.js","sourceRoot":"","sources":["../../../../../../../apps/api/src/modules/v4/token/token.repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,OAAgB,eAAe;IACnC,MAAM,CAAC,8BAA8B,CAAC,KAAiD,EAAE;QACvF,MAAM,GAAG,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzD,OAAO;YACL,KAAK,EAAE;gBACL,GAAG,EAAE;oBACH;wBACE,EAAE,EAAE,KAAK,CAAC,MAAM;4BACd,CAAC,CAAC;gCACE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;gCACzD,EAAE,aAAa,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;gCAChE,GAAG,GAAG;6BACP;4BACH,CAAC,CAAC,KAAK,CAAC,aAAa;gCACnB,CAAC,CAAC;oCACE;wCACE,aAAa,EAAE,EAAE;wCACjB,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE;qCAC7D;oCACD,EAAE,aAAa,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;oCACvE,GAAG,GAAG;iCACP;gCACH,CAAC,CAAC,GAAG,CAAC,MAAM;oCACV,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;oCACV,CAAC,CAAC,SAAS;wBACjB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS;wBACnF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS;wBAC9D,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS;wBAC5E,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;wBACjE,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;wBACjE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;wBACvD,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS;wBACrD,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;qBACzD;oBACD,CAAC,KAAK,CAAC,MAAM;wBACX,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC;4BACE,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC;gCACvD,EAAE,EAAE;oCACF,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;oCAClD,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;oCACpD,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;oCACtD,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE;oCACvD,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE;iCAChE;6BACF,CAAC,CAAC;yBACJ;iBACN;aACF;SACsD,CAAC;IAAA,CAC3D;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiB,EAAE;QAC3C,OAAO,uBAAuB,CAAC,KAAK,CAAC,OAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAAA,CAC9E;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAU,EAAuC;QACvE,OAAO,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,SAAS,CAAC;IAAA,CAC7E;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAA2B;QAClE,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAAA,CACrE;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAyB,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC9C,GAAG,uBAAuB,CAAC,KAAK,CAAC;YACjC,GAAG,eAAe,CAAC,8BAA8B,CAAC,KAAK,CAAC;SACzD,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAAA,CACf;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAiD,EAAE;QACxE,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC;IAAA,CACjG;IAED,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAe,EAAE,SAAmB,EAAE,KAAmB,EAAE;QAC/E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC9C,KAAK,EAAE;gBACL,OAAO;gBACP,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;aACxC;SACF,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAAA,CACf;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAyB,EAAE;QAChD,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC;IAAA,CAC7F;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAqB,EAAE;QACzC,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACpC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE;SACxB,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,KAAa,EAAE,gBAA0B,EAAE;QACzF,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;YACxC,IAAI,EAAE,EAAE,KAAK,EAAE;YACf,KAAK,EAAE;gBACL,MAAM;gBACN,OAAO,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE;aACrC;SACF,CAAC,CAAC;IAAA,CACJ;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,KAAa,EAAE,OAAgB,EAAE;QACjF,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;YACxC,IAAI,EAAE,EAAE,KAAK,EAAE;YACf,KAAK,EAAE;gBACL,OAAO,EAAE,OAAO,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;gBACvC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE;aAClD;SACF,CAAC,CAAC;IAAA,CACJ;IAED,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,MAAc,EAAE,IAAY,EAAE;QACrE,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;YACxC,IAAI,EAAE,EAAE,IAAI,EAAE;YACd,KAAK,EAAE;gBACL,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAE;aACT;SACF,CAAC,CAAC;IAAA,CACJ;IAED,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,eAAuB,EAAE;QACjE,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,0CAA0C,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAAA,CACxG;IAED,MAAM,CAAC,KAAK,CAAC,UAAU,GAAqC;QAC1D,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC9C,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE;SACpC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC;YACd,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;YAC9B,OAAO,GAAG,CAAC;QAAA,CACZ,EACD,EAA6B,CAC9B,CAAC;IAAA,CACH;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAqB,EAAuC;QAC9E,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE;gBACJ,GAAG,KAAK;gBACR,OAAO,EAAE,SAAS;gBAClB,KAAK,EAAE;oBACL,eAAe,EAAE;wBACf,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE;wBAC5B,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,OAAkB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;qBACxF;iBACF;aACF;SACF,CAAC,CAAC;IAAA,CACJ;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE;QACtD,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAAA,CAChE;CACF"}

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

@@ -0,0 +1,336 @@
+import { type Campaign, type CampaignParameters, type ChainId } from "@angleprotocol/sdk/ts";
+import { TokenType } from "@package/databases";
+import { Prisma } from "@package/databases/api";
+import type { Pricer } from "../../../utils/pricer";
+import type { CreateTokenModel, NotionWebhookModel } from "./token.model";
+import type { GetTokenQueryModel, Token, TokenModel, TokenUnique, UpdateTokenModel } from "./token.model";
+import { TokenRepository } from "./token.repository";
+export declare abstract class TokenService {
+    static hashId(token: TokenUnique): string;
+    static format(token: Awaited<ReturnType<typeof TokenRepository.findMany>>[number]): Token["model"];
+    static fetchNativeBalance(chainId: number, userAddress: string): Promise<import("ethers").BigNumber>;
+    /**
+     * Fetches balances of provided tokens
+     */
+    static fetchBalances(chainId: number, userAddress: string, tokens: Token["model"][]): Promise<(Token["model"] & {
+        balance: bigint;
+    })[]>;
+    /**
+     * Fetches tokens and include balances
+     */
+    static fetchTokensAndBalances(chainId: number, userAddress: string, addresses: string[]): Promise<({
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    } & {
+        balance: bigint;
+    })[]>;
+    /**
+     * Fetches balances of verified tokens
+     * @info tokens that are popular and must be detected in the app are marked as 'verified'
+     * @param additionalTokens balances along with the verified ones
+     */
+    static fetchVerifiedAndNativeBalances(chainId: number, userAddress: string, additionalTokenAddresses?: string[]): Promise<({
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    } & {
+        balance: bigint;
+    })[]>;
+    static fetchOnChain(token: TokenModel): Promise<Omit<Token["model"], "id">>;
+    static fetchManyOnChain(chainId: ChainId, addresses: string[]): Promise<{
+        [address: string]: Omit<{
+            address: string;
+            chainId: number;
+            decimals: number;
+            icon: string;
+            id: string;
+            isNative: boolean;
+            isTest: boolean;
+            name: string | null;
+            symbol: string;
+            type: TokenType;
+            verified: boolean;
+        } & {
+            price?: number | null | undefined;
+            isTokenWrapper?: boolean | undefined;
+            tokenWrapperAddress?: string | undefined;
+        }, "id">;
+    }>;
+    /**
+     * Updates price of tokens that share the same symbol
+     * @param symbol
+     * @param price value
+     * @param excludeAddresses to not update symbols that defined using addresses
+     */
+    static updateSymbolPrices(symbol: string, price: number, excludeAddresses: string[]): Promise<Prisma.BatchPayload>;
+    /**
+     * Updates price of tokens that share the same address
+     * @param address
+     * @param price value
+     * @param chainId
+     */
+    static updateAddressPrices(address: string, price: number, chainId?: number): Promise<Prisma.BatchPayload>;
+    /**
+     * Updates price of tokens that share the same symbol
+     * @param symbol
+     * @param price value
+     * @param excludeAddresses to not update symbols that defined using addresses
+     */
+    static updatePrices(pricer: Pricer): Promise<void>;
+    /**
+     * Read token from database
+     * @param chainId
+     * @param address
+     */
+    static findUniqueOrThrow(token: TokenUnique | string): Promise<{
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    }>;
+    /**
+     * Read token from database, tries to fill it if unexistant
+     * @param chainId
+     * @param address
+     */
+    static findUniqueFillOrThrow(token: TokenUnique, requirePrice: true): Promise<Token["model"] & {
+        price: number;
+    }>;
+    static findUniqueFillOrThrow(token: TokenUnique, requirePrice?: false): Promise<Token["model"]>;
+    /**
+     * Checks if two tokens are the same based on chainId/address combo
+     * @param a token
+     * @param b token
+     * @returns true if both tokens are the same
+     */
+    static isSame(a: Pick<Token["model"], "chainId" | "address">, b: Pick<Token["model"], "chainId" | "address">): boolean;
+    /**
+     * Get the list of tokens satisfying the query
+     * @param query
+     * @returns A list of tokens
+     */
+    static findMany(query: GetTokenQueryModel): Promise<({
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    })[]>;
+    /**
+     * Get the list of tokens satisfying the query or fetch if chainId and address are provided
+     * @param query
+     * @returns A list of tokens
+     */
+    static findManyOrFetch(query: GetTokenQueryModel): Promise<({
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    })[]>;
+    static getPrice(query: Omit<GetTokenQueryModel, "page" | "items">): Promise<number>;
+    static findManyObjectPerAddress(query: GetTokenQueryModel): Promise<Record<string, {
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    }>>;
+    static getRewardTokenPrice(campaign: CampaignParameters<Campaign>): Promise<number>;
+    /**
+     * Get value of tokens
+     * @param tokenAmounts address/chain + amount of token
+     * @returns the cumulated dollar value of all tokens
+     */
+    static getValue(tokenAmounts: {
+        amount?: bigint;
+        address: string;
+        chainId: number;
+    }[]): Promise<number>;
+    static getValueByTokenId(id: string, amount: bigint): Promise<number>;
+    static aggregateValueByTokenIds(tokenToAmount: Map<string, bigint>): Promise<number>;
+    /**
+     * Counts the number of tokens that complies to query
+     * @description used for pagination purposes
+     * @param query
+     * @returns the number of tokens
+     */
+    static countMany(query: GetTokenQueryModel): Promise<number>;
+    static findChains(): Promise<Record<string, ChainId>>;
+    /**
+     * Read token from DB or fetch onchain
+     * @param chainId
+     * @param address
+     */
+    static findManyOrCreate(tokens: TokenModel[]): Promise<({
+        address: string;
+        chainId: number;
+        decimals: number;
+        icon: string;
+        id: string;
+        isNative: boolean;
+        isTest: boolean;
+        name: string | null;
+        symbol: string;
+        type: TokenType;
+        verified: boolean;
+    } & {
+        price?: number | null | undefined;
+        isTokenWrapper?: boolean | undefined;
+        tokenWrapperAddress?: string | undefined;
+    })[]>;
+    static getAllValidRewardTokens(query: {
+        chainId?: string;
+    }): Promise<Record<number, {
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: TokenType;
+        isNative: boolean;
+        price: number | null;
+        minimumAmountPerHour: string | undefined;
+        isTokenWrapper: true | undefined;
+        tokenWrapperAddress: string | undefined;
+    }[]>>;
+    static getValidRewardTokens(chainId: number, types?: TokenType[]): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: TokenType;
+        isNative: boolean;
+        price: number | null;
+        minimumAmountPerHour: string | undefined;
+        isTokenWrapper: true | undefined;
+        tokenWrapperAddress: string | undefined;
+    }[]>;
+    static update(id: string, data: UpdateTokenModel): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: TokenType;
+        isNative: boolean;
+        price: number | null;
+    }>;
+    static notionWebhook(body: NotionWebhookModel): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: TokenType;
+        isNative: boolean;
+        price: number | null;
+    }>;
+    /**
+     * Fetches symbol, address, decimals and creates token on database
+     * @param chainId
+     * @param address
+     */
+    static fillAndCreate(token: CreateTokenModel): Promise<{
+        id: string;
+        name: string | null;
+        chainId: number;
+        address: string;
+        decimals: number;
+        symbol: string;
+        displaySymbol: string;
+        icon: string;
+        verified: boolean;
+        isTest: boolean;
+        type: TokenType;
+        isNative: boolean;
+        price: number | null;
+    }>;
+}