@gearbox-protocol/sdk 16.0.0-next.16 → 16.0.0-next.17

package/dist/cjs/rewards/index.js

@@ -4,5 +4,5 @@ const require_rewards_rewards_api = require("./rewards/api.js");
 const require_rewards_rewards_extra_apy = require("./rewards/extra-apy.js");
 require("./rewards/index.js");
 exports.PoolPointsAPI = require_rewards_rewards_extra_apy.PoolPointsAPI;
-exports.RewardAmountAPI = require_rewards_rewards_api.RewardAmountAPI;
 exports.getKeyForPoolPointsInfo = require_rewards_rewards_extra_apy.getKeyForPoolPointsInfo;
+exports.getMerklRewards = require_rewards_rewards_api.getMerklRewards;

package/dist/cjs/rewards/rewards/api.js

@@ -1,70 +1,80 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_onchain_utils_AddressMap = require("../../onchain/utils/AddressMap.js");
 const require_onchain_utils_bigint_math = require("../../onchain/utils/bigint-math.js");
-const require_onchain_chain_chains = require("../../onchain/chain/chains.js");
 const require_onchain_utils_formatter = require("../../onchain/utils/formatter.js");
 require("../../onchain/index.js");
 require("../../common-utils/index.js");
 const require_rewards_rewards_merkl_api = require("./merkl-api.js");
 let viem = require("viem");
 //#region src/rewards/rewards/api.ts
