@merkl/api 0.10.128 → 0.10.130

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

@@ -0,0 +1,62 @@
+import { ConflictError } from "../../../errors/Conflict.error";
+import { AuthorizationHeadersDto, BackOfficeGuard } from "../../../guards/BackOffice.guard";
+import Elysia from "elysia";
+import { CreatePriceSourceDto, PriceSourceIdentifier, UpdatePriceSourceDto } from "./price.model";
+import { PriceService } from "./price.service";
+// ─── Prices Controller ───────────────────────────────────────────────────────
+export const PriceController = new Elysia({ prefix: "/prices", detail: { tags: ["Prices"] } })
+    // ─── Get All Prices ──────────────────────────────────────────────────
+    .get("/", async () => {
+    return await PriceService.findMany();
+})
+    .get("/array", async () => {
+    return await PriceService.findManyArray();
+})
+    // ─── Get Price By Token Symbol ───────────────────────────────────────
+    .get("/symbol/:symbol", async ({ params }) => {
+    return await PriceService.fetchPriceSourceBySymbol(params.symbol);
+}, { params: PriceSourceIdentifier })
+    // ─── Price Sources Group ─────────────────────────────────────────────
+    .group("/sources", app => {
+    return (app
+        // ─── Get All Price Sources ───────────────────
+        .get("/", async () => {
+        return await PriceService.getManyPriceSources();
+    })
+        // ─── Get Price Source By Token Symbol ────────
+        .get("/symbol/:symbol", async ({ params }) => {
+        return await PriceService.getPriceSourceBySymbol(params.symbol);
+    }, { params: PriceSourceIdentifier })
+        // ─── Create A Price Source ───────────────────
+        .post("/", async ({ body }) => {
+        try {
+            return await PriceService.createPriceSource(body);
+        }
+        catch (err) {
+            if (err && err.code === "P2002") {
+                throw new ConflictError();
+            }
+        }
+    }, {
+        headers: AuthorizationHeadersDto,
+        body: CreatePriceSourceDto,
+        beforeHandle: BackOfficeGuard,
+    })
+        // ─── Update A Price Source ───────────────────
+        .patch("/symbol/:symbol", async ({ params, body }) => {
+        return await PriceService.updatePriceSource(params.symbol, body);
+    }, {
+        headers: AuthorizationHeadersDto,
+        params: PriceSourceIdentifier,
+        body: UpdatePriceSourceDto,
+        beforeHandle: BackOfficeGuard,
+    })
+        // ─── Delete A Price Source ───────────────────
+        .delete("/symbol/:symbol", async ({ params }) => {
+        return await PriceService.deletePriceSource(params.symbol);
+    }, {
+        headers: AuthorizationHeadersDto,
+        params: PriceSourceIdentifier,
+        beforeHandle: BackOfficeGuard,
+    }));
+});

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

@@ -0,0 +1,12 @@
+import { PriceSourceMethod } from "../../../../database/api/.generated";
+import { t } from "elysia";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+export const CreatePriceSourceDto = t.Object({
+    symbol: t.String(),
+    method: t.Enum(PriceSourceMethod),
+    args: t.Object({}, { additionalProperties: true }),
+});
+export const UpdatePriceSourceDto = t.Partial(CreatePriceSourceDto);
+export const PriceSourceIdentifier = t.Object({
+    symbol: t.String(),
+});

package/dist/src/modules/v4/price/price.repository.js

@@ -0,0 +1,18 @@
+import { apiDbClient } from "../../../utils/prisma";
+export class PriceRepository {
+    static async findBySymbolOrThrow(symbol) {
+        return await apiDbClient.priceSource.findUniqueOrThrow({ where: { symbol } });
+    }
+    static async findMany() {
+        return await apiDbClient.priceSource.findMany();
+    }
+    static async create(priceSource) {
+        return await apiDbClient.priceSource.create({ data: priceSource });
+    }
+    static async updateBySymbol(unique, newPriceSource) {
+        return await apiDbClient.priceSource.update({ where: { symbol: unique }, data: newPriceSource });
+    }
+    static async deleteBySymbol(symbol) {
+        return await apiDbClient.priceSource.delete({ where: { symbol } });
+    }
+}

package/dist/src/modules/v4/price/price.service.js

