@dhedge/v2-sdk 1.10.4 → 1.10.6

package/README.md

@@ -216,6 +216,26 @@ const tx = await pool.trade(
 )
 ```
 
+#### 🚨 Important Update  
+Due to the upgrade of our contract, trading out of a Toros token now involves a second step. Please follow the updated process below:
+1. Step:
+```ts
+const tx = await pool.trade(
+  Dapp.TOROS,
+  "TOROS_TOKEN_ADDRESS",
+  "USDC_TOKEN_ADDRESS",
+  '100000000',
+  slippage
+)
+```
+2. Step:
+```ts
+const tx = await pool.completeTorosWithdrawal(
+  "USDC_TOKEN_ADDRESS",
+  slippage
+)
+```
+
 ### Liquidity
 
 ---
@@ -361,6 +381,9 @@ const tx = await pool.decreaseLiquidity(
 );
 ```
 
+Removing 100% will burn the NFT position.
+Burning a Ramses CL NFT position won't claim rewards, so `getRewards` needs to be called before.
+
 3. Increase liquidity in the existing WETH/USDC pool
 
 ```ts
@@ -378,6 +401,12 @@ const result = await pool.increaseLiquidity(
 const tx = await pool.claimFees(Dapp.UNISWAPV3, tokenId);
 ```
 
+4. Claim rewards (e.g. for Ramses CL)
+
+```ts
+const tx = await pool.getRewards(Dapp.RAMSESCL, tokenId, [RAM_ADDRESS]);
+```
+
 #### VelodromeV2 / Ramses / Aerodrome
 
 For VelodromeV2 / Ramses / Aerodrome , we use `addLiquidityV2`, `stakeInGauge`, `unstakeFromGauge`, `removeLiquidityV2`, and `claimFees`.

package/dist/entities/pool.d.ts