-var RewardAmountAPI = class RewardAmountAPI {
-	constructor() {}
-	static async getLmRewardsMerkle({ pools, account, network, reportError, apiKey }) {
-		const [merkleXYZLMResponse] = await Promise.allSettled([require_rewards_rewards_merkl_api.MerkleXYZApi.fetchWithFallback(require_rewards_rewards_merkl_api.MerkleXYZApi.getUserRewardsUrl({ params: {
-			chainId: require_onchain_chain_chains.chains[network].id,
-			user: (0, viem.getAddress)(account)
-		} }), apiKey)]);
-		const merkleXYZLm = RewardAmountAPI.extractFulfilled(merkleXYZLMResponse, reportError, "merkleXYZLm")?.data;
-		const poolByItsToken = Object.values(pools).reduce((acc, p) => {
-			p.stakedDieselToken.forEach((t) => {
-				if (t) acc[t] = p.address;
-			});
-			p.stakedDieselToken_old.forEach((t) => {
-				if (t) acc[t] = p.address;
-			});
-			acc[p.dieselToken] = p.address;
-			return acc;
-		}, {});
-		const extraRewards = (merkleXYZLm || []).reduce((acc, chainRewards) => {
-			chainRewards.rewards.forEach((reward) => {
-				const rewardToken = reward.token.address.toLowerCase();
-				reward.breakdowns.forEach((reason) => {
-					const poolToken = ((reason.reason || "").split("_").find((part) => part.startsWith("0x")) || "").toLowerCase();
-					const pool = poolByItsToken[poolToken];
-					const total = require_onchain_utils_formatter.toBigInt(reason.amount || 0);
-					const claimed = require_onchain_utils_formatter.toBigInt(reason.claimed || 0);
-					const claimable = require_onchain_utils_bigint_math.BigIntMath.max(total - claimed, 0n);
-					const key = [
-						pool,
-						poolToken,
-						rewardToken
-					].join("_");
-					if (pool && claimable > 0n) {
-						const prevAmount = acc[key]?.amount || 0n;
-						acc[key] = {
-							pool,
-							poolToken,
-							rewardToken,
-							rewardTokenSymbol: reward.token.symbol,
-							rewardTokenDecimals: reward.token.decimals || 18,
-							amount: prevAmount + claimable,
-							type: "extraMerkle"
-						};
-					}
+/**
+* The wallet's claimable Merkl rewards on one chain.
+*
+* Never rejects on a transport failure: the fetch is settled rather than
+* awaited, and a failure goes to `reportError` and yields an empty list. A
+* caller that must tell "this chain is down" from "this chain has no rewards"
+* has to watch that callback.
+*/
+async function getMerklRewards({ sdk, account, reportError, apiKey }) {
+	const [merkleXYZLMResponse] = await Promise.allSettled([require_rewards_rewards_merkl_api.MerkleXYZApi.fetchWithFallback(require_rewards_rewards_merkl_api.MerkleXYZApi.getUserRewardsUrl({ params: {
+		chainId: sdk.chainId,
+		user: (0, viem.getAddress)(account)
+	} }), apiKey)]);
+	const merkleXYZLm = extractFulfilled(merkleXYZLMResponse, reportError, "merkleXYZLm")?.data;
+	const poolByItsToken = require_onchain_utils_AddressMap.AddressMap.fromMappedArray(sdk.marketRegister.pools.map(({ pool }) => pool.address), (address) => address);
+	const claimable = /* @__PURE__ */ new Map();
+	for (const chainRewards of merkleXYZLm || []) for (const reward of chainRewards.rewards) {
+		if (!(0, viem.isAddress)(reward.token.address, { strict: false })) continue;
+		const rewardTokenAddress = (0, viem.getAddress)(reward.token.address);
+		for (const reason of reward.breakdowns) {
+			const poolTokenAddress = (reason.reason || "").split("_").find((part) => part.startsWith("0x")) ?? "";
+			if (!(0, viem.isAddress)(poolTokenAddress, { strict: false })) continue;
+			const pool = poolByItsToken.get(poolTokenAddress);
+			if (!pool) continue;
+			const total = require_onchain_utils_formatter.toBigInt(reason.amount || 0);
+			const claimed = require_onchain_utils_formatter.toBigInt(reason.claimed || 0);
+			const amount = require_onchain_utils_bigint_math.BigIntMath.max(total - claimed, 0n);
+			if (amount === 0n) continue;
+			const key = `${pool}_${rewardTokenAddress}`;
+			const seen = claimable.get(key);
+			if (seen) {
+				claimable.set(key, {
+					...seen,
+					amount: seen.amount + amount
 				});
+				continue;
+			}
+			const poolToken = sdk.tokensMeta.getToken(pool);
+			if (!poolToken) continue;
+			claimable.set(key, {
+				chainId: sdk.chainId,
+				pool,
+				poolToken,
+				rewardToken: toRewardToken(sdk, rewardTokenAddress, reward.token),
+				amount
 			});
-			return acc;
-		}, {});
-		return Object.values(extraRewards);
-	}
-	static extractFulfilled(r, reportError, description) {
-		if (r.status === "fulfilled") return r.value;
-		else {
-			if (reportError) reportError(r.reason, description);
-			else console.error(r.reason);
-			return;
 		}
 	}
-};
+	return [...claimable.values()];
+}
+/**
+* A campaign's incentive token is not protocol collateral, so the registry
+* usually has no entry for it — and Merkl always names it. The one place the
+* two sources are reconciled.
+*/
+function toRewardToken(sdk, address, merkl) {
+	return sdk.tokensMeta.getToken(address) ?? {
+		chainId: sdk.chainId,
+		address,
+		symbol: merkl.symbol,
+		name: merkl.symbol,
+		decimals: merkl.decimals || 18
+	};
+}
+function extractFulfilled(r, reportError, description) {
+	if (r.status === "fulfilled") return r.value;
+	if (reportError) reportError(r.reason, description);
+	else console.error(r.reason);
+}
 //#endregion
-exports.RewardAmountAPI = RewardAmountAPI;
+exports.getMerklRewards = getMerklRewards;

package/dist/cjs/rewards/rewards/index.js

@@ -2,5 +2,5 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_rewards_rewards_api = require("./api.js");
 const require_rewards_rewards_extra_apy = require("./extra-apy.js");
 exports.PoolPointsAPI = require_rewards_rewards_extra_apy.PoolPointsAPI;
-exports.RewardAmountAPI = require_rewards_rewards_api.RewardAmountAPI;
 exports.getKeyForPoolPointsInfo = require_rewards_rewards_extra_apy.getKeyForPoolPointsInfo;
+exports.getMerklRewards = require_rewards_rewards_api.getMerklRewards;

package/dist/esm/rewards/index.js

@@ -1,5 +1,5 @@
 import "./apy/index.js";
-import { RewardAmountAPI } from "./rewards/api.js";
+import { getMerklRewards } from "./rewards/api.js";
 import { PoolPointsAPI, getKeyForPoolPointsInfo } from "./rewards/extra-apy.js";
 import "./rewards/index.js";
-export { PoolPointsAPI, RewardAmountAPI, getKeyForPoolPointsInfo };
+export { PoolPointsAPI, getKeyForPoolPointsInfo, getMerklRewards };

package/dist/esm/rewards/rewards/api.js

@@ -1,69 +1,79 @@
+import { AddressMap } from "../../onchain/utils/AddressMap.js";
 import { BigIntMath } from "../../onchain/utils/bigint-math.js";
-import { chains } from "../../onchain/chain/chains.js";
 import { toBigInt } from "../../onchain/utils/formatter.js";
 import "../../onchain/index.js";
 import "../../common-utils/index.js";
 import { MerkleXYZApi } from "./merkl-api.js";
-import { getAddress } from "viem";
+import { getAddress, isAddress } from "viem";
 //#region src/rewards/rewards/api.ts
-var RewardAmountAPI = class RewardAmountAPI {
-	constructor() {}
-	static async getLmRewardsMerkle({ pools, account, network, reportError, apiKey }) {
-		const [merkleXYZLMResponse] = await Promise.allSettled([MerkleXYZApi.fetchWithFallback(MerkleXYZApi.getUserRewardsUrl({ params: {
-			chainId: chains[network].id,
-			user: getAddress(account)
-		} }), apiKey)]);
-		const merkleXYZLm = RewardAmountAPI.extractFulfilled(merkleXYZLMResponse, reportError, "merkleXYZLm")?.data;
-		const poolByItsToken = Object.values(pools).reduce((acc, p) => {
-			p.stakedDieselToken.forEach((t) => {
-				if (t) acc[t] = p.address;
-			});
-			p.stakedDieselToken_old.forEach((t) => {
-				if (t) acc[t] = p.address;
-			});
-			acc[p.dieselToken] = p.address;
-			return acc;
-		}, {});
-		const extraRewards = (merkleXYZLm || []).reduce((acc, chainRewards) => {
-			chainRewards.rewards.forEach((reward) => {
-				const rewardToken = reward.token.address.toLowerCase();
-				reward.breakdowns.forEach((reason) => {
-					const poolToken = ((reason.reason || "").split("_").find((part) => part.startsWith("0x")) || "").toLowerCase();
-					const pool = poolByItsToken[poolToken];
-					const total = toBigInt(reason.amount || 0);
-					const claimed = toBigInt(reason.claimed || 0);
-					const claimable = BigIntMath.max(total - claimed, 0n);
-					const key = [
-						pool,
-						poolToken,
-						rewardToken
-					].join("_");
-					if (pool && claimable > 0n) {
-						const prevAmount = acc[key]?.amount || 0n;
-						acc[key] = {
-							pool,
-							poolToken,
-							rewardToken,
-							rewardTokenSymbol: reward.token.symbol,
-							rewardTokenDecimals: reward.token.decimals || 18,
-							amount: prevAmount + claimable,
-							type: "extraMerkle"
-						};
-					}
+/**
+* The wallet's claimable Merkl rewards on one chain.
+*
+* Never rejects on a transport failure: the fetch is settled rather than
+* awaited, and a failure goes to `reportError` and yields an empty list. A
+* caller that must tell "this chain is down" from "this chain has no rewards"
+* has to watch that callback.
+*/
+async function getMerklRewards({ sdk, account, reportError, apiKey }) {
+	const [merkleXYZLMResponse] = await Promise.allSettled([MerkleXYZApi.fetchWithFallback(MerkleXYZApi.getUserRewardsUrl({ params: {
+		chainId: sdk.chainId,
+		user: getAddress(account)
+	} }), apiKey)]);
+	const merkleXYZLm = extractFulfilled(merkleXYZLMResponse, reportError, "merkleXYZLm")?.data;
+	const poolByItsToken = AddressMap.fromMappedArray(sdk.marketRegister.pools.map(({ pool }) => pool.address), (address) => address);
+	const claimable = /* @__PURE__ */ new Map();
+	for (const chainRewards of merkleXYZLm || []) for (const reward of chainRewards.rewards) {
+		if (!isAddress(reward.token.address, { strict: false })) continue;
+		const rewardTokenAddress = getAddress(reward.token.address);
+		for (const reason of reward.breakdowns) {
+			const poolTokenAddress = (reason.reason || "").split("_").find((part) => part.startsWith("0x")) ?? "";
+			if (!isAddress(poolTokenAddress, { strict: false })) continue;
+			const pool = poolByItsToken.get(poolTokenAddress);
+			if (!pool) continue;
+			const total = toBigInt(reason.amount || 0);
+			const claimed = toBigInt(reason.claimed || 0);
+			const amount = BigIntMath.max(total - claimed, 0n);
+			if (amount === 0n) continue;
+			const key = `${pool}_${rewardTokenAddress}`;
+			const seen = claimable.get(key);
+			if (seen) {
+				claimable.set(key, {
+					...seen,
+					amount: seen.amount + amount
 				});
+				continue;
+			}
+			const poolToken = sdk.tokensMeta.getToken(pool);
+			if (!poolToken) continue;
+			claimable.set(key, {
+				chainId: sdk.chainId,
+				pool,
+				poolToken,
+				rewardToken: toRewardToken(sdk, rewardTokenAddress, reward.token),
+				amount
 			});
-			return acc;
-		}, {});
-		return Object.values(extraRewards);
-	}
-	static extractFulfilled(r, reportError, description) {
-		if (r.status === "fulfilled") return r.value;
-		else {
-			if (reportError) reportError(r.reason, description);
-			else console.error(r.reason);
-			return;
 		}
 	}
-};
+	return [...claimable.values()];
+}
+/**
+* A campaign's incentive token is not protocol collateral, so the registry
+* usually has no entry for it — and Merkl always names it. The one place the
+* two sources are reconciled.
+*/
+function toRewardToken(sdk, address, merkl) {
+	return sdk.tokensMeta.getToken(address) ?? {
+		chainId: sdk.chainId,
+		address,
+		symbol: merkl.symbol,
+		name: merkl.symbol,
+		decimals: merkl.decimals || 18
+	};
+}
+function extractFulfilled(r, reportError, description) {
+	if (r.status === "fulfilled") return r.value;
+	if (reportError) reportError(r.reason, description);
+	else console.error(r.reason);
+}
 //#endregion
-export { RewardAmountAPI };
+export { getMerklRewards };

package/dist/esm/rewards/rewards/index.js

@@ -1,3 +1,3 @@
-import { RewardAmountAPI } from "./api.js";
+import { getMerklRewards } from "./api.js";
 import { PoolPointsAPI, getKeyForPoolPointsInfo } from "./extra-apy.js";
-export { PoolPointsAPI, RewardAmountAPI, getKeyForPoolPointsInfo };
+export { PoolPointsAPI, getKeyForPoolPointsInfo, getMerklRewards };

package/dist/types/rewards/index.d.ts

@@ -1,7 +1,7 @@
 import { Apy, ApyDetails, DebtReward, ExternalApy, ExtraCollateralAPY, ExtraCollateralPointsInfo, FarmInfo, GearAPY, GearAPYDetails, PointsInfo, PointsReward, PoolExtraApy, PoolOutputDetails, PoolPointsInfo, TokenOutputDetails } from "./apy/output-details.js";
 import { DataResult, Output } from "./apy/output.js";
 import "./apy/index.js";
-import { GearboxExtraMerkleLmReward, GearboxLmReward, GetLmRewardsMerkleProps, PoolData, RewardAmountAPI } from "./rewards/api.js";
+import { GetMerklRewardsProps, MerklReward, MerklRewardsSdk, getMerklRewards } from "./rewards/api.js";
 import { GetPointsByPoolProps, GetTotalTokensOnProtocolProps, PoolPointsAPI, PoolPointsBase, getKeyForPoolPointsInfo } from "./rewards/extra-apy.js";
 import "./rewards/index.js";
-export { Apy, ApyDetails, DataResult, DebtReward, ExternalApy, ExtraCollateralAPY, ExtraCollateralPointsInfo, FarmInfo, GearAPY, GearAPYDetails, GearboxExtraMerkleLmReward, GearboxLmReward, GetLmRewardsMerkleProps, GetPointsByPoolProps, GetTotalTokensOnProtocolProps, Output, PointsInfo, PointsReward, PoolData, PoolExtraApy, PoolOutputDetails, PoolPointsAPI, PoolPointsBase, PoolPointsInfo, RewardAmountAPI, TokenOutputDetails, getKeyForPoolPointsInfo };
+export { Apy, ApyDetails, DataResult, DebtReward, ExternalApy, ExtraCollateralAPY, ExtraCollateralPointsInfo, FarmInfo, GearAPY, GearAPYDetails, GetMerklRewardsProps, GetPointsByPoolProps, GetTotalTokensOnProtocolProps, MerklReward, MerklRewardsSdk, Output, PointsInfo, PointsReward, PoolExtraApy, PoolOutputDetails, PoolPointsAPI, PoolPointsBase, PoolPointsInfo, TokenOutputDetails, getKeyForPoolPointsInfo, getMerklRewards };

package/dist/types/rewards/rewards/api.d.ts

@@ -1,39 +1,54 @@
-import { NetworkType } from "../../onchain/chain/chains.js";
+import { ChainId, Token } from "../../model/primitives.js";
+import "../../model/index.js";
+import { OnchainSDK } from "../../onchain/OnchainSDK.js";
 import "../../onchain/index.js";
 import { Address } from "viem";
 //#region src/rewards/rewards/api.d.ts
-interface PoolData {
-  address: Address;
-  version: number;
-  underlyingToken: Address;
-  dieselRateRay: bigint;
-  dieselToken: Address;
-  stakedDieselToken: Address[];
-  stakedDieselToken_old: Address[];
-  expectedLiquidity: bigint;
+/**
+ * One claimable Merkl liquidity-mining reward, denominated.
+ *
+ * Both tokens arrive resolved, so a consumer neither looks one up nor
+ * reassembles one out of the loose fields Merkl sends.
+ */
+interface MerklReward {
+  readonly chainId: ChainId;
+  /** Market pool whose depositors the campaign rewards. */
+  readonly pool: Address;
+  /** That pool's share token — what the campaign is keyed on. */
+  readonly poolToken: Token;
+  /** The incentive token being handed out. */
+  readonly rewardToken: Token;
+  /** Claimable amount, i.e. distributed minus already claimed. Always > 0. */
+  readonly amount: bigint;
 }
-interface GearboxExtraMerkleLmReward {
-  pool: Address;
-  poolToken: Address;
-  rewardTokenSymbol: string;
-  rewardTokenDecimals: number;
-  rewardToken: Address;
-  amount: bigint;
-  type: "extraMerkle";
-}
-type GearboxLmReward = GearboxExtraMerkleLmReward;
 type ReportHandler = (e: unknown, description?: string) => void;
-interface GetLmRewardsMerkleProps {
-  pools: Record<Address, PoolData>;
+/**
+ * What this read needs off a chain's SDK: which chain to ask Merkl about, the
+ * pools a campaign can be keyed on, and the registry that names their tokens.
+ *
+ * Sliced rather than taking the whole {@link OnchainSDK} so a caller can hand
+ * over a narrowed object — a test fixture included — without casting.
+ */
+type MerklRewardsSdk = Pick<OnchainSDK, "chainId" | "marketRegister" | "tokensMeta">;
+interface GetMerklRewardsProps {
+  /**
+   * The chain's SDK, attached. Reading `marketRegister` before attach throws,
+   * which the slice above cannot express.
+   */
+  sdk: MerklRewardsSdk;
   account: Address;
-  network: NetworkType;
   reportError?: ReportHandler;
+  /** Raises Merkl's rate limit; the keyless path answers too. */
   apiKey?: string;
 }
-declare class RewardAmountAPI {
-  private constructor();
-  static getLmRewardsMerkle({ pools, account, network, reportError, apiKey }: GetLmRewardsMerkleProps): Promise<GearboxExtraMerkleLmReward[]>;
-  private static extractFulfilled;
-}
+/**
+ * The wallet's claimable Merkl rewards on one chain.
+ *
+ * Never rejects on a transport failure: the fetch is settled rather than
+ * awaited, and a failure goes to `reportError` and yields an empty list. A
+ * caller that must tell "this chain is down" from "this chain has no rewards"
+ * has to watch that callback.
+ */
+declare function getMerklRewards({ sdk, account, reportError, apiKey }: GetMerklRewardsProps): Promise<MerklReward[]>;
 //#endregion
-export { GearboxExtraMerkleLmReward, GearboxLmReward, GetLmRewardsMerkleProps, PoolData, RewardAmountAPI };
+export { GetMerklRewardsProps, MerklReward, MerklRewardsSdk, getMerklRewards };

package/dist/types/rewards/rewards/index.d.ts

@@ -1,3 +1,3 @@
-import { GearboxExtraMerkleLmReward, GearboxLmReward, GetLmRewardsMerkleProps, PoolData, RewardAmountAPI } from "./api.js";
+import { GetMerklRewardsProps, MerklReward, MerklRewardsSdk, getMerklRewards } from "./api.js";
 import { GetPointsByPoolProps, GetTotalTokensOnProtocolProps, PoolPointsAPI, PoolPointsBase, getKeyForPoolPointsInfo } from "./extra-apy.js";
-export { GearboxExtraMerkleLmReward, GearboxLmReward, GetLmRewardsMerkleProps, GetPointsByPoolProps, GetTotalTokensOnProtocolProps, PoolData, PoolPointsAPI, PoolPointsBase, RewardAmountAPI, getKeyForPoolPointsInfo };
+export { GetMerklRewardsProps, GetPointsByPoolProps, GetTotalTokensOnProtocolProps, MerklReward, MerklRewardsSdk, PoolPointsAPI, PoolPointsBase, getKeyForPoolPointsInfo, getMerklRewards };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "16.0.0-next.16",
+  "version": "16.0.0-next.17",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {