@fereai/sdk 0.4.0 → 0.5.0-dev.47

package/README.md

@@ -1,19 +1,19 @@
-# @fere/sdk
+# @fereai/sdk
 
 TypeScript SDK for the FereAI Gateway API.
 
 ## Install
 
 ```bash
-npm install @fere/sdk
+npm install @fereai/sdk
 ```
 
 ## Usage
 
 ```typescript
-import { FereClient } from "@fere/sdk";
+import { FereClient } from "@fereai/sdk";
 
-const client = new FereClient({ apiKey: "your-api-key", baseUrl: "https://api.fere.ai" });
+const client = new FereClient({ apiKey: "your-api-key", baseUrl: "https://api.fereai.xyz" });
 ```
 
-See the [FereAI docs](https://api.fere.ai) for full API reference.
+See the [FereAI docs](https://api.fereai.xyz) for full API reference.

package/dist/client.d.ts

@@ -13,7 +13,7 @@
  * });
  * ```
  */
-import type { ChatEvent, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, SecurityCheckResponse, TokenToCheck, UserResponse } from "./types.js";
+import type { ChatEvent, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, PerpOpenRequest, PerpCloseRequest, PerpCancelRequest, PerpFundRequest, PerpWithdrawRequest, SecurityCheckResponse, TokenToCheck, UserResponse } from "./types.js";
 export declare class FereClient {
     private readonly api;
     private constructor();
@@ -30,17 +30,28 @@ export declare class FereClient {
         threadId?: string;
         agent?: string;
     }): AsyncGenerator<ChatEvent>;
+    /**
+     * Execute a swap and wait for completion.
+     *
+     * Fully gasless for the user (no native gas token needed on any
+     * chain). One call handles same-chain, cross-chain, and EVM↔Solana
+     * bridge swaps, with bridging built in.
+     */
     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 })`.
+     * Pre-check tokens for honeypot / scam / rug-pull flags.
      */
     checkTokenSecurity(tokens: TokenToCheck[]): Promise<SecurityCheckResponse>;
     deposit(request: DepositRequest, timeout?: number): Promise<Record<string, unknown>>;
     withdraw(request: WithdrawRequest, timeout?: number): Promise<Record<string, unknown>>;
+    perpOpen(request: PerpOpenRequest, timeout?: number): Promise<Record<string, unknown>>;
+    perpClose(request: PerpCloseRequest, timeout?: number): Promise<Record<string, unknown>>;
+    perpCancelOrder(request: PerpCancelRequest, timeout?: number): Promise<Record<string, unknown>>;
+    perpSetup(forceRerun?: boolean, timeout?: number): Promise<Record<string, unknown>>;
+    perpFund(request: PerpFundRequest, timeout?: number): Promise<Record<string, unknown>>;
+    perpWithdraw(request: PerpWithdrawRequest, timeout?: number): Promise<Record<string, unknown>>;
     getWallets: () => Promise<unknown>;
     getHoldings: () => Promise<unknown>;
     getCredits: () => Promise<import("./types.js").CreditsInfo>;