@@ -292,7 +292,7 @@ export declare class Pool {
     harvestAaveV3Rewards(assets: string[], rewardAsset: string, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Create UniswapV3 liquidity pool
-     * @param {dapp} Platform UniswapV3, VelodromeCL or AerodromeCL
+     * @param {dapp} Platform UniswapV3, VelodromeCL, AerodromeCL or RamesesCL
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amountA Amount first asset
@@ -306,7 +306,7 @@ export declare class Pool {
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    addLiquidityUniswapV3(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL, 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, estimateGas?: boolean): Promise<any>;
+    addLiquidityUniswapV3(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL, 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, estimateGas?: boolean): Promise<any>;
     /**
      * Remove liquidity from an UniswapV3 or Arrakis liquidity pool
      * @param {Dapp} dapp Platform either UniswapV3 or Arrakis
@@ -337,6 +337,16 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     claimFees(dapp: Dapp, tokenId: string, options?: any, estimateGas?: boolean): 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 {boolean} estimateGas Simulate/estimate gas
+     * @returns {Promise<any>} Transaction
+     */
+    getRewards(dapp: Dapp, tokenId: string, rewards: string[], options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Trade an asset into another asset
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
@@ -519,4 +529,13 @@ export declare class Pool {
      */
     redeemUnitViaFlatMoney(withdrawAmount: ethers.BigNumber | string, slippage: number | undefined, maxKeeperFeeInUsd: number | null, options?: any, estimateGas?: boolean): Promise<any>;
     cancelOrderViaFlatMoney(options?: any, estimateGas?: boolean): Promise<any>;
+    /**
+     * Complete a Toros withdrawal to a single asset
+     * @param {string} destinationToken Address of destination asset
+     * @param {number} slippage Slippage tolerance in %
+     * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
+     * @returns {Promise<any>} Transaction
+     */
+    completeTorosWithdrawal(destinationToken: string, slippage?: number, options?: any, estimateGas?: boolean): Promise<any>;
 }

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

@@ -1,3 +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): Promise<string>;
+export declare function getOneInchSwapTxData(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber | string, slippage: number, forEasySwapper?: boolean): Promise<{
+    swapTxData: string;
+    dstAmount: string;
+}>;

package/dist/services/ramses/vesting.d.ts

@@ -1,3 +1,4 @@
 import { BigNumber } from "ethers";
 export declare function getCreateVestTxData(amount: BigNumber | string): string;
 export declare function getExitVestTxData(vestId: number): string;
+export declare function getRewardsTxDta(tokenId: string, rewards: string[]): string;

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

@@ -2,6 +2,7 @@ import { ethers } from "ethers";
 import { Pool } from "../..";
 export declare function getPoolDepositAsset(pool: Pool, poolAddress: string, investAsset: string): Promise<string | undefined>;
 export declare function getTorosPoolTokenPrice(pool: Pool, poolAddress: string): Promise<ethers.BigNumber>;
-export declare function getEasySwapperDepositQuote(pool: Pool, torosAsset: string, investAsset: string, depositAsset: string, amountIn: ethers.BigNumber): Promise<ethers.BigNumber>;
+export declare function getEasySwapperDepositQuote(pool: Pool, torosAsset: string, investAsset: string, amountIn: ethers.BigNumber): Promise<ethers.BigNumber>;
 export declare function getEasySwapperWithdrawalQuote(pool: Pool, torosAsset: string, investAsset: string, amountIn: ethers.BigNumber): Promise<ethers.BigNumber>;
 export declare function getEasySwapperTxData(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber, slippage: number): Promise<any>;
+export declare function getCompleteWithdrawalTxData(pool: Pool, destToken: string, slippage: number): 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, 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, tokenId: string, pool: Pool): Promise<BigNumber>;
+export declare function getUniswapV3MintTxData(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL, 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, 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): Promise<any>;

package/dist/test/constants.d.ts

@@ -23,6 +23,7 @@ export declare const CONTRACT_ADDRESS: {
     polygon: {
         USDC: string;
         USDT: string;
+        SUSD: string;
         SWETH: string;
         WETH: string;
         WBTC: string;
@@ -35,6 +36,7 @@ export declare const CONTRACT_ADDRESS: {
         VELODROME_CL_USDC_WETH_GAUGE: string;
         VELO: string;
         COMPOUNDV3_WETH: string;
+        TOROS: string;
     };
     optimism: {
         USDC: string;
@@ -53,10 +55,12 @@ export declare const CONTRACT_ADDRESS: {
         VELODROME_CL_USDC_WETH_GAUGE: string;
         VELO: string;
         COMPOUNDV3_WETH: string;
+        TOROS: string;
     };
     arbitrum: {
         USDC: string;
         USDT: string;
+        SUSD: string;
         SWETH: string;
         WETH: string;
         WBTC: string;
@@ -72,10 +76,12 @@ export declare const CONTRACT_ADDRESS: {
         VELODROME_CL_USDC_WETH_GAUGE: string;
         VELO: string;
         COMPOUNDV3_WETH: string;
+        TOROS: string;
     };
     base: {
         USDC: string;
         USDT: string;
+        SUSD: string;
         WETH: string;
         WBTC: string;
         SWETH: string;
@@ -88,6 +94,7 @@ export declare const CONTRACT_ADDRESS: {
         VELODROME_CL_USDC_WETH_GAUGE: string;
         VELO: string;
         COMPOUNDV3_WETH: string;
+        TOROS: string;
     };
 };
 export declare const MAX_AMOUNT: ethers.BigNumber;

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

@@ -1,4 +1,3 @@
-/// <reference types="jest" />
 import { ethers } from "ethers";
 import { Network } from "../../types";
 import { Pool } from "../../entities";

package/dist/types.d.ts

@@ -24,7 +24,8 @@ export declare enum Dapp {
     ZEROEX = "0x",
     RAMSES = "ramses",
     AERODROME = "aerodrome",
-    AERODROMECL = "aerodromeCL"
+    AERODROMECL = "aerodromeCL",
+    RAMSESCL = "ramsesCL"
 }
 export declare enum Transaction {
     SWAP = "swapExactTokensForTokens",