@dhedge/v2-sdk 1.9.6 → 1.9.8

package/README.md

@@ -9,27 +9,76 @@
 - Easy-to-use functions to trade assets, provide liquidity or stake assets
 - Useful for creating automated trading bots
 - Use in your Javascript or Typescript project with full Typescript source
+- All protocols and networks of [dHEDGE App](https://dhedge.org/management/create) are supported
 
 ## Installation
 
 ### Node
 
-```
+```bash
 npm install @dhedge/v2-sdk
 ```
 
 ### Yarn
 
-```
+```bash
 yarn add @dhedge/v2-sdk
 ```
 
 ## Usage
 
+### Table of Contents
+
+  <ol>
+    <li>
+      <a href="#initial-setup">Initial setup</a>
+    </li>
+      <li>
+        <a href="#general-pool-management">General Pool Management</a>
+        <ul>
+          <li><a href="#1-create-pool">Create pool</a></li>
+          <li><a href="#2-load-pool">Load pool</a></li>
+          <li><a href="#3-get-pool-composition">Get pool composition</a></li>
+          <li><a href="#4-change-pool-assets-enabledisable">Change pool assets</a></li>
+          <li><a href="#5-set-trader">Set trader</a></li>
+          <li><a href="#6-approve-asset-for-deposit">Approve asset for deposit</a></li>
+          <li><a href="#7-deposit-asset-into-pool">Deposit asset into pool</a></li>
+          <li><a href="#8-withdraw-from-pool">Withdraw from pool</a></li>
+          <li><a href="#9-approve-pool-asset-for-trading--staking)">Approve pool asset for trading & staking</a></li>
+          <li><a href="#10-trade-pool-assets">Trade pool assets</a></li>
+        </ul>
+    </li>
+    <li>
+       <a href="#liquidity">Liquidity</a>
+        <ul>
+            <li>
+              <a href="#uniswap-v2-style">Uniswap-v2 style protocols </a>
+            </li>
+           <li>
+              <a href="#balancer">Balancer</a>
+            </li>
+            <li>
+              <a href="#uniswap-v3-style">Uniswap-v3 style protocols</a>
+            </li>
+            <li>
+              <a href="#velodromev2--ramses">VelodromeV2 / Ramses / Aerodrome</a>
+            </li>
+        </ul>
+    </li>
+    <li>
+      <a href="#lendingborrowing-aave">Lending/Borrowing Aave</a>
+    </li>
+
+  </ol>
+
+<br>
+
 ### Initial setup
 
+---
+
 If you want to use 1Inch to trade pool assets you need to apply for an API key at [1Inch Dev Portal](https://docs.1inch.io/docs/aggregation-protocol/introduction).
-Then you need to copy .env.example file to .env and set your url there.
+Then you need to copy .env.example file to .env and set your API key there.
 
 ```
 ONEINCH_API_KEY=YOUR_API_KEY_FROM_1INCH
@@ -37,7 +86,7 @@ ONEINCH_API_KEY=YOUR_API_KEY_FROM_1INCH
 
 Initialize the sdk with an [ethers wallet](https://docs.ethers.io/v5/api/signer/#Wallet) and the network.
 
-```
+```ts
 import { Dhedge, Dapp, Network, ethers } from "@dhedge/v2-sdk";
 
 const privateKey = "YOUR_PRIVATE_KEY";
@@ -49,13 +98,17 @@ const walletWithProvider = new ethers.Wallet(privateKey, provider);
 const dhedge = new Dhedge(walletWithProvider, Network.POLYGON);
 ```
 
-### Create pool
+<br>
+
+### General Pool Management
 
-Create a pool.
+---
+
+#### 1. Create a pool
 
 USDC and DAI enabled assets, but only USDC available for deposit.
 
-```
+```ts
 const usdcTokenAddress = "USDC_TOKEN_ADDRESS"
 const daiTokenAddress = "DAI_TOKEN_ADDRESS"
 const pool = await dhedge.createPool(
@@ -71,24 +124,24 @@ const pool = await dhedge.createPool(
 console.log("created pool with address", pool.address)
 ```
 
-### Load pool
+#### 2. Load pool
 
-```
+```ts
 const poolAddress = "YOUR_POOL_ADDRESS"
 const pool = await dhedge.loadPool(poolAddress)
 ```
 
-### Get pool composition
+#### 3. Get pool composition
 
-```
+```ts
 const composition = await pool.getComposition();
 ```
 
-### Change pool assets (enable/disable)
+#### 4. Change pool assets (enable/disable)
 
 Change pool assets to allow DAI for deposits. Also enable WETH as an asset, but shouldn't be allowed as deposit.
 
-```
+```ts
 const enabledAssets = [
   { asset: "USDC_TOKEN_ADDRESS", isDeposit: true },
   { asset: "DAI_TOKEN_ADDRESS", isDeposit: true },
@@ -97,49 +150,49 @@ const enabledAssets = [
 const tx = await pool.changeAssets(enabledAssets)
 ```
 
-### Set trader
+#### 5. Set trader
 
 Set an account with trading permissions
 
-```
+```ts
 const tx = await pool.setTrader("TRADER_ACCOUNT_ADDRESS")
 ```
 
-### Approve asset for deposit
+#### 6. Approve asset for deposit
 
 Before depositing an asset into a Pool, it needs to be approved.
 
 Approve unlimited amount of USDC to deposit into Pool.
 
-```
+```ts
 const tx = await pool.approveDeposit("USDC_TOKEN_ADDRESS", ethers.constants.MaxUint256);
 ```
 
-### Deposit asset into pool
+#### 7. Deposit asset into pool
 
 Deposit 1 USDC into Pool
 
-```
+```ts
 const usdcDepositAmount = "100000"
 const tx = await pool.deposit("USDC_TOKEN_ADDRESS", usdcDepositAmount);
 ```
 
-### Withdraw from pool
+#### 8. Withdraw from pool
 
 Withdraw 1.00002975 pool tokens. Note that this cannot be called if set as Trader account
 
-```
+```ts
 const poolTokensWithdrawAmount = "1000029750000000000"
 const tx = await pool.withdraw(poolTokensWithdrawAmount);
 ```
 
-### Approve pool asset for trading & staking
+#### 9. Approve pool asset for trading & staking
 
 Before trading an asset on platforms like Sushiswap it needs to be approved.
 
 Approve unlimited amount of USDC to trade on Sushiswap
 
-```
+```ts
 const tx = await pool.approve(
   Dapp.SUSHISWAP,
   "USDC_TOKEN_ADDRESS",
@@ -147,11 +200,11 @@ const tx = await pool.approve(
 )
 ```
 
-### Trade pool assets
+#### 10. Trade pool assets
 
-Trade 1 USDC into DAI on Sushiswap (other options: QUICKSWAP, BALANCER, or ONEINCH)
+Trade 1 USDC into DAI on Sushiswap (other options: TOROS, QUICKSWAP, BALANCER, or ONEINCH)
 
-```
+```ts
 const amountIn = "1000000"
 const slippage = 0.5
 const tx = await pool.trade(
@@ -165,9 +218,15 @@ const tx = await pool.trade(
 
 ### Liquidity
 
-Add USDC/DAI into a Sushiswap liquidity pool
+---
 
-```
+#### Uniswap-v2 style
+
+For Uniswap-v2 like protocols, such as sushiswap, we use `addLiquidity`, `removeLiquidity`, `stake`, and `unstake`, and `harvestRewards`
+
+1. Add USDC/DAI into a Sushiswap liquidity pool
+
+```ts
 const amountUsdc = "1000000"
 const amountDai = "997085"
 const tx = await pool.addLiquidity(
@@ -179,9 +238,9 @@ const tx = await pool.addLiquidity(
 )
 ```
 
-Remove USDC/DAI worth of 1 Sushiswap LP from the liquidity pool
+2. Remove USDC/DAI worth of 1 Sushiswap LP from the liquidity pool
 
-```
+```ts
 const amountSlpUsdcDai = "1000000000000000000"
 const tx = await pool.removeLiquidity(
   Dapp.SUSHISWAP,
@@ -191,33 +250,9 @@ const tx = await pool.removeLiquidity(
 )
 ```
 
-Add 0.00002 WBTC, 1 USDC and 0.0002 WETH to a WBTC/USDC/WETH Balancer pool
-
-```
-const balancerPoolId = "0x03cd191f589d12b0582a99808cf19851e468e6b500010000000000000000000a"
-const assets = [WBTC_TOKEN_ADDRESS, USDC_TOKEN_ADDRESS, WETH_TOKEN_ADDRESS];
-const amounts = ["2000", "1000000", "200000000000000"];
-const tx = await pool.joinBalancerPool(balancerPoolId, assets, amounts)
-```
-
-Remove all tokens from WBTC/USDC/WETH Balancer pool
-
-```
-const amount = await dhedge.utils.getBalance(BALANCER_LP_TOKEN_ADDRESS, pool.address)
-const tx = await pool.exitBalancerPool(balancerPoolId, assets, amount)
-```
-
-Harvest rewards from Balancer
+3. Approve unlimited amound of SLP USDC-DAI token for staking on Sushiswap
 
-```
-const tx = await pool.harvestBalancerRewards()
-```
-
-### Staking
-
-Approve unlimited amound of SLP USDC-DAI token for staking on Sushiswap
-
-```
+```ts
 const tx = await pool.approveStaking(
   Dapp.SUSHISWAP,
   "SLP_USDC_DAI_TOKEN_ADDRESS",
@@ -225,9 +260,9 @@ const tx = await pool.approveStaking(
 )
 ```
 
-Stake 1 Sushiswap LP USDC/DAI token
+4. Stake 1 Sushiswap LP USDC/DAI token
 
-```
+```ts
 const amountSlpUsdcDai = "1000000000000000000"
 const tx = await pool.stake(
   Dapp.SUSHISWAP,
@@ -236,9 +271,9 @@ const tx = await pool.stake(
 )
 ```
 
-Unstake 1 Sushiswap LP USDC/DAI token
+5. Unstake 1 Sushiswap LP USDC/DAI token
 
-```
+```ts
 const amountSlpUsdcDai = "1000000000000000000"
 const tx = await pool.unstake(
   Dapp.SUSHISWAP,
@@ -247,46 +282,148 @@ const tx = await pool.unstake(
 )
 ```
 
-Harvest rewards from staked Sushiswap LP USDC/DAI tokens
+6. Harvest rewards from staked Sushiswap LP USDC/DAI tokens
 
-```
+```ts
 const tx = await pool.harvestRewards(
   Dapp.SUSHISWAP,
   "SLP_USDC_DAI_TOKEN_ADDRESS"
 )
 ```
 
-### Lending/Borrowing Aave
+#### Balancer
+
+For Balancer, we use `joinBalancerPool`, `exitBalancerPool`, and `harvestBalancerRewards`
 
-Deposit 1 USDC into Aave lending pool
+1. Add 0.00002 WBTC, 1 USDC and 0.0002 WETH to a WBTC/USDC/WETH Balancer pool
 
+```ts
+const balancerPoolId = "0x03cd191f589d12b0582a99808cf19851e468e6b500010000000000000000000a"
+const assets = [WBTC_TOKEN_ADDRESS, USDC_TOKEN_ADDRESS, WETH_TOKEN_ADDRESS];
+const amounts = ["2000", "1000000", "200000000000000"];
+const tx = await pool.joinBalancerPool(balancerPoolId, assets, amounts)
 ```
-const tx = await pool.lend(Dapp.AAVE, USDC_TOKEN_ADDRESS, "1000000")
+
+2. Remove all tokens from WBTC/USDC/WETH Balancer pool
+
+```ts
+const amount = await dhedge.utils.getBalance(BALANCER_LP_TOKEN_ADDRESS, pool.address)
+const tx = await pool.exitBalancerPool(balancerPoolId, assets, amount)
 ```
 
-Withdraw 1 USDC from Aave lending pool
+3. Harvest rewards from Balancer
 
+```ts
+const tx = await pool.harvestBalancerRewards()
 ```
-const tx = await pool.withdrawDeposit(Dapp.AAVE, USDC_TOKEN_ADDRESS, "1000000")
+
+#### Uniswap-v3 style
+
+For Arrakis, we use `increaseLiquidity` to stake or increase lp, and `decreaseLiquidity`, and `claimFees`. see example in the [arrakis test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/arrakis.test.ts)
+
+---
+
+For Uniswap v3, we use `approveUniswapV3Liquidity`, `addLiquidityUniswapV3`, `decreaseLiquidity`, `increaseLiquidity`, and `claimFees`.
+
+1. Add liquidity of 100 USDC and 0.00043 WETH to a UniswapV3 pool (here price range is used)
+
+```ts
+
+await pool.approveUniswapV3Liquidity(
+  USDC_ADDRESS,
+  ethers.constants.MaxInt256
+);
+await pool.approveUniswapV3Liquidity(
+  WETH_ADDRESS,
+  ethers.constants.MaxInt256
+);
+const tx = await pool.addLiquidityUniswapV3(
+  WETH_ADDRESS
+  USDC_ADDRESS,
+  '430000000000000', // wethBalance
+  '100000000',     // usdcBalance
+  2000,
+  3000,
+  null,
+  null,
+  FeeAmount.MEDIUM,
+)
 ```
 
-Borrow 0.0001 WETH from Aave lending pool
+2. Remove 50% liquidity from the existing pool
 
+```ts
+tokenId = await nonfungiblePositionManager.tokenOfOwnerByIndex(pool.address,0).toString();
+const tx = await pool.decreaseLiquidity(
+  Dapp.UNISWAPV3,
+  tokenId,
+  50 // precent
+);
 ```
-const tx = await pool.borrow(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
+
+3. Increase liquidity in the existing WETH/USDC pool
+
+```ts
+const result = await pool.increaseLiquidity(
+  Dapp.UNISWAPV3,
+  tokenId,
+  new BigNumber(3000).times(1e6).toFixed(0), // usdc
+  new BigNumber(1).times(1e18).toFixed(0) // eth
+);
 ```
 
-Repay 0.0001 WETH to Aave lending pool
+4. Claim fees
 
+```ts
+const tx = await pool.claimFees(Dapp.UNISWAPV3, tokenId);
 ```
-const tx = await pool.repay(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
+
+#### VelodromeV2 / Ramses / Aerodrome
+
+For VelodromeV2 / Ramses / Aerodrome , we use `addLiquidityV2`, `stakeInGauge`, `unstakeFromGauge`, `removeLiquidityV2`, and `claimFees`.
+
+Add liquidity of 100 USDC and 0.00043 WETH to USDC/WETH Ramses pool
+(for Velodrome just use Dapp.VELODROMEV2, for Aerodrome Dapp.AERODROME). see example in the [arrakis test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/ramses.test.ts), [velodromeV2 test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/velodromeV2.test.ts) and [aerdodrome test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/aerdodrome.test.ts)
+
+```ts
+const tx = await pool.addLiquidityV2(
+  Dapp.RAMSES,
+  USDC_ADDRESS,
+  WETH_ADDRESS,
+  '10000000',
+  '430000000000000',
+  false
+)
 ```
 
-Harvest rewards from Aave
+<br>
 
+### Lending/Borrowing Aave
+
+---
+
+For Aave, we use `lend`, `withdrawDeposit`, `borrow` and `repay`
+
+##### 1. Deposit 1 USDC into Aave lending pool
+
+```ts
+const tx = await pool.lend(Dapp.AAVE, USDC_TOKEN_ADDRESS, "1000000")
 ```
-const tx = await pool.harvestAaveRewards([
-    AAVE_USDC_ADDRESS,
-    AAVE_WETH_DEBT_ADDRESS
-  ]);
+
+##### 2. Withdraw 1 USDC from Aave lending pool
+
+```ts
+const tx = await pool.withdrawDeposit(Dapp.AAVE, USDC_TOKEN_ADDRESS, "1000000")
+```
+
+##### 3. Borrow 0.0001 WETH from Aave lending pool
+
+```ts
+const tx = await pool.borrow(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
+```
+
+##### 4. Repay 0.0001 WETH to Aave lending pool
+
+```ts
+const tx = await pool.repay(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
 ```

package/dist/entities/pool.d.ts

@@ -21,24 +21,27 @@ export declare class Pool {
      * @param {string} nasset Address of deposit asset
      * @param {BigNumber | string} amount Amount to be approved
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    approveDeposit(asset: string, amount: BigNumber | string, options?: any): Promise<any>;
+    approveDeposit(asset: string, amount: BigNumber | string, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Deposit  asset into a pool
      * @param {string} asset Address of asset
      * @param {BigNumber | string} amount Amount to be deposited
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    deposit(asset: string, amount: string | BigNumber, options?: any): Promise<any>;
+    deposit(asset: string, amount: string | BigNumber, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Withdraw  assets from a pool
      * @param fundTokenAmount Amount of pool tokens to be withdrawn
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    withdraw(fundTokenAmount: string | BigNumber, options?: any): Promise<any>;
+    withdraw(fundTokenAmount: string | BigNumber, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Approve the asset for trading and providing liquidity
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
@@ -208,16 +211,18 @@ export declare class Pool {
      * Change enabled pool assets
      * @param {AssetEnabled[]} assets New pool assets
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    changeAssets(assets: AssetEnabled[], options?: any): Promise<any>;
+    changeAssets(assets: AssetEnabled[], options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Set a new trader with trading permissions
      * @param {string} trader Address trader account
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    setTrader(trader: string, options?: any): Promise<any>;
+    setTrader(trader: string, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Invest into a Balancer pool
      * @param {string} poolId Balancer pool id
@@ -363,7 +368,7 @@ export declare class Pool {
     removeLiquidityVelodromeV2(assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Add liquidity to Velodrome V2 or Ramses pool
-     * @param {Dapp} dapp VelodromeV2 or Ramses
+     * @param {Dapp} dapp VelodromeV2, Ramses or Aerodrome
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amountA Amount first asset
@@ -373,10 +378,10 @@ export declare class Pool {
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    addLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, isStable: boolean, options?: any, estimateGas?: boolean): Promise<any>;
+    addLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, isStable: boolean, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Remove liquidity from Velodrome V2 or Ramses pool
-     * @param {Dapp} dapp VelodromeV2 or Ramses
+     * @param {Dapp} dapp VelodromeV2, Ramses or Aerodrome
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amount Amount of LP tokens
@@ -385,7 +390,7 @@ export declare class Pool {
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    removeLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES, assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, estimateGas?: boolean): Promise<any>;
+    removeLiquidityV2(dapp: Dapp.VELODROMEV2 | Dapp.RAMSES | Dapp.AERODROME, assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Trade options on lyra
      * @param {LyraOptionMarket} market Underlying market e.g. eth
@@ -436,9 +441,10 @@ export declare class Pool {
     /**
      * mintManagerFee
      * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    mintManagerFee(options?: any): Promise<any>;
+    mintManagerFee(options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * getAvailableManagerFee
      * @returns {Promise<BigNumber>} fee

package/dist/test/constants.d.ts

@@ -27,6 +27,10 @@ export declare const CONTRACT_ADDRESS: {
         WBTC: string;
         ARRAKIS_USDC_WETH_GAUGE: string;
         ARRAKIS_USDC_WETH_LP: string;
+        WMATIC: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
     };
     optimism: {
         USDC: string;
@@ -35,6 +39,12 @@ export declare const CONTRACT_ADDRESS: {
         WETH: string;
         WBTC: string;
         KWENTA_ETH_PERP_V2: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
+        WMATIC: string;
+        ARRAKIS_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_LP: string;
     };
     arbitrum: {
         USDC: string;
@@ -44,12 +54,24 @@ export declare const CONTRACT_ADDRESS: {
         WSTETH: string;
         BALANCER_WSTETH_WETH_POOL: string;
         BALANCER_WSTETH_WETH_GAUGE: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
+        ARRAKIS_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_LP: string;
+        WMATIC: string;
     };
     base: {
         USDC: string;
         WETH: string;
         WBTC: string;
         SWETH: string;
+        uniswapV3: {
+            nonfungiblePositionManager: string;
+        };
+        ARRAKIS_USDC_WETH_GAUGE: string;
+        ARRAKIS_USDC_WETH_LP: string;
+        WMATIC: string;
     };
 };
 export declare const MAX_AMOUNT: ethers.BigNumber;

package/dist/types.d.ts

@@ -21,7 +21,8 @@ export declare enum Dapp {
     VELODROMEV2 = "velodromeV2",
     LYRA = "lyra",
     ZEROEX = "0x",
-    RAMSES = "ramses"
+    RAMSES = "ramses",
+    AERODROME = "aerodrome"
 }
 export declare enum Transaction {
     SWAP = "swapExactTokensForTokens",