@shroudfi/sdk

TypeScript SDK for integrating ShroudFi MEV protection into your dApp or trading system.

Installation

npm install @shroudfi/sdk

Quick Start

import { ShroudFiSDK } from '@shroudfi/sdk';

// Initialize with your API key
const shroud = new ShroudFiSDK({
  apiKey: 'your-api-key',
  chainId: 1, // Ethereum mainnet
  rpcUrl: 'https://rpc.shroudfi.com/rpc/1',
});

// Submit a protected swap intent
const result = await shroud.submitIntent({
  tokenIn: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH
  tokenOut: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
  amountIn: '1000000000000000000', // 1 ETH
  slippageBps: 50, // 0.5%
});

console.log('Intent ID:', result.intentId);
console.log('Status:', result.status);

// Track settlement
const settlement = await shroud.getSettlement(result.intentId);
console.log('Executed at:', settlement.executionPrice);
console.log('MEV saved:', settlement.mevSaved);

Features

• Submit intents — Express swap intents with slippage protection
• Track settlements — Monitor intent execution and MEV savings
• Threat analysis — Get real-time MEV threat scores for transactions
• Protected send — Route raw transactions through private relays
• Multi-chain — Works across 10 EVM chains + Solana

API Reference

ShroudFiSDK

new ShroudFiSDK({
  apiKey: string;        // Your ShroudFi API key
  chainId: number;       // Target chain ID
  rpcUrl?: string;       // Custom RPC URL (defaults to rpc.shroudfi.com)
})

Methods

| Method | Description | |---|---| | submitIntent(intent) | Submit a swap intent for MEV-protected execution | | getSettlement(intentId) | Get settlement details for an intent | | analyzeThreat(tx) | Get AI threat analysis for a transaction | | sendProtected(signedTx) | Send a signed transaction via private relay | | getApiKeyUsage() | Check your API key usage and limits |

Supported Chains

Ethereum, Base, Arbitrum, Optimism, Polygon, BNB Chain, Avalanche, zkSync Era, Linea, Scroll, Solana (Beta)

Links

• Website
• GitHub
• Dashboard

License

MIT — Astra Fintech Labs Pvt. Ltd.