@gearbox-protocol/sdk 17.8.0 → 17.10.0

package/dist/types/sdk/rewards/RewardsNamespace.d.ts

@@ -0,0 +1,24 @@
+import { ChainId } from "../../model/primitives.js";
+import { DataResponse } from "../../model/response.js";
+import { Reward } from "../../model/rewards.js";
+import "../../model/index.js";
+import { MultichainSDK } from "../../onchain/MultichainSDK.js";
+import { MultichainConstruct } from "../../onchain/base/MultichainConstruct.js";
+import "../../onchain/index.js";
+import { IRewards, RewardsKeys } from "./types.js";
+import { NamespaceOptions } from "../types.js";
+import { Address } from "viem";
+//#region src/sdk/rewards/RewardsNamespace.d.ts
+/**
+ * {@inheritDoc IRewards}
+ **/
+declare class RewardsNamespace extends MultichainConstruct implements IRewards {
+  #private;
+  constructor(onchain: MultichainSDK, keys: RewardsKeys | undefined, options: NamespaceOptions);
+  /**
+   * {@inheritDoc IRewards.list}
+   **/
+  list(wallet: Address, chainIds?: ChainId[]): Promise<DataResponse<Reward[]>>;
+}
+//#endregion
+export { RewardsNamespace };

package/dist/types/{rewards → sdk/rewards}/errors.d.ts

@@ -1,7 +1,7 @@
-import { ChainId } from "../model/primitives.js";
-import "../model/index.js";
+import { ChainId } from "../../model/primitives.js";
+import "../../model/index.js";
 import { BaseError } from "viem";
