npm - @merkl/api - Versions diffs - 1.0.78 → 1.0.80 - Mend

@merkl/api 1.0.78 → 1.0.80

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

Files changed (470) hide show

package/dist/src/modules/v4/campaign/campaign.service.d.ts ADDED Viewed

@@ -0,0 +1,405 @@
+import { type CampaignParameters, Campaign as CampaignType, type ChainId } from "@angleprotocol/sdk/ts";
+import type { CampaignManualOverride } from "@package/databases/api";
+import type { CampaignConfigMinimalModel, CampaignUnique, CampaignWithParams, CreateCampaignModel, FindCampaignModel, TransactionModel, UpdateCampaignCreatorModel, UpdateCampaignModel, findCampaignWithStatusModel } from "../../../modules/v4/campaign/campaign.model";
+import type { FindCampaignComputedValueModel } from "../computedValue/computedValue.model";
+import { CampaignFormatter } from "./campaign.formatter";
+export declare abstract class CampaignService {
+    static hashId(campaign: CampaignUnique): string;
+    static splitIdOrThrow(chainAndCampaignId: `${number}-${string}` | string): CampaignUnique;
+    static getPastCampaigns(query?: findCampaignWithStatusModel): Promise<({
+        Opportunity: {
+            name: string;
+            apr: number;
+            tvl: number;
+            description: string;
+            id: string;
+            status: import("@package/databases").Status;
+            chainId: number;
+            action: import("@package/databases").OpportunityAction;
+            type: string;
+            depositUrl: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            howToSteps: string[];
+            explorerAddress: string | null;
+            mainProtocolId: string | null;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/client").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        opportunityId: string;
+        creatorAddress: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    })[]>;
+    static getFutureCampaigns(query?: findCampaignWithStatusModel): Promise<({
+        Opportunity: {
+            name: string;
+            apr: number;
+            tvl: number;
+            description: string;
+            id: string;
+            status: import("@package/databases").Status;
+            chainId: number;
+            action: import("@package/databases").OpportunityAction;
+            type: string;
+            depositUrl: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            howToSteps: string[];
+            explorerAddress: string | null;
+            mainProtocolId: string | null;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/client").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        opportunityId: string;
+        creatorAddress: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    })[]>;
+    static getLiveCampaigns(query?: findCampaignWithStatusModel): Promise<({
+        Opportunity: {
+            name: string;
+            apr: number;
+            tvl: number;
+            description: string;
+            id: string;
+            status: import("@package/databases").Status;
+            chainId: number;
+            action: import("@package/databases").OpportunityAction;
+            type: string;
+            depositUrl: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            howToSteps: string[];
+            explorerAddress: string | null;
+            mainProtocolId: string | null;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+        RewardBreakdown: ({
+            Reward: {
+                claimed: string;
+                id: string;
+                recipient: string;
+                amount: string;
+                root: string;
+                proofs: string[];
+                pending: string;
+                rewardTokenId: string;
+            };
+        } & {
+            protocolId: string | null;
+            campaignId: string;
+            claimed: string;
+            id: string;
+            amount: string;
+            reason: string;
+            rewardId: string;
+            pending: string;
+            subCampaignId: string | null;
+        })[];
+        RewardToken: {
+            symbol: string;
+            name: string | null;
+            decimals: number;
+            price: number | null;
+            address: string;
+            id: string;
+            chainId: number;
+            icon: string;
+            isNative: boolean;
+            isPoint: boolean;
+            isPreTGE: boolean;
+            isTest: boolean;
+            verified: boolean;
+            displaySymbol: string;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/client").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        opportunityId: string;
+        creatorAddress: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    })[]>;
+    static countLives(query?: findCampaignWithStatusModel): Promise<number>;
+    static create(body: Omit<CreateCampaignModel, "id">, dryRun?: boolean): Promise<{
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/client").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        opportunityId: string;
+        creatorAddress: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    } | {
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        status: "PAST" | "LIVE" | "SOON";
+        action: OpportunityAction;
+        tokens: ({
+            symbol: string;
+            name: string | null;
+            decimals: number;
+            address: string;
+            id: string;
+            chainId: number;
+            icon: string;
+            isNative: boolean;
+            isPoint: boolean;
+            isPreTGE: boolean;
+            isTest: boolean;
+            verified: boolean;
+        } & {
+            price?: number | null | undefined;
+            isTokenWrapper?: boolean | undefined;
+            tokenWrapperAddress?: string | undefined;
+        })[];
+        mainProtocol: "splice" | "curve" | "morpho" | "compound" | "silo" | "reserve" | "gamma" | "vest" | "zero" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quickswap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "pinto" | "mimswap" | "ichi" | "radiant" | "aave" | "fraxlend" | "ironclad" | "euler" | "gearbox" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "zerolend" | "lnd" | "dlend" | "hyperdrive" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "stability" | "hypurrfi" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "termmax" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "punchswap" | "satlayer" | "puffer" | undefined;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        tags: string[];
+    } | ({
+        Tokens: {
+            symbol: string;
+            name: string | null;
+            decimals: number;
+            price: number | null;
+            address: string;
+            id: string;
+            chainId: number;
+            icon: string;
+            isNative: boolean;
+            isPoint: boolean;
+            isPreTGE: boolean;
+            isTest: boolean;
+            verified: boolean;
+            displaySymbol: string;
+        }[];
+        Protocols: {
+            name: string;
+            description: string;
+            id: string;
+            url: string;
+            icon: string;
+            tags: string[];
+        }[];
+    } & {
+        name: string;
+        apr: number;
+        tvl: number;
+        description: string;
+        id: string;
+        status: import("@package/databases").Status;
+        chainId: number;
+        action: import("@package/databases").OpportunityAction;
+        type: string;
+        depositUrl: string | null;
+        manualOverrides: import("@package/databases").OpportunityManualOverride[];
+        identifier: string;
+        howToSteps: string[];
+        explorerAddress: string | null;
+        mainProtocolId: string | null;
+        dailyRewards: number;
+        tags: string[];
+        lastCampaignCreatedAt: Date;
+    }) | undefined>;
+    static getCampaignIdsFromCreationTxHash(query: TransactionModel): Promise<string[]>;
+    /**
+     * @dev back-office function for manual overrides
+     */
+    static updateCreator(campaign: UpdateCampaignCreatorModel): Promise<void>;
+    /**
+     * @dev back-office function
+     */
+    static moveToOpportunity(data: Omit<UpdateCampaignModel, "id">, upsert?: boolean): Promise<string>;
+    static findMany(query: FindCampaignModel): Promise<Omit<CampaignWithParams, "manualOverrides">[]>;
+    static countMany(query: Omit<FindCampaignModel, "page" | "items">): Promise<number>;
+    static findFirst(query: Omit<FindCampaignModel, "page" | "items">): Promise<Omit<CampaignWithParams, "manualOverrides"> | null>;
+    static findAndGroupByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<number, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string | undefined, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static countBy<T>(campaignsMap: Map<T, ReturnType<(typeof CampaignFormatter)["format"]>[]>): Record<string, number>;
+    static checkIfExist(campaign: CampaignUnique | string): Promise<boolean>;
+    static findUnique(campaign: CampaignUnique | string): Promise<Omit<CampaignWithParams, "manualOverrides"> | null>;
+    static findUniqueOrThrow(campaign: CampaignUnique | string, withOpportunity?: boolean): Promise<Omit<CampaignWithParams, "manualOverrides">>;
+    static findCampaignValue(params: FindCampaignComputedValueModel): Promise<{
+        apr: number | null;
+        tvl: number | null;
+        averageBoost: number | null;
+        totalDistributedInUSD: number | null;
+        forfeitingBoost: number | null;
+        averageAPIBoost: number | null;
+        computeMethodBoost: number | null;
+        lastRecordedNumberOfRecipients: number | null;
+    } | null>;
+    static removeManualOverride(campaign: CampaignUnique | string, field: CampaignManualOverride): Promise<void>;
+    static findCampaignsToProcess(distributionChainId: ChainId): Promise<{
+        campaignId: string;
+        endTimestamp: bigint;
+        CampaignStatus: {
+            status: import("@package/databases").RunStatus;
+            computedUntil: bigint;
+            processingStarted: bigint;
+        }[];
+    }[]>;
+    static findNextCampaignToProcess(chainId: ChainId): Promise<{
+        campaignId: string;
+    }>;
+    static pickCampaignToProcess(chainId: ChainId): Promise<{
+        campaignId: string;
+    }>;
+    static findEngineCampaigns(campaigns: CampaignUnique[]): Promise<{
+        amount: string;
+        chainId: number;
+        computeChainId: number;
+        creator: string;
+        endTimestamp: string;
+        campaignId: string;
+        opportunityIdentifier: string;
+        params: string;
+        rewardTokenAddress: string;
+        startTimestamp: string;
+        type: number;
+        subType: number;
+    }[]>;
+    static fill(campaigns: CampaignUnique[]): Promise<{
+        success: number;
+        fail: number;
+    }>;
+    static findChains(): Promise<Record<string, ChainId>>;
+    /**
+     * Returns the campaign data
+     * @param type index of Campaign enum from sdk
+     * @returns a string
+     */
+    static getTypeFromV3(type: CampaignType): string;
+    /**
+     * Split a campaigns array into three array for each status
+     * @param campaigns
+     * @param timestamp to compare to campaigns timestamps
+     * @returns a status => campaigns map
+     */
+    static splitOnStatus<C extends {
+        startTimestamp: bigint | number;
+        endTimestamp: bigint | number;
+    }>(campaigns: C[], timestamp?: number): {
+        past: C[];
+        live: C[];
+        soon: C[];
+    };
+    /**
+     * Shortcut to get daily amount from total
+     * @param start timestamp
+     * @param end timestamp
+     * @param amount
+     * @returns daily token amount
+     */
+    static getDailyAmount<T extends bigint | number>(start: T, end: T, amount: bigint): bigint;
+    static createFakeCampaign<C extends CampaignType>(body: CampaignConfigMinimalModel): CampaignParameters<C>;
+    static createFakeCampaignEngine(body: CampaignConfigMinimalModel): {
+        computeChainId: ChainId.ARBITRUM | ChainId.AVALANCHE | ChainId.BASE | ChainId.BSC | ChainId.CELO | ChainId.CORE | ChainId.FANTOM | ChainId.FUSE | ChainId.XLAYER | ChainId.GNOSIS | ChainId.LINEA | ChainId.MAINNET | ChainId.MANTLE | ChainId.OPTIMISM | ChainId.POLYGON | ChainId.POLYGONZKEVM | ChainId.THUNDERCORE | ChainId.ZKSYNC | ChainId.SCROLL | ChainId.MANTA | ChainId.IMMUTABLE | ChainId.BLAST | ChainId.MODE | ChainId.ASTAR | ChainId.ROOTSTOCK | ChainId.TAIKO | ChainId.SEI | ChainId.MOONBEAM | ChainId.SKALE | ChainId.FRAXTAL | ChainId.BOB | ChainId.WORLDCHAIN | ChainId.ETHERLINK | ChainId.LISK | ChainId.UNICHAIN | ChainId.BERACHAIN | ChainId.SWELL | ChainId.ARTHERA | ChainId.SONIC | ChainId.CORN | ChainId.SONEIUM | ChainId.INK | ChainId.RONIN | ChainId.FLOW | ChainId.NIBIRU | ChainId.APECHAIN | ChainId.HYPEREVM | ChainId.ZIRCUIT | ChainId.HEMI | ChainId.SAGA_EVM | ChainId.PLUME | ChainId.XDC | ChainId.KATANA | ChainId.REDBELLY;
+        chainId: ChainId.ARBITRUM | ChainId.AVALANCHE | ChainId.BASE | ChainId.BSC | ChainId.CELO | ChainId.CORE | ChainId.FANTOM | ChainId.FUSE | ChainId.XLAYER | ChainId.GNOSIS | ChainId.LINEA | ChainId.MAINNET | ChainId.MANTLE | ChainId.OPTIMISM | ChainId.POLYGON | ChainId.POLYGONZKEVM | ChainId.THUNDERCORE | ChainId.ZKSYNC | ChainId.SCROLL | ChainId.MANTA | ChainId.IMMUTABLE | ChainId.BLAST | ChainId.MODE | ChainId.ASTAR | ChainId.ROOTSTOCK | ChainId.TAIKO | ChainId.SEI | ChainId.MOONBEAM | ChainId.SKALE | ChainId.FRAXTAL | ChainId.BOB | ChainId.WORLDCHAIN | ChainId.ETHERLINK | ChainId.LISK | ChainId.UNICHAIN | ChainId.BERACHAIN | ChainId.SWELL | ChainId.ARTHERA | ChainId.SONIC | ChainId.CORN | ChainId.SONEIUM | ChainId.INK | ChainId.RONIN | ChainId.FLOW | ChainId.NIBIRU | ChainId.APECHAIN | ChainId.HYPEREVM | ChainId.ZIRCUIT | ChainId.HEMI | ChainId.SAGA_EVM | ChainId.PLUME | ChainId.XDC | ChainId.KATANA | ChainId.REDBELLY;
+        campaignId: string;
+        creator: string;
+        type: CampaignType;
+        subType: number;
+        rewardTokenAddress: string;
+        amount: string;
+        opportunityIdentifier: string;
+        startTimestamp: string;
+        endTimestamp: string;
+        params: string;
+    };
+    static createFakeERC20Campaign(query: {
+        address: string;
+        chainId: ChainId;
+    }): Promise<import("@angleprotocol/sdk/ts").ERC20Campaign>;
+    static getWalletCount(campaignId: CampaignUnique | string): Promise<number>;
+    static getMetrics(campaignId: CampaignUnique | string): Promise<{
+        tvlRecords: {
+            timestamp: bigint;
+            total: number;
+        }[];
+        aprRecords: {
+            timestamp: bigint;
+            apr: number;
+        }[];
+        dailyRewardsRecords: {
+            timestamp: bigint;
+            total: number;
+        }[];
+        walletCount: {
+            timestamp: bigint;
+            walletCount: number;
+        }[];
+        tvlInflowPerDollar: number;
+    }>;
+}