@gearbox-protocol/ui-kit 4.7.0 → 4.8.0-next.1

package/dist/types/user-agreements/use-agreement.d.ts

@@ -0,0 +1,76 @@
+import { Address } from 'viem';
+import { AgreementRecord } from './agreement-cache';
+import { AgreementError } from './agreement-error';
+import { AgreementConfig, AgreementResult, AgreementStatus, CheckAgreementProps, SignAgreementProps } from './types';
+export interface CheckAgreementErrorEvent {
+    error: AgreementError;
+    account: Address;
+    chainId: number;
+}
+export interface SignAgreementEvent {
+    account: Address;
+    chainId: number;
+    legalMessageVersion: number;
+}
+export interface SignAgreementSuccessEvent {
+    account: Address;
+    result: AgreementResult;
+    chainId: number;
+    legalMessageVersion: number;
+}
+export interface SignAgreementErrorEvent {
+    error: AgreementError;
+    account: Address;
+    chainId: number;
+}
+export interface UseAgreementOptions {
+    /** Agreement service configuration */
+    config: AgreementConfig;
+    /** Account address (optional, falls back to wagmi's useAccount) */
+    account?: Address;
+    /** Current chain ID (optional, falls back to wagmi's useChainId) */
+    chainId?: number;
+    /** Auto-check agreement status on mount */
+    autoCheck?: boolean;
+    /**
+     * Constant reference with additional query key parts, used to namespace
+     * statuses, e.g. ["RWA"] or ["COMMON"] for the RWA or combined agreement
+     */
+    additionalQueryDep?: string[];
+    onCheckAgreement?: (props: CheckAgreementProps) => void;
+    onCheckAgreementError?: (event: CheckAgreementErrorEvent) => void;
+    onSignAgreement?: (event: SignAgreementEvent) => void;
+    onSignAgreementSuccess?: (event: SignAgreementSuccessEvent) => void;
+    onSignAgreementError?: (event: SignAgreementErrorEvent) => void;
+}
+export interface UseAgreementReturn {
+    /** Current agreement status */
+    status: AgreementStatus | undefined;
+    /** Whether check is in progress */
+    isLoading: boolean;
+    /** Whether signing is in progress */
+    isSigning: boolean;
+    /** Error if check/sign failed */
+    error: Error | null;
+    /** Check agreement status */
+    checkAgreement: () => Promise<AgreementResult | undefined>;
+    /** Sign the legal agreement */
+    signAgreement: (props: SignAgreementProps) => Promise<AgreementResult | undefined>;
+    /** Whether user has an older signature (needs re-sign) */
+    hasV2Signature: boolean;
+    /** Legal message text */
+    legalMessage: string;
+    /** Legal message version */
+    legalMessageVersion: number;
+    /** All agreement statuses (for multiple accounts) */
+    allStatuses: AgreementRecord;
+}
+/**
+ * Checks and signs the legal agreement, caching statuses in react-query.
+ *
+ * @example
+ * ```tsx
+ * const { status, signAgreement } = useAgreement({ config: {} });
+ * ```
+ */
+export declare function useAgreement(options: UseAgreementOptions): UseAgreementReturn;

package/dist/types/user-agreements/use-blocked-region.d.ts

@@ -0,0 +1,15 @@
+import { AgreementConfig } from './types';
+export interface UseBlockedRegionReturn {
+    isBlocked: boolean;
+    isLoading: boolean;
+    isError: boolean;
+}
+/**
+ * Checks whether the user's region is blocked via the access check endpoint.
+ *
+ * @example
+ * ```tsx
+ * const { isBlocked } = useBlockedRegion({});
+ * ```
+ */
+export declare function useBlockedRegion(config: AgreementConfig): UseBlockedRegionReturn;

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

@@ -12,5 +12,6 @@ export * from './ranges';
 export * from './shorten-string';
 export * from './sort';
 export * from './templates';
+export * from './wallet';
 export * from './window';
 export * from './z-index';

package/dist/types/utils/wallet.d.ts

@@ -0,0 +1,25 @@
+export type WalletType = "EOA" | "UNKNOWN_CONTRACT" | "UNKNOWN";
+/**
+ * Minimal connector shape, compatible with any wagmi version
+ */
+export interface ConnectorLike {
+    id: string;
+    name: string;
+    type?: string;
+}
+/**
+ * Parent domains that embed the app as a Safe app
+ */
+export declare const DEFAULT_SAFE_DOMAINS: RegExp[];
+export declare function isSafeAppsSDK(connector: ConnectorLike): boolean;
+export declare function isBinanceSDK(connector: ConnectorLike): boolean;
+/**
+ * Whether the app runs in an iframe embedded by one of the given domains.
+ * Always false outside the browser.
+ *
+ * @example
+ * ```ts
+ * isSafeDomain([...DEFAULT_SAFE_DOMAINS, /my-safe\.example\.com$/]);
+ * ```
+ */
+export declare function isSafeDomain(domains?: RegExp[]): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/ui-kit",
-  "version": "4.7.0",
+  "version": "4.8.0-next.1",
   "description": "Internal UI components",
   "repository": {
     "type": "git",
@@ -29,6 +29,11 @@
       "import": "./dist/esm/configs/tailwind-preset.js",
       "default": "./dist/cjs/configs/tailwind-preset.cjs"
     },
+    "./user-agreements": {
+      "types": "./dist/types/user-agreements/index.d.ts",
+      "import": "./dist/esm/user-agreements/index.js",
+      "default": "./dist/cjs/user-agreements/index.cjs"
+    },
     "./globals.css": "./dist/globals.css",
     "./grid-safelist.css": "./dist/grid-safelist.css",
     "./theme.css": "./src/styles/theme.css",
@@ -76,24 +81,29 @@
     "@radix-ui/react-tooltip": "^1.1.6",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
-    "react-markdown": "^10.1.0",
-    "remark-gfm": "^4.0.1",
     "lightweight-charts": "^5.2.1",
     "luxon": "^3.5.0",
+    "react-markdown": "^10.1.0",
+    "remark-gfm": "^4.0.1",
     "tailwind-merge": "^3.4.0",
     "tailwindcss-animate": "^1.0.7"
   },
   "peerDependencies": {
     "@gearbox-protocol/sdk": "*",
+    "@tanstack/react-query": "^5.0.0",
     "@types/react": "^18 || ^19",
     "react": "^18 || ^19",
     "react-intl": "^6.0.0 || ^7.0.0 || ^10.0.0",
     "react-router-dom": "^6.0.0 || ^7.0.0",
     "sonner": "^2.0.0",
     "tailwindcss": "^4.0.0",
-    "viem": "^2.0.0"
+    "viem": "^2.0.0",
+    "wagmi": "^2.0.0 || ^3.0.0"
   },
   "peerDependenciesMeta": {
+    "@tanstack/react-query": {
+      "optional": true
+    },
     "react-intl": {
       "optional": true
     },
@@ -102,6 +112,9 @@
     },
     "tailwindcss": {
       "optional": true
+    },
+    "wagmi": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -119,6 +132,7 @@
     "@storybook/addon-vitest": "^10.0.8",
     "@storybook/react-vite": "^10.0.8",
     "@tailwindcss/postcss": "^4.3.3",
+    "@tanstack/react-query": "^5.104.1",
     "@types/cross-spawn": "^6.0.6",
     "@types/luxon": "^3.7.5",
     "@types/react": "^19.2.18",
@@ -151,7 +165,8 @@
     "vite": "^6.3.5",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^4.0.14"
+    "vitest": "^4.0.14",
+    "wagmi": "^3.7.7"
   },
   "commitlint": {
     "extends": [