@gearbox-protocol/sdk 16.0.0-next.54 → 16.0.0-next.55

package/dist/esm/dev/mode-parity/scriptUtils.js

@@ -1,4 +1,5 @@
 import { getAlchemyUrl } from "../providers.js";
+import { appendFileSync } from "node:fs";
 import { pino } from "pino";
 //#region src/dev/mode-parity/scriptUtils.ts
 const NETWORKS = [
@@ -76,6 +77,40 @@ function worstColumns(worst) {
 	};
 }
 /**
+* Reasons a compare run should fail CI: unexpected membership or field diffs,
+* both sources empty, a chain that could not be read, or wallets that failed
+* to list. Expected diffs (mode-scoped, backend-preferred, tolerance) do not
+* fail the run.
+**/
+function evaluateCompareFailure(report) {
+	const { summary } = report;
+	const reasons = [];
+	if (summary.onchainRows === 0 && summary.offchainRows === 0) reasons.push("both sources produced no data");
+	if (summary.different > 0) reasons.push(`${summary.different} matched rows are different`);
+	if (summary.onlyOnchain > 0) reasons.push(`${summary.onlyOnchain} rows only onchain`);
+	if (summary.onlyOffchain > 0) reasons.push(`${summary.onlyOffchain} rows only offchain`);
+	if ((summary.walletsFailed ?? 0) > 0) reasons.push(`${summary.walletsFailed} wallets failed to list`);
+	for (const chain of [...report.onchainChains, ...report.offchainChains]) if (chain.status === "error") reasons.push(`chain ${chain.chainId} failed on ${chain.source ?? "unknown"}: ${errorMessage(chain.error)}`);
+	return reasons;
+}
+function splitDiffs(summary) {
+	return {
+		unexpected: summary.diffsByPath.filter((entry) => entry.unexpected > 0),
+		expected: summary.diffsByPath.filter((entry) => entry.unexpected === 0 && entry.expected > 0)
+	};
+}
+function markdownCell(value) {
+	return String(value).replaceAll("|", "\\|").replaceAll("\n", " ");
+}
+function markdownTable(headers, rows) {
+	const line = (cells) => `| ${cells.map(markdownCell).join(" | ")} |`;
+	return [
+		line(headers),
+		line(headers.map(() => "---")),
+		...rows.map(line)
+	].join("\n");
+}
+/**
 * Prints the shared membership table, the fields that differed most often,
 * and any chain that failed to answer.
 **/
@@ -87,15 +122,13 @@ function printCompareSummary(noun, report, extraLines = []) {
 		onchain: chain.onchainRows,
 		offchain: chain.offchainRows,
 		matched: chain.matched,
-		identical: chain.identical,
-		clean: chain.clean,
-		differing: chain.differing,
+		similar: chain.similar,
+		different: chain.different,
 		"only onchain": chain.onlyOnchain,
 		"only offchain": chain.onlyOffchain
 	})));
 	for (const line of extraLines) console.log(line);
