@fereai/sdk 0.3.1 → 0.4.0-dev.29

package/dist/client.d.ts

@@ -13,7 +13,7 @@
  * });
  * ```
  */
-import type { ChatEvent, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, UserResponse } from "./types.js";
+import type { ChatEvent, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, SecurityCheckResponse, TokenToCheck, UserResponse } from "./types.js";
 export declare class FereClient {
     private readonly api;
     private constructor();
@@ -33,6 +33,12 @@ export declare class FereClient {
     swap(request: SwapRequest, timeout?: number): Promise<Record<string, unknown>>;
     limitOrder(request: LimitOrderRequest, timeout?: number): Promise<Record<string, unknown>>;
     setHooks(request: HooksRequest): Promise<unknown>;
+    /**
+     * Pre-check tokens for honeypot / scam / rug-pull flags. If a
+     * token is flagged and the user still wants to proceed, call
+     * `swap({ ..., bypass_security_check: true })`.
+     */
+    checkTokenSecurity(tokens: TokenToCheck[]): Promise<SecurityCheckResponse>;
     deposit(request: DepositRequest, timeout?: number): Promise<Record<string, unknown>>;
     withdraw(request: WithdrawRequest, timeout?: number): Promise<Record<string, unknown>>;
     getWallets: () => Promise<unknown>;

package/dist/client.js

@@ -78,6 +78,14 @@ class FereClient {
     async setHooks(request) {
         return this.api.setHooks(request);
     }
+    /**
+     * Pre-check tokens for honeypot / scam / rug-pull flags. If a
+     * token is flagged and the user still wants to proceed, call
+     * `swap({ ..., bypass_security_check: true })`.
+     */
+    async checkTokenSecurity(tokens) {
+        return this.api.checkTokenSecurity(tokens);
+    }
     // ----------------------------------------------------------
     // Earn (blocks until complete)
     // ----------------------------------------------------------

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FereAPI } from "./low-level.js";
 export { FereClient } from "./client.js";
 export { AuthManager } from "./auth.js";
-export type { ChatEvent, TaskResponse, TaskStatusResponse, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, CreditsInfo, WalletInfo, UserResponse, } from "./types.js";
+export type { ChatEvent, TaskResponse, TaskStatusResponse, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, CreditsInfo, WalletInfo, UserResponse, TokenToCheck, SecurityCheckRequest, TokenSecurityResult, SecurityCheckSummary, SecurityCheckResponse, } from "./types.js";
 export { TaskTimeoutError } from "./types.js";

package/dist/low-level.d.ts

@@ -1,7 +1,7 @@
 /**
  * Low-level SDK — 1:1 typed wrappers around every gateway endpoint.
  */
-import type { ChatEvent, CreditsInfo, DepositRequest, HooksRequest, LimitOrderRequest, SwapRequest, TaskResponse, TaskStatusResponse, UserResponse, WithdrawRequest } from "./types.js";
+import type { ChatEvent, CreditsInfo, DepositRequest, HooksRequest, LimitOrderRequest, SecurityCheckResponse, SwapRequest, TaskResponse, TaskStatusResponse, TokenToCheck, UserResponse, WithdrawRequest } from "./types.js";
 export declare class FereAPI {
     private readonly baseUrl;
     private readonly auth;
@@ -33,6 +33,13 @@ export declare class FereAPI {
     getLimitOrder(orderId: string): Promise<unknown>;
     cancelLimitOrder(orderId: string): Promise<unknown>;
     setHooks(request: HooksRequest): Promise<unknown>;
+    /**
+     * Pre-check whether output tokens have been flagged by Honeypot.is
+     * (EVM) or RugCheck.xyz (Solana) before submitting a swap. If a
+     * token is flagged and the user still wants to proceed, set
+     * `bypass_security_check: true` on the swap request.
+     */
+    checkTokenSecurity(tokens: TokenToCheck[]): Promise<SecurityCheckResponse>;
     getWallets(): Promise<unknown>;
     getHoldings(): Promise<unknown>;
     getEarnInfo(): Promise<unknown>;

package/dist/low-level.js

@@ -175,6 +175,20 @@ class FereAPI {
         return this.authedPost("/v1/hooks", request);
     }
     // ----------------------------------------------------------
+    // Security
+    // ----------------------------------------------------------
+    /**
+     * Pre-check whether output tokens have been flagged by Honeypot.is
+     * (EVM) or RugCheck.xyz (Solana) before submitting a swap. If a
+     * token is flagged and the user still wants to proceed, set
+     * `bypass_security_check: true` on the swap request.
+     */
+    async checkTokenSecurity(tokens) {
+        return this.authedPost("/v1/security/check", {
+            tokens,
+        });
+    }
+    // ----------------------------------------------------------
     // Wallets
     // ----------------------------------------------------------
     async getWallets() {

package/dist/types.d.ts

@@ -55,6 +55,44 @@ export interface SwapRequest {
         sell_percentage: number;
     };
     cancel_conditional_orders?: boolean;
+    /**
+     * Skip the in-task rug-check entirely. Set true only after
+     * pre-checking the output token via checkTokenSecurity and
+     * surfacing the verdict to your end user. Has no effect on
+     * scheduled trades.
+     */
+    bypass_security_check?: boolean;
+}
+export interface TokenToCheck {
+    token_address: string;
+    chain_id: number | string;
+}
+export interface SecurityCheckRequest {
+    tokens: TokenToCheck[];
+}
+export interface TokenSecurityResult {
+    token_address: string;
+    chain_id: number;
+    allowed: boolean;
+    /** passed | failed | warning | api_unavailable | unsupported_chain | skipped */
+    status: string;
+    reason?: string | null;
+    /** "rugcheck" | "honeypot_is" | "unknown" */
+    provider: string;
+    risk_details?: Record<string, unknown> | null;
+}
+export interface SecurityCheckSummary {
+    total: number;
+    passed: number;
+    failed: number;
+    warning: number;
+    api_unavailable: number;
+    unsupported_chain?: number;
+    skipped?: number;
+}
+export interface SecurityCheckResponse {
+    results: TokenSecurityResult[];
+    summary: SecurityCheckSummary;
 }
 export interface LimitOrderRequest {
     chain_id_in: number;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@fereai/sdk",
-  "version": "0.3.1",
+  "version": "0.4.0-dev.29",
   "description": "TypeScript SDK for the FereAI Gateway API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "tsc"