-//#region src/rewards/errors.d.ts
+//#region src/sdk/rewards/errors.d.ts
 /**
  * Thrown when Merkl did not answer for a chain.
  *

package/dist/types/{rewards → sdk/rewards}/helpers.d.ts

@@ -1,8 +1,9 @@
-import { Token } from "../model/primitives.js";
-import "../model/index.js";
-import { MerklReward, RewardsSdk } from "./types.js";
+import { Token } from "../../model/primitives.js";
+import { MerklReward } from "../../model/rewards.js";
+import "../../model/index.js";
+import { RewardsSdk } from "./types.js";
 import { Address } from "viem";
-//#region src/rewards/helpers.d.ts
+//#region src/sdk/rewards/helpers.d.ts
 /** A claimable amount of one token in one pool, before it is merged. */
 interface RewardPart {
   pool: Address;

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

@@ -0,0 +1,6 @@
+import { IRewards, IRewardsByMode, RewardsKeys } from "./types.js";
+import { MerklRequestFailedError, TurtleRequestFailedError } from "./errors.js";
+import { MerkleXYZUserRewardsV4Response } from "./merkl-api.js";
+import { RewardsNamespace } from "./RewardsNamespace.js";
+import { TurtleWalletRewards } from "./turtle-api.js";
+export { type IRewards, type IRewardsByMode, MerklRequestFailedError, type MerkleXYZUserRewardsV4Response, type RewardsKeys, RewardsNamespace, TurtleRequestFailedError, type TurtleWalletRewards };

package/dist/types/{rewards → sdk/rewards}/merkl-api.d.ts

@@ -1,7 +1,7 @@
-import { ChainId } from "../model/primitives.js";
-import "../model/index.js";
+import { ChainId } from "../../model/primitives.js";
+import "../../model/index.js";
 import { Address } from "viem";
-//#region src/rewards/merkl-api.d.ts
+//#region src/sdk/rewards/merkl-api.d.ts
 interface MerkleXYZUserRewardsV4 {
   chain: MerkleXYZChain;
   rewards: Array<{

package/dist/types/{rewards → sdk/rewards}/toMerklRewards.d.ts

@@ -1,6 +1,8 @@
-import { MerklReward, RewardsSdk } from "./types.js";
+import { MerklReward } from "../../model/rewards.js";
+import "../../model/index.js";
+import { RewardsSdk } from "./types.js";
 import { MerkleXYZUserRewardsV4Response } from "./merkl-api.js";
-//#region src/rewards/toMerklRewards.d.ts
+//#region src/sdk/rewards/toMerklRewards.d.ts
 /**
  * Merkl's answer for one chain, one reward per pool and incentive token.
  * A breakdown Merkl cannot be read from is skipped rather than thrown on: it

package/dist/types/{rewards → sdk/rewards}/toTurtleRewards.d.ts

@@ -1,6 +1,8 @@
-import { Reward, RewardsSdk } from "./types.js";
+import { Reward } from "../../model/rewards.js";
+import "../../model/index.js";
+import { RewardsSdk } from "./types.js";
 import { TurtleWalletRewards } from "./turtle-api.js";
-//#region src/rewards/toTurtleRewards.d.ts
+//#region src/sdk/rewards/toTurtleRewards.d.ts
 /**
  * The streams targeting a pool on the SDK's chain, merged per pool and
  * incentive. A token reward is what is committed and not yet claimed.

package/dist/types/{rewards → sdk/rewards}/turtle-api.d.ts

@@ -1,7 +1,7 @@
-import { OnchainSDK } from "../onchain/OnchainSDK.js";
-import "../onchain/index.js";
+import { OnchainSDK } from "../../onchain/OnchainSDK.js";
+import "../../onchain/index.js";
 import { Address } from "viem";
-//#region src/rewards/turtle-api.d.ts
+//#region src/sdk/rewards/turtle-api.d.ts
 interface TurtleWalletStream {
   streamId: string;
   snapshots: Array<{

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

@@ -0,0 +1,35 @@
+import { ChainId } from "../../model/primitives.js";
+import { DataResponse } from "../../model/response.js";
+import { Reward } from "../../model/rewards.js";
+import "../../model/index.js";
+import { OnchainSDK } from "../../onchain/OnchainSDK.js";
+import "../../onchain/index.js";
+import { Address } from "viem";
+//#region src/sdk/rewards/types.d.ts
+/**
+ * Claimable Merkl and Turtle rewards.
+ **/
+interface IRewards {
+  /**
+   * Claimable rewards of `wallet`; a chain errors only when every source failed on it.
+   **/
+  list(wallet: Address, chainIds?: ChainId[]): Promise<DataResponse<Reward[]>>;
+}
+/**
+ * `sdk.rewards` per mode: absent when the SDK reads no chain.
+ **/
+interface IRewardsByMode {
+  onchain: IRewards;
+  offchain: undefined;
+  both: IRewards;
+}
+interface RewardsKeys {
+  /** Raises Merkl's rate limit; the keyless path answers too. */
+  merklApiKey?: string;
+  /** Turtle is skipped without one: its API answers no keyless request. */
+  turtleApiKey?: string;
+}
+/** What the mapping needs off a chain's SDK, and nothing asynchronous. */
+type RewardsSdk = Pick<OnchainSDK, "chainId" | "marketRegister" | "tokensMeta">;
+//#endregion
+export { IRewards, IRewardsByMode, RewardsKeys, RewardsSdk };

package/dist/types/sdk/types.d.ts

@@ -14,6 +14,7 @@ import { ILiquidationsByMode } from "./liquidations/types.js";
 import { IOpportunities } from "./opportunities/types.js";
 import { IPositions } from "./positions/types.js";
 import { IPreviewByMode } from "./preview/types.js";
+import { IRewardsByMode, RewardsKeys } from "./rewards/types.js";
 //#region src/sdk/types.d.ts
 /**
  * Which sources a {@link GearboxSDK} reads from, and therefore which of its
@@ -74,6 +75,10 @@ interface GearboxSDKOptions<M extends Mode = Mode> {
    * builds the on-chain source itself.
    **/
   attach?: MultichainAttachOptions;
+  /**
+   * API keys for {@link IGearboxSDK.rewards}.
+   **/
+  rewards?: RewardsKeys;
   logger?: ILogger;
 }
 /**
@@ -170,6 +175,10 @@ interface IGearboxSDK<M extends Mode = Mode> {
    * `offchain` mode.
    **/
   readonly preview: IPreviewByMode[M];
+  /**
+   * Namespace for claimable rewards. Absent in `offchain` mode.
+   **/
+  readonly rewards: IRewardsByMode[M];
   /**
    * The banners the backend attaches to a pool opportunity or a strategy
    * position, see {@link Notice}. Absent in `onchain` mode.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "17.8.0",
+  "version": "17.10.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {
@@ -58,11 +58,6 @@
       "types": "./dist/types/permissionless/index.d.ts",
       "import": "./dist/esm/permissionless/index.js",
       "default": "./dist/cjs/permissionless/index.js"
-    },
-    "./rewards": {
-      "types": "./dist/types/rewards/index.d.ts",
-      "import": "./dist/esm/rewards/index.js",
-      "default": "./dist/cjs/rewards/index.js"
     }
   },
   "files": [

package/dist/cjs/rewards/RewardsService.js

@@ -1,48 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_onchain_base_MultichainConstruct = require("../onchain/base/MultichainConstruct.js");
-require("../onchain/index.js");
-const require_rewards_merkl_api = require("./merkl-api.js");
-const require_rewards_toMerklRewards = require("./toMerklRewards.js");
-const require_rewards_toTurtleRewards = require("./toTurtleRewards.js");
-const require_rewards_turtle_api = require("./turtle-api.js");
-let viem = require("viem");
-//#region src/rewards/RewardsService.ts
-var RewardsService = class extends require_onchain_base_MultichainConstruct.MultichainConstruct {
-	#keys;
-	constructor(sdk, keys = {}) {
-		super(sdk);
-		this.#keys = keys;
-	}
-	/**
-	* Every claimable reward a wallet holds — Merkl campaigns and the Gearbox
-	* organisation's Turtle streams — across the chains the handle carries.
-	* A chain is `status: "error"` only when every source failed on it; a chain
-	* with nothing to claim is a `"success"` with no rewards.
-	**/
-	async list(wallet, chainIds) {
-		const { merklApiKey, turtleApiKey } = this.#keys;
-		const user = (0, viem.getAddress)(wallet);
-		const turtle = turtleApiKey ? require_rewards_turtle_api.fetchTurtleWalletRewards(user, turtleApiKey) : void 0;
-		turtle?.catch(() => {});
-		return this.queryChains({
-			chainIds,
-			label: "list rewards",
-			block: "state",
-			run: async (sdk) => {
-				const sources = [require_rewards_merkl_api.fetchMerklUserRewards({
-					chainId: sdk.chainId,
-					user,
-					apiKey: merklApiKey
-				}).then((response) => require_rewards_toMerklRewards.toMerklRewards(sdk, response))];
-				if (turtle) sources.push(turtle.then(async (rewards) => require_rewards_toTurtleRewards.toTurtleRewards(sdk, rewards, await require_rewards_turtle_api.readTurtleClaimed(sdk, user, rewards))));
-				const settled = await Promise.allSettled(sources);
-				const failed = settled.flatMap((r) => r.status === "rejected" ? [r.reason] : []);
-				if (failed.length === settled.length) throw failed.length === 1 ? failed[0] : new AggregateError(failed, "no rewards source answered");
-				for (const reason of failed) (sdk.logger ?? this.sdk.logger)?.warn(reason, `rewards source failed on chain ${sdk.chainId}`);
-				return settled.flatMap((r) => r.status === "fulfilled" ? r.value : []);
-			}
-		});
-	}
-};
-//#endregion
-exports.RewardsService = RewardsService;

package/dist/cjs/rewards/index.js

@@ -1,6 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_rewards_errors = require("./errors.js");
-const require_rewards_RewardsService = require("./RewardsService.js");
-exports.MerklRequestFailedError = require_rewards_errors.MerklRequestFailedError;
-exports.RewardsService = require_rewards_RewardsService.RewardsService;
-exports.TurtleRequestFailedError = require_rewards_errors.TurtleRequestFailedError;

package/dist/cjs/rewards/package.json

@@ -1 +0,0 @@
-{"type": "commonjs"}

package/dist/esm/rewards/index.js

@@ -1,3 +0,0 @@
-import { MerklRequestFailedError, TurtleRequestFailedError } from "./errors.js";
-import { RewardsService } from "./RewardsService.js";
-export { MerklRequestFailedError, RewardsService, TurtleRequestFailedError };

package/dist/esm/rewards/package.json

@@ -1 +0,0 @@
-{"type": "module","sideEffects":false}

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

@@ -1,29 +0,0 @@
-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 { MultichainConstruct } from "../onchain/base/MultichainConstruct.js";
-import "../onchain/index.js";
-import { Reward } from "./types.js";
-import { Address } from "viem";
-//#region src/rewards/RewardsService.d.ts
-interface RewardsServiceKeys {
-  /** Raises Merkl's rate limit; the keyless path answers too. */
-  merklApiKey?: string;
-  /** Turtle is skipped without one: its API answers no keyless request. */
-  turtleApiKey?: string;
-}
-declare class RewardsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
-  #private;
-  constructor(sdk: MultichainSDK<Plugins>, keys?: RewardsServiceKeys);
-  /**
-   * Every claimable reward a wallet holds — Merkl campaigns and the Gearbox
-   * organisation's Turtle streams — across the chains the handle carries.
-   * A chain is `status: "error"` only when every source failed on it; a chain
-   * with nothing to claim is a `"success"` with no rewards.
-   **/
-  list(wallet: Address, chainIds?: ChainId[]): Promise<DataResponse<Reward[]>>;
-}
-//#endregion
-export { RewardsService };

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

@@ -1,6 +0,0 @@
-import { MerklReward, PointsReward, Reward } from "./types.js";
-import { RewardsService } from "./RewardsService.js";
-import { MerklRequestFailedError, TurtleRequestFailedError } from "./errors.js";
-import { MerkleXYZUserRewardsV4Response } from "./merkl-api.js";
-import { TurtleWalletRewards } from "./turtle-api.js";
-export { MerklRequestFailedError, type MerklReward, type MerkleXYZUserRewardsV4Response, type PointsReward, type Reward, RewardsService, TurtleRequestFailedError, type TurtleWalletRewards };