@steerprotocol/sdk 1.23.2 → 1.26.0

package/README.md

@@ -22,12 +22,12 @@ import { VaultClient, StakingClient } from '@steerprotocol/sdk';
 // Create viem clients
 const publicClient = createPublicClient({
   chain: mainnet,
-  transport: http()
+  transport: http(),
 });
 
 const walletClient = createWalletClient({
   chain: mainnet,
-  transport: http()
+  transport: http(),
 });
 
 // Initialize clients
@@ -41,6 +41,39 @@ const vaults = await vaultClient.getVaults({ chainId: 1 });
 const pools = await stakingClient.getStakingPools();
 ```
 
+## Supported Chains, Subgraphs, and Protocols
+
+The SDK exposes a capabilities registry so integrators can discover supported chains and the relevant configuration (subgraph URLs, protocol availability, deployments) without enumerating enums.
+
+```ts
+import { getSupportedChains, getSupportedChainIds } from '@steerprotocol/sdk';
+
+// Most lightweight: chains that have Steer subgraph config
+const supportedChainIds = getSupportedChainIds();
+
+// Opt in to additional details (deployments, protocol subgraphs, etc)
+const supported = getSupportedChains({
+  include: {
+    subgraph: true,
+    deployments: true,
+    protocols: true,
+    singleAssetDeposit: true,
+  },
+  // Used for protocol-specific subgraph discovery (The Graph / Studio)
+  theGraphApiKey: process.env.SUBGRAPH_STUDIO_KEY ?? '',
+});
+
+for (const chain of supported) {
+  console.log({
+    chainId: chain.chainId,
+    chain: chain.chain,
+    subgraphUrl: chain.subgraphUrl,
+    protocolCount: chain.protocols?.length ?? 0,
+    features: chain.features,
+  });
+}
+```
+
 ### Available Features
 
 - **Vault Operations**: Traditional vault deposits, withdrawals, and balance checking
@@ -77,7 +110,7 @@ const polygonPools = await stakingClient.getStakingPools(137); // Polygon chain
 // Stake tokens
 await stakingClient.stake({
   stakingPool: '0x...', // staking pool address
-  amount: 1000000000000000000n // amount in wei
+  amount: 1000000000000000000n, // amount in wei
 });
 
 // Check earned rewards
@@ -85,11 +118,7 @@ const earned = await stakingClient.earned('0x...', '0x...'); // pool address, ac
 console.log('Earned rewards:', earned.data);
 
 // Calculate APR
-const apr = stakingClient.calculateAPR(
-  pool,
-  rewardTokenPriceUSD,
-  totalStakedUSD
-);
+const apr = stakingClient.calculateAPR(pool, rewardTokenPriceUSD, totalStakedUSD);
 ```
 
 ### Available Methods
@@ -137,35 +166,38 @@ import { mainnet } from 'viem/chains';
 // Setup clients
 const publicClient = createPublicClient({
   chain: mainnet,
-  transport: http()
+  transport: http(),
 });
 
 const walletClient = createWalletClient({
   chain: mainnet,
-  transport: http()
+  transport: http(),
 });
 
 // Initialize vault client
 const vaultClient = new VaultClient(publicClient, walletClient, 'production');
 
 // Preview single-asset deposit