-	const unexpected = summary.diffsByPath.filter((entry) => entry.unexpected > 0);
-	const expected = summary.diffsByPath.filter((entry) => entry.unexpected === 0 && entry.expected > 0);
+	const { unexpected, expected } = splitDiffs(summary);
 	if (unexpected.length) {
 		console.log("\nunexpected fields that differed most often:");
 		console.table(unexpected.slice(0, 25).map((entry) => ({
@@ -117,5 +150,108 @@ function printCompareSummary(noun, report, extraLines = []) {
 	}
 	for (const chain of [...report.onchainChains, ...report.offchainChains]) if (chain.status === "error") console.log(`chain ${chain.chainId} failed on ${chain.source}:`, chain.error);
 }
+/**
+* Markdown of the same summary printed to the console, for GitHub job summaries.
+**/
+function formatCompareMarkdown(noun, report, extraLines = [], reasons = []) {
+	const { summary } = report;
+	const { unexpected, expected } = splitDiffs(summary);
+	const parts = [
+		`# ${noun} compare`,
+		"",
+		reasons.length ? "**Failed**" : "**Passed**",
+		"",
+		`${noun} from \`${report.backendUrl}\` vs the chain`,
+		""
+	];
+	if (reasons.length) {
+		parts.push("## Failures", "");
+		for (const reason of reasons) parts.push(`- ${reason}`);
+		parts.push("");
+	}
+	if (extraLines.length) {
+		for (const line of extraLines) parts.push(line);
+		parts.push("");
+	}
+	if (summary.byChain.length) parts.push(markdownTable([
+		"chain",
+		"onchain",
+		"offchain",
+		"matched",
+		"similar",
+		"different",
+		"only onchain",
+		"only offchain"
+	], summary.byChain.map((chain) => [
+		chain.chainId,
+		chain.onchainRows,
+		chain.offchainRows,
+		chain.matched,
+		chain.similar,
+		chain.different,
+		chain.onlyOnchain,
+		chain.onlyOffchain
+	])), "");
+	if (unexpected.length) parts.push("## Unexpected fields that differed most often", "", markdownTable([
+		"field",
+		"unexpected",
+		"expected",
+		"kinds",
+		"max diff",
+		"worst entity"
+	], unexpected.slice(0, 25).map((entry) => {
+		const worst = worstColumns(entry.worstUnexpected);
+		return [
+			entry.path,
+			entry.unexpected,
+			entry.expected,
+			entry.kinds.join(", "),
+			worst["max diff"],
+			worst["worst entity"]
+		];
+	})), "");
+	if (expected.length) parts.push("## Expected fields (mode-scoped, backend-preferred, or within tolerance)", "", markdownTable([
+		"field",
+		"rows",
+		"kinds",
+		"max diff",
+		"worst entity"
+	], expected.slice(0, 25).map((entry) => {
+		const worst = worstColumns(entry.worstExpected);
+		return [
+			entry.path,
+			entry.expected,
+			entry.kinds.join(", "),
+			worst["max diff"],
+			worst["worst entity"]
+		];
+	})), "");
+	const failedChains = [...report.onchainChains, ...report.offchainChains].filter((chain) => chain.status === "error");
+	if (failedChains.length) {
+		parts.push("## Chain errors", "");
+		for (const chain of failedChains) parts.push(`- chain ${chain.chainId} failed on ${chain.source ?? "unknown"}: ${errorMessage(chain.error)}`);
+		parts.push("");
+	}
+	return parts.join("\n");
+}
+/**
+* Appends {@link formatCompareMarkdown} to `GITHUB_STEP_SUMMARY` when running
+* in GitHub Actions. No-op locally.
+**/
+function writeGithubJobSummary(noun, report, extraLines = [], reasons = []) {
+	const path = process.env.GITHUB_STEP_SUMMARY;
+	if (!path) return;
+	appendFileSync(path, `${formatCompareMarkdown(noun, report, extraLines, reasons)}\n`);
+}
+/**
+* Console + job-summary output for a compare run. Returns the failure reasons
+* so the caller can exit 1 when the report is not similar.
+**/
+function reportCompare(noun, report, extraLines = []) {
+	printCompareSummary(noun, report, extraLines);
+	const reasons = evaluateCompareFailure(report);
+	writeGithubJobSummary(noun, report, extraLines, reasons);
+	return reasons;
+}
 //#endregion
-export { BACKEND_URL, NETWORKS, TIMEOUT, createLogger, errorMessage, formatBpsAsPercent, mapPool, printCompareSummary, requireEnv, rpcUrls };
+export { BACKEND_URL, NETWORKS, TIMEOUT, createLogger, errorMessage, evaluateCompareFailure, formatBpsAsPercent, formatCompareMarkdown, mapPool, printCompareSummary, reportCompare, requireEnv, rpcUrls, writeGithubJobSummary };

package/dist/esm/rewards/errors.js

@@ -0,0 +1,26 @@
+import { BaseError } from "viem";
+//#region src/rewards/errors.ts
+/**
+* Thrown when none of Merkl's domains answered for a chain.
+*
+* Everything a reader needs is in the message: this error travels to consumers
+* inside a chain's {@link ChainFailed} metadata, where it is typed `unknown`
+* and may be serialised by something that turns an arbitrary object into `{}`.
+*/
+var MerklRequestFailedError = class extends BaseError {
+	name = "MerklRequestFailedError";
+	chainId;
+	constructor(chainId, path, attempts) {
+		super(`Merkl could not be reached for chain ${chainId}.`, {
+			cause: attempts.find(([, c]) => c instanceof Error)?.[1],
+			metaMessages: attempts.map(([domain, cause]) => `${domain}${path} — ${describe(cause)}`)
+		});
+		this.chainId = chainId;
+	}
+};
+function describe(cause) {
+	if (cause instanceof Error) return cause.name === "TimeoutError" ? "timed out" : cause.message;
+	return String(cause);
+}
+//#endregion
+export { MerklRequestFailedError };

package/dist/esm/rewards/index.js

@@ -1,5 +1,4 @@
-import "./apy/index.js";
-import { getMerklRewards } from "./rewards/api.js";
-import { PoolPointsAPI, getKeyForPoolPointsInfo } from "./rewards/extra-apy.js";
-import "./rewards/index.js";
-export { PoolPointsAPI, getKeyForPoolPointsInfo, getMerklRewards };
+import { MerklRequestFailedError } from "./errors.js";
+import { toMerklRewards } from "./toMerklRewards.js";
+import { getMerklRewardsMultichain } from "./multichain.js";
+export { MerklRequestFailedError, getMerklRewardsMultichain, toMerklRewards };

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

@@ -0,0 +1,42 @@
+import { MerklRequestFailedError } from "./errors.js";
+//#region src/rewards/merkl-api.ts
+/**
+* Merkl's own host and the Angle mirror, tried in this order.
+*/
+const MERKL_DOMAINS = ["https://api.merkl.xyz", "https://api-merkl.angle.money"];
+const MERKL_API_KEY_HEADER = "X-API-Key";
+/**
+* Per-attempt budget. Merkl has no timeout of its own, and a hung connection
+* would otherwise stall its leg of a fan-out for as long as the socket lives.
+*/
+const ATTEMPT_TIMEOUT = 1e4;
+/**
+* The wallet's raw Merkl rewards on one chain.
+*
+* Rejects with {@link MerklRequestFailedError} when neither domain answers, so
+* a caller can tell an unreachable Merkl from a wallet with nothing to claim.
+* A non-2xx counts as no answer and moves to the next domain: it carries no
+* rewards either way, and treating it as success would report emptiness that
+* was never established.
+*/
+async function fetchMerklUserRewards({ chainId, user, apiKey }) {
+	const path = `/v4/users/${user}/rewards?chainId=${chainId}`;
+	const headers = apiKey ? { [MERKL_API_KEY_HEADER]: apiKey } : void 0;
+	const attempts = [];
+	for (const domain of MERKL_DOMAINS) try {
+		const response = await fetch(`${domain}${path}`, {
+			headers,
+			signal: AbortSignal.timeout(ATTEMPT_TIMEOUT)
+		});
+		if (!response.ok) {
+			attempts.push([domain, /* @__PURE__ */ new Error(`answered ${response.status}`)]);
+			continue;
+		}
+		return await response.json();
+	} catch (error) {
+		attempts.push([domain, error]);
+	}
+	throw new MerklRequestFailedError(chainId, path, attempts);
+}
+//#endregion
+export { MERKL_API_KEY_HEADER, MERKL_DOMAINS, fetchMerklUserRewards };

package/dist/esm/rewards/multichain.js

@@ -0,0 +1,39 @@
+import { MultichainConstruct } from "../onchain/base/MultichainConstruct.js";
+import "../onchain/index.js";
+import { fetchMerklUserRewards } from "./merkl-api.js";
+import { toMerklRewards } from "./toMerklRewards.js";
+import { getAddress } from "viem";
+//#region src/rewards/multichain.ts
+/**
+* The fan-out itself. Private because rewards are not an SDK namespace yet:
+* the read is a free function, and this is only how it reaches `queryChains`.
+**/
+var MerklRewardsFanOut = class extends MultichainConstruct {
+	async list(wallet, chainIds, apiKey) {
+		const user = getAddress(wallet);
+		return this.queryChains({
+			chainIds,
+			label: "list rewards",
+			block: "state",
+			run: async (sdk) => toMerklRewards(sdk, await fetchMerklUserRewards({
+				chainId: sdk.chainId,
+				user,
+				apiKey
+			}))
+		});
+	}
+};
+/**
+* Every claimable Merkl reward a wallet holds, across the chains the handle
+* carries.
+*
+* Answers the read model's own envelope, so a chain that could not be reached
+* is `status: "error"` in `meta.chains` while a chain with nothing to claim is
+* a `"success"` that contributed no rows. That distinction is the point: the
+* single-chain read this replaces resolved empty either way.
+**/
+async function getMerklRewardsMultichain({ sdk, wallet, chainIds, apiKey }) {
+	return new MerklRewardsFanOut(sdk).list(wallet, chainIds, apiKey);
+}
+//#endregion
+export { getMerklRewardsMultichain };

package/dist/esm/rewards/{rewards/api.js → toMerklRewards.js}

@@ -1,27 +1,16 @@
-import { AddressMap } from "../../onchain/utils/AddressMap.js";
-import { BigIntMath } from "../../onchain/utils/bigint-math.js";
-import { toBigInt } from "../../onchain/utils/formatter.js";
-import "../../onchain/index.js";
-import { MerkleXYZApi } from "./merkl-api.js";
+import { AddressMap } from "../onchain/utils/AddressMap.js";
+import { BigIntMath } from "../onchain/utils/bigint-math.js";
+import { toBigInt } from "../onchain/utils/formatter.js";
+import "../onchain/index.js";
 import { formatUnits, getAddress, isAddress } from "viem";
-//#region src/rewards/rewards/api.ts
+//#region src/rewards/toMerklRewards.ts
 /**
-* 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.
+* Merkl's answer for one chain, turned into rows of the read model.
 */
-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;
+function toMerklRewards(sdk, response) {
 	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) {
+	for (const chainRewards of response) 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) {
@@ -29,9 +18,9 @@ async function getMerklRewards({ sdk, account, reportError, apiKey }) {
 			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);
+			const amounts = toAmounts(reason);
+			if (!amounts) continue;
+			const amount = BigIntMath.max(amounts.total - amounts.claimed, 0n);
 			if (amount === 0n) continue;
 			const key = `${pool}_${rewardTokenAddress}`;
 			const seen = claimable.get(key);
@@ -53,6 +42,20 @@ async function getMerklRewards({ sdk, account, reportError, apiKey }) {
 	}
 	return [...claimable.values()].map(toReward);
 }
+/**
+* `toBigInt` throws on anything `BigInt()` cannot parse, and Merkl's amounts
+* are free-form strings.
+*/
+function toAmounts(reason) {
+	try {
+		return {
+			total: toBigInt(reason.amount || 0),
+			claimed: toBigInt(reason.claimed || 0)
+		};
+	} catch {
+		return;
+	}
+}
 function toReward({ price, token, value, ...rest }) {
 	return {
 		...rest,
@@ -77,10 +80,5 @@ function toRewardToken(sdk, address, merkl) {
 		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 { getMerklRewards };
+export { toMerklRewards };

package/dist/types/dev/mode-parity/compareOpportunities.d.ts

@@ -36,14 +36,10 @@ interface OpportunityMatch {
    **/
   onchainName: string;
   offchainName: string;
-  /**
-   * No diffs at all, including the documented offchain-only ones.
-   **/
-  identical: boolean;
   /**
    * No unexpected diffs: every disagreement is mode-scoped or within tolerance.
    **/
-  clean: boolean;
+  similar: boolean;
   diffs: FieldDiff[];
 }
 /**
@@ -93,8 +89,8 @@ interface CompareOpportunitiesInput {
  *
  * Nothing is filtered out. A field only the backend can fill, or a USD value
  * that drifted within snapshot-lag noise, is still reported — tagged
- * {@link FieldDiff.expected} so that {@link CompareCounts.clean} can ignore it
- * while {@link CompareCounts.identical} stays strict.
+ * {@link FieldDiff.expected} so that {@link CompareCounts.similar} can ignore
+ * it.
  **/
 declare function compareOpportunities(input: CompareOpportunitiesInput): OpportunityCompareReport;
 /**

package/dist/types/dev/mode-parity/comparePositions.d.ts

@@ -34,15 +34,11 @@ interface PositionMatch {
   chainId: ChainId;
   onchainName: string;
   offchainName: string;
-  /**
-   * No diffs at all, including the documented mode-scoped ones.
-   **/
-  identical: boolean;
   /**
    * No unexpected diffs: every disagreement is mode-scoped, backend-preferred,
    * or within tolerance.
    **/
-  clean: boolean;
+  similar: boolean;
   diffs: FieldDiff[];
 }
 /**
@@ -78,7 +74,7 @@ interface PositionsCompareSummary extends CompareCounts {
    * Wallets whose listings were read and that have no membership gaps and no
    * unexpected field diffs.
    **/
-  walletsClean: number;
+  walletsSimilar: number;
   walletsFailed: number;
   byChain: ChainCompareCounts[];
   byWallet: WalletCompareCounts[];
@@ -139,8 +135,8 @@ interface ComparePositionsInput {
  * Nothing is filtered out. A field only one mode can fill, a strategy field
  * both-mode merge overlays from the backend, or a USD value that drifted
  * within snapshot-lag noise, is still reported — tagged
- * {@link FieldDiff.expected} so that {@link CompareCounts.clean} can ignore it
- * while {@link CompareCounts.identical} stays strict.
+ * {@link FieldDiff.expected} so that {@link CompareCounts.similar} can ignore
+ * it.
  **/
 declare function comparePositions(input: ComparePositionsInput): PositionsCompareReport;
 /**

package/dist/types/dev/mode-parity/fieldDiff.d.ts

@@ -42,7 +42,7 @@ interface FieldDiff {
   kind: DiffKind;
   /**
    * Present when this disagreement is documented or within snapshot-lag noise,
-   * so it does not keep the row from being counted as clean.
+   * so it does not keep the row from being counted as similar.
    **/
   expected?: true;
   reason?: ExpectedDiffReason;
@@ -102,12 +102,14 @@ interface CompareCounts {
   onchainRows: number;
   offchainRows: number;
   matched: number;
-  identical: number;
   /**
-   * Matched rows with no unexpected diffs, including the identical ones.
+   * Matched rows with no unexpected diffs.
    **/
-  clean: number;
-  differing: number;
+  similar: number;
+  /**
+   * Matched rows with at least one unexpected diff.
+   **/
+  different: number;
   onlyOnchain: number;
   onlyOffchain: number;
 }
@@ -157,7 +159,7 @@ declare function diffValue(path: string, onchain: unknown, offchain: unknown, ou
  **/
 declare function diffObjects(onchain: unknown, offchain: unknown, options?: DiffOptions): FieldDiff[];
 /**
- * Mark a diff expected, so a later `clean` count can ignore it.
+ * Mark a diff expected, so a later `similar` count can ignore it.
  **/
 declare function withExpected(diff: FieldDiff, reason: ExpectedDiffReason): FieldDiff;
 /**
@@ -174,8 +176,7 @@ declare function collapseArrayKeys(path: string): string;
  * Membership and match totals of one comparison, from already-built lists.
  **/
 declare function toCompareCounts(onchainRows: number, offchainRows: number, onlyOnchain: number, onlyOffchain: number, matched: ReadonlyArray<{
-  identical: boolean;
-  clean: boolean;
+  similar: boolean;
 }>): CompareCounts;
 /**
  * USD floats within {@link USD_RELATIVE_EPSILON}.

package/dist/types/dev/mode-parity/scriptUtils.d.ts

@@ -16,6 +16,10 @@ declare const TIMEOUT = 480000;
 interface PrintableCompareSummary extends CompareCounts {
   byChain: ChainCompareCounts[];
   diffsByPath: DiffPathCount[];
+  /**
+   * Present on position reports: wallets whose listings could not be read.
+   **/
+  walletsFailed?: number;
 }
 /**
  * Per-source chain metadata both compare reports carry.
@@ -38,10 +42,31 @@ declare function mapPool<T>(items: readonly T[], concurrency: number, fn: (item:
  * Formats a relative difference in bps as a percent, e.g. 12.5 → `"0.125%"`.
  **/
 declare function formatBpsAsPercent(bps: number): string;
+/**
+ * Reasons a compare run should fail CI: unexpected membership or field diffs,
+ * both sources empty, a chain that could not be read, or wallets that failed
+ * to list. Expected diffs (mode-scoped, backend-preferred, tolerance) do not
+ * fail the run.
+ **/
+declare function evaluateCompareFailure(report: PrintableCompareReport): string[];
 /**
  * Prints the shared membership table, the fields that differed most often,
  * and any chain that failed to answer.
  **/
 declare function printCompareSummary(noun: string, report: PrintableCompareReport, extraLines?: string[]): void;
+/**
+ * Markdown of the same summary printed to the console, for GitHub job summaries.
+ **/
+declare function formatCompareMarkdown(noun: string, report: PrintableCompareReport, extraLines?: string[], reasons?: string[]): string;
+/**
+ * Appends {@link formatCompareMarkdown} to `GITHUB_STEP_SUMMARY` when running
+ * in GitHub Actions. No-op locally.
+ **/
+declare function writeGithubJobSummary(noun: string, report: PrintableCompareReport, extraLines?: string[], reasons?: string[]): void;
+/**
+ * Console + job-summary output for a compare run. Returns the failure reasons
+ * so the caller can exit 1 when the report is not similar.
+ **/
+declare function reportCompare(noun: string, report: PrintableCompareReport, extraLines?: string[]): string[];
 //#endregion
-export { BACKEND_URL, ComparedNetwork, NETWORKS, PrintableCompareReport, PrintableCompareSummary, TIMEOUT, createLogger, errorMessage, formatBpsAsPercent, mapPool, printCompareSummary, requireEnv, rpcUrls };
+export { BACKEND_URL, ComparedNetwork, NETWORKS, PrintableCompareReport, PrintableCompareSummary, TIMEOUT, createLogger, errorMessage, evaluateCompareFailure, formatBpsAsPercent, formatCompareMarkdown, mapPool, printCompareSummary, reportCompare, requireEnv, rpcUrls, writeGithubJobSummary };

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

@@ -0,0 +1,18 @@
+import { ChainId } from "../model/primitives.js";
+import "../model/index.js";
+import { BaseError } from "viem";
+//#region src/rewards/errors.d.ts
+/**
+ * Thrown when none of Merkl's domains answered for a chain.
+ *
+ * Everything a reader needs is in the message: this error travels to consumers
+ * inside a chain's {@link ChainFailed} metadata, where it is typed `unknown`
+ * and may be serialised by something that turns an arbitrary object into `{}`.
+ */
+declare class MerklRequestFailedError extends BaseError {
+  name: string;
+  readonly chainId: ChainId;
+  constructor(chainId: ChainId, path: string, attempts: ReadonlyArray<[domain: string, cause: unknown]>);
+}
+//#endregion
+export { MerklRequestFailedError };

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

@@ -1,7 +1,4 @@
-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 { 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, GetMerklRewardsProps, GetPointsByPoolProps, GetTotalTokensOnProtocolProps, MerklReward, MerklRewardsSdk, Output, PointsInfo, PointsReward, PoolExtraApy, PoolOutputDetails, PoolPointsAPI, PoolPointsBase, PoolPointsInfo, TokenOutputDetails, getKeyForPoolPointsInfo, getMerklRewards };
+import { MerklRequestFailedError } from "./errors.js";
+import { MerklReward, MerklRewardsSdk, toMerklRewards } from "./toMerklRewards.js";
+import { GetMerklRewardsMultichainProps, getMerklRewardsMultichain } from "./multichain.js";
+export { GetMerklRewardsMultichainProps, MerklRequestFailedError, MerklReward, MerklRewardsSdk, getMerklRewardsMultichain, toMerklRewards };

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

@@ -0,0 +1,64 @@
+import { ChainId } from "../model/primitives.js";
+import "../model/index.js";
+import { Address } from "viem";
+//#region src/rewards/merkl-api.d.ts
+interface MerkleXYZUserRewardsV4 {
+  chain: MerkleXYZChain;
+  rewards: Array<{
+    root: Address;
+    recipient: Address;
+    amount: string;
+    claimed: string;
+    pending: string;
+    proofs: Array<Address>;
+    token: {
+      address: Address;
+      chainId: number;
+      symbol: string;
+      decimals: number;
+      /**
+       * USD price of one whole token. Optional because Merkl omits the key
+       * outright for the tokens it does not price — points and the like —
+       * rather than sending a null.
+       */
+      price?: number;
+    };
+    breakdowns: Array<{
+      reason: string;
+      amount: string;
+      claimed: string;
+      pending: string;
+      campaignId: Address;
+    }>;
+  }>;
+}
+type MerkleXYZUserRewardsV4Response = Array<MerkleXYZUserRewardsV4>;
+interface MerkleXYZChain {
+  id: number;
+  name: string;
+  icon: string;
+}
+/**
+ * Merkl's own host and the Angle mirror, tried in this order.
+ */
+declare const MERKL_DOMAINS: readonly ["https://api.merkl.xyz", "https://api-merkl.angle.money"];
+declare const MERKL_API_KEY_HEADER = "X-API-Key";
+interface FetchMerklUserRewardsProps {
+  chainId: ChainId;
+  /** Checksummed by the caller — Merkl keys its answer on the exact string. */
+  user: Address;
+  /** Raises Merkl's rate limit; the keyless path answers too. */
+  apiKey?: string;
+}
+/**
+ * The wallet's raw Merkl rewards on one chain.
+ *
+ * Rejects with {@link MerklRequestFailedError} when neither domain answers, so
+ * a caller can tell an unreachable Merkl from a wallet with nothing to claim.
+ * A non-2xx counts as no answer and moves to the next domain: it carries no
+ * rewards either way, and treating it as success would report emptiness that
+ * was never established.
+ */
+declare function fetchMerklUserRewards({ chainId, user, apiKey }: FetchMerklUserRewardsProps): Promise<MerkleXYZUserRewardsV4Response>;
+//#endregion
+export { FetchMerklUserRewardsProps, MERKL_API_KEY_HEADER, MERKL_DOMAINS, MerkleXYZUserRewardsV4, MerkleXYZUserRewardsV4Response, fetchMerklUserRewards };

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

@@ -0,0 +1,33 @@
+import { ChainId } from "../model/primitives.js";
+import { DataResponse } from "../model/response.js";
+import "../model/index.js";
+import { PluginsMap } from "../onchain/plugins/types.js";
+import { MultichainSDK } from "../onchain/MultichainSDK.js";
+import "../onchain/index.js";
+import { MerklReward } from "./toMerklRewards.js";
+import { Address } from "viem";
+//#region src/rewards/multichain.d.ts
+interface GetMerklRewardsMultichainProps<Plugins extends PluginsMap = {}> {
+  /** Handle whose chains are asked. */
+  sdk: MultichainSDK<Plugins>;
+  /** Wallet whose claimable rewards to list. */
+  wallet: Address;
+  /**
+   * Chains to ask, defaulting to every chain the handle carries.
+   **/
+  chainIds?: ChainId[];
+  /** Raises Merkl's rate limit; the keyless path answers too. */
+  apiKey?: string;
+}
+/**
+ * Every claimable Merkl reward a wallet holds, across the chains the handle
+ * carries.
+ *
+ * Answers the read model's own envelope, so a chain that could not be reached
+ * is `status: "error"` in `meta.chains` while a chain with nothing to claim is
+ * a `"success"` that contributed no rows. That distinction is the point: the
+ * single-chain read this replaces resolved empty either way.
+ **/
+declare function getMerklRewardsMultichain<const Plugins extends PluginsMap = {}>({ sdk, wallet, chainIds, apiKey }: GetMerklRewardsMultichainProps<Plugins>): Promise<DataResponse<MerklReward[]>>;
+//#endregion
+export { GetMerklRewardsMultichainProps, getMerklRewardsMultichain };