@steerprotocol/sdk 1.26.0 → 1.28.0

package/src/base/vault/withdraw/index.ts

@@ -0,0 +1,187 @@
+import { Address, Hash, PublicClient, WalletClient } from 'viem';
+import { abis } from '../../../const/deployments/abis.js';
+import { getContractAddressByChainIdAndContractName } from '../../../const/network.js';
+import { AlgebraVaultDetails, SteerResponse, VaultDetails } from '../../../types.js';
+import { TokensFromLpResponse, VaultWithdrawParams } from './types.js';
+
+const VAULT_ABI = abis.QuickSwapUniv3MultiPositionLiquidityManager;
+const PERIPHERY_ABI = abis.SteerPeriphery;
+
+export class VaultWithdrawClient {
+  constructor(
+    protected readonly publicClient: PublicClient,
+    protected readonly walletClient: WalletClient
+  ) {}
+
+  /**
+   * Withdraws tokens from a vault
+   * @param params The withdrawal parameters
+   */
+  public async withdraw(params: VaultWithdrawParams): Promise<SteerResponse<Hash>> {
+    try {
+      const account = await this.walletClient.getAddresses();
+      if (!account[0]) throw new Error('No account found');
+
+      const { request } = await this.publicClient.simulateContract({
+        address: params.vaultAddress,
+        abi: VAULT_ABI,
+        functionName: 'withdraw',
+        args: [
+          params.shares,
+          params.amount0Min,
+          params.amount1Min,
+          params.to ?? account[0]
+        ],
+        account: account[0],
+      });
+
+      const hash = await this.walletClient.writeContract(request);
+
+      return {
+        data: hash,
+        status: 200,
+        success: true,
+      };
+    } catch (error) {
+      return {
+        data: null,
+        status: 500,
+        success: false,
+        error: error instanceof Error ? error.message : 'Unknown error occurred',
+      };
+    }
+  }
+
+  
+
+  /**
+   * Prepares the transaction data for withdrawing tokens from a vault without executing it
+   * @param params The withdrawal parameters
+   */
+  public async prepareWithdrawTx(params: VaultWithdrawParams): Promise<SteerResponse<{
+    address: Address;
+    abi: {
+      type: string;
+      inputs: {
+        name: string;
+        internalType: string;
+        type: string;
+      }[];
+      name: string;
+      outputs: never[];
+      stateMutability: string;
+    }[];
+    functionName: string;
+    args: readonly [
+      bigint,
+      bigint,
+      bigint,
+      Address
+    ];
+  }>> {
+    try {
+      const account = await this.walletClient.getAddresses();
+
+      if (!params.to) {
+        if (!account[0]) throw new Error('No account found');
+      }
+
+      // Prepare the complete contract interaction data
+      return {
+        data: {
+          address: params.vaultAddress,
+          abi: [{
+            type: 'function',
+            inputs: [
+              { name: 'shares', internalType: 'uint256', type: 'uint256' },
+              { name: 'amount0Min', internalType: 'uint256', type: 'uint256' },
+              { name: 'amount1Min', internalType: 'uint256', type: 'uint256' },
+              { name: 'to', internalType: 'address', type: 'address' }
+            ],
+            name: 'withdraw',
+            outputs: [],
+            stateMutability: 'nonpayable'
+          }],
+          functionName: 'withdraw',
+          args: [
+            params.shares,
+            0n,
+            0n,
+            params.to ?? account[0]
+          ] as const
+        },
+        status: 200,
+        success: true
+      };
+    } catch (error) {
+      return {
+        data: null,
+        status: 500,
+        success: false,
+        error: error instanceof Error ? error.message : 'Unknown error occurred'
+      };
+    }
+  }
+
+  /**
+   * Calculates the amount of tokens that would be received for a given amount of LP tokens
+   * @param vaultAddress The vault address
+   * @param lpToken The amount of LP tokens to calculate for
+   */
+  public async getTokensFromLp(
+    vaultAddress: Address,
+    lpToken: bigint
+  ): Promise<SteerResponse<TokensFromLpResponse>> {
+    try {
+      // Get chain ID and periphery address
+      const chainId = await this.publicClient.getChainId();
+      const steerPeripheryAddress = getContractAddressByChainIdAndContractName(chainId, 'SteerPeriphery');
+      if (!steerPeripheryAddress) throw new Error('SteerPeriphery address not found');
+
+      // Try to get vault details, first attempt with regular vault
+      let vaultDetails: VaultDetails | AlgebraVaultDetails;
+      try {
+        // First try regular vault
+        vaultDetails = await this.publicClient.readContract({
+          address: steerPeripheryAddress as Address,
+          abi: PERIPHERY_ABI,
+          functionName: 'vaultDetailsByAddress',
+          args: [vaultAddress]
+        }) as VaultDetails;
+      } catch (error) {
+        // If regular vault fails, try Algebra vault
+        vaultDetails = await this.publicClient.readContract({
+          address: steerPeripheryAddress as Address,
+          abi: PERIPHERY_ABI,
+          functionName: 'algebraVaultDetailsByAddress',
+          args: [vaultAddress]
+        }) as AlgebraVaultDetails;
+      }
+
+      // Calculate token amounts based on LP token proportion
+      const token0Val = vaultDetails.totalLPTokensIssued > 0n
+        ? (vaultDetails.token0Balance * lpToken) / vaultDetails.totalLPTokensIssued
+        : BigInt(1);
+
+      const token1Val = vaultDetails.totalLPTokensIssued > 0n
+        ? (vaultDetails.token1Balance * lpToken) / vaultDetails.totalLPTokensIssued
+        : BigInt(1);
+
+      return {
+        data: {
+          token0Val,
+          token1Val
+        },
+        status: 200,
+        success: true
+      };
+    } catch (error) {
+      return {
+        data: null,
+        status: 500,
+        success: false,
+        error: error instanceof Error ? error.message : 'Unknown error occurred'
+      };
+    }
+  }
+} 

