@dhedge/v2-sdk 2.1.8 → 2.2.0

package/dist/config.d.ts

@@ -1,19 +1,29 @@
 import { AddressNetworkMap, Network, AddressDappNetworkMap, LyraNetworkMap } from "./types";
 import { NetworkChainIdMap } from ".";
+/** dHEDGE PoolFactory proxy address per network — used by `Dhedge.createPool` and pool lookups. */
 export declare const factoryAddress: AddressNetworkMap;
+/** Router/spender address for each (network, Dapp). Target of `pool.approve`/`pool.trade`. */
 export declare const routerAddress: AddressDappNetworkMap;
+/** CoW Protocol GPv2Settlement address per network (where pre-signed orders are submitted). */
 export declare const gpv2SettlementAddress: Partial<Record<Network, string>>;
+/** Pair-factory address for each (network, Dapp). Used for LP pair lookup (e.g. Sushi/Quickswap). */
 export declare const dappFactoryAddress: AddressDappNetworkMap;
+/** Staking-rewards / MasterChef / Voter address for each (network, Dapp). */
 export declare const stakingAddress: AddressDappNetworkMap;
+/** Aave PoolAddressesProvider per network — entrypoint for Aave V2/V3 lookups. */
 export declare const aaveAddressProvider: AddressDappNetworkMap;
+/** ERC-721 NonfungiblePositionManager for each Uniswap V3-style CL Dapp. */
 export declare const nonfungiblePositionManagerAddress: AddressDappNetworkMap;
+/** EVM chain id for each `Network` — used by API quotes (1inch, Pendle, KyberSwap…). */
 export declare const networkChainIdMap: NetworkChainIdMap;
+/** Balancer SOR subgraph URL per network (used by `Utils.getBalancerSwapTx`). */
 export declare const balancerSubgraph: AddressNetworkMap;
+/** Multicall3 contract per network — used by `multicall` / `Multicaller`. */
 export declare const multiCallAddress: AddressNetworkMap;
+/** Lyra deployment id per network — passed to `@lyrafinance/lyra-js` to scope queries. */
 export declare const lyraNetworkMap: LyraNetworkMap;
 export declare const MaxUint128 = "0xffffffffffffffffffffffffffffffff";
-export declare const UNISWAPV3_QUOTER_ADDRESS = "0xb27308f9F90D607463bb33eA1BeBb41C27CE5AB6";
-export declare const SYNTHETIX_TRACKING_CODE = "0x4448454447450000000000000000000000000000000000000000000000000000";
+/** FlatMoney v1/v2 module addresses per network (DelayedOrder, FlatcoinVault, StableModule). */
 export declare const flatMoneyContractAddresses: Readonly<Partial<Record<Network, {
     OrderExecution?: string;
     DelayedOrder: string;
@@ -21,6 +31,7 @@ export declare const flatMoneyContractAddresses: Readonly<Partial<Record<Network
     StableModule: string;
     COLLATERAL: string;
 }>>>;