@@ -0,0 +1,44 @@
+import { Pricer } from "../../../utils/pricer";
+import PriceFetcherFactory from "../../../utils/prices/priceFetcherFactory";
+import { PriceSourceMethod } from "../../../../database/api/.generated";
+import { PriceRepository } from "./price.repository";
+export class PriceService {
+    // ─── Prices ──────────────────────────────────────────────────────────
+    static async findMany() {
+        return (await Pricer.load()).prices;
+    }
+    static async findManyArray() {
+        return (await Pricer.load()).getArray();
+    }
+    /** Fetches a single price */
+    static async fetchPriceSourceBySymbol(symbol) {
+        const priceSource = await PriceRepository.findBySymbolOrThrow(symbol);
+        if (!priceSource) {
+            throw new Error(`Price source with symbol ${symbol} not found`);
+        }
+        if (priceSource.method === PriceSourceMethod.CONSTANT) {
+            return priceSource.args.value;
+        }
+        if (priceSource.method === PriceSourceMethod.EQUAL_TO) {
+            return PriceService.fetchPriceSourceBySymbol(priceSource.args.token);
+        }
+        return (await PriceFetcherFactory.instance.get(priceSource.method).getPrice([priceSource]))?.[0]?.rate;
+    }
+    // ─── Price Sources ───────────────────────────────────────────────────
+    static async getPriceSourceBySymbol(symbol) {
+        return await PriceRepository.findBySymbolOrThrow(symbol);
+    }
+    static async getManyPriceSources() {
+        return await PriceRepository.findMany();
+    }
+    static async createPriceSource(priceSource) {
+        const created = await PriceRepository.create(priceSource);
+        return await PriceService.fetchPriceSourceBySymbol(created.symbol);
+    }
+    static async updatePriceSource(symbol, newPriceSource) {
+        return await PriceRepository.updateBySymbol(symbol, newPriceSource);
+    }
+    static async deletePriceSource(symbol) {
+        return await PriceRepository.deleteBySymbol(symbol);
+    }
+}

package/dist/src/modules/v4/prisma/index.js

@@ -0,0 +1 @@
+export {};

package/dist/src/modules/v4/protocol/index.js

@@ -0,0 +1,3 @@
+export * from "./protocol.controller";
+export * from "./protocol.model";
+export * from "./protocol.service";

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

@@ -0,0 +1,23 @@
+import Elysia from "elysia";
+import { GetProtocolsQueryDto } from "./protocol.model";
+import { ProtocolService } from "./protocol.service";
+// ─── Protocols Controller ────────────────────────────────────────────────────
+export const ProtocolController = new Elysia({ prefix: "/protocols", detail: { tags: ["Protocols"] } })
+    // ─── Get A Protocol By Its Id ────────────────────────────────────────
+    .get("/:id", async ({ params }) => {
+    const fromId = await ProtocolService.getFromId(params.id);
+    if (fromId)
+        return fromId;
+    return await ProtocolService.getFromName(params.id);
+})
+    // ─── Get Many Protocols ──────────────────────────────────────────────
+    .get("/", async ({ query }) => {
+    return await ProtocolService.findMany(query);
+}, {
+    query: GetProtocolsQueryDto,
+})
+    .get("/count", async ({ query }) => {
+    return await ProtocolService.countMany(query);
+}, {
+    query: GetProtocolsQueryDto,
+});

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