-const preview = await vaultClient.previewSingleAssetDeposit({
-  assets: parseEther('100'),          // 100 tokens to deposit
-  receiver: userAddress,              // Address to receive LP tokens
-  vault: vaultAddress,                // Vault contract address
-  isToken0: true,                     // Depositing token0
-  depositSlippagePercent: 5n,         // 5% max slippage for deposit
-  swapSlippageBP: 500,               // 5% slippage for internal swap (in basis points)
-  ammType: AMMType.UniswapV3,        // AMM type
-  singleAssetDepositContract: contractAddress // Single-asset deposit contract
-}, poolAddress);
+const preview = await vaultClient.previewSingleAssetDeposit(
+  {
+    assets: parseEther('100'), // 100 tokens to deposit
+    receiver: userAddress, // Address to receive LP tokens
+    vault: vaultAddress, // Vault contract address
+    isToken0: true, // Depositing token0
+    depositSlippagePercent: 5n, // 5% max slippage for deposit
+    swapSlippageBP: 500, // 5% slippage for internal swap (in basis points)
+    ammType: AMMType.UniswapV3, // AMM type
+    singleAssetDepositContract: contractAddress, // Single-asset deposit contract
+  },
+  poolAddress
+);
 
 if (preview.success) {
   console.log('Expected LP tokens:', preview.data.lpEstimation.lpTokens);
   console.log('Amount to be swapped:', preview.data.swapAmount);
   console.log('Final token0 amount:', preview.data.lpEstimation.finalAmount0);
   console.log('Final token1 amount:', preview.data.lpEstimation.finalAmount1);
-  
+
   // Execute the deposit
   const result = await vaultClient.singleAssetDeposit({
     assets: parseEther('100'),
@@ -175,9 +207,9 @@ if (preview.success) {
     depositSlippagePercent: 5n,
     swapSlippageBP: 500,
     ammType: AMMType.UniswapV3,
-    singleAssetDepositContract: contractAddress
+    singleAssetDepositContract: contractAddress,
   });
-  
+
   if (result.success) {
     console.log('Transaction hash:', result.data);
   }
@@ -191,12 +223,12 @@ if (preview.success) {
 Each step can be used independently for testing or custom implementations:
 
 ```typescript
-import { 
-  calculateSwapAmount, 
-  calculateLimitPrice, 
-  simulateSwap, 
+import {
+  calculateSwapAmount,
+  calculateLimitPrice,
+  simulateSwap,
   estimateLpTokens,
-  AMMType 
+  AMMType,
 } from '@steerprotocol/sdk';
 
 // Step 1: Calculate swap amount
@@ -206,7 +238,7 @@ const swapResult = await calculateSwapAmount(publicClient, {
   vault: vaultAddress,
   pool: poolAddress,
   ammType: AMMType.UniswapV3,
-  singleAssetDepositContract: contractAddress
+  singleAssetDepositContract: contractAddress,
 });
 
 // Step 2: Calculate price limit for slippage protection
@@ -214,21 +246,25 @@ const limitPrice = await calculateLimitPrice(publicClient, {
   pool: poolAddress,
   slippageBP: 500,
   zeroForOne: true,
-  ammType: AMMType.UniswapV3
+  ammType: AMMType.UniswapV3,
 });
 
 // Step 3: Simulate the swap
-const simulation = await simulateSwap(publicClient, {
-  pool: poolAddress,
-  recipient: userAddress,
-  zeroForOne: true,
-  amountSpecified: parseEther('10'),
-  sqrtPriceLimitX96: limitPrice,
-  ammType: AMMType.UniswapV3,
-  tokenIn: '0x...',  // Token being swapped from
-  tokenOut: '0x...', // Token being swapped to
-  fee: 3000          // Pool fee in basis points
-}, 137); // Chain ID (e.g., 137 for Polygon)
+const simulation = await simulateSwap(
+  publicClient,
+  {
+    pool: poolAddress,
+    recipient: userAddress,
+    zeroForOne: true,
+    amountSpecified: parseEther('10'),
+    sqrtPriceLimitX96: limitPrice,
+    ammType: AMMType.UniswapV3,
+    tokenIn: '0x...', // Token being swapped from
+    tokenOut: '0x...', // Token being swapped to
+    fee: 3000, // Pool fee in basis points
+  },
+  137
+); // Chain ID (e.g., 137 for Polygon)
 
 // Step 4: Estimate LP tokens
 const estimation = await estimateLpTokens(publicClient, {
@@ -236,7 +272,7 @@ const estimation = await estimateLpTokens(publicClient, {
   originalAssets: parseEther('100'),
   swapAmount: swapResult.data.swapAmount,
   swapResult: simulation.data,
-  isToken0: true
+  isToken0: true,
 });
 ```
 
@@ -261,11 +297,11 @@ client.validateDepositParams(params);
 
 ```typescript
 enum AMMType {
-  UniswapV3 = 0,          // ✅ Fully implemented
-  Algebra = 1,            // 🚧 Planned
-  AlgebraDirectional = 2, // 🚧 Planned  
-  AlgebraVE33 = 3,       // 🚧 Planned
-  AlgebraIntegral = 4    // 🚧 Planned
+  UniswapV3 = 0, // ✅ Fully implemented
+  Algebra = 1, // 🚧 Planned
+  AlgebraDirectional = 2, // 🚧 Planned
+  AlgebraVE33 = 3, // 🚧 Planned
+  AlgebraIntegral = 4, // 🚧 Planned
 }
 ```
 
@@ -317,9 +353,9 @@ describe('Single-Asset Deposit', () => {
       vault: vaultAddress,
       pool: poolAddress,
       ammType: AMMType.UniswapV3,
-      singleAssetDepositContract: contractAddress
+      singleAssetDepositContract: contractAddress,
     });
-    
+
     expect(result.success).toBe(true);
     expect(result.data.swapAmount).toBeGreaterThan(0n);
   });
@@ -328,16 +364,16 @@ describe('Single-Asset Deposit', () => {
 
 ### Configuration Parameters
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `assets` | `bigint` | Amount of input token to deposit |
-| `receiver` | `Address` | Address to receive LP tokens |
-| `vault` | `Address` | Vault contract address |
-| `isToken0` | `boolean` | `true` for token0, `false` for token1 |
-| `depositSlippagePercent` | `bigint` | Max slippage for deposit (in %) |
-| `swapSlippageBP` | `number` | Slippage for internal swap (basis points) |
-| `ammType` | `AMMType` | Type of AMM (currently UniswapV3) |
-| `singleAssetDepositContract` | `Address` | Single-asset deposit contract address |
+| Parameter                    | Type      | Description                               |
+| ---------------------------- | --------- | ----------------------------------------- |
+| `assets`                     | `bigint`  | Amount of input token to deposit          |
+| `receiver`                   | `Address` | Address to receive LP tokens              |
+| `vault`                      | `Address` | Vault contract address                    |
+| `isToken0`                   | `boolean` | `true` for token0, `false` for token1     |
+| `depositSlippagePercent`     | `bigint`  | Max slippage for deposit (in %)           |
+| `swapSlippageBP`             | `number`  | Slippage for internal swap (basis points) |
+| `ammType`                    | `AMMType` | Type of AMM (currently UniswapV3)         |
+| `singleAssetDepositContract` | `Address` | Single-asset deposit contract address     |
 
 ### Architecture
 
@@ -348,13 +384,14 @@ src/base/vault/single-asset/
 ├── types.ts                    # TypeScript interfaces and enums
 ├── calculateSwapAmount.ts      # Step 1: Calculate swap amount
 ├── calculateLimitPrice.ts      # Step 2: Calculate slippage protection
-├── simulateSwap.ts            # Step 3: Simulate swap execution  
+├── simulateSwap.ts            # Step 3: Simulate swap execution
 ├── estimateLpTokens.ts        # Step 4: Estimate LP token output
 ├── singleAssetDeposit.ts      # Main orchestrator client
 └── index.ts                   # Exports everything
 ```
 
 This design allows for:
+
 - **Individual Testing**: Each function can be unit tested separately
 - **Reusability**: Functions can be used in different contexts
 - **Maintainability**: Easy to update or extend individual components
@@ -368,26 +405,31 @@ This design allows for:
 ## Development
 
 1. Install dependencies:
+
 ```bash
 npm install
 ```
 
 2. Build the package:
+
 ```bash
 npm run build
 ```
 
 3. Run tests:
+
 ```bash
 npm test
 ```
 
 4. Format code:
+
 ```bash
 npm run format
 ```
 
 5. Lint code:
+
 ```bash
 npm run lint
 ```
@@ -397,6 +439,7 @@ npm run lint
 ### CommonJS/ESM Import Issues
 
 If you encounter the following error:
+
 ```typescript
 import { SteerClient } from "@steerprotocol/sdk";
          ^^^^^^^^^^^
@@ -404,6 +447,7 @@ SyntaxError: Named export 'SteerClient' not found. The requested module '@steerp
 ```
 
 Add the following to your `tsconfig.json`:
+
 ```json
 {
   "compilerOptions": {
@@ -415,4 +459,4 @@ Add the following to your `tsconfig.json`:
 
 ## License
 
-MIT 
+MIT