@@ -48,6 +59,9 @@ export declare class FereClient {
     getChains: () => Promise<unknown>;
     getEarnInfo: () => Promise<unknown>;
     getPositions: () => Promise<unknown>;
+    getPerpMarkets: (searchText?: string) => Promise<unknown>;
+    getPerpSetupStatus: () => Promise<unknown>;
+    getPerpOrders: () => Promise<unknown>;
     getThreads: (skip?: number, limit?: number) => Promise<unknown[]>;
     getLimitOrders: (status?: string) => Promise<unknown[]>;
     getNotifications: (opts?: {

package/dist/client.js

@@ -17,7 +17,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FereClient = void 0;
 const low_level_js_1 = require("./low-level.js");
-const DEFAULT_TIMEOUT = 120;
+/** Must stay <= gateway wait=true max (90) or the API 422s. */
+const DEFAULT_TIMEOUT = 90;
 class FereClient {
     api;
     constructor(api) {
@@ -63,6 +64,13 @@ class FereClient {
     // ----------------------------------------------------------
     // Trading (blocks until complete)
     // ----------------------------------------------------------
+    /**
+     * Execute a swap and wait for completion.
+     *
+     * Fully gasless for the user (no native gas token needed on any
+     * chain). One call handles same-chain, cross-chain, and EVM↔Solana
+     * bridge swaps, with bridging built in.
+     */
     async swap(request, timeout = DEFAULT_TIMEOUT) {
         return this.api.createSwap(request, {
             wait: true,
@@ -79,9 +87,7 @@ class FereClient {
         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 })`.
+     * Pre-check tokens for honeypot / scam / rug-pull flags.
      */
     async checkTokenSecurity(tokens) {
         return this.api.checkTokenSecurity(tokens);
@@ -102,6 +108,45 @@ class FereClient {
         });
     }
     // ----------------------------------------------------------
+    // Perp — venue-neutral perpetual futures (blocks until complete)
+    // ----------------------------------------------------------
+    async perpOpen(request, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpOpen(request, {
+            wait: true,
+            timeout,
+        });
+    }
+    async perpClose(request, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpClose(request, {
+            wait: true,
+            timeout,
+        });
+    }
+    async perpCancelOrder(request, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpCancelOrder(request, {
+            wait: true,
+            timeout,
+        });
+    }
+    async perpSetup(forceRerun = false, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpSetup(forceRerun, {
+            wait: true,
+            timeout,
+        });
+    }
+    async perpFund(request, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpFund(request, {
+            wait: true,
+            timeout,
+        });
+    }
+    async perpWithdraw(request, timeout = DEFAULT_TIMEOUT) {
+        return this.api.perpWithdraw(request, {
+            wait: true,
+            timeout,
+        });
+    }
+    // ----------------------------------------------------------
     // Read-only (pass-through)
     // ----------------------------------------------------------
     getWallets = () => this.api.getWallets();
@@ -111,6 +156,9 @@ class FereClient {
     getChains = () => this.api.getChains();
     getEarnInfo = () => this.api.getEarnInfo();
     getPositions = () => this.api.getPositions();
+    getPerpMarkets = (searchText) => this.api.getPerpMarkets(searchText);
+    getPerpSetupStatus = () => this.api.getPerpSetupStatus();
+    getPerpOrders = () => this.api.getPerpOrders();
     getThreads = (skip, limit) => this.api.getThreads(skip, limit);
     getLimitOrders = (status) => this.api.getLimitOrders(status);
     getNotifications = (opts) => this.api.getNotifications(opts);

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, TokenToCheck, SecurityCheckRequest, TokenSecurityResult, SecurityCheckSummary, SecurityCheckResponse, } from "./types.js";
+export type { ChatEvent, TaskResponse, TaskStatusResponse, SwapRequest, LimitOrderRequest, HooksRequest, DepositRequest, WithdrawRequest, PerpOpenRequest, PerpCloseRequest, PerpCancelRequest, PerpFundRequest, PerpWithdrawRequest, 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, SecurityCheckResponse, SwapRequest, TaskResponse, TaskStatusResponse, TokenToCheck, UserResponse, WithdrawRequest } from "./types.js";
+import type { ChatEvent, CreditsInfo, DepositRequest, HooksRequest, LimitOrderRequest, PerpCancelRequest, PerpCloseRequest, PerpFundRequest, PerpOpenRequest, PerpWithdrawRequest, SecurityCheckResponse, SwapRequest, TaskResponse, TaskStatusResponse, TokenToCheck, UserResponse, WithdrawRequest } from "./types.js";
 export declare class FereAPI {
     private readonly baseUrl;
     private readonly auth;
@@ -35,9 +35,7 @@ export declare class FereAPI {
     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.
+     * (EVM) or RugCheck.xyz (Solana) before submitting a swap.
      */
     checkTokenSecurity(tokens: TokenToCheck[]): Promise<SecurityCheckResponse>;
     getWallets(): Promise<unknown>;
@@ -52,6 +50,34 @@ export declare class FereAPI {
         timeout?: number;
     }): Promise<TaskResponse | Record<string, unknown>>;
     getPositions(): Promise<unknown>;
+    getPerpMarkets(searchText?: string): Promise<unknown>;
+    getPerpSetupStatus(): Promise<unknown>;
+    getPerpOrders(): Promise<unknown>;
+    perpSetup(forceRerun?: boolean, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    perpOpen(request: PerpOpenRequest, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    perpClose(request: PerpCloseRequest, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    perpCancelOrder(request: PerpCancelRequest, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    perpFund(request: PerpFundRequest, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    perpWithdraw(request: PerpWithdrawRequest, opts?: {
+        wait?: boolean;
+        timeout?: number;
+    }): Promise<TaskResponse | Record<string, unknown>>;
+    private perpTask;
     getTask(taskId: string): Promise<TaskStatusResponse>;
     getNotifications(opts?: {
         limit?: number;

package/dist/low-level.js

@@ -179,9 +179,7 @@ class FereAPI {
     // ----------------------------------------------------------
     /**
      * 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.
+     * (EVM) or RugCheck.xyz (Solana) before submitting a swap.
      */
     async checkTokenSecurity(tokens) {
         return this.authedPost("/v1/security/check", {
@@ -226,6 +224,47 @@ class FereAPI {
         return this.authedGet("/v1/earn/positions");
     }
     // ----------------------------------------------------------
+    // Perp (venue-neutral perpetual futures)
+    // ----------------------------------------------------------
+    async getPerpMarkets(searchText) {
+        const params = {};
+        if (searchText)
+            params.search_text = searchText;
+        return this.authedGet("/v1/perp/markets", params);
+    }
+    async getPerpSetupStatus() {
+        return this.authedGet("/v1/perp/setup");
+    }
+    async getPerpOrders() {
+        return this.authedGet("/v1/perp/orders");
+    }
+    async perpSetup(forceRerun = false, opts) {
+        return this.perpTask("/v1/perp/setup", { force_rerun: forceRerun }, opts);
+    }
+    async perpOpen(request, opts) {
+        return this.perpTask("/v1/perp/open", request, opts);
+    }
+    async perpClose(request, opts) {
+        return this.perpTask("/v1/perp/close", request, opts);
+    }
+    async perpCancelOrder(request, opts) {
+        return this.perpTask("/v1/perp/orders/cancel", request, opts);
+    }
+    async perpFund(request, opts) {
+        return this.perpTask("/v1/perp/fund", request, opts);
+    }
+    async perpWithdraw(request, opts) {
+        return this.perpTask("/v1/perp/withdraw", request, opts);
+    }
+    async perpTask(path, body, opts) {
+        const params = {};
+        if (opts?.wait) {
+            params.wait = "true";
+            params.timeout = String(opts.timeout ?? 120);
+        }
+        return this.authedPost(path, body, params);
+    }
+    // ----------------------------------------------------------
     // Tasks
     // ----------------------------------------------------------
     async getTask(taskId) {

package/dist/types.d.ts

@@ -55,13 +55,6 @@ 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;
@@ -127,6 +120,41 @@ export interface WithdrawRequest {
     position_id: string;
     amount_usdc: number;
 }
+export interface PerpOpenRequest {
+    asset: string;
+    is_buy: boolean;
+    size: number;
+    leverage?: number;
+    is_cross?: boolean;
+    order_type?: "market" | "limit";
+    limit_price?: number;
+    slippage_pct?: number;
+    reduce_only?: boolean;
+    tp_price?: number;
+    sl_price?: number;
+    tp_is_market?: boolean;
+    sl_is_market?: boolean;
+}
+export interface PerpCloseRequest {
+    asset: string;
+    size?: number;
+    slippage_pct?: number;
+}
+export interface PerpCancelRequest {
+    asset: string;
+    order_id: number;
+}
+export interface PerpFundRequest {
+    amount: string;
+    source_chain_id: number;
+    source_token?: string;
+    display_amount_usd?: number;
+}
+export interface PerpWithdrawRequest {
+    amount_usd: number;
+    destination_chain_id: number;
+    destination_token?: string;
+}
 export declare class TaskTimeoutError extends Error {
     readonly taskId: string;
     readonly timeout: number;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@fereai/sdk",
-  "version": "0.4.0",
+  "version": "0.5.0-dev.47",
   "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"
@@ -16,6 +18,18 @@
     "@types/node": "^22.0",
     "typescript": "^5.5"
   },
+  "engines": {
+    "node": "22.x"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fere-ai/all-in-one.git",
+    "directory": "gateway_service/sdks/typescript"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "license": "MIT",
-  "author": "Fere AI <info@fere.ai>"
+  "author": "Fere AI <hello@fereai.xyz>"
 }