@gearbox-protocol/sdk 17.2.0 → 17.2.1

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

@@ -0,0 +1,41 @@
+import { ChainId, Token, TokenAmount } from "../model/primitives.js";
+import { PointsProgramPnL } from "../model/positions.js";
+import "../model/index.js";
+import { OnchainSDK } from "../onchain/OnchainSDK.js";
+import "../onchain/index.js";
+import { Address } from "viem";
+//#region src/rewards/types.d.ts
+/**
+ * One claimable token reward, denominated and priced.
+ *
+ * Both tokens arrive resolved, so a consumer neither looks one up nor
+ * reassembles one out of the loose fields a source sends.
+ */
+interface MerklReward {
+  /** Where the reward is claimed. */
+  readonly source: "merkl" | "turtle";
+  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, how much of it is claimable
+   * (distributed minus already claimed, always > 0) and what that is worth.
+   *
+   * Priced by the source, not by the market oracles: a campaign's incentive
+   * token is rarely collateral in the pool it incentivises, so the oracles
+   * usually do not know it — GEAR, which most Gearbox campaigns pay in, among
+   * them. `valueUsd` is `null` for a token the source does not price either.
+   */
+  readonly amount: TokenAmount;
+}
+/** Points have no token and no price, and are not claimed. */
+interface PointsReward extends Omit<MerklReward, "amount"> {
+  readonly points: PointsProgramPnL;
+}
+type Reward = MerklReward | PointsReward;
+/** What the mapping needs off a chain's SDK, and nothing asynchronous. */
+type RewardsSdk = Pick<OnchainSDK, "chainId" | "marketRegister" | "tokensMeta">;
+//#endregion
+export { MerklReward, PointsReward, Reward, RewardsSdk };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "17.2.0",
+  "version": "17.2.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

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

@@ -1,28 +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 "../onchain/index.js";
-import { Reward } from "./toMerklRewards.js";
-import { Address } from "viem";
-//#region src/rewards/multichain.d.ts
-interface GetRewardsMultichainProps<Plugins extends PluginsMap = {}> {
-  sdk: MultichainSDK<Plugins>;
-  wallet: Address;
-  /** Defaults to every chain the handle carries. */
-  chainIds?: ChainId[];
-  /** 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;
-}
-/**
- * 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 rows.
- **/
-declare function getRewardsMultichain<const Plugins extends PluginsMap = {}>({ sdk, ...props }: GetRewardsMultichainProps<Plugins>): Promise<DataResponse<Reward[]>>;
-//#endregion
-export { GetRewardsMultichainProps, getRewardsMultichain };