@shogun-sdk/intents-sdk 1.2.31 → 1.4.0

package/README.md

@@ -22,12 +22,6 @@ A comprehensive TypeScript SDK for intent-based cross-chain and single-chain tok
 - **Slippage Protection**: Built-in slippage controls and price impact calculations
 - **Deadline Management**: Time-based order expiration
 
-### 🔌 Multi-Provider Integration
-- **EVM Chains**: ParaSwap integration for optimal routing
-- **Solana**: Jupiter aggregator for best prices
-- **Sui**: Aftermath and LiquidSwap integration
-- **Cross-Chain**: DefiLlama price feeds and stablecoin routing
-
 ## Installation
 
 ```bash
@@ -86,8 +80,8 @@ const isNativeEth = isNativeEvmToken('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
 The SDK uses a modular architecture with chain-specific implementations:
 
 - **`EVMSDK`**: Ethereum Virtual Machine chains (Arbitrum, Optimism, Base, Hyperliquid)
-- **`SolanaSDK`**: Solana blockchain with Jupiter integration
-- **`SuiSDK`**: Sui blockchain with Aftermath and LiquidSwap support
+- **`SolanaSDK`**: Solana blockchain 
+- **`SuiSDK`**: Sui blockchain 
 
 ## Usage
 
@@ -129,6 +123,9 @@ const response = await evmSdk.createAndSendCrossChainOrder({
   destinationTokenAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v', // USDC
   destinationAddress: '3Kiz4oBXpR9YuPNsVfvE5XnNzgwjrM9m2CbRzyyEVkpQ',
   deadline: Math.floor(Date.now() / 1000) + 3600,
+  // Optional: Add stop-loss and take-profit parameters
+  stopLossMaxOut: BigInt(9_000_000), // Stop loss at 9 USDC
+  takeProfitMinOut: BigInt(11_000_000), // Take profit at 11 USDC
 });
 ```
 
@@ -145,6 +142,9 @@ const response = await solanaSdk.createAndSendSingleChainOrder({
   amountOutMin: BigInt(100_000_000), // 100 USDC
   destinationAddress: '3Kiz4oBXpR9YuPNsVfvE5XnNzgwjrM9m2CbRzyyEVkpQ',
   deadline: Math.floor(Date.now() / 1000) + 86400,
+  // Optional: Add stop-loss and take-profit parameters
+  stopLossMaxOut: BigInt(90_000_000), // Stop loss at 90 USDC
+  takeProfitMinOut: BigInt(110_000_000), // Take profit at 110 USDC
 });
 ```
 
@@ -199,6 +199,9 @@ const limitOrder = await SingleChainOrder.create({
   destinationAddress: "0x...",
   deadline: Math.floor(Date.now() / 1000) + 3600,
   user: "0x...",
+  // Optional: Add stop-loss and take-profit parameters
+  stopLossMaxOut: BigInt(180_000), // Stop loss at 180k units
+  takeProfitMinOut: BigInt(220_000), // Take profit at 220k units
 });
 
 // Generate secret data
@@ -234,6 +237,9 @@ const intentRequest = createSuiSingleChainLimitOrderIntentRequest({
   deadline: limitOrder.deadline,
   transactionHash: result.digest,
   secretNumber,
+  // Optional: Include stop-loss and take-profit parameters
+  stopLossMaxOut: limitOrder.stopLossMaxOut,
+  takeProfitMinOut: limitOrder.takeProfitMinOut,
 });
 
 // Example: Sui Single-Chain DCA Order
@@ -281,7 +287,21 @@ const dcaIntentRequest = createSuiSingleChainDcaOrderIntentRequest({
 });
 ```
 
-### Advanced risk management (stop-loss / take-profit)
+### Advanced Risk Management (Stop-Loss / Take-Profit)
+
+The SDK now supports advanced risk management features including stop-loss and take-profit orders. These parameters can be added to both cross-chain and single-chain orders across all supported chains (EVM, Solana, and Sui).
+
+#### Stop-Loss Orders
+Stop-loss orders automatically execute when the price moves unfavorably, limiting potential losses:
+- **`stopLossMaxOut`**: Maximum amount of output tokens to accept (triggers when price drops)
+- When specified, the order will execute immediately if the current price would result in receiving more than this amount
+
+#### Take-Profit Orders  
+Take-profit orders automatically execute when the price reaches a favorable target, locking in profits:
+- **`takeProfitMinOut`**: Minimum amount of output tokens required (triggers when price rises)
+- When specified, the order will execute immediately if the current price would result in receiving at least this amount
+
+#### Cross-Chain Risk Management Example
 
 ```typescript
 import { ChainID } from "@shogun-sdk/intents-sdk";
@@ -293,12 +313,38 @@ await evmSdk.createAndSendCrossChainOrder({
   destinationChainId: ChainID.Arbitrum,
   destinationTokenAddress: '0x82aF49447D8a07e3bd95BD0d56f35241523fBab1', // WETH
   destinationAddress: '0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6',
-  stopLossMaxOut: BigInt(2_500_000_000),
-  takeProfitMinOut: BigInt(3_500_000_000),
+  // Risk management parameters
+  stopLossMaxOut: BigInt(2_500_000_000), // Stop loss: max 2.5 WETH (18dp)
+  takeProfitMinOut: BigInt(3_500_000_000), // Take profit: min 3.5 WETH (18dp)
+  deadline: Math.floor(Date.now() / 1000) + 3600,
+});
+```
+
+#### Single-Chain Risk Management Example
+
+```typescript
+import { ChainID } from "@shogun-sdk/intents-sdk";
+
+await evmSdk.createAndSendSingleChainOrder({
+  chainId: ChainID.Arbitrum,
+  amountIn: BigInt(1_000_000_000_000_000_000), // 1 ETH (18dp)
+  tokenIn: '0x82aF49447D8a07e3bd95BD0d56f35241523fBab1', // WETH
+  tokenOut: '0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9', // USDT
+  destinationAddress: '0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6',
   deadline: Math.floor(Date.now() / 1000) + 3600,
+  // Risk management parameters
+  stopLossMaxOut: BigInt(2_200_000_000), // Stop loss: max 2200 USDT (6dp)
+  takeProfitMinOut: BigInt(2_800_000_000), // Take profit: min 2800 USDT (6dp)
 });
 ```
 