@@ -0,0 +1,68 @@
+import { ProtocolTag } from "../../../../database/api/.generated";
+import { t } from "elysia";
+const protocolTypes = [
+    // ─── AMM ─────────────────────────────────────────────────────────────
+    "arthswap",
+    "baseswap",
+    "camelot",
+    "crust",
+    "fenix",
+    "horiza",
+    "izumi",
+    "kim",
+    "pancakeswap-v3",
+    "quickswap-algebra",
+    "quickswap-uni",
+    "ramses",
+    "retro",
+    "stryke",
+    "stryke-pcs",
+    "stryke-sushi",
+    "sushiswap-v3",
+    "swapr",
+    "thruster",
+    "uniswap-v3",
+    "voltage",
+    "zero",
+    "koi",
+    "supswap-v3",
+    // ─── LP DEX ──────────────────────────────────────────────────────────
+    "uniswap-v2",
+    "velodrome",
+    "aerodrome",
+    "balancer",
+    "curve",
+    "aura",
+    "akron",
+    "beefy",
+    "dragonswap",
+    "poolside",
+    "koi",
+    // ─── LP Lending ──────────────────────────────────────────────────────
+    "radiant",
+    "aave",
+    "euler",
+    "gearbox",
+    "compound",
+    "sturdy",
+    "frax",
+    "ionic",
+    "moonwell",
+    "fluid",
+    "silo",
+    "morpho",
+    "coumpound",
+    "dolomite",
+    "badger",
+    "ajna",
+    "layerbank",
+];
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+export const GetProtocolsQueryDto = t.Object({
+    id: t.Optional(t.Array(t.String())),
+    name: t.Optional(t.String()),
+    tags: t.Optional(t.Array(t.Enum(ProtocolTag))),
+    page: t.Optional(t.Numeric()),
+    items: t.Optional(t.Numeric()),
+});
+export const GetProtocolParamsDto = t.Object({ id: t.String() });

package/dist/src/modules/v4/protocol/protocol.repository.js

@@ -0,0 +1,37 @@
+import { apiDbClient } from "../../../utils/prisma";
+// ─── Protocols Repository ────────────────────────────────────────────────────
+export class ProtocolRepository {
+    static async create(template) {
+        return await apiDbClient.protocol.create(template);
+    }
+    static async read(type) {
+        return await apiDbClient.protocol.findUnique({ where: { id: type } });
+    }
+    static async findManyByName(name) {
+        return await apiDbClient.protocol.findMany({ where: { name: { equals: name } } });
+    }
+    static #transformQueryToPrismaFilters(query) {
+        return {
+            where: {
+                name: query.name ? { contains: query.name, mode: "insensitive" } : undefined,
+                tags: query.tags ? { hasEvery: query.tags } : undefined,
+                id: query.id ? { in: query.id } : undefined,
+            },
+        };
+    }
+    static async findMany(query) {
+        const { page: _page, items: _items } = query;
+        const page = _page ? _page : 0;
+        const items = _items ? _items : 20;
+        const args = ProtocolRepository.#transformQueryToPrismaFilters(query);
+        return await apiDbClient.protocol.findMany({
+            take: items,
+            skip: page * items,
+            ...args,
+        });
+    }
+    static async countMany(query) {
+        const args = ProtocolRepository.#transformQueryToPrismaFilters(query);
+        return await apiDbClient.protocol.count(args);
+    }
+}

package/dist/src/modules/v4/protocol/protocol.service.js

@@ -0,0 +1,77 @@
+import { AMM as AMMV3 } from "@sdk";
+import { ProtocolRepository } from "./protocol.repository";
+// ─── Protocols Services ──────────────────────────────────────────────────────
+export class ProtocolService {
+    static getIdFromAmmV3(amm) {
+        return {
+            [AMMV3.ARTHSWAP]: "arthswap",
+            [AMMV3.BaseSwap]: "baseswap",
+            [AMMV3.Camelot]: "camelot",
+            [AMMV3.Crust]: "crust",
+            [AMMV3.Fenix]: "fenix",
+            [AMMV3.Horiza]: "horiza",
+            [AMMV3.Izumi]: "izumi",
+            [AMMV3.Kim]: "kim",
+            [AMMV3.PancakeSwapV3]: "pancakeswap-v3",
+            [AMMV3.QuickswapAlgebra]: "quickswap-algebra",
+            [AMMV3.QuickswapUni]: "quickswap-uni",
+            [AMMV3.Ramses]: "ramses",
+            [AMMV3.Retro]: "retro",
+            [AMMV3.Stryke]: "stryke",
+            [AMMV3.StrykePCS]: "stryke-pcs",
+            [AMMV3.StrykeSushi]: "stryke-sushi",
+            [AMMV3.SushiSwapV3]: "sushiswap-v3",
+            [AMMV3.Swapr]: "swapr",
+            [AMMV3.Thruster]: "thruster",
+            [AMMV3.UniswapV3]: "uniswap-v3",
+            [AMMV3.Voltage]: "voltage",
+            [AMMV3.ZERO]: "zero",
+            [AMMV3.KOI]: "koi",
+            [AMMV3.SupswapV3]: "supswap-v3",
+        }[amm];
+    }
+    static getIdFromErc20Type(_type) {
+        return {
+            uniswapv2: "uniswap-v2",
+            velodrome: "velodrome",
+            aerodrome: "aerodrome",
+            balancerGauge: "balancer",
+            balancerPool: "balancer",
+            curve: "curve",
+            aura: "aura",
+            akron: "akron",
+            dragonswap: "dragonswap",
+            poolside: "poolside",
+            koi: "koi",
+            radiant_borrow: "radiant",
+            radiant_lend: "radiant",
+            aave_borrowing: "radiant",
+            euler_borrow: "euler",
+            euler_lend: "euler",
+            gearbox: "gearbox",
+            compound: "compound",
+            aave_lending: "aave",
+            sturdy_aggregator: "sturdy",
+            sturdy_silo: "sturdy",
+            fraxlend: "frax",
+            moonwell: "moonwell",
+            ionic: "ionic",
+            fluid: "fluid",
+            silostaking: "silo",
+            layerbank: "layerbank",
+            beefy: "beefy",
+        }[_type];
+    }
+    static async findMany(query) {
+        return await ProtocolRepository.findMany(query);
+    }
+    static async countMany(query) {
+        return await ProtocolRepository.countMany(query);
+    }
+    static async getFromId(id) {
+        return await ProtocolRepository.read(id);
+    }
+    static async getFromName(name) {
+        return (await ProtocolRepository.findManyByName(name))[0];
+    }
+}

