@dhedge/v2-sdk 2.1.8 → 2.2.1

package/src/entities/pool.ts

@@ -7,7 +7,7 @@ import IERC20 from "../abi/IERC20.json";
 import IERC721 from "../abi/IERC721.json";
 import IMiniChefV2 from "../abi/IMiniChefV2.json";
 import ILendingPool from "../abi/ILendingPool.json";
-import ISynthetix from "../abi/ISynthetix.json";
+
 import IUniswapV2Router from "../abi/IUniswapV2Router.json";
 import INonfungiblePositionManager from "../abi/INonfungiblePositionManager.json";
 import IAaveIncentivesController from "../abi/IAaveIncentivesController.json";
@@ -20,7 +20,6 @@ import {
   routerAddress,
   gpv2SettlementAddress,
   stakingAddress,
-  SYNTHETIX_TRACKING_CODE,
   limitOrderAddress
 } from "../config";
 import {
@@ -43,7 +42,7 @@ import {
   getIncreaseLiquidityTxData,
   getUniswapV3MintTxData
 } from "../services/uniswap/V3Liquidity";
-import { getUniswapV3SwapTxData } from "../services/uniswap/V3Trade";
+
 import { getEasySwapperTxData } from "../services/toros/easySwapper";
 import { getAaveV3ClaimTxData } from "../services/aave/incentives";
 import {
@@ -59,17 +58,7 @@ import {
 import { getLyraOptionTxData } from "../services/lyra/trade";
 import { getOptionPositions } from "../services/lyra/positions";
 import { getDeadline } from "../utils/deadline";
-import {
-  getFuturesChangeMarginTxData,
-  getFuturesChangePositionTxData
-} from "../services/futures";
-import { getFuturesCancelOrderTxData } from "../services/futures/trade";
 import { getOneInchSwapTxData } from "../services/oneInch";
-import {
-  getCreateVestTxData,
-  getExitVestTxData,
-  getRewardsTxDta
-} from "../services/ramses/vesting";
 import { getPoolTxOrGasEstimate, isSdkOptionsBoolean } from "../utils/contract";
 import {
   cancelOrderViaFlatMoney,
@@ -98,6 +87,7 @@ import {
 } from "../services/toros/limitOrder";
 import { getKyberSwapTxData } from "../services/kyberSwap";
 import { getCowSwapTxData } from "../services/cowSwap";
+import { getOndoSwapTxData } from "../services/ondo";
 import {
   getClosePositionHyperliquidTxData,
   getDepositHyperliquidTxData,
@@ -164,7 +154,7 @@ export class Pool {
 
   /**
    * 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
@@ -264,7 +254,7 @@ export 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
@@ -292,10 +282,10 @@ export 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
+   * 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
@@ -426,20 +416,6 @@ export class Pool {
           slippage
         );
         break;
-      case Dapp.SYNTHETIX:
-        const iSynthetix = new ethers.utils.Interface(ISynthetix.abi);
-        const assets = [assetFrom, assetTo].map(asset =>
-          ethers.utils.formatBytes32String(asset)
-        );
-        const daoAddress = await this.factory.owner();
-        swapTxData = iSynthetix.encodeFunctionData(Transaction.SWAP_SYNTHS, [
-          assets[0],
-          amountIn,
-          assets[1],
-          daoAddress,
-          SYNTHETIX_TRACKING_CODE
-        ]);
-        break;
       case Dapp.TOROS:
         swapTxData = await getEasySwapperTxData(
           this,
@@ -476,6 +452,15 @@ export class Pool {
           slippage
         ));
         break;
+      case Dapp.ONDO:
+        ({ swapTxData, minAmountOut } = await getOndoSwapTxData(
+          this,
+          assetFrom,
+          assetTo,
+          amountIn.toString(),
+          slippage
+        ));
+        break;
       case Dapp.COWSWAP: {
         const cowSwapEstimateGas = isSdkOptionsBoolean(sdkOptions)
           ? sdkOptions
@@ -696,7 +681,6 @@ export class Pool {
         ]);
         break;
       case Dapp.VELODROME:
-      case Dapp.RAMSES:
         stakeTxData = getVelodromeStakeTxData(amount, false);
         break;
       case Dapp.VELODROMEV2:
@@ -862,7 +846,7 @@ export class Pool {
   }
 
   /**
-   * 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
@@ -894,7 +878,7 @@ export class Pool {
   }
 
   /**
-   * 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
@@ -1042,9 +1026,25 @@ export class Pool {
       e.asset.toLocaleLowerCase()
     );
     const newAssets = assets.map(e => e.asset.toLocaleLowerCase());
-    const removedAssets = currentAssets.filter(e => !newAssets.includes(e));
+    const candidateRemovals = currentAssets.filter(e => !newAssets.includes(e));
     const changedAssets = assets.map(e => [e.asset, e.isDeposit]);
 
+    // Simulate each removal to filter out assets that can't be removed
+    // (non-zero balance, guard dependency, active order, etc.)
+    const removedAssets: string[] = [];
+    for (const asset of candidateRemovals) {
+      try {
+        await this.managerLogic.callStatic.changeAssets([], [asset]);
+        removedAssets.push(asset);
+      } catch (err) {
+        console.warn(
+          `changeAssets: skipping removal of ${asset} — ${
+            (err as Error).message
+          }`
+        );
+      }
+    }
+
     if (estimateGas) {
       return await this.managerLogic.estimateGas.changeAssets(
         changedAssets,
@@ -1159,11 +1159,11 @@ export class Pool {
   }
 
   /**
-   * 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
@@ -1306,12 +1306,7 @@ export class Pool {
    * @returns {Promise<any>} Transaction
    */
   async addLiquidityUniswapV3(
-    dapp:
-      | Dapp.UNISWAPV3
-      | Dapp.VELODROMECL
-      | Dapp.AERODROMECL
-      | Dapp.RAMSESCL
-      | Dapp.PANCAKECL,
+    dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.PANCAKECL,
     assetA: string,
     assetB: string,
     amountA: BigNumber | string,
@@ -1383,7 +1378,6 @@ export class Pool {
     let txData;
     switch (dapp) {
       case Dapp.UNISWAPV3:
-      case Dapp.RAMSESCL:
         dappAddress = nonfungiblePositionManagerAddress[this.network][dapp];
         break;
       case Dapp.VELODROMECL:
@@ -1450,7 +1444,6 @@ export class Pool {
     let txData;
     switch (dapp) {
       case Dapp.UNISWAPV3:
-      case Dapp.RAMSESCL:
         dappAddress = nonfungiblePositionManagerAddress[this.network][dapp];
         break;
       case Dapp.VELODROMECL:
@@ -1516,7 +1509,6 @@ export class Pool {
     );
     switch (dapp) {
       case Dapp.UNISWAPV3:
-      case Dapp.RAMSESCL:
         contractAddress = nonfungiblePositionManagerAddress[this.network][dapp];
         txData = iNonfungiblePositionManager.encodeFunctionData(
           Transaction.COLLECT,
@@ -1530,7 +1522,6 @@ export class Pool {
         txData = abi.encodeFunctionData("claim_rewards()", []);
         break;
       case Dapp.VELODROME:
-      case Dapp.RAMSES:
         contractAddress = tokenId;
         txData = getVelodromeClaimTxData(this, tokenId, false);
         break;
@@ -1571,75 +1562,6 @@ export class Pool {
     return tx;
   }
 
-  /**
-   * 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
-   */
-  async getRewards(
-    dapp: Dapp,
-    tokenId: string,
-    rewards: string[],
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [
-        nonfungiblePositionManagerAddress[this.network][dapp],
-        getRewardsTxDta(tokenId, rewards),
-        options
-      ],
-      sdkOptions
-    );
-    return tx;
-  }
-
-  /**
-   * 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
-   */
-  async tradeUniswapV3(
-    assetFrom: string,
-    assetTo: string,
-    amountIn: BigNumber | string,
-    feeAmount: number,
-    slippage = 0.5,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const swapxData = await getUniswapV3SwapTxData(
-      this,
-      assetFrom,
-      assetTo,
-      amountIn,
-      slippage,
-      feeAmount
-    );
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [routerAddress[this.network][Dapp.UNISWAPV3], swapxData, options],
-      sdkOptions
-    );
-    return tx;
-  }
-
   /**
    * Add liquidity to Velodrome pool
    * @param {string} assetA First asset
@@ -1799,8 +1721,8 @@ export class Pool {
   }
 
   /**
-   * 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
@@ -1811,7 +1733,7 @@ export class Pool {
    * @returns {Promise<any>} Transaction
    */
   async addLiquidityV2(
-    dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME,
+    dapp: Dapp.VELODROMEV2 | Dapp.AERODROME,
     assetA: string,
     assetB: string,
     amountA: BigNumber | string,
@@ -1842,8 +1764,8 @@ export class Pool {
   }
 
   /**
-   * 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
@@ -1853,7 +1775,7 @@ export class Pool {
    * @returns {Promise<any>} Transaction
    */
   async removeLiquidityV2(
-    dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME,
+    dapp: Dapp.VELODROMEV2 | Dapp.AERODROME,
     assetA: string,
     assetB: string,
     amount: BigNumber | string,
@@ -1939,82 +1861,6 @@ export class Pool {
     return await getOptionPositions(this, market);
   }
 
-  /** 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
-   */
-  async changeFuturesMargin(
-    market: string,
-    changeAmount: BigNumber | string,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [market, getFuturesChangeMarginTxData(changeAmount), options],
-      sdkOptions
-    );
-    return tx;
-  }
-
-  /** 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
-   */
-  async changeFuturesPosition(
-    market: string,
-    changeAmount: BigNumber | string,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const txData = await getFuturesChangePositionTxData(
-      changeAmount,
-      market,
-      this
-    );
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [market, txData, options],
-      sdkOptions
-    );
-    return tx;
-  }
-
-  /** 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
-   */
-  async cancelFuturesOrder(
-    market: string,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const txData = await getFuturesCancelOrderTxData(this);
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [market, txData, options],
-      sdkOptions
-    );
-    return tx;
-  }
-
   /**
    * mintManagerFee
    * @param {any} options Transaction options
@@ -2034,60 +1880,11 @@ export class Pool {
    * @returns {Promise<BigNumber>} fee
    */
   async getAvailableManagerFee(): Promise<BigNumber> {
-    const fee = await this.poolLogic.availableManagerFee();
+    const fundValue = await this.managerLogic.totalFundValue();
+    const fee = await this.poolLogic.calculateAvailableManagerFee(fundValue);
     return BigNumber.from(fee);
   }
 
-  /** 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
-   */
-  async vestTokens(
-    tokenAddress: string,
-    amount: BigNumber | string,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const txData = await getCreateVestTxData(amount);
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [tokenAddress, txData, options],
-      sdkOptions
-    );
-    return tx;
-  }
-
-  /** 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
-   */
-  async exitVestedToken(
-    tokenAddress: string,
-    id: number,
-    options: any = null,
-    sdkOptions: SDKOptions = {
-      estimateGas: false
-    }
-  ): Promise<any> {
-    const txData = await getExitVestTxData(id);
-    const tx = await getPoolTxOrGasEstimate(
-      this,
-      [tokenAddress, txData, options],
-      sdkOptions
-    );
-    return tx;
-  }
-
   /** deposit rETH to mint UNIT via the Flat Money protocol
    *
    * @param { BigNumber | string } depositAmount Amount of rETH to deposit
@@ -2146,6 +1943,12 @@ export class Pool {
     return tx;
   }
 
+  /**
+   * 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
+   */
   async cancelOrderViaFlatMoney(
     options: any = null,
     estimateGas = false

package/src/entities/utils.ts

@@ -199,6 +199,11 @@ export class Utils {
     );
   }
 
+  /**
+   * 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%).
+   */
   async getBalancerSwapTx(
     pool: Pool,
     assetFrom: string,
@@ -275,6 +280,7 @@ export class Utils {
     }
   }
 
+  /** Build calldata to join a Balancer pool by depositing the given asset amounts. */
   async getBalancerJoinPoolTx(
     pool: Pool,
     balancerPoolId: string,
@@ -307,6 +313,11 @@ export class Utils {
     return joinPoolTx;
   }
 
+  /**
+   * 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.
+   */
   async getBalancerExitPoolTx(
     pool: Pool,
     balancerPoolId: string,
@@ -339,10 +350,12 @@ export class Utils {
     return exitPoolTx;
   }
 
+  /** List available expiry timestamps for a Lyra option market. */
   async getLyraOptionExpiries(market: LyraOptionMarket): Promise<number[]> {
     return await getExpiries(this.network, market);
   }
 
+  /** List available strikes for a Lyra option market at a given expiry. */
   async getLyraOptionStrikes(
     market: LyraOptionMarket,
     expiry: number
@@ -350,6 +363,7 @@ export class Utils {
     return await getStrikes(this.network, market, expiry);
   }
 
+  /** Resolve a single Lyra strike by its strike price for a market/expiry. */
   async getLyraOptionStrike(
     market: LyraOptionMarket,
     expiry: number,
@@ -358,6 +372,7 @@ export class Utils {
     return await getStrike(this.network, market, expiry, strike);
   }
 
+  /** Get a Lyra option quote (premium, fees, slippage) for a strike/type/size. */
   async getLyraOptionQuote(
     strike: Strike,
     type: LyraOptionType,

package/src/services/hyperliquid/index.ts

@@ -24,6 +24,7 @@ import { getPositionSize } from "./positionData";
 const depositWallet = new ethers.utils.Interface(ICoreDepositWalletAbi);
 const coreWriter = new ethers.utils.Interface(ICoreWriterAbi);
 
+/** Encode `deposit(amount, dexId)` on the Hyperliquid CoreDepositWallet to bridge USDC into HyperCore. */
 export const getDepositHyperliquidTxData = (
   dexId: number,
   amount: ethers.BigNumber | string
@@ -31,6 +32,11 @@ export const getDepositHyperliquidTxData = (
   return depositWallet.encodeFunctionData("deposit", [amount, dexId]);
 };
 
+/**
+ * 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 const getWithdrawSpotHyperliquidTxData = (
   amount: ethers.BigNumber | string
 ): string => {
@@ -49,6 +55,11 @@ export const getWithdrawSpotHyperliquidTxData = (
   );
   return coreWriter.encodeFunctionData("sendRawAction", [rawTXData]);
 };
+/**
+ * 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 const getSendAssetHyperliquidTxData = (
   sourceDex: number,
   destinationDex: number,
@@ -80,6 +91,11 @@ export const getSendAssetHyperliquidTxData = (
   return coreWriter.encodeFunctionData("sendRawAction", [rawTXData]);
 };
 
+/**
+ * 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 const getLimitOrderHyperliquidTxData = async (
   assetId: number,
   isLong: boolean,
@@ -128,6 +144,12 @@ export const getLimitOrderHyperliquidTxData = async (
   return coreWriter.encodeFunctionData("sendRawAction", [rawTXData]);
 };
 
+/**
+ * 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 const getClosePositionHyperliquidTxData = async (
   assetId: number,
   percentageToClose: number,

package/src/services/kyberSwap/index.ts

@@ -9,7 +9,9 @@ export async function getKyberSwapTxData(
   tokenIn: string,
   tokenOut: string,
   amountIn: ethers.BigNumber | string,
-  slippage: number
+  slippage: number,
+  sender?: string,
+  receiver?: string
 ): Promise<{ swapTxData: string; minAmountOut: string }> {
   const params = {
     tokenIn,
@@ -29,8 +31,8 @@ export async function getKyberSwapTxData(
 
     const buildParams = {
       routeSummary: quoteResult.data.data.routeSummary,
-      sender: pool.address,
-      recipient: pool.address,
+      sender: sender || pool.address,
+      recipient: receiver || pool.address,
       slippageTolerance: slippage * 100 // in basis points
     };