feat: migrate to yield api balances

.changeset/lemon-drinks-prove.md

@@ -0,0 +1,5 @@
+---
+"@stakekit/widget": patch
+---
+
+feat: migrate to yield api balances

AGENTS.md

@@ -0,0 +1,46 @@
+# StakeKit Widget — Agent Guide
+
+## Project Overview
+- Monorepo managed with `pnpm` workspaces + Turborepo.
+- Main package is `@stakekit/widget` in `packages/widget` (React + TypeScript + Vite).
+- Widget supports two entry modes:
+  - React component export (`src/index.package.ts`)
+  - Fully bundled renderer (`src/index.bundle.ts`)
+- Runtime branches between classic widget and dashboard variant in `src/App.tsx`.
+
+## Repo Layout (important paths)
+- `packages/widget/src/App.tsx` — root app, router setup, bundle renderer.
+- `packages/widget/src/Widget.tsx` — non-dashboard route flow (earn/review/steps/details).
+- `packages/widget/src/Dashboard.tsx` + `pages-dashboard/*` — dashboard variant UI.
+- `packages/widget/src/providers/*` — global provider composition (API, query, wallet, tracking, theme, stores).
+- `packages/widget/src/hooks/*` — feature and API hooks.
+- `packages/widget/src/domain/*` — shared domain types/helpers.
+- `packages/widget/src/translation/*` — i18n resources (`English`, `French`).
+- `packages/widget/tests/*` — Vitest browser tests (MSW-backed).
+- `packages/examples/*` — integration examples (`with-vite`, `with-vite-bundled`, `with-nextjs`, `with-cdn-script`).
+
+## Commands Agents Should Use
+
+### From repo root (all workspaces via Turbo)
+- `pnpm build` — build all packages.
+- `pnpm lint` — lint/type-check all packages.
+- `pnpm test` — run all workspace tests.
+- `pnpm format` — run formatting checks/tasks.
+
+### Focused widget commands (recommended for most tasks)
+- `pnpm --filter @stakekit/widget {command}`
+
+## Agent Working Guidelines (short)
+- Keep public API compatibility in `src/index.package.ts` and `src/index.bundle.ts`.
+- When changing user-facing copy, update both:
+  - `packages/widget/src/translation/English/translations.json`
+  - `packages/widget/src/translation/French/translations.json`
+- After changes, confirm nothing is broken with lint command which checks lint/type errors
+
+## Useful Context for Debugging
+- API client is configured in `packages/widget/src/providers/api/api-client-provider.tsx`.
+- React Query defaults are in `packages/widget/src/providers/query-client/index.tsx`.
+- App-level config/env mapping is in `packages/widget/src/config/index.ts`.
+- Test bootstrapping + MSW worker setup:
+  - `packages/widget/tests/utils/setup.ts`
+  - `packages/widget/tests/mocks/worker.ts`

mise.toml

@@ -1,3 +1,3 @@
 [tools]
-node = "22"
-pnpm = "10"
+node = "24"
+pnpm = "10"

packages/widget/package.json

@@ -55,7 +55,8 @@
     "clean": "rm -rf dist",
     "preview": "vite -c vite/vite.config.dev.ts preview --outDir dist/website",
     "check-unused": "npx knip",
-    "check-circular-deps": "skott ./src/index.package.ts -m 'raw' && pnpm lint"
+    "check-circular-deps": "skott ./src/index.package.ts -m 'raw' && pnpm lint",
+    "gen:yield-api": "openapi-typescript https://docs.yield.xyz/openapi/appsyield-apiswagger-docsopenapi.yaml -o src/types/yield-api-schema.d.ts"
   },
   "peerDependencies": {
     "react": ">=18",
@@ -130,6 +131,9 @@
     "mixpanel-browser": "^2.72.0",
     "motion": "12.23.26",
     "msw": "^2.12.4",
+    "openapi-fetch": "^0.17.0",
+    "openapi-react-query": "^0.5.4",
+    "openapi-typescript": "^7.13.0",
     "playwright": "^1.57.0",
     "postcss": "^8.5.6",
     "purify-ts": "2.1.0",

packages/widget/src/common/private-api.ts

@@ -3,8 +3,6 @@ import {
   type TokenBalanceScanDto,
   type TokenBalanceScanResponseDto,
   type ValidatorSearchResultDto,
-  type YieldBalanceScanRequestDto,
-  type YieldBalancesWithIntegrationIdDto,
   type YieldDto,
 } from "@stakekit/api-hooks";
 
@@ -25,23 +23,6 @@ export const tokenTokenBalancesScan = (
   });
 };
 
