@merkl/api 0.16.14 → 0.16.16

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/BalancerPoolProcessor.d.ts

@@ -22,6 +22,10 @@ type dataRawBP = callKeysBP & {
     poolTokens: Array<{
         token: string;
         balance: string;
+        amountInPool: number;
+        symbol: string;
+        decimals: number;
+        price: number;
     }>;
 };
 type dataTypeBP = dataType & {
@@ -30,7 +34,10 @@ type dataTypeBP = dataType & {
     vault: string;
     poolTokens: Array<{
         token: string;
-        balance: string;
+        amountInPool: number;
+        symbol: string;
+        decimals: number;
+        price: number;
     }>;
     totalSupply: number;
     blacklistedSupply: number;

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/BalancerPoolProcessor.js

@@ -25,7 +25,6 @@ export class BalancerPoolProcessor extends GenericProcessor {
         const vaultBalanceBN = BigNumber.from(typeInfo.vaultBalance);
         const totalSupplyUpdated = BN2Number(totalSupplyBN.sub(vaultBalanceBN), campaign.campaignParameters.decimalsTargetToken);
         const vaultBalance = BN2Number(vaultBalanceBN, campaign.campaignParameters.decimalsTargetToken);
-        const poolTokensinfo = {};
         let tvl = 0;
         const symbols = [];
         let indexUpdated = index + this.rounds.round4.length;
@@ -36,23 +35,16 @@ export class BalancerPoolProcessor extends GenericProcessor {
             blacklistedSupply -= BN2Number(decodeCall(calls, index + vaultIndex, "balanceOf"), campaign.campaignParameters.decimalsTargetToken); // The vault balance was already removed from the total supply
         }
         for (const poolToken of typeInfo.poolTokens) {
-            const symbol = decodeCall(calls, indexUpdated++, "symbol");
-            const decimals = decodeCall(calls, indexUpdated++, "decimals");
-            poolTokensinfo[poolToken.token] = {
-                symbol: symbol,
-                decimals: decimals,
-                amountInPool: BN2Number(poolToken.balance, decimals),
-                price: (await pricer.get({ symbol: symbol })) ?? 0,
-            };
-            tvl += poolTokensinfo[poolToken.token].price * poolTokensinfo[poolToken.token].amountInPool;
-            symbols.push(symbol);
+            poolToken.symbol = decodeCall(calls, indexUpdated++, "symbol");
+            poolToken.decimals = decodeCall(calls, indexUpdated++, "decimals");
+            poolToken.amountInPool = BN2Number(poolToken.balance, poolToken.decimals);
+            poolToken.price = (await pricer.get({ symbol: poolToken.symbol })) ?? 0;
+            tvl += poolToken.price * poolToken.amountInPool;
+            symbols.push(poolToken.symbol);
         }
         const priceTargetToken = tvl / totalSupplyUpdated;
         return {
-            tokenAddress: typeInfo.tokenAddress,
-            poolId: typeInfo.poolId,
-            vault: typeInfo.vault,
-            poolTokens: poolTokensinfo,
+            ...typeInfo,
             totalSupply: totalSupplyUpdated,
             whitelistedSupplyTargetToken,
             blacklistedSupply,
@@ -72,6 +64,10 @@ export class BalancerPoolProcessor extends GenericProcessor {
                 poolTokens.push({
                     token: token,
                     balance: balances[i].toString(),
+                    amountInPool: 0,
+                    symbol: "",
+                    decimals: 0,
+                    price: 0,
                 });
             }
             i++;

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/BalancerV3PoolProcessor.js

@@ -40,8 +40,10 @@ export class BalancerV3PoolProcessor extends GenericProcessor {
         const { whitelistedSupplyTargetToken, totalSupply, blacklistedSupply } = this.handleWhiteListBlacklistRound5(typeInfo, campaign);
         let tvl = 0;
         for (let i = 0; i < typeInfo.numberTokens; i++) {
-            const symbol = typeInfo[`symbolToken${i}`];
+            let symbol = typeInfo[`symbolToken${i}`];
             const price = (await pricer.get({ symbol: symbol })) ?? 0;
+            symbol = symbol.replace("wmooSiloV2Sonic", "");
+            typeInfo[`symbolToken${i}`] = symbol.replace(" (wS Market)", "");
             const decimals = Number(typeInfo[`decimalsToken${i}`]);
             const amount = BN2Number(typeInfo[`balanceToken${i}`], decimals);
             tvl += amount * price;
@@ -58,10 +60,7 @@ export class BalancerV3PoolProcessor extends GenericProcessor {
         }
         const symbols = [];
         for (let i = 0; i < typeInfo.numberTokens; i++) {
-            let symbolToClean = typeInfo[`symbolToken${i}`];
-            symbolToClean = symbolToClean.replace("wmooSiloV2Sonic", "");
-            symbolToClean = symbolToClean.replace(" (wS Market)", "");
-            symbols.push(symbolToClean);
+            symbols.push(typeInfo[`symbolToken${i}`]);
         }
         return {
             ...typeInfo,

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/GenericProcessor.js

@@ -1,6 +1,7 @@
 import { decodeCall } from "../../../../../utils/decodeCalls";
 import { createCall } from "../../../../../utils/encodeCalls";
 import { generateCardName } from "../../../../../utils/generateCardName";
+import { generateIcons } from "../../../../../utils/generateIcons";
 import { BN2Number } from "@sdk";
 import { tokenTypeToProtocol } from "../helpers/tokenType";
 export var roundType;
@@ -130,7 +131,10 @@ export class GenericProcessor {
             console.log("Round 5", {
                 type: type,
                 calls: [],
-                outputInfo,
+                typeInfo: {
+                    ...outputInfo,
+                    icons: generateIcons(type, typeInfo, campaign),
+                },
             });
         }
         return {
@@ -138,6 +142,7 @@ export class GenericProcessor {
             calls: [],
             typeInfo: {
                 ...outputInfo,
+                icons: generateIcons(type, typeInfo, campaign),
             },
         };
     }

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/StakingProcessor.js

@@ -5,6 +5,7 @@ export class StakingProcessor extends GenericProcessor {
         round1: [
             { key: "lockNFT", call: "lockNFT", target: "stakingContract", optional: true },
             { key: "eip712DomainName", call: "eip712DomainName", target: "stakingContract", optional: true },
+            { key: "stakingSymbol", call: "symbol", target: "stakingContract", optional: true },
         ],
         round2: [{ key: "stakingSymbol", call: "symbol", target: "lockNFT", optional: true }],
         round3: [],

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/VicunaProcessor.js

@@ -21,7 +21,6 @@ export class VicunaProcessor extends GenericProcessor {
         const vicunaTVL = (await axios("https://vicuna.orthae.xyz/tvl/details")).data;
         // find the entry that matches the vault address
         const tvl = findTvlByVaultAddress(vicunaTVL[campaign.chainId], typeInfo.tokenAddress) ?? 0;
-        console.log("tvl", tvl);
         const priceTargetToken = tvl / totalSupply;
         return {
             ...typeInfo,

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/curveProcessor.d.ts

@@ -22,8 +22,10 @@ type dataRawCurve = callKeysCurve & {
     poolTokens: {
         [key: string]: string;
     };
+    numberTokens: number;
 };
 type dataTypeCurve = dataType & {
+    numberTokens: number;
     lp_price: number;
     token0: string;
     token1: string;

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/curveProcessor.js

@@ -29,12 +29,14 @@ export class CurveProcessor extends GenericProcessor {
                 [typeInfo.token1]: typeInfo.symbolToken1,
                 [typeInfo.token2]: typeInfo.symbolToken2,
             };
+            typeInfo.numberTokens = 3;
         }
         else {
             typeInfo.poolTokens = {
                 [typeInfo.token0]: typeInfo.symbolToken0,
                 [typeInfo.token1]: typeInfo.symbolToken1,
             };
+            typeInfo.numberTokens = 2;
         }
         if (type === tokenType.curve_2) {
             const prices = [];

package/dist/src/modules/v4/referral/referral.controller.d.ts

@@ -0,0 +1,82 @@
+import Elysia from "elysia";
+export declare const ReferralController: Elysia<"/referral", false, {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    type: {};
+    error: {};
+}, {
+    schema: {};
+    macro: {};
+    macroFn: {};
+}, {
+    referral: {
+        code: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    chainId: number;
+                    address: string;
+                    referralKey: string;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        code: string;
+                        referrer: boolean;
+                        referredUsers: never[];
+                        transaction: {
+                            to: string;
+                            data: `0x${string}`;
+                        };
+                    } | {
+                        code: any;
+                        referrer: boolean;
+                        referredUsers: any;
+                        transaction?: undefined;
+                    };
+                };
+            };
+        };
+    };
+} & {
+    referral: {
+        redeem: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    code: string;
+                    chainId: number;
+                    referralKey: string;
+                };
+                headers: unknown;
+                response: {
+                    200: {
+                        code: string;
+                        referrer: any;
+                        transaction?: undefined;
+                    } | {
+                        code: string;
+                        referrer: any;
+                        transaction: {
+                            to: string;
+                            data: `0x${string}`;
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}>;

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

@@ -0,0 +1,25 @@
+import { throwOnUnsupportedChainId } from "../../../utils/throw";
+import Elysia from "elysia";
+import { ReferralCodeDto, ReferralRedeemCodeDto } from "./referral.model";
+import { ReferralService } from "./referral.service";
+// ─── Rewards Controller ──────────────────────────────────────────────────────
+export const ReferralController = new Elysia({ prefix: "/referral", detail: { tags: ["Referral"] } })
+    // ─── Get Reward Breakdowns For Campaign Ids ──────────────────────────
+    .get("/code", async ({ query: { chainId, referralKey, address } }) => await ReferralService.getCodeOrTransaction(chainId, referralKey, address), {
+    query: ReferralCodeDto,
+    beforeHandle: ({ query: { chainId } }) => {
+        throwOnUnsupportedChainId(chainId);
+    },
+    detail: {
+        description: "Returns the transaction to register user as a referrer on-chain and some additional state",
+    },
+})
+    .get("/redeem", async ({ query: { chainId, referralKey, code } }) => await ReferralService.getReferralTransaction(chainId, referralKey, code), {
+    query: ReferralRedeemCodeDto,
+    beforeHandle: ({ query: { chainId } }) => {
+        throwOnUnsupportedChainId(chainId);
+    },
+    detail: {
+        description: "Returns the transaction to redeem a referral code on-chain and some additional state",
+    },
+});

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

@@ -0,0 +1,10 @@
+export declare const ReferralCodeDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    referralKey: import("@sinclair/typebox").TString;
+    address: import("@sinclair/typebox").TString;
+}>;
+export declare const ReferralRedeemCodeDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    referralKey: import("@sinclair/typebox").TString;
+    code: import("@sinclair/typebox").TString;
+}>;

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

@@ -0,0 +1,12 @@
+import { t } from "elysia";
+// ─── DTOs ────────────────────────────────────────────────────────────────────
+export const ReferralCodeDto = t.Object({
+    chainId: t.Number(),
+    referralKey: t.String(),
+    address: t.String(),
+});
+export const ReferralRedeemCodeDto = t.Object({
+    chainId: t.Number(),
+    referralKey: t.String(),
+    code: t.String(),
+});

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

@@ -0,0 +1,216 @@
+export declare abstract class ReferralService {
+    #private;
+    static abi: readonly [{
+        readonly name: "getReferralKeys";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "string[]";
+        }];
+    }, {
+        readonly name: "getReferrerStatus";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "address";
+            readonly name: "user";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bytes32";
+        }];
+    }, {
+        readonly name: "referrerCodeMapping";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "address";
+            readonly name: "user";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "string";
+        }];
+    }, {
+        readonly name: "codeToReferrer";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "string";
+            readonly name: "user";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "address";
+        }];
+    }, {
+        readonly name: "getReferrer";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "address";
+            readonly name: "user";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "address";
+        }];
+    }, {
+        readonly name: "getReferredUsers";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "address";
+            readonly name: "user";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "address[]";
+        }];
+    }, {
+        readonly name: "acknowledgeReferrerByKey";
+        readonly type: "function";
+        readonly stateMutability: "nonpayable";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "string";
+            readonly name: "referrerCode";
+        }];
+        readonly outputs: readonly [];
+    }, {
+        readonly name: "getCostOfReferral";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly name: "getPaymentToken";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "address";
+        }];
+    }, {
+        readonly name: "getReferrerStatusByKey";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "address";
+            readonly name: "referrer";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint8";
+        }];
+    }, {
+        readonly name: "requiresAuthorization";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bool";
+        }];
+    }, {
+        readonly name: "requiresRefererToBeSet";
+        readonly type: "function";
+        readonly stateMutability: "view";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "bool";
+        }];
+    }, {
+        readonly name: "becomeReferrer";
+        readonly type: "function";
+        readonly stateMutability: "payable";
+        readonly inputs: readonly [{
+            readonly type: "string";
+            readonly name: "key";
+        }, {
+            readonly type: "string";
+            readonly name: "referrerCode";
+        }];
+        readonly outputs: readonly [];
+    }];
+    static getReferralContract(chainId: number): "0xF39CC381B91f36238c77f42B9fF4D45376F80E5b" | undefined;
+    static isKeyAvailable(key: string, chainId: number): Promise<any>;
+    static getReferredUsers(chainId: number, key: string, address: string): Promise<any>;
+    static getReferralStatus(chainId: number, key: string, address: string): Promise<boolean>;
+    static generateCode(chainId: number, key: string, address: string): string;
+    static getCode(chainId: number, key: string, address: string): Promise<any>;
+    /**
+     * Get state & transaction for creating a referral code
+     * @param chainId of the referral contract
+     * @param key of referral
+     * @param address of the creator
+     */
+    static getCodeOrTransaction(chainId: number, key: string, address: string): Promise<{
+        code: string;
+        referrer: boolean;
+        referredUsers: never[];
+        transaction: {
+            to: string;
+            data: `0x${string}`;
+        };
+    } | {
+        code: any;
+        referrer: boolean;
+        referredUsers: any;
+        transaction?: undefined;
+    }>;
+    /**
+     * Checks if code exists in the contracts
+     * @param chainId of the referral contract
+     * @param key of referral
+     * @param code user referral code
+     * @returns referrerAddress if code exitst
+     */
+    static isCodeRegistered(chainId: number, key: string, code: string): Promise<any>;
+    /**
+     * Get state & transaction for redeeming a referral code
+     * @param chainId of the referral contract
+     * @param key of referral
+     * @param code user referral code
+     */
+    static getReferralTransaction(chainId: number, key: string, code: string): Promise<{
+        code: string;
+        referrer: any;
+        transaction?: undefined;
+    } | {
+        code: string;
+        referrer: any;
+        transaction: {
+            to: string;
+            data: `0x${string}`;
+        };
+    }>;
+}