+**Important Notes:**
+- Risk management parameters are optional and can be used independently
+- When `stopLossMaxOut` is specified, the order may execute immediately if current market conditions trigger the stop-loss
+- When `takeProfitMinOut` is specified, the order may execute immediately if current market conditions meet the take-profit target
+- These parameters work across all supported chains: EVM (Arbitrum, Optimism, Base, Hyperliquid), Solana, and Sui
+- All amount values should be specified in the smallest units of the respective tokens (considering decimals)
+
 ### EVM Guard Addresses and Configuration
 
 When working with EVM chains, you can access guard addresses for different order types:
@@ -436,16 +482,25 @@ await order.sendToAuctioneer({ nonce: nonce.toString(), signature: signature.sli
 ### Fetching User Orders
 
 ```typescript
-import { fetchUserOrders } from "@shogun-sdk/intents-sdk";
+import { fetchUserOrders, ChainID } from "@shogun-sdk/intents-sdk";
 
-// Authenticate and fetch user orders
+// Query directly by wallet address (JWT verification is currently skipped auctioneer-side)
+const orders = await fetchUserOrders({ wallet: '0x...' });
+
+// Optionally restrict the results to a single network
+const baseOrders = await fetchUserOrders({ wallet: '0x...', network: ChainID.Base });
+
+// Or authenticate via SIWE and let the JWT claims carry the wallet(s)
 const jwt = await evmSdk.authenticate(); // or solanaSdk.authenticate(), suiSdk.authenticate()
-const orders = await fetchUserOrders(jwt);
+const authedOrders = await fetchUserOrders({ token: jwt });
 
 console.log('Cross-chain orders:', orders.crossChainLimitOrders);
 console.log('Single-chain orders:', orders.singleChainLimitOrders);
 ```
 
+> **Note:** at least one of `wallet` or `token` must be provided. `network` accepts any
+> `SupportedChain` (e.g. `ChainID.Base`); omit it to return orders across every network.
+
 ### Canceling Orders
 
 ```typescript
@@ -490,7 +545,7 @@ You can fetch rough price/amount estimates without creating orders using the bui
 ```typescript
 import { ChainID, QuoteProvider } from "@shogun-sdk/intents-sdk";
 
-// Cross-chain quote (uses routers with DefiLlama fallback)
+// Cross-chain quote
 const quote = await QuoteProvider.getQuote({
   sourceChainId: ChainID.Arbitrum,
   destChainId: ChainID.Base,
@@ -506,16 +561,6 @@ console.log({
 });
 ```
 
-## Quote Providers
-
-The SDK integrates with multiple quote providers for optimal pricing:
-
-- **ParaSwap**: EVM chain routing and pricing
-- **Jupiter**: Solana DEX aggregation
-- **Aftermath**: Sui DEX integration
-- **LiquidSwap**: Sui native DEX
-- **DefiLlama**: Cross-chain price feeds
-
 ## Error Handling
 
 ```typescript
@@ -591,6 +636,9 @@ const crossChainResponse = await suiSdk.createAndSendCrossChainOrder({
   destinationTokenAddress: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
   destinationAddress: '0xD022311DAcaa30f8396cA9d2C4662a2eF083A1Dd',
   deadline: Math.floor(Date.now() / 1000) + 1200,
+  // Optional: Add stop-loss and take-profit parameters
+  stopLossMaxOut: BigInt(450_000), // Stop loss at 450k units
+  takeProfitMinOut: BigInt(550_000), // Take profit at 550k units
 });
 ```
 
@@ -649,6 +697,9 @@ const crossChainIntent = createSuiCrossChainOrderIntentRequest({
   tokenOut: "0x...",
   amountOutMin: BigInt(1),
   transactionHash: "FQWndwYJhNQUoHyvR8UuhGURC2EKx9eWErFm9Tc2DggF",
+  // Optional: Add stop-loss and take-profit parameters
+  stopLossMaxOut: BigInt(450_000), // Stop loss
+  takeProfitMinOut: BigInt(550_000), // Take profit
 });
 ```