@merkl/api 0.9.15

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

@@ -0,0 +1,262 @@
+import type { Campaign, CompFork, CompoundSubCampaignType, Forwarder, ForwarderParameters, HOOK, HookParameters, MerklChainId, MorphoSubCampaignType } from "@sdk";
+export declare const CampaignPayloadInputDto: import("@sinclair/typebox").TObject<{
+    campaign: import("@sinclair/typebox").TString;
+    program: import("@sinclair/typebox").TString;
+    creator: import("@sinclair/typebox").TString;
+    rewardToken: import("@sinclair/typebox").TString;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    startTimestamp: import("@sinclair/typebox").TNumber;
+    endTimestamp: import("@sinclair/typebox").TNumber;
+    amount: import("@sinclair/typebox").TString;
+}>;
+export declare const CampaignDataDto: import("@sinclair/typebox").TObject<{
+    campaignType: import("@sinclair/typebox").TNumber;
+    campaignData: import("@sinclair/typebox").TString;
+    amount: import("@sinclair/typebox").TString;
+    chainId: import("@sinclair/typebox").TNumber;
+    computeChainId: import("@sinclair/typebox").TNumber;
+    duration: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    startTimestamp: import("@sinclair/typebox").TNumber;
+}>;
+export declare const SinglePayloadInputDto: import("@sinclair/typebox").TObject<{
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    amount: import("@sinclair/typebox").TString;
+    startTimestamp: import("@sinclair/typebox").TNumber;
+    computeChainId: import("@sinclair/typebox").TNumber;
+    creator: import("@sinclair/typebox").TString;
+    hooks: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{}>>>;
+    whitelist: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    blacklist: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    campaignType: import("@sinclair/typebox").TNumber;
+    endTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    targetToken: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    url: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    forwarders: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{}>, import("@sinclair/typebox").TString]>>>;
+    poolAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    isOutOfRangeIncentivized: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    weightFees: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    weightToken0: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    weightToken1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    usesBlockNumber: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    snapshotTimestamp: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    snapshotBlockNumber: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    jsonUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    subCampaignType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    repository: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    capInUSD: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    marketId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    compFork: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    poolId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    evkAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    collateralAddress: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    strategy: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    contract: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const ProgramPayloadInputDto: import("@sinclair/typebox").TObject<{
+    program: import("@sinclair/typebox").TString;
+    creator: import("@sinclair/typebox").TString;
+    rewardToken: import("@sinclair/typebox").TString;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    startTimestamp: import("@sinclair/typebox").TNumber;
+    endTimestamp: import("@sinclair/typebox").TNumber;
+    amount: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const CampaignAmountsInputDto: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>;
+export type CampaignPayloadInputModel = typeof CampaignPayloadInputDto.static;
+export type ProgramPayloadInputModel = typeof ProgramPayloadInputDto.static;
+export type CampaignAmountsInputModel = typeof CampaignAmountsInputDto.static;
+export type SinglePayloadInputDtoModel = typeof SinglePayloadInputDto.static;
+export type CampaignDataDtoModel = typeof CampaignDataDto.static;
+export type approvalTransaction = {
+    to: string;
+    value: string;
+    data: null;
+    contractMethod: {
+        inputs: {
+            name: string;
+            type: string;
+            internalType: string;
+        }[];
+        name: string;
+        payable: boolean;
+    };
+    contractInputsValues: {
+        spender: string;
+        amount: string;
+    };
+};
+export type acceptConditionsTransaction = {
+    to: string;
+    value: string;
+    data: null;
+    contractMethod: {
+        inputs: any[];
+        name: string;
+        payable: boolean;
+    };
+    contractInputsValues: null;
+};
+export type createCampaignTransaction = {
+    to: string;
+    value: string;
+    data: null;
+    contractMethod: {
+        inputs: {
+            components: {
+                internalType: string;
+                name: string;
+                type: string;
+            }[];
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        payable: boolean;
+    };
+    contractInputsValues: {
+        newCampaign: string;
+    };
+};
+export type transaction = approvalTransaction | acceptConditionsTransaction | createCampaignTransaction;
+export type safeCompletePayload = {
+    version: string;
+    chainId: string;
+    createdAt: number;
+    meta: {
+        name: string;
+        txBuilderVersion: string;
+    };
+    transactions: [approvalTransaction, acceptConditionsTransaction, createCampaignTransaction];
+};
+export type safePayload = {
+    version: string;
+    chainId: string;
+    createdAt: number;
+    meta: {
+        name: string;
+        txBuilderVersion: string;
+    };
+    transactions: transaction[];
+};
+export type partialConfigERC20 = {
+    computeChainId?: MerklChainId;
+    hooks?: (HookParameters<HOOK> | string)[];
+    campaignType: Campaign;
+    targetToken: string;
+    whitelist: string[];
+    blacklist: string[];
+    url?: string;
+    forwarders: ForwarderParameters<Forwarder>[];
+};
+export type partialConfigMorpho = {
+    computeChainId?: MerklChainId;
+    hooks?: (HookParameters<HOOK> | string)[];
+    campaignType: Campaign;
+    whitelist: string[];
+    blacklist: string[];
+    forwarders: ForwarderParameters<Forwarder>[];
+} & ({
+    subCampaignType: MorphoSubCampaignType.META;
+    targetToken: string;
+} | {
+    subCampaignType: MorphoSubCampaignType.SUPPLY_BLUE | MorphoSubCampaignType.COLLATERAL_BLUE | MorphoSubCampaignType.BORROWING_BLUE;
+    marketId: string;
+});
+export type partialConfigCLAMM = {
+    computeChainId?: MerklChainId;
+    hooks?: (HookParameters<HOOK> | string)[];
+    campaignType: Campaign;
+    poolAddress: string;
+    isOutOfRangeIncentivized: boolean;
+    weightFees: number;
+    weightToken0: number;
+    weightToken1: number;
+    whitelist: string[];
+    blacklist: string[];
+    url?: string;
+};
+export type partialConfigIonic = {
+    computeChainId?: MerklChainId;
+    hooks?: (HookParameters<HOOK> | string)[];
+    campaignType: Campaign;
+    endTimestamp: number;
+    subCampaignType: CompoundSubCampaignType;
+    compFork: CompFork;
+    targetToken: string;
+    whitelist: string[];
+    blacklist: string[];
+    forwarders: string[];
+};
+export type partialConfigAirdrop = {
+    jsonUrl: string;
+    url?: string;
+    computeChainId?: MerklChainId;
+    hooks?: (HookParameters<HOOK> | string)[];
+    campaignType: Campaign;
+};
+export type partialConfig = partialConfigERC20 | partialConfigMorpho | partialConfigCLAMM | partialConfigIonic | partialConfigAirdrop;
+export declare const safeTemplate: {
+    version: string;
+    chainId: string;
+    createdAt: number;
+    meta: {
+        name: string;
+        txBuilderVersion: string;
+    };
+    transactions: ({
+        to: string;
+        value: string;
+        data: null;
+        contractMethod: {
+            inputs: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+            name: string;
+            payable: boolean;
+        };
+        contractInputsValues: {
+            spender: string;
+            amount: string;
+            newCampaign?: undefined;
+        };
+    } | {
+        to: string;
+        value: string;
+        data: null;
+        contractMethod: {
+            inputs: never[];
+            name: string;
+            payable: boolean;
+        };
+        contractInputsValues: null;
+    } | {
+        to: string;
+        value: string;
+        data: null;
+        contractMethod: {
+            inputs: {
+                components: {
+                    internalType: string;
+                    name: string;
+                    type: string;
+                }[];
+                internalType: string;
+                name: string;
+                type: string;
+            }[];
+            name: string;
+            payable: boolean;
+        };
+        contractInputsValues: {
+            newCampaign: string;
+            spender?: undefined;
+            amount?: undefined;
+        };
+    })[];
+};
+export type safeTemplate = typeof safeTemplate;

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

@@ -0,0 +1,176 @@
+import { t } from "elysia";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+export const CampaignPayloadInputDto = t.Object({
+    campaign: t.String({ description: "Campaign identifier, these are shared by the merkl team" }),
+    program: t.String({ description: "Program identifier, these are shared by the merkl team" }),
+    creator: t.String({ description: "Address of the campaign creator" }),
+    rewardToken: t.String({ description: "Address of the reward token to be distributed" }),
+    distributionChainId: t.Numeric({ description: "Chain ID where the reward tokens will be distributed" }),
+    startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
+    endTimestamp: t.Numeric({ description: "End timestamp for the campaign" }),
+    amount: t.String({ description: "Amount of the reward token to be distributed" }),
+});
+export const CampaignDataDto = t.Object({
+    campaignType: t.Numeric({ description: "Type of the campaign 1 : ERC20, 2: CLAMM , ..." }),
+    campaignData: t.String({ description: "Campaign data" }),
+    amount: t.String({ description: "Amount of the reward token to be distributed" }),
+    chainId: t.Numeric({ description: "Chain ID where the reward tokens will be distributed" }),
+    computeChainId: t.Numeric({ description: "Chain ID used for computation" }),
+    duration: t.Numeric({ description: "Duration for the campaign" }),
+    rewardToken: t.String({ description: "Address of the reward token to be distributed" }),
+    startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
+});
+export const SinglePayloadInputDto = t.Object({
+    distributionChainId: t.Numeric({ description: "Chain ID where the reward tokens will be distributed" }),
+    rewardToken: t.String({ description: "Address of the reward token to be distributed" }),
+    amount: t.String({ description: "Amount of the reward token to be distributed" }),
+    startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
+    computeChainId: t.Numeric({ description: "Chain ID used for computation" }),
+    creator: t.String({ description: "Address of the campaign creator" }),
+    hooks: t.Optional(t.Array(t.Object({}))),
+    whitelist: t.Optional(t.Array(t.String({ description: "List of addresses allowed to participate" }))),
+    blacklist: t.Optional(t.Array(t.String({ description: "List of addresses not allowed to participate" }))),
+    campaignType: t.Numeric({ description: "Type of the campaign 1 : ERC20, 2: CLAMM , ..." }),
+    endTimestamp: t.Optional(t.Numeric({ description: "End timestamp for the campaign" })),
+    targetToken: t.Optional(t.String({ description: "Address of the target token that is incentivized" })),
+    url: t.Optional(t.String({ description: "URL for more information" })),
+    forwarders: t.Optional(t.Array(t.Union([t.Object({}), t.String()]))),
+    poolAddress: t.Optional(t.String({ description: "Address of the pool that is incentivized" })),
+    isOutOfRangeIncentivized: t.Optional(t.Boolean({ description: "Whether out-of-range is incentivized" })),
+    weightFees: t.Optional(t.Number({ description: "Weight of the fees" })),
+    weightToken0: t.Optional(t.Number({ description: "Weight of token 0" })),
+    weightToken1: t.Optional(t.Number({ description: "Weight of token 1" })),
+    usesBlockNumber: t.Optional(t.Boolean({ description: "Whether block number is used" })),
+    snapshotTimestamp: t.Optional(t.Numeric({ description: "Snapshot timestamp" })),
+    snapshotBlockNumber: t.Optional(t.Numeric({ description: "Snapshot block number" })),
+    jsonUrl: t.Optional(t.String({ description: "URL for JSON data for Airdrops" })),
+    subCampaignType: t.Optional(t.Numeric({ description: "Type of the sub-campaign" })),
+    repository: t.Optional(t.String({ description: "Repository URL" })),
+    capInUSD: t.Optional(t.String({ description: "Cap in USD" })),
+    marketId: t.Optional(t.String({ description: "Market ID" })),
+    compFork: t.Optional(t.Numeric({ description: "Compound fork ID" })),
+    poolId: t.Optional(t.String({ description: "Pool ID that is incentivized" })),
+    evkAddress: t.Optional(t.String({ description: "EVK address" })),
+    collateralAddress: t.Optional(t.String({ description: "Collateral address" })),
+    strategy: t.Optional(t.String({ description: "Strategy that is incentivized" })),
+    contract: t.Optional(t.String({ description: "Contract address" })),
+});
+export const ProgramPayloadInputDto = t.Object({
+    program: t.String({ description: "Program identifier, these are shared by the merkl team" }),
+    creator: t.String({ description: "Address of the campaign creator" }),
+    rewardToken: t.String({ description: "Address of the reward token to be distributed" }),
+    distributionChainId: t.Numeric({ description: "Chain ID where the reward tokens will be distributed" }),
+    startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
+    endTimestamp: t.Numeric({ description: "End timestamp for the campaign" }),
+    amount: t.Optional(t.String({ description: "Amount of the reward token to be distributed" })),
+});
+export const CampaignAmountsInputDto = t.Record(t.String(), t.String());
+// ---- Template below ----
+export const safeTemplate = {
+    version: "1.0",
+    chainId: "100",
+    createdAt: 1708537104580,
+    meta: {
+        name: "Create Merkl Campaign",
+        txBuilderVersion: "1.16.3",
+    },
+    transactions: [
+        {
+            to: "0x4200000000000000000000000000000000000042",
+            value: "0",
+            data: null,
+            contractMethod: {
+                inputs: [
+                    {
+                        name: "spender",
+                        type: "address",
+                        internalType: "address",
+                    },
+                    {
+                        name: "amount",
+                        type: "uint256",
+                        internalType: "uint256",
+                    },
+                ],
+                name: "approve",
+                payable: false,
+            },
+            contractInputsValues: {
+                spender: "0x8BB4C975Ff3c250e0ceEA271728547f3802B36Fd",
+                amount: "2000000000000000000000",
+            },
+        },
+        {
+            to: "0x8BB4C975Ff3c250e0ceEA271728547f3802B36Fd",
+            value: "0",
+            data: null,
+            contractMethod: {
+                inputs: [],
+                name: "acceptConditions",
+                payable: false,
+            },
+            contractInputsValues: null,
+        },
+        {
+            to: "0x8BB4C975Ff3c250e0ceEA271728547f3802B36Fd",
+            value: "0",
+            data: null,
+            contractMethod: {
+                inputs: [
+                    {
+                        components: [
+                            {
+                                internalType: "bytes32",
+                                name: "campaignId",
+                                type: "bytes32",
+                            },
+                            {
+                                internalType: "address",
+                                name: "creator",
+                                type: "address",
+                            },
+                            {
+                                internalType: "address",
+                                name: "rewardToken",
+                                type: "address",
+                            },
+                            {
+                                internalType: "uint256",
+                                name: "amount",
+                                type: "uint256",
+                            },
+                            {
+                                internalType: "uint32",
+                                name: "campaignType",
+                                type: "uint32",
+                            },
+                            {
+                                internalType: "uint32",
+                                name: "startTimestamp",
+                                type: "uint32",
+                            },
+                            {
+                                internalType: "uint32",
+                                name: "duration",
+                                type: "uint32",
+                            },
+                            {
+                                internalType: "bytes",
+                                name: "campaignData",
+                                type: "bytes",
+                            },
+                        ],
+                        internalType: "struct CampaignParameters",
+                        name: "newCampaign",
+                        type: "tuple",
+                    },
+                ],
+                name: "createCampaign",
+                payable: false,
+            },
+            contractInputsValues: {
+                newCampaign: '["0x0000000000000000000000000000000000000000000000000000000000000000","0x0000000000000000000000000000000000000000","0x31429d1856aD1377A8A0079410B297e1a9e214c2","1000000000000000000000",1,1676649600,0,"0x0000000000000000000000001a7e4e63778b4f12a199c062f3efdd288afcbce800000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"]',
+            },
+        },
+    ],
+};