package/dist/src/modules/v4/reward/index.js

@@ -0,0 +1,3 @@
+export * from "./reward.service";
+export * from "./reward.model";
+export * from "./reward.controller";

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

@@ -0,0 +1,52 @@
+import { BackOfficeGuard } from "../../../guards/BackOffice.guard";
+import { AuthorizationHeadersDto, EngineGuard } from "../../../guards/Engine.guard";
+import { throwOnUnsupportedChainId } from "../../../utils/throw";
+import Elysia from "elysia";
+import { CampaignIdDto, CreateManyBreakdownDto, CreateManyRewardDto, UpdatePendingDto } from "./reward.model";
+import { RewardService } from "./reward.service";
+// ─── Rewards Controller ──────────────────────────────────────────────────────
+export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags: ["Rewards"] } })
+    // ─── Get Reward Breakdowns For Campaign Ids ──────────────────────────
+    .get("/", async ({ query }) => await RewardService.breakdownForCampaign(query), {
+    query: CampaignIdDto,
+    beforeHandle: ({ query }) => {
+        throwOnUnsupportedChainId(query.chainId);
+    },
+})
+    // ─── Get Total Amount Rewarded For Campaign Id ──────────────────────
+    .get("/total", async ({ query }) => await RewardService.total(query), {
+    query: CampaignIdDto,
+    beforeHandle: ({ query }) => {
+        throwOnUnsupportedChainId(query.chainId);
+    },
+})
+    // ─── Create Many Rewards ─────────────────────────────────────────────
+    .post("/engine", async ({ body }) => await RewardService.createManyReward(body), {
+    headers: AuthorizationHeadersDto,
+    body: CreateManyRewardDto,
+    beforeHandle: EngineGuard,
+})
+    // ─── Create Many Reward Breakdowns ───────────────────────────────────
+    .post("/engine/breakdowns", async ({ body }) => await RewardService.createManyBreakdown(body), {
+    headers: AuthorizationHeadersDto,
+    body: CreateManyBreakdownDto,
+    beforeHandle: EngineGuard,
+})
+    // ─── Create Many Pending Rewards ─────────────────────────────────────
+    .post("/pendings", async ({ body }) => await RewardService.updatePendings(body), {
+    headers: AuthorizationHeadersDto,
+    body: UpdatePendingDto,
+    beforeHandle: EngineGuard,
+})
+    // ─── Get Reward Count By Chain And Root ───────────────────────────────────────
+    .get("/count", async ({ query }) => await RewardService.count(query), {
+    query: CampaignIdDto,
+    beforeHandle: ({ query }) => {
+        throwOnUnsupportedChainId(query.chainId);
+    },
+})
+    // ─── Get Reward Count By Chain And Root ───────────────────────────────────────
+    .get("/count/chains", async () => await RewardService.countAllchains(), {
+    headers: AuthorizationHeadersDto,
+    beforeHandle: BackOfficeGuard,
+});

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