package/src/base/vault/withdraw/types.ts

@@ -0,0 +1,14 @@
+import { Address } from 'viem';
+
+export interface VaultWithdrawParams {
+  vaultAddress: Address;
+  shares: bigint;
+  amount0Min: bigint;
+  amount1Min: bigint;
+  to?: Address; // optional, defaults to sender
+}
+
+export interface TokensFromLpResponse {
+  token0Val: bigint;
+  token1Val: bigint;
+} 

package/src/client.ts

@@ -0,0 +1,161 @@
+import { SteerConfig, SteerResponse } from './types.js';
+import { SubgraphClient } from './base/SubgraphClient.js';
+import { VaultClient } from './base/VaultClient.js';
+import { SmartRewardsClient } from './base/SmartRewardClient.js';
+import { PoolClient } from './base/PoolClient.js';
+import type { PublicClient, WalletClient } from 'viem';
+import { StakingClient } from './base/StakingClient.js';
+
+/**
+ * The main client for interacting with the Steer Protocol.
+ * This client provides access to vault operations, smart rewards functionality, pool data, and staking.
+ * 
+ * @example
+ * ```typescript
+ * import { createPublicClient, createWalletClient, http } from 'viem';
+ * import { mainnet } from 'viem/chains';
+ * import { SteerClient, Protocol } from '@steerprotocol/sdk';
+ * 
+ * // Create viem clients
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ * 
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ * 
+ * // Initialize the Steer client
+ * const steerClient = new SteerClient({
+ *   environment: 'production',
+ *   client: publicClient,
+ *   walletClient: walletClient,
+ *   subgraphStudioKey: 'your-subgraph-studio-key' // Optional
+ * });
+ * 
+ * // Use vault operations
+ * const vaults = await steerClient.vaults.getLatestVaults();
+ * 
+ * // Use rewards functionality
+ * const campaigns = await steerClient.rewards.getCampaigns(1);
+ * const summary = await steerClient.rewards.getRewardSummary(userAddress, chainId);
+ * 
+ * // Use pool data functionality
+ * const topPools = await steerClient.pools.getTopPools(100, Protocol.UniswapV3, 1);
+ * const poolDetails = await steerClient.pools.getPoolById(poolId, Protocol.UniswapV3, 1);
+ * 
+ * // Use staking functionality
+ * const stakingPools = await steerClient.staking.getStakingPools(1);
+ * ```
+ * 
+ * @group Client
+ */
+export class SteerClient extends SubgraphClient {
+  
+  /** The environment the client is configured for */
+  private readonly environment: 'production' | 'development';
+  
+  /** The vault client instance for interacting with Steer vaults */
+  public readonly vaults: VaultClient;
+
+  /** The rewards client instance for interacting with Smart Rewards */
+  public readonly rewards: SmartRewardsClient;
+
+  /** The staking client instance for interacting with staking pools */
+  public readonly staking: StakingClient;
+
+  /** The pool client instance for fetching pool data from DEX protocols */
+  public readonly pools: PoolClient;
+
+  /**
+   * Creates a new instance of the SteerClient
+   * 
+   * @param config - The configuration object for the client
+   * @param config.environment - The environment to use ('production' or 'development')
+   * @param config.client - The viem client for blockchain interactions
+   * @param config.walletClient - Optional wallet client for write operations
+   * @param config.subgraphStudioKey - Optional Subgraph Studio API key for higher rate limits
+   * 
+   * @example
+   * ```typescript
+   * const steerClient = new SteerClient({
+   *   environment: 'production',
+   *   client: publicClient,
+   *   walletClient: walletClient,
+   *   subgraphStudioKey: 'your-key'
+   * });
+   * ```
+   */
+  constructor(config: SteerConfig) {
+    super(config.client);
+    this.environment = config.environment || 'production';
+    
+    // Initialize clients based on provided configuration
+    const publicClient = config.client as PublicClient;
+    const walletClient = config.walletClient;
+    const subgraphStudioKey = config.subgraphStudioKey || '';
+
+    // Initialize vault client with both public and wallet clients if available
+    this.vaults = new VaultClient(
+      publicClient,
+      walletClient || publicClient as unknown as WalletClient,
+      this.environment === 'production' ? 'production' : 'development'
+    );
+
+    // Initialize staking client with both public and wallet clients if available
+    this.staking = new StakingClient(walletClient ? 
+      { ...publicClient, ...walletClient } as PublicClient & WalletClient : 
+      publicClient as unknown as PublicClient & WalletClient
+    );
+
+    // Initialize pool client with both public and wallet clients if available
+    this.pools = new PoolClient(walletClient ? 
+      { ...publicClient, ...walletClient } as PublicClient & WalletClient : 
+      publicClient as unknown as PublicClient & WalletClient,
+      subgraphStudioKey
+    );
+
+    // Initialize rewards client with both public and wallet clients if available
+    if (walletClient) {
+      this.rewards = new SmartRewardsClient(
+        publicClient,
+        walletClient,
+        this.environment === 'production' ? 'production' : 'development'
+      );
+    } else {
+      // If no wallet client is provided, initialize with read-only capabilities
+      this.rewards = new SmartRewardsClient(
+        publicClient,
+        publicClient as unknown as WalletClient, // Type cast for read-only operations
+        this.environment === 'production' ? 'production' : 'development'
+      );
+    }
+  }
+
+  /**
+   * Gets the active chain ID from the client
+   * @returns A promise that resolves to the active chain ID
+   * @throws Error if no active chain is found
+   * 
+   * @example
+   * ```typescript
+   * const chainId = await steerClient.getActiveChain();
+   * console.log(chainId.data); // e.g., 1 for Ethereum mainnet
+   * ```
+   */
+  public async getActiveChain<T>(): Promise<SteerResponse<T>> {
+    const activeChain = await this.client.chain?.id;
+
+    if (!activeChain) {
+      throw new Error('No active chain found');
+    }
+
+    return {
+      data: activeChain as unknown as T,
+      status: 200,
+      success: true,
+    };
+  }
+}

