@merkl/api 0.0.22

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

@@ -0,0 +1,97 @@
+import type { CreateCreatorDto, Creator, GetManyCreatorModel, UpdateCreatorDto } from "./creator.model";
+export declare abstract class CreatorRepository {
+    static findUnique(id: Creator["model"]["id"]): Promise<{
+        Users: {
+            address: string;
+            tags: string[];
+            creatorId: string | null;
+        }[];
+    } & {
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static findUniqueFromAddress(address: string): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    } | null>;
+    static findMany(query: GetManyCreatorModel): Promise<({
+        Users: {
+            address: string;
+        }[];
+    } & {
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    })[]>;
+    static create({ addresses, ...creator }: typeof CreateCreatorDto.static): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static update(id: Creator["model"]["id"], { addresses, ...creator }: UpdateCreatorDto): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static delete(id: Creator["model"]["id"]): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static getCampaignsFor(creatorAddress: string): 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;
+            explorerAddress: string | null;
+            howToSteps: string[];
+            mainProtocolId: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/library").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        opportunityId: string;
+        creatorAddress: string;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    })[]>;
+    static updateRebate(id: Creator["model"]["id"], rebate: number): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+}

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

@@ -0,0 +1,352 @@
+import type { CreateCreatorDto, Creator, GetManyCreatorModel, UpdateCreatorDto, UpdateCreatorRebateDto } from "./creator.model";
+export declare abstract class CreatorService {
+    /**
+     * Finds a creator from its id (i.e. "uniswap")
+     * @param id
+     * @returns creator
+     */
+    static findUnique(id: Creator["model"]["id"]): Promise<{
+        Users: {
+            address: string;
+            tags: string[];
+            creatorId: string | null;
+        }[];
+    } & {
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    /**
+     * Finds many creators
+     * @param id
+     * @returns creators[]
+     */
+    static findMany(query: GetManyCreatorModel): Promise<({
+        Users: {
+            address: string;
+        }[];
+    } & {
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    })[]>;
+    /**
+     * Creates a creator
+     * @param creator {addresses, id, name}
+     */
+    static create(creator: typeof CreateCreatorDto.static): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    /**
+     * Updates data on a creator
+     * @notice will override the entire address array
+     * @param id of creator
+     * @param creator data for each field
+     */
+    static update(id: Creator["model"]["id"], creator: UpdateCreatorDto): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static delete(id: Creator["model"]["id"]): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+    static getCreatorIdFromAddress(address: string): Promise<string | null>;
+    static getCreatorAddresses(id: Creator["model"]["id"]): Promise<string[]>;
+    static getGlobalDashboard(creatorId: string): Promise<{
+        pastCampaigns: number;
+        liveCampaigns: number;
+        futureCampaigns: number;
+        totalTvl: number;
+        totalWallets: number;
+        totalCampaigns: number;
+        creatorId: string | null;
+    }>;
+    static getDashboardForAddress(creatorAddress: string): Promise<{
+        pastCampaigns: number;
+        liveCampaigns: number;
+        futureCampaigns: number;
+        totalTvl: number;
+        totalWallets: number;
+        totalCampaigns: number;
+        creatorId: string | null;
+    }>;
+    static getCampaignsForCreator(creatorId: string, status?: "PAST" | "LIVE" | "FUTURE"): 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;
+            explorerAddress: string | null;
+            howToSteps: string[];
+            mainProtocolId: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/library").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        opportunityId: string;
+        creatorAddress: string;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    }) | {
+        params: any;
+        chain: {
+            name: string;
+            id: number;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            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;
+        };
+        distributionChain: {
+            name: string;
+            id: number;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            campaignId: string;
+            error: string;
+            status: import("@package/databases").RunStatus;
+            details: import("@prisma/client/runtime/library").JsonValue;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            address: string;
+            tags: string[];
+            creatorId: string | null;
+        };
+        createdAt: string;
+        description: string | undefined;
+        parentCampaignId: string | undefined;
+        rootCampaignId: string | undefined;
+        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;
+            explorerAddress: string | null;
+            howToSteps: string[];
+            mainProtocolId: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+        campaignId: string;
+        id: string;
+        amount: string;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        opportunityId: string;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+    })[]>;
+    static getCampaignsForAddress(creatorAddress: string, status?: "PAST" | "LIVE" | "FUTURE"): 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;
+            explorerAddress: string | null;
+            howToSteps: string[];
+            mainProtocolId: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+    } & {
+        campaignId: string;
+        description: string | null;
+        id: string;
+        params: import("@prisma/client/runtime/library").JsonValue;
+        amount: string;
+        startTimestamp: bigint;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        endTimestamp: bigint;
+        opportunityId: string;
+        creatorAddress: string;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+        manualOverrides: import("@package/databases").CampaignManualOverride[];
+        createdAt: Date;
+        rootCampaignId: string | null;
+        parentCampaignId: string | null;
+    })[] | {
+        params: any;
+        chain: {
+            name: string;
+            id: number;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            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;
+        };
+        distributionChain: {
+            name: string;
+            id: number;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            campaignId: string;
+            error: string;
+            status: import("@package/databases").RunStatus;
+            details: import("@prisma/client/runtime/library").JsonValue;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            address: string;
+            tags: string[];
+            creatorId: string | null;
+        };
+        createdAt: string;
+        description: string | undefined;
+        parentCampaignId: string | undefined;
+        rootCampaignId: string | undefined;
+        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;
+            explorerAddress: string | null;
+            howToSteps: string[];
+            mainProtocolId: string | null;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+        campaignId: string;
+        id: string;
+        amount: string;
+        type: string;
+        computeChainId: number;
+        distributionChainId: number;
+        opportunityId: string;
+        distributionType: import("@package/databases").DistributionType;
+        subType: number | null;
+        rewardTokenId: string;
+    }[]>;
+    static getCampaignMetrics(campaignId: string): Promise<{
+        tvlRecords: {
+            timestamp: bigint;
+            total: number;
+        }[];
+        aprRecords: {
+            timestamp: bigint;
+            apr: number;
+        }[];
+        dailyRewardsRecords: {
+            timestamp: bigint;
+            total: number;
+        }[];
+        walletCount: {
+            timestamp: bigint;
+            walletCount: number;
+        }[];
+        tvlInflowPerDollar: number;
+    }>;
+    static updateRebate(id: Creator["model"]["id"], rebate: UpdateCreatorRebateDto["rebate"]): Promise<{
+        name: string;
+        id: string;
+        icon: string | null;
+        rebateFee: number;
+    }>;
+}

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