@@ -0,0 +1,104 @@
+import { t } from "elysia";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+const BreakdownDto = t.Object({
+    recipient: t.String(),
+    protocolId: t.Optional(t.String()),
+    reason: t.String(),
+    amount: t.String(),
+    claimed: t.String(),
+    pending: t.String(),
+    auxiliaryData1: t.Optional(t.String()),
+    auxiliaryData2: t.Optional(t.String()),
+});
+export const CreateManyBreakdownDto = t.Array(t.Object({
+    distributionChainId: t.Numeric(),
+    rewardToken: t.String(),
+    campaignId: t.String(),
+    root: t.String(),
+    breakdowns: t.Array(BreakdownDto),
+}));
+const RewardDto = t.Object({
+    root: t.String(),
+    recipient: t.String(),
+    distributionChainId: t.Number(),
+    rewardToken: t.String(),
+    proofs: t.Array(t.String()),
+});
+export const CreateManyRewardDto = t.Array(RewardDto);
+const PendingDto = t.Object({
+    recipient: t.String(),
+    reason: t.String(),
+    pending: t.String(),
+    auxiliaryData1: t.Optional(t.String()),
+    auxiliaryData2: t.Optional(t.String()),
+});
+export const UpdatePendingDto = t.Object({
+    distributionChainId: t.Numeric(),
+    rewardToken: t.String(),
+    campaignId: t.String(),
+    root: t.String(),
+    toUpdate: t.Array(PendingDto),
+    toCreate: t.Array(PendingDto),
+});
+export const RewardsByUser = t.Object({
+    address: t.String(),
+});
+export const RewardsByUserAndChain = t.Object({
+    address: t.String(),
+    chainId: t.Numeric(),
+});
+export const UserRewardQueryDto = t.Object({
+    chainId: t.Numeric(),
+    mainParameter: t.Optional(t.String()),
+    proof: t.Optional(t.String()),
+    rewardToken: t.Optional(t.String()),
+    user: t.String(),
+});
+export const RewardsPerChainDto = t.Object({
+    chainId: t.Numeric(),
+});
+export const CampaignIdListDto = t.Object({
+    chainId: t.Numeric(),
+    campaignIds: t
+        .Transform(t.Union([t.String(), t.Array(t.String())]))
+        .Decode(value => (typeof value === "string" ? value.split(",") : value))
+        .Encode(value => [...value]),
+    page: t.Optional(t.Numeric()), // 0-indexed
+    items: t.Optional(t.Numeric()), // items per page
+});
+export const CampaignIdDto = t.Object({
+    chainId: t.Numeric(),
+    campaignId: t.String(),
+    page: t.Optional(t.Numeric()), // 0-indexed
+    items: t.Optional(t.Numeric()), // items per page
+});
+export const UserRewardV3Dto = t.Record(t.String({ title: "TokenAddress" }), t.Object({
+    symbol: t.String(),
+    decimals: t.Number(),
+    accumulated: t.String(),
+    unclaimed: t.String(),
+    pending: t.Optional(t.String()),
+    reasons: t.Record(t.String({ title: "Reason" }), t.Object({ accumulated: t.String(), unclaimed: t.String(), pending: t.Optional(t.String()) })),
+    proof: t.Optional(t.Array(t.String())),
+}));
+export const RewardV3Dto = t.Record(t.String({ title: "Chain" }), t.Object({
+    campaignData: t.Record(t.String({ title: "CampaignId" }), t.Record(t.String({ title: "reason" }), t.Object({
+        accumulated: t.String(),
+        unclaimed: t.String(),
+        pending: t.Optional(t.String()),
+        auxiliaryData1: t.String(),
+        auxiliaryData2: t.String(),
+        decimals: t.Numeric(),
+        mainParameter: t.String(),
+        symbol: t.String(),
+        token: t.String(),
+    }))),
+    tokenData: t.Record(t.String(), t.Object({
+        accumulated: t.String(),
+        unclaimed: t.String(),
+        pending: t.Optional(t.String()),
+        decimals: t.Numeric(),
+        proof: t.Array(t.String()),
+        symbol: t.String(),
+    })),
+}), { $id: "Rewards", additionalProperties: true });