package/src/const/abis/UniswapPool.ts

@@ -0,0 +1 @@
+export const UniswapV3PoolABI = [{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"int24","name":"tickLower","type":"int24"},{"indexed":true,"internalType":"int24","name":"tickUpper","type":"int24"},{"indexed":false,"internalType":"uint128","name":"amount","type":"uint128"},{"indexed":false,"internalType":"uint256","name":"amount0","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount1","type":"uint256"}],"name":"Burn","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":false,"internalType":"address","name":"recipient","type":"address"},{"indexed":true,"internalType":"int24","name":"tickLower","type":"int24"},{"indexed":true,"internalType":"int24","name":"tickUpper","type":"int24"},{"indexed":false,"internalType":"uint128","name":"amount0","type":"uint128"},{"indexed":false,"internalType":"uint128","name":"amount1","type":"uint128"}],"name":"Collect","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint128","name":"amount0","type":"uint128"},{"indexed":false,"internalType":"uint128","name":"amount1","type":"uint128"}],"name":"CollectProtocol","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount0","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount1","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"paid0","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"paid1","type":"uint256"}],"name":"Flash","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint16","name":"observationCardinalityNextOld","type":"uint16"},{"indexed":false,"internalType":"uint16","name":"observationCardinalityNextNew","type":"uint16"}],"name":"IncreaseObservationCardinalityNext","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint160","name":"sqrtPriceX96","type":"uint160"},{"indexed":false,"internalType":"int24","name":"tick","type":"int24"}],"name":"Initialize","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"int24","name":"tickLower","type":"int24"},{"indexed":true,"internalType":"int24","name":"tickUpper","type":"int24"},{"indexed":false,"internalType":"uint128","name":"amount","type":"uint128"},{"indexed":false,"internalType":"uint256","name":"amount0","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount1","type":"uint256"}],"name":"Mint","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"feeProtocol0Old","type":"uint8"},{"indexed":false,"internalType":"uint8","name":"feeProtocol1Old","type":"uint8"},{"indexed":false,"internalType":"uint8","name":"feeProtocol0New","type":"uint8"},{"indexed":false,"internalType":"uint8","name":"feeProtocol1New","type":"uint8"}],"name":"SetFeeProtocol","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"int256","name":"amount0","type":"int256"},{"indexed":false,"internalType":"int256","name":"amount1","type":"int256"},{"indexed":false,"internalType":"uint160","name":"sqrtPriceX96","type":"uint160"},{"indexed":false,"internalType":"uint128","name":"liquidity","type":"uint128"},{"indexed":false,"internalType":"int24","name":"tick","type":"int24"}],"name":"Swap","type":"event"},{"inputs":[{"internalType":"int24","name":"tickLower","type":"int24"},{"internalType":"int24","name":"tickUpper","type":"int24"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"burn","outputs":[{"internalType":"uint256","name":"amount0","type":"uint256"},{"internalType":"uint256","name":"amount1","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"int24","name":"tickLower","type":"int24"},{"internalType":"int24","name":"tickUpper","type":"int24"},{"internalType":"uint128","name":"amount0Requested","type":"uint128"},{"internalType":"uint128","name":"amount1Requested","type":"uint128"}],"name":"collect","outputs":[{"internalType":"uint128","name":"amount0","type":"uint128"},{"internalType":"uint128","name":"amount1","type":"uint128"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"uint128","name":"amount0Requested","type":"uint128"},{"internalType":"uint128","name":"amount1Requested","type":"uint128"}],"name":"collectProtocol","outputs":[{"internalType":"uint128","name":"amount0","type":"uint128"},{"internalType":"uint128","name":"amount1","type":"uint128"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"factory","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"fee","outputs":[{"internalType":"uint24","name":"","type":"uint24"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feeGrowthGlobal0X128","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feeGrowthGlobal1X128","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"uint256","name":"amount0","type":"uint256"},{"internalType":"uint256","name":"amount1","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"flash","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint16","name":"observationCardinalityNext","type":"uint16"}],"name":"increaseObservationCardinalityNext","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint160","name":"sqrtPriceX96","type":"uint160"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"liquidity","outputs":[{"internalType":"uint128","name":"","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maxLiquidityPerTick","outputs":[{"internalType":"uint128","name":"","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"int24","name":"tickLower","type":"int24"},{"internalType":"int24","name":"tickUpper","type":"int24"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"mint","outputs":[{"internalType":"uint256","name":"amount0","type":"uint256"},{"internalType":"uint256","name":"amount1","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"observations","outputs":[{"internalType":"uint32","name":"blockTimestamp","type":"uint32"},{"internalType":"int56","name":"tickCumulative","type":"int56"},{"internalType":"uint160","name":"secondsPerLiquidityCumulativeX128","type":"uint160"},{"internalType":"bool","name":"initialized","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32[]","name":"secondsAgos","type":"uint32[]"}],"name":"observe","outputs":[{"internalType":"int56[]","name":"tickCumulatives","type":"int56[]"},{"internalType":"uint160[]","name":"secondsPerLiquidityCumulativeX128s","type":"uint160[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"positions","outputs":[{"internalType":"uint128","name":"liquidity","type":"uint128"},{"internalType":"uint256","name":"feeGrowthInside0LastX128","type":"uint256"},{"internalType":"uint256","name":"feeGrowthInside1LastX128","type":"uint256"},{"internalType":"uint128","name":"tokensOwed0","type":"uint128"},{"internalType":"uint128","name":"tokensOwed1","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"protocolFees","outputs":[{"internalType":"uint128","name":"token0","type":"uint128"},{"internalType":"uint128","name":"token1","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint8","name":"feeProtocol0","type":"uint8"},{"internalType":"uint8","name":"feeProtocol1","type":"uint8"}],"name":"setFeeProtocol","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"slot0","outputs":[{"internalType":"uint160","name":"sqrtPriceX96","type":"uint160"},{"internalType":"int24","name":"tick","type":"int24"},{"internalType":"uint16","name":"observationIndex","type":"uint16"},{"internalType":"uint16","name":"observationCardinality","type":"uint16"},{"internalType":"uint16","name":"observationCardinalityNext","type":"uint16"},{"internalType":"uint8","name":"feeProtocol","type":"uint8"},{"internalType":"bool","name":"unlocked","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"int24","name":"tickLower","type":"int24"},{"internalType":"int24","name":"tickUpper","type":"int24"}],"name":"snapshotCumulativesInside","outputs":[{"internalType":"int56","name":"tickCumulativeInside","type":"int56"},{"internalType":"uint160","name":"secondsPerLiquidityInsideX128","type":"uint160"},{"internalType":"uint32","name":"secondsInside","type":"uint32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"bool","name":"zeroForOne","type":"bool"},{"internalType":"int256","name":"amountSpecified","type":"int256"},{"internalType":"uint160","name":"sqrtPriceLimitX96","type":"uint160"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"swap","outputs":[{"internalType":"int256","name":"amount0","type":"int256"},{"internalType":"int256","name":"amount1","type":"int256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"int16","name":"","type":"int16"}],"name":"tickBitmap","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"tickSpacing","outputs":[{"internalType":"int24","name":"","type":"int24"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"int24","name":"","type":"int24"}],"name":"ticks","outputs":[{"internalType":"uint128","name":"liquidityGross","type":"uint128"},{"internalType":"int128","name":"liquidityNet","type":"int128"},{"internalType":"uint256","name":"feeGrowthOutside0X128","type":"uint256"},{"internalType":"uint256","name":"feeGrowthOutside1X128","type":"uint256"},{"internalType":"int56","name":"tickCumulativeOutside","type":"int56"},{"internalType":"uint160","name":"secondsPerLiquidityOutsideX128","type":"uint160"},{"internalType":"uint32","name":"secondsOutside","type":"uint32"},{"internalType":"bool","name":"initialized","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"token0","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"token1","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]