@@ -0,0 +1,62 @@
+import type { SinglePayloadInputDto } from "../../../modules/v4/programPayload/programPayload.model";
+export declare const DynamicDataSourceIdentifier: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    tokenAddress: import("@sinclair/typebox").TString;
+    rewardTokenAddress: import("@sinclair/typebox").TString;
+    symbolRewardToken: import("@sinclair/typebox").TString;
+    decimals: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+export declare const DynamicDataExtendedDto: import("@sinclair/typebox").TObject<{
+    targetTokenSymbol: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const SimplifiedCampaignDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    distributionChainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    rewardTokenId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    opportunityId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    computeChainId: import("@sinclair/typebox").TNumber;
+    chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    campaignId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    creatorAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    type: import("@sinclair/typebox").TString;
+    subType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    rewardTokenAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    amount: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    opportunityIdentifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    startTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    endTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    params: import("@sinclair/typebox").TObject<{}>;
+    tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    chain: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+    rewardToken: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+    distributionChain: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+    campaignStatus: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+}>;
+export declare const FilledCampaignDto: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardTokenId: import("@sinclair/typebox").TString;
+    opportunityId: import("@sinclair/typebox").TString;
+    computeChainId: import("@sinclair/typebox").TNumber;
+    chainId: import("@sinclair/typebox").TNumber;
+    campaignId: import("@sinclair/typebox").TString;
+    identifier: import("@sinclair/typebox").TString;
+    creatorAddress: import("@sinclair/typebox").TString;
+    type: import("@sinclair/typebox").TString;
+    subType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    rewardTokenAddress: import("@sinclair/typebox").TString;
+    amount: import("@sinclair/typebox").TString;
+    opportunityIdentifier: import("@sinclair/typebox").TString;
+    startTimestamp: import("@sinclair/typebox").TString;
+    endTimestamp: import("@sinclair/typebox").TString;
+    campaignParameters: import("@sinclair/typebox").TObject<{}>;
+    mainParameter: import("@sinclair/typebox").TString;
+}>;
+export type DynamicDataSourceModel = typeof DynamicDataSourceIdentifier.static;
+export type SimplifiedCampaignDtoModel = typeof SimplifiedCampaignDto.static;
+export type FilledCampaignDtoModel = typeof FilledCampaignDto.static;
+export type DynamicDataExtendedDtoModel = typeof DynamicDataExtendedDto.static;
+export type SinglePayloadInputDtoModelExtended = typeof SinglePayloadInputDto.static & {
+    targetTokenSymbol: string;
+};

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

@@ -0,0 +1,14 @@
+import { type CampaignParameters, Campaign as CampaignType, ChainId, type MerklChainId } from "@angleprotocol/sdk/ts";
+export declare class DynamicDataService {
+    /**
+     * @notice Updates all records for opportunities associated to the given campaigns
+     *
+     * @dev The list must ONLY contain campaigns of the same type and the same computeChainId
+     */
+    static checkValidUpdate(opportunityId: string, newApr: number): Promise<boolean>;
+    static update(chainId: ChainId, type: CampaignType, campaigns: CampaignParameters<CampaignType>[], dryRun?: boolean): Promise<unknown[]>;
+    /**
+     * @dev Recursive function to handle errors in fetching dynamic data
+     */
+    static fetchWithRecursiveErrorHandling<R>(fn: (chainId: MerklChainId, campaigns: CampaignParameters<CampaignType>[]) => Promise<R[]>, campaigns: CampaignParameters<CampaignType>[], chainId: number): Promise<R[]>;
+}