txflow-sdk 0.1.0 → 0.2.0

package/README.md

@@ -200,6 +200,43 @@ const funding = await client.getFundingHistory({
 await client.requestFund("0xUSER_ADDRESS");
 ```
 
+### Sign Without Submitting
+
+Every trading method has a corresponding `build*` method that returns the signed request payload without sending it to the API. This is useful for custom submission logic, queuing, or inspecting the signed data.
+
+```typescript
+import { TxFlowClient, SignedRequest } from "txflow-sdk";
+
+const client = new TxFlowClient({ privateKey: "0x..." });
+
+const signed: SignedRequest = await client.buildPlaceOrder({
+  asset: 1,
+  isBuy: true,
+  price: "50000",
+  size: "0.01",
+});
+
+// signed = { action, signature: { r, s, v }, nonce, vaultAddress? }
+// You now have full control over when and how to submit it.
+
+// Submit later when ready:
+const result = await client.submitSignedRequest(signed);
+```
+
+Available `build*` methods:
+
+| Method | Description |
+|---|---|
+| `buildPlaceOrder(params)` | Sign a single order |
+| `buildPlaceBatchOrders(params[])` | Sign a batch of orders |
+| `buildCancelOrder(params)` | Sign an order cancellation |
+| `buildCancelOrders(params[])` | Sign multiple cancellations |
+| `buildModifyOrder(params)` | Sign an order modification |
+| `buildUpdateLeverage(params)` | Sign a leverage update |
+| `buildUpdateMarginMode(params)` | Sign a margin mode update |
+
+All `build*` methods accept the same parameters as their corresponding action methods and return a `SignedRequest` object.
+
 ## Advanced: Low-Level Signing
 
 For custom integrations, the signing primitives are exported directly:

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { ethers } from "ethers";
-import type { TxFlowConfig, PlaceOrderParams, CancelOrderParams, ModifyOrderParams, UpdateLeverageParams, UpdateMarginModeParams, ApproveAgentParams, WithdrawParams, TransferTokenParams, SendTokenParams, ApiResponse, InfoResponse } from "./types.js";
+import type { TxFlowConfig, SignedRequest, PlaceOrderParams, CancelOrderParams, ModifyOrderParams, UpdateLeverageParams, UpdateMarginModeParams, ApproveAgentParams, WithdrawParams, TransferTokenParams, SendTokenParams, ApiResponse, InfoResponse } from "./types.js";
 export declare class TxFlowClient {
     private wallet;
     private baseUrl;
@@ -22,6 +22,14 @@ export declare class TxFlowClient {
     withdraw(userWallet: ethers.Wallet, params: WithdrawParams): Promise<ApiResponse>;
     transferToken(userWallet: ethers.Wallet, params: TransferTokenParams): Promise<ApiResponse>;
     sendToken(userWallet: ethers.Wallet, params: SendTokenParams): Promise<ApiResponse>;
+    buildPlaceOrder(params: PlaceOrderParams): Promise<SignedRequest>;
+    buildPlaceBatchOrders(orderParams: PlaceOrderParams[]): Promise<SignedRequest>;
+    buildCancelOrder(params: CancelOrderParams): Promise<SignedRequest>;
+    buildCancelOrders(params: CancelOrderParams[]): Promise<SignedRequest>;
+    buildModifyOrder(params: ModifyOrderParams): Promise<SignedRequest>;
+    buildUpdateLeverage(params: UpdateLeverageParams): Promise<SignedRequest>;
+    buildUpdateMarginMode(params: UpdateMarginModeParams): Promise<SignedRequest>;
+    submitSignedRequest(signed: SignedRequest): Promise<ApiResponse>;
     getOpenOrders(user: string): Promise<InfoResponse>;
     getMultiUserOpenOrders(users: string[]): Promise<InfoResponse>;
     getMaxPositions(params: {

package/dist/client.js

@@ -233,6 +233,102 @@ export class TxFlowClient {
             signature: { r: signature.r, s: signature.s, v: signature.v },
         });
     }
+    async buildPlaceOrder(params) {
+        const order = this.buildOrderWire(params);
+        const action = { grouping: "na", orders: [order] };
+        const { signature, nonce } = await createSign(this.wallet, action, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "order", grouping: "na", orders: [order], nonce },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+        };
+    }
+    async buildPlaceBatchOrders(orderParams) {
+        const orders = orderParams.map((p) => this.buildOrderWire(p));
+        const action = { grouping: "na", orders };
+        const { signature, nonce } = await createSign(this.wallet, action, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "order", grouping: "na", orders, nonce },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+        };
+    }
+    async buildCancelOrder(params) {
+        const cancelAction = {
+            cancels: [{ a: params.asset, o: BigInt(params.orderId) }],
+        };
+        const { signature, nonce } = await createSign(this.wallet, cancelAction, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "cancel", cancels: [{ a: params.asset, o: params.orderId }] },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+            vaultAddress: this.vaultAddress,
+        };
+    }
+    async buildCancelOrders(params) {
+        const cancelAction = {
+            cancels: params.map((p) => ({ a: p.asset, o: BigInt(p.orderId) })),
+        };
+        const { signature, nonce } = await createSign(this.wallet, cancelAction, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: {
+                type: "cancel",
+                cancels: params.map((p) => ({ a: p.asset, o: p.orderId })),
+            },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+            vaultAddress: this.vaultAddress,
+        };
+    }
+    async buildModifyOrder(params) {
+        const order = this.buildOrderWire({
+            asset: params.asset,
+            isBuy: params.isBuy,
+            price: params.price,
+            size: params.size,
+            reduceOnly: params.reduceOnly,
+            timeInForce: params.timeInForce,
+        });
+        const modifyAction = { oid: BigInt(params.orderId), order };
+        const { signature, nonce } = await createSign(this.wallet, modifyAction, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "modify", oid: params.orderId, order },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+            vaultAddress: this.vaultAddress,
+        };
+    }
+    async buildUpdateLeverage(params) {
+        const action = { asset: params.asset, leverage: params.leverage };
+        const { signature, nonce } = await createSign(this.wallet, action, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "updateLeverage", ...action },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+            vaultAddress: this.vaultAddress,
+        };
+    }
+    async buildUpdateMarginMode(params) {
+        const action = { asset: params.asset, isCross: params.isCross };
+        const { signature, nonce } = await createSign(this.wallet, action, this.isMainnet, this.vaultAddress, this.chainId);
+        return {
+            action: { type: "updateMarginMode", ...action },
+            signature: { r: signature.r, s: signature.s, v: signature.v },
+            nonce,
+            vaultAddress: this.vaultAddress,
+        };
+    }
+    async submitSignedRequest(signed) {
+        const body = {
+            action: signed.action,
+            signature: signed.signature,
+            nonce: signed.nonce,
+        };
+        if (signed.vaultAddress !== undefined) {
+            body.vaultAddress = signed.vaultAddress;
+        }
+        return this.postExchange(body);
+    }
     async getOpenOrders(user) {
         return this.postInfo({ type: "openorders", user });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "txflow-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for TxFlow perpetual DEX with EIP-712 signing and MCP server",
   "type": "module",
   "main": "dist/index.js",