+/** Toros PoolLimitOrderManager address per network — used for stop-loss / take-profit orders. */
 export declare const limitOrderAddress: AddressNetworkMap;
 export declare const OdosSwapFeeRecipient: {
     polygon: string;

package/dist/entities/pool.d.ts

@@ -18,7 +18,7 @@ export declare class Pool {
     getComposition(): Promise<FundComposition[]>;
     /**
      * Approve the asset that can be deposited into a pool
-     * @param {string} nasset Address of deposit asset
+     * @param {string} asset Address of deposit asset
      * @param {BigNumber | string} amount Amount to be approved
      * @param {any} options Transaction options
      * @param {boolean} estimateGas Simulate/estimate gas
@@ -56,17 +56,17 @@ export declare class Pool {
      * Approve the liquidity pool token for staking
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
      * @param {string} asset Address of liquidity pool token
-     * @param {BigNumber | string} amount Aamount to be approved
+     * @param {BigNumber | string} amount Amount to be approved
      * @param {any} options Transaction options
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
      */
     approveStaking(dapp: Dapp, asset: string, amount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Approve the liquidity pool token for staking
-     * @param {Dapp} dapp Platform like Sushiswap or Uniswap
-     * @param {string} asset Address of liquidity pool token
-     * @param {BigNumber | string} amount Aamount to be approved
+     * Approve an asset for the Uniswap V3 NonfungiblePositionManager
+     * (used before mint/increase liquidity calls)
+     * @param {string} asset Address of asset to approve
+     * @param {BigNumber | string} amount Amount to be approved
      * @param {any} options Transaction options
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
@@ -188,7 +188,7 @@ export declare class Pool {
      */
     lendCompoundV3(market: string, asset: string, amount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Witdraw asset from a lending pool
+     * Withdraw asset from a lending pool
      * @param {Dapp} dapp Platform like Aave
      * @param {string} asset Asset
      * @param  {BigNumber | string} amount Amount of asset to lend
@@ -198,7 +198,7 @@ export declare class Pool {
      */
     withdrawDeposit(dapp: Dapp, asset: string, amount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Witdraw asset from a Compound V3 or Fluid lending pool
+     * Withdraw asset from a Compound V3 or Fluid lending pool
      * @param {string} market Address of cToken or fToken
      * @param {string} asset Asset
      * @param  {BigNumber | string} amount Amount of asset to withdraw
@@ -280,11 +280,11 @@ export declare class Pool {
      */
     joinBalancerPool(poolId: string, assets: string[], amountsIn: string[] | BigNumber[], options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Invest into a Balancer pool
+     * Exit a Balancer pool
      * @param {string} poolId Balancer pool id
-     * @param {string[] | } assets Array of balancer pool assets
-     * @param {BigNumber | string } amount Amount of pool tokens to withdraw
-     * @param { null | number } singleExitAssetIndex Index of asset to withdraw to
+     * @param {string[]} assets Array of balancer pool assets
+     * @param {BigNumber | string} amount Amount of pool tokens to withdraw
+     * @param {null | number} singleExitAssetIndex Index of asset to withdraw to
      * @param {any} options Transaction options
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
@@ -331,7 +331,7 @@ export declare class Pool {
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
      */
-    addLiquidityUniswapV3(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL | Dapp.PANCAKECL, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, minPrice: number | null, maxPrice: number | null, minTick: number | null, maxTick: number | null, feeAmountOrTickSpacing: number, options?: any, sdkOptions?: SDKOptions): Promise<any>;
+    addLiquidityUniswapV3(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.PANCAKECL, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, minPrice: number | null, maxPrice: number | null, minTick: number | null, maxTick: number | null, feeAmountOrTickSpacing: number, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
      * Remove liquidity from an UniswapV3 or Arrakis liquidity pool
      * @param {Dapp} dapp Platform either UniswapV3 or Arrakis
@@ -362,29 +362,6 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     claimFees(dapp: Dapp, tokenId: string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
-    /**
-     * Get rewards of an NFT position
-     * @param {Dapp} dapp Platform e.g. Ramses CL
-     * @param {string} tokenId Token Id
-     * @param {string[]} rewards Reward tokens
-     * @param {any} options Transaction option
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    getRewards(dapp: Dapp, tokenId: string, rewards: string[], options?: any, sdkOptions?: SDKOptions): Promise<any>;
-    /**
-     * Trade an asset into another asset
-     * @param {Dapp} dapp Platform like Sushiswap or Uniswap
-     * @param {string} assetFrom Asset to trade from
-     * @param {string} assetTo Asset to trade into
-     * @param {BigNumber | string} amountIn Amount
-     * @param { FeeAmount } feeAmount Fee tier (Low 0.05%, Medium 0.3%, High 1%)
-     * @param {number} slippage Slippage tolerance in %
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    tradeUniswapV3(assetFrom: string, assetTo: string, amountIn: BigNumber | string, feeAmount: number, slippage?: number, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
      * Add liquidity to Velodrome pool
      * @param {string} assetA First asset
@@ -432,8 +409,8 @@ export declare class Pool {
      */
     removeLiquidityVelodromeV2(assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Add liquidity to Velodrome V2 or Ramses pool
-     * @param {Dapp} dapp VelodromeV2, Ramses or Aerodrome
+     * Add liquidity to Velodrome V2 or Aerodrome pool
+     * @param {Dapp} dapp VelodromeV2 or Aerodrome
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amountA Amount first asset
@@ -443,10 +420,10 @@ export declare class Pool {
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
      */
-    addLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, isStable: boolean, options?: any, sdkOptions?: SDKOptions): Promise<any>;
+    addLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.AERODROME, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, isStable: boolean, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
-     * Remove liquidity from Velodrome V2 or Ramses pool
-     * @param {Dapp} dapp VelodromeV2, Ramses or Aerodrome
+     * Remove liquidity from Velodrome V2 or Aerodrome pool
+     * @param {Dapp} dapp VelodromeV2 or Aerodrome
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amount Amount of LP tokens
@@ -455,7 +432,7 @@ export declare class Pool {
      * @param {SDKOptions} sdkOptions SDK options including estimateGas
      * @returns {Promise<any>} Transaction
      */
-    removeLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME, assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, sdkOptions?: SDKOptions): Promise<any>;
+    removeLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.AERODROME, assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
      * Trade options on lyra
      * @param {LyraOptionMarket} market Underlying market e.g. eth
@@ -477,32 +454,6 @@ export declare class Pool {
      * @returns {Promise<Position>} Transaction
      */
     getLyraPositions(market: LyraOptionMarket): Promise<LyraPosition[]>;
-    /** Deposit or withdraws (negative amount) asset for Synthetix future margin trading
-     *
-     * @param {string} market Address of futures market
-     * @param {BigNumber | string } changeAmount Amount to increase/decrease margin
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    changeFuturesMargin(market: string, changeAmount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
-    /** Change position in Synthetix futures market (long/short)
-     *
-     * @param {string} market Address of futures market
-     * @param {BigNumber | string } changeAmount Negative for short, positive for long
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    changeFuturesPosition(market: string, changeAmount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
-    /** Cancels an open oder on Synthetix futures market
-     *
-     * @param {string} market Address of futures market
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    cancelFuturesOrder(market: string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /**
      * mintManagerFee
      * @param {any} options Transaction options
@@ -515,24 +466,6 @@ export declare class Pool {
      * @returns {Promise<BigNumber>} fee
      */
     getAvailableManagerFee(): Promise<BigNumber>;
-    /** Vest tokens (e.g. Ramses xoRAM)
-     *
-     * @param {string} tokenAddress Address of the token to vest
-     * @param {BigNumber | string } changeAmount Negative for short, positive for long
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    vestTokens(tokenAddress: string, amount: BigNumber | string, options?: any, sdkOptions?: SDKOptions): Promise<any>;
-    /** Exit position of vested tokens (e.g. Ramses xoRAM)
-     *
-     * @param {string} tokenAddress Address of the token to vest
-     * @param {number } id position Id of the vested tokens
-     * @param {any} options Transaction options
-     * @param {SDKOptions} sdkOptions SDK options including estimateGas
-     * @returns {Promise<any>} Transaction
-     */
-    exitVestedToken(tokenAddress: string, id: number, options?: any, sdkOptions?: SDKOptions): Promise<any>;
     /** deposit rETH to mint UNIT via the Flat Money protocol
      *
      * @param { BigNumber | string } depositAmount Amount of rETH to deposit
@@ -553,6 +486,12 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     redeemUnitViaFlatMoney(withdrawAmount: ethers.BigNumber | string, slippage: number | undefined, maxKeeperFeeInUsd: number | null, options?: any, sdkOptions?: SDKOptions): Promise<any>;
+    /**
+     * Cancel a previously announced FlatMoney order (mint/redeem UNIT) before it executes
+     * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas instead of sending
+     * @returns {Promise<any>} Transaction
+     */
     cancelOrderViaFlatMoney(options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Complete a Toros withdrawal to a single asset

package/dist/entities/utils.d.ts

@@ -48,11 +48,26 @@ export declare class Utils {
      * @returns {Promise<ethers.BigNumber>} Reserves of the assets in BigNumber
      */
     getMinAmountOut(dapp: Dapp, assetFrom: string, assetTo: string, amountIn: string | ethers.BigNumber, slippage: number): Promise<ethers.BigNumber>;
+    /**
+     * Build calldata for a Balancer swap. Routes through the Balancer SOR — picks
+     * a single `swap` for direct hops or `batchSwap` for multi-hop routes.
+     * `slippage` is in % (e.g. 0.5 = 0.5%).
+     */
     getBalancerSwapTx(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber | string, slippage: number): Promise<any>;
+    /** Build calldata to join a Balancer pool by depositing the given asset amounts. */
     getBalancerJoinPoolTx(pool: Pool, balancerPoolId: string, assets: string[], amountsIn: string[] | ethers.BigNumber[]): Promise<any>;
+    /**
+     * Build calldata to exit a Balancer pool. If `singleExitAssetIndex` is null
+     * the exit is proportional across all `assets`; otherwise the BPT is redeemed
+     * into the single asset at that index.
+     */
     getBalancerExitPoolTx(pool: Pool, balancerPoolId: string, assets: string[], singleExitAssetIndex: null | number, amount: string | ethers.BigNumber): Promise<any>;
+    /** List available expiry timestamps for a Lyra option market. */
     getLyraOptionExpiries(market: LyraOptionMarket): Promise<number[]>;
+    /** List available strikes for a Lyra option market at a given expiry. */
     getLyraOptionStrikes(market: LyraOptionMarket, expiry: number): Promise<Strike[]>;
+    /** Resolve a single Lyra strike by its strike price for a market/expiry. */
     getLyraOptionStrike(market: LyraOptionMarket, expiry: number, strike: number): Promise<Strike>;
+    /** Get a Lyra option quote (premium, fees, slippage) for a strike/type/size. */
     getLyraOptionQuote(strike: Strike, type: LyraOptionType, tradeType: LyraTradeType, amount: BigNumber | string): Promise<Quote>;
 }

package/dist/services/hyperliquid/index.d.ts

@@ -1,6 +1,28 @@
 import { ethers } from "ethers";
+/** Encode `deposit(amount, dexId)` on the Hyperliquid CoreDepositWallet to bridge USDC into HyperCore. */
 export declare const getDepositHyperliquidTxData: (dexId: number, amount: ethers.BigNumber | string) => string;
+/**
+ * Encode a CoreWriter `sendRawAction` for SPOT_SEND that bridges USDC from the
+ * HyperCore Spot wallet back to EVM. Amount is supplied in 6 decimals (EVM USDC) and
+ * scaled up by 100 for HyperCore's 8-decimal USDC.
+ */
 export declare const getWithdrawSpotHyperliquidTxData: (amount: ethers.BigNumber | string) => string;
+/**
+ * Encode a CoreWriter `sendRawAction` for SEND_ASSET that moves USDC between
+ * HyperCore dexes (perp/spot/xyz). Amount is supplied in 6 decimals (EVM USDC) and
+ * scaled to HyperCore's 8 decimals.
+ */
 export declare const getSendAssetHyperliquidTxData: (sourceDex: number, destinationDex: number, receiver: string, amount: ethers.BigNumber | string) => string;
+/**
+ * Encode a CoreWriter `sendRawAction` for an IOC limit order on a Hyperliquid asset.
+ * Auto-flips side and sets `reduceOnly` when `changeAmount` is negative (perp close).
+ * Price is offset by `slippage`% from the current mid in the direction of execution.
+ */
 export declare const getLimitOrderHyperliquidTxData: (assetId: number, isLong: boolean, changeAmount: number, slippage: number) => Promise<string>;
+/**
+ * Encode a CoreWriter `sendRawAction` for an IOC limit order that closes
+ * `percentageToClose`% of the pool's current Hyperliquid position. Reads the
+ * existing position size on-chain to determine the side (buy to close shorts,
+ * sell to close longs).
+ */
 export declare const getClosePositionHyperliquidTxData: (assetId: number, percentageToClose: number, slippage: number, poolAddress: string) => Promise<string>;

package/dist/services/kyberSwap/index.d.ts

@@ -1,7 +1,7 @@
 import { ethers } from "../..";
 import { Pool } from "../../entities";
 export declare const kyberBaseUrl = "https://aggregator-api.kyberswap.com";
-export declare function getKyberSwapTxData(pool: Pool, tokenIn: string, tokenOut: string, amountIn: ethers.BigNumber | string, slippage: number): Promise<{
+export declare function getKyberSwapTxData(pool: Pool, tokenIn: string, tokenOut: string, amountIn: ethers.BigNumber | string, slippage: number, sender?: string, receiver?: string): Promise<{
     swapTxData: string;
     minAmountOut: string;
 }>;

package/dist/services/oneInch/index.d.ts

@@ -1,6 +1,6 @@
 import { ethers } from "../..";
 import { Pool } from "../../entities";
-export declare function getOneInchSwapTxData(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber | string, slippage: number, forEasySwapper?: boolean): Promise<{
+export declare function getOneInchSwapTxData(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber | string, slippage: number, sender?: string, receiver?: string): Promise<{
     swapTxData: string;
     dstAmount: string;
 }>;

package/dist/services/toros/easySwapper.d.ts

@@ -1,8 +1,22 @@
 import { ethers } from "ethers";
 import { Pool } from "../..";
+/** Minimum USD value of a leftover token to bother swapping during a withdrawal. */
 export declare const LOW_USD_VALUE_FOR_WITHDRAWAL = 1;
+/** Slippage (bps) applied to the swap of small-value leftover tokens during withdrawal. */
 export declare const SLIPPAGE_FOR_LOW_VALUE_SWAP = 500;
+/**
+ * Resolve which asset should be used to deposit into a Toros pool. Returns the
+ * caller's `investAsset` if the pool already accepts it, otherwise the pool's
+ * primary deposit asset.
+ */
 export declare function getPoolDepositAsset(pool: Pool, poolAddress: string, investAsset: string): Promise<string | undefined>;
+/** Read the current per-token price of a Toros vault from its PoolLogic. */
 export declare function getTorosPoolTokenPrice(pool: Pool, poolAddress: string): Promise<ethers.BigNumber>;
+/** Quote how many Toros vault tokens a deposit of `investAsset` would mint. */
 export declare function getEasySwapperDepositQuote(pool: Pool, torosAsset: string, investAsset: string, amountIn: ethers.BigNumber): Promise<ethers.BigNumber>;
+/**
+ * Build the EasySwapper calldata for a Toros deposit or the start of a withdrawal.
+ * If `assetFrom` is a Toros pool, this is treated as a withdrawal and routes through
+ * `getInitWithdrawalTxData`. Otherwise it builds a `depositWithCustomCooldown` call.
+ */
 export declare function getEasySwapperTxData(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber, slippage: number): Promise<any>;

package/dist/services/toros/swapData.d.ts

@@ -1,11 +1,11 @@
-export declare const SWAPPER_ADDERSS = "0x4F754e0F0924afD74980886b0B479Fa1D7C58D0D";
+import { Pool } from "../..";
+export declare const SWAPPER_ADDRESS = "0x4F754e0F0924afD74980886b0B479Fa1D7C58D0D";
+export declare const ROUTER_KEYS: readonly ["KYBER_SWAP_V2", "ONE_INCH"];
+export declare type RouterKey = typeof ROUTER_KEYS[number];
 export interface SwapParams {
     srcAsset: string;
     srcAmount: string;
     dstAsset: string;
-    chainId: number;
-    from: string;
-    receiver: string;
     slippage: number;
 }
-export declare const getSwapDataViaOdos: ({ srcAsset, srcAmount, dstAsset, chainId, from, slippage }: SwapParams) => Promise<string>;
+export declare const getSwapData: (pool: Pool, params: SwapParams, routerKeyString: RouterKey) => Promise<string>;

package/dist/services/uniswap/V3Liquidity.d.ts

@@ -4,7 +4,7 @@ import { Dapp, Pool } from "../..";
 import BigNumber from "bignumber.js";
 export declare function tryParsePrice(baseToken: Token, quoteToken: Token, value: string): Price<Token, Token>;
 export declare function tryParseTick(baseToken: Token, quoteToken: Token, feeAmount: number, value: string): number;
-export declare function getUniswapV3MintTxData(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL | Dapp.PANCAKECL, pool: Pool, assetA: string, assetB: string, amountA: string | ethers.BigNumber, amountB: string | ethers.BigNumber, minPrice: number | null, maxPrice: number | null, minTick: number | null, maxTick: number | null, feeAmountOrTickSpacing: number): Promise<any>;
-export declare function getUniswapV3Liquidity(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL | Dapp, tokenId: string, pool: Pool): Promise<BigNumber>;
+export declare function getUniswapV3MintTxData(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.PANCAKECL, pool: Pool, assetA: string, assetB: string, amountA: string | ethers.BigNumber, amountB: string | ethers.BigNumber, minPrice: number | null, maxPrice: number | null, minTick: number | null, maxTick: number | null, feeAmountOrTickSpacing: number): Promise<any>;
+export declare function getUniswapV3Liquidity(dapp: Dapp, tokenId: string, pool: Pool): Promise<BigNumber>;
 export declare function getIncreaseLiquidityTxData(pool: Pool, dapp: Dapp, tokenId: string, amountA: ethers.BigNumber | string, amountB: ethers.BigNumber | string): Promise<any>;
 export declare function getDecreaseLiquidityTxData(pool: Pool, dapp: Dapp, tokenId: string, amount: number | undefined, isStaked: boolean): Promise<any>;

package/dist/services/velodrome/liquidity.d.ts

@@ -1,6 +1,9 @@
 import { ethers } from "ethers";
 import { Pool } from "../../entities";
 import { Dapp } from "../../types";
+/** Encode Velodrome router calldata to add liquidity to a stable or volatile pair. */
 export declare function getVelodromeAddLiquidityTxData(pool: Pool, assetA: string, assetB: string, amountA: ethers.BigNumber | string, amountB: ethers.BigNumber | string, isStable: boolean): Promise<any>;
+/** Encode Velodrome router calldata to remove liquidity from a stable or volatile pair. */
 export declare function getVelodromeRemoveLiquidityTxData(pool: Pool, assetA: string, assetB: string, amount: ethers.BigNumber | string, isStable: boolean): Promise<any>;
+/** Read the current owner of a Velodrome/Aerodrome/Pancake CL position NFT. */
 export declare function getClOwner(pool: Pool, dapp: Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.PANCAKECL, tokenId: string): Promise<string>;

package/dist/test/constants.d.ts

@@ -11,8 +11,6 @@ export declare const VEL = "0x3c8B650257cFb5f272f799F5e2b4e65093a11a05";
 export declare const SUSD = "0x8c6f28f2f1a3c87f0f938b96d27520d9751ec8d9";
 export declare const SETH = "0xE405de8F52ba7559f9df3C368500B6E6ae6Cee49";
 export declare const ARRAKIS_USDC_WETH_GAUGE = "0xb8888ea29e2f70ad62a3b69b1a1342720612a00d";
-export declare const KWENTA_ETH_PERP = "0xf86048dff23cf130107dfb4e6386f574231a5c65";
-export declare const KWENTA_ETH_PERP_V2 = "0x2b3bb4c683bfc5239b029131eef3b1d214478d93";
 export declare const TEST_POOL: {
     polygon: string;
     optimism: string;
@@ -43,6 +41,9 @@ export declare const CONTRACT_ADDRESS: {
         FLUID_WETH: string;
         TOROS: string;
         UNIT: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
     optimism: {
         USDC: string;
@@ -52,7 +53,6 @@ export declare const CONTRACT_ADDRESS: {
         SUSD: string;
         WETH: string;
         WBTC: string;
-        KWENTA_ETH_PERP_V2: string;
         uniswapV3: {
             nonfungiblePositionManager: string;
         };
@@ -65,6 +65,9 @@ export declare const CONTRACT_ADDRESS: {
         COMPOUNDV3_WETH: string;
         FLUID_WETH: string;
         TOROS: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
     arbitrum: {
         USDC: string;
@@ -110,6 +113,9 @@ export declare const CONTRACT_ADDRESS: {
         COMPOUNDV3_WETH: string;
         FLUID_WETH: string;
         TOROS: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
     ethereum: {
         USDC: string;
@@ -131,16 +137,55 @@ export declare const CONTRACT_ADDRESS: {
         FLUID_WETH: string;
         TOROS: string;
         UNIT: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
     plasma: {
         USDC: string;
         WETH: string;
+        WBTC: string;
         USDT: string;
         USDE: string;
+        VELO: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
+        COMPOUNDV3_WETH: string;
+        FLUID_WETH: string;
+        UNIT: string;
+        TOROS: string;
+        SUSD: string;
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_LP: string;
+        WMATIC: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
     hyperliquid: {
         USDC: string;
+        USDT: string;
+        USDE: string;
         WETH: string;
+        WBTC: string;
+        VELO: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
+        COMPOUNDV3_WETH: string;
+        FLUID_WETH: string;
+        UNIT: string;
+        TOROS: string;
+        SUSD: string;
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_LP: string;
+        WMATIC: string;
+        WSTETH: string;
+        BALANCER_WSTETH_WETH_POOL: string;
+        BALANCER_WSTETH_WETH_GAUGE: string;
     };
 };
 export declare const MAX_AMOUNT: ethers.BigNumber;

package/dist/test/utils/testingHelper.d.ts

@@ -45,6 +45,10 @@ export declare const runWithImpersonateAccount: ({ account, provider }: {
 }, fnToRun: ({ signer }: {
     signer: ethers.providers.JsonRpcSigner;
 }) => void) => Promise<void>;
+export declare const fixOracleAggregatorStaleness: ({ pool, provider }: {
+    pool: Pool;
+    provider: ethers.providers.JsonRpcProvider;
+}) => Promise<void>;
 export declare const setChainlinkTimeout: ({ pool, provider }: {
     pool: Pool;
     provider: ethers.providers.JsonRpcProvider;

package/dist/types.d.ts

@@ -1,5 +1,7 @@
 import { Deployment } from "@lyrafinance/lyra-js";
 import { BigNumber } from "ethers";
+/** Networks supported by the SDK. The string value matches keys in `routerAddress`,
+ * `nonfungiblePositionManagerAddress`, etc. in `config.ts`. */
 export declare enum Network {
     POLYGON = "polygon",
     OPTIMISM = "optimism",
@@ -9,6 +11,8 @@ export declare enum Network {
     PLASMA = "plasma",
     HYPERLIQUID = "hyperliquid"
 }
+/** Identifies a target protocol/integration for `pool.trade`, `pool.approve`, etc.
+ * Each entry maps to address registries (router, factory, gauge) in `config.ts`. */
 export declare enum Dapp {
     SUSHISWAP = "sushiswap",
     AAVE = "aave",
@@ -16,7 +20,6 @@ export declare enum Dapp {
     QUICKSWAP = "quickswap",
     BALANCER = "balancer",
     UNISWAPV3 = "uniswapV3",
-    SYNTHETIX = "synthetix",
     AAVEV3 = "aavev3",
     ARRAKIS = "arrakis",
     TOROS = "toros",
@@ -24,10 +27,8 @@ export declare enum Dapp {
     VELODROMEV2 = "velodromeV2",
     VELODROMECL = "velodromeCL",
     LYRA = "lyra",
-    RAMSES = "ramses",
     AERODROME = "aerodrome",
     AERODROMECL = "aerodromeCL",
-    RAMSESCL = "ramsesCL",
     PANCAKECL = "pancakeCL",
     COMPOUNDV3 = "compoundV3",
     ODOS = "odos",
@@ -36,6 +37,8 @@ export declare enum Dapp {
     HYPERLIQUID = "hyperliquid",
     COWSWAP = "cowswap"
 }
+/** Function-name strings used when encoding ABI calls — keep in sync with the
+ * matching ABI files in `src/abi/`. */
 export declare enum Transaction {
     SWAP = "swapExactTokensForTokens",
     ADD_LIQUIDITY = "addLiquidity",
@@ -53,7 +56,6 @@ export declare enum Transaction {
     WITHDRAW = "withdraw",
     MINT = "mint",
     BURN = "burn",
-    SWAP_SYNTHS = "exchangeWithTracking",
     ADD_LIQUIDITY_STAKE = "addLiquidityAndStake",
     REMOVE_LIQUIDITY_UNSTAKE = "removeLiquidityAndUnstake"
 }
@@ -62,11 +64,14 @@ export declare type AddressDappMap = {
     [key in Dapp]?: string;
 };
 export declare type AddressDappNetworkMap = Readonly<Record<Network, AddressDappMap>>;
+/** Tuple form `[asset, isDeposit]` accepted by the factory's `createFund`. */
 export declare type SupportedAsset = [string, boolean];
+/** Object form of a supported asset entry; preferred over `SupportedAsset` in SDK methods. */
 export declare type AssetEnabled = {
     asset: string;
     isDeposit: boolean;
 };
+/** A pool's holding of one asset returned by `pool.getComposition()`. */
 export declare type FundComposition = {
     asset: string;
     isDeposit: boolean;
@@ -95,11 +100,21 @@ export declare type LyraPosition = {
     collateral: BigNumber;
     state: number;
 };
+/**
+ * Options that control how SDK methods dispatch a transaction:
+ *  - `estimateGas`: simulate and return gas + minAmountOut without sending.
+ *  - `onlyGetTxData`: return the encoded calldata without sending or simulating.
+ *  - `useTraderAddressAsFrom`: send via the EOA wallet instead of the pool's
+ *    `execTransaction` (used when the SDK is acting as a non-dHEDGE caller).
+ *  - `boolean` shorthand: `true` is equivalent to `{ estimateGas: true }` (kept
+ *    for backward compatibility).
+ */
 export declare type SDKOptions = {
     estimateGas: boolean;
     onlyGetTxData?: boolean;
     useTraderAddressAsFrom?: boolean;
 } | boolean;
+/** Parameters for a Toros limit order (stop-loss / take-profit) on a vault token. */
 export declare type LimitOrderInfo = {
     amount: BigNumber;
     stopLossPriceD18: BigNumber;

package/dist/utils/contract.d.ts

@@ -1,6 +1,17 @@
 import { ethers, Network, Pool, SDKOptions } from "..";
+/** Single contract read: `call = [address, methodName, params?]`. */
 export declare function call(provider: ethers.Signer, abi: any[], call: any[], options?: any): Promise<any>;
+/**
+ * Batch multiple contract reads through Multicall's `tryAggregate`.
+ * Each call entry is `[address, methodName, params]`. When `requireSuccess` is false,
+ * failing calls return `null` instead of reverting the whole batch.
+ */
 export declare function multicall<T>(network: Network, provider: ethers.Signer, abi: any[], calls: any[], options?: any, requireSuccess?: boolean): Promise<(T | null)[]>;
+/**
+ * Fluent helper for building a multicall and dispatching results into a typed object.
+ * Use `.call(path, address, fn, params)` repeatedly, then `.execute()` returns the
+ * populated object with results placed at the given lodash paths.
+ */
 export declare class Multicaller {
     network: Network;
     provider: ethers.Signer;
@@ -13,4 +24,13 @@ export declare class Multicaller {
     execute(from?: any): Promise<any>;
 }
 export declare const isSdkOptionsBoolean: (sdkOptions: SDKOptions) => sdkOptions is boolean;
+/**
+ * Central executor for SDK transactions. Routes a (`to`, `data`, `txOptions`) tuple
+ * through one of four paths depending on `pool.isDhedge` and `sdkOptions`:
+ *   - dHEDGE pool:    `pool.poolLogic.execTransaction(...)` (or its gas estimate)
+ *   - non-dHEDGE/EOA: `pool.signer.sendTransaction(...)` (or its gas estimate)
+ * Honours `sdkOptions.onlyGetTxData` (returns the encoded tx without sending),
+ * `estimateGas` (returns gas + minAmountOut without sending), and
+ * `useTraderAddressAsFrom` (forces the EOA path even for dHEDGE pools).
+ */
 export declare const getPoolTxOrGasEstimate: (pool: Pool, args: any[], sdkOptions: SDKOptions) => Promise<any>;