-/**
- * Scans for yield balances among enabled yields.
- * @summary Scan for yield balances
- */
-export const yieldYieldBalancesScan = (
-  yieldBalanceScanRequestDto: YieldBalanceScanRequestDto,
-  signal?: AbortSignal
-) => {
-  return customFetch<YieldBalancesWithIntegrationIdDto[]>({
-    url: "/v1/yields/balances/scan",
-    method: "POST",
-    headers: { "Content-Type": "application/json" },
-    data: yieldBalanceScanRequestDto,
-    signal,
-  });
-};
-
 /**
  * Returns a yield that is associated with given integration ID
  * @summary Get a yield given an integration ID

packages/widget/src/components/atoms/token-icon/index.tsx

@@ -1,5 +1,6 @@
 import type { TokenDto, YieldMetadataDto } from "@stakekit/api-hooks";
 import { useSettings } from "../../../providers/settings";
+import type { YieldTokenDto } from "../../../providers/yield-api-client-provider/types";
 import type { Atoms } from "../../../styles/theme/atoms.css";
 import { NetworkLogoImage } from "./network-icon-image";
 import { TokenIconContainer } from "./token-icon-container";
@@ -12,7 +13,7 @@ export const TokenIcon = ({
   tokenNetworkLogoHw,
   hideNetwork,
 }: {
-  token: TokenDto;
+  token: TokenDto | YieldTokenDto;
   metadata?: YieldMetadataDto;
   tokenLogoHw?: Atoms["hw"];
   tokenNetworkLogoHw?: Atoms["hw"];

packages/widget/src/components/atoms/token-icon/token-icon-container/hooks/use-variant-token-urls.ts

@@ -3,9 +3,10 @@ import { Maybe } from "purify-ts";
 import { useMemo } from "react";
 import { config } from "../../../../../config";
 import { useSettings } from "../../../../../providers/settings";
+import type { YieldTokenDto } from "../../../../../providers/yield-api-client-provider/types";
 
 export const useVariantTokenUrls = (
-  token: TokenDto,
+  token: TokenDto | YieldTokenDto,
   metadata?: YieldMetadataDto
 ): {
   mainUrl: string | undefined;
@@ -35,7 +36,7 @@ export const useVariantTokenUrls = (
     const tokenMappingResult = Maybe.fromNullable(tokenIconMapping)
       .chainNullable((mapping) => {
         if (typeof mapping === "function") {
-          return mapping(token);
+          return mapping(token as TokenDto);
         }
 
         return mapping[token.symbol];

packages/widget/src/components/atoms/token-icon/token-icon-container/index.tsx

@@ -1,12 +1,13 @@
 import type { TokenDto, YieldMetadataDto } from "@stakekit/api-hooks";
 import type { Networks } from "@stakekit/common";
 import type { ReactElement } from "react";
+import type { YieldTokenDto } from "../../../../providers/yield-api-client-provider/types";
 import { Box } from "../../box";
 import { useVariantNetworkUrls } from "./hooks/use-variant-network-urls";
 import { useVariantTokenUrls } from "./hooks/use-variant-token-urls";
 
 type TokenIconContainerProps = {
-  token: TokenDto;
+  token: TokenDto | YieldTokenDto;
   metadata?: YieldMetadataDto;
   hideNetwork?: boolean;
   children: (props: TokenIconContainerReturnType) => ReactElement;

packages/widget/src/config/index.ts

@@ -15,6 +15,8 @@ export const config = {
   appPrefix: "sk-widget",
   env: {
     apiUrl: import.meta.env.VITE_API_URL ?? "https://api.stakek.it/",
+    yieldsApiUrl:
+      import.meta.env.VITE_YIELDS_API_URL ?? "https://api.yield.xyz",
     isTestMode: import.meta.env.MODE === "test",
     isDevMode: import.meta.env.MODE === "development",
     forceAddress: import.meta.env.VITE_FORCE_ADDRESS,

packages/widget/src/domain/index.ts

@@ -1,6 +1,5 @@
 import type {
   ActionDto,
-  PendingActionDto,
   TokenDto,
   TransactionDto,
   TransactionStatus,
@@ -9,15 +8,25 @@ import type {
 import BigNumber from "bignumber.js";
 import { Left, type Maybe, Right } from "purify-ts";
 import type { Override } from "../types/utils";
+import type { AnyPendingActionDto } from "./types/pending-action";
+import {
+  isPendingActionValidatorAddressesRequired,
+  isPendingActionValidatorAddressRequired,
+} from "./types/pending-action";
 import type { TokenString } from "./types/tokens";
 
 export { getTokenPriceInUSD } from "./types/price";
 
-export const tokenString = (token: TokenDto): TokenString => {
-  return `${token.network}-${token.address?.toLowerCase()}`;
+type TokenLike = Pick<TokenDto, "symbol"> & {
+  network: string;
+  address?: string;
 };
 
-export const equalTokens = (a: TokenDto, b: TokenDto) =>
+export const tokenString = (token: TokenLike): TokenString => {
+  return `${token.network}-${token.address?.toLowerCase() ?? ""}` as TokenString;
+};
+
+export const equalTokens = (a: TokenLike, b: TokenLike) =>
   tokenString(a) === tokenString(b) && a.symbol === b.symbol;
 
 export const stakeTokenSameAsGasToken = ({
@@ -81,11 +90,11 @@ export const getValidStakeSessionTx = (stakeDto: ActionDto) => {
 export const isTxError = (txStatus: TransactionStatus) =>
   txStatus === "FAILED" || txStatus === "BLOCKED";
 
-export const PAMultiValidatorsRequired = (pa: PendingActionDto) =>
-  !!pa.args?.args?.validatorAddresses?.required;
+export const PAMultiValidatorsRequired = (pa: AnyPendingActionDto) =>
+  isPendingActionValidatorAddressesRequired(pa);
 
-export const PASingleValidatorRequired = (pa: PendingActionDto) =>
-  !!pa.args?.args?.validatorAddress?.required;
+export const PASingleValidatorRequired = (pa: AnyPendingActionDto) =>
+  isPendingActionValidatorAddressRequired(pa);
 
 export const skNormalizeChainId = (chainId: string) => {
   const cId = Number(chainId);

packages/widget/src/domain/types/pending-action.ts

@@ -0,0 +1,104 @@
+import type { PendingActionDto as LegacyPendingActionDto } from "@stakekit/api-hooks";
+import type { YieldPendingActionDto } from "../../providers/yield-api-client-provider/types";
+
+type PendingActionArgName =
+  | "amount"
+  | "validatorAddress"
+  | "validatorAddresses";
+
+export type AnyPendingActionDto =
+  | LegacyPendingActionDto
+  | YieldPendingActionDto;
+
+export type PendingActionAmountConfig = {
+  required: boolean;
+  minimum: number | null;
+  maximum: number | null;
+  forceMax: boolean;
+};
+
+export const isPendingActionAmountRequired = (
+  pendingAction: AnyPendingActionDto
+) => !!getPendingActionAmountConfig(pendingAction)?.required;
+
+export const isPendingActionValidatorAddressRequired = (
+  pendingAction: AnyPendingActionDto
+) => !!getPendingActionArgument(pendingAction, "validatorAddress")?.required;
+
+export const isPendingActionValidatorAddressesRequired = (
+  pendingAction: AnyPendingActionDto
+) => !!getPendingActionArgument(pendingAction, "validatorAddresses")?.required;
+
+export const getPendingActionAmountConfig = (
+  pendingAction: AnyPendingActionDto
+): PendingActionAmountConfig | null => {
+  const amountArg = getPendingActionArgument(pendingAction, "amount");
+
+  if (!amountArg) {
+    return null;
+  }
+
+  const minimum = toNumberOrNull(amountArg.minimum);
+  const maximum = toNumberOrNull(amountArg.maximum);
+
+  return {
+    required: !!amountArg.required,
+    minimum,
+    maximum,
+    forceMax: minimum === -1 && maximum === -1,
+  };
+};
+
+const getPendingActionArgument = (
+  pendingAction: AnyPendingActionDto,
+  name: PendingActionArgName
+) => {
+  const v2Field = (
+    pendingAction as YieldPendingActionDto
+  ).arguments?.fields?.find(
+    (
+      field: NonNullable<YieldPendingActionDto["arguments"]>["fields"][number]
+    ) => field.name === name
+  );
+
+  if (v2Field) {
+    return {
+      required: !!v2Field.required,
+      minimum: v2Field.minimum ?? null,
+      maximum: v2Field.maximum ?? null,
+    };
+  }
+
+  const legacyField = (pendingAction as LegacyPendingActionDto).args?.args?.[
+    name
+  ] as
+    | {
+        required?: boolean;
+        minimum?: number | string | null;
+        maximum?: number | string | null;
+      }
+    | undefined;
+
+  if (!legacyField) {
+    return null;
+  }
+
+  return {
+    required: !!legacyField.required,
+    minimum: legacyField.minimum ?? null,
+    maximum: legacyField.maximum ?? null,
+  };
+};
+
+const toNumberOrNull = (value: number | string | null | undefined) => {
+  if (value === null || value === undefined) {
+    return null;
+  }
+
+  if (typeof value === "number") {
+    return Number.isFinite(value) ? value : null;
+  }
+
+  const parsed = Number(value);
+  return Number.isFinite(parsed) ? parsed : null;
+};