@dhedge/v2-sdk 1.9.7 → 1.9.9

package/README.md

@@ -61,7 +61,7 @@ yarn add @dhedge/v2-sdk
               <a href="#uniswap-v3-style">Uniswap-v3 style protocols</a>
             </li>
             <li>
-              <a href="#velodromev2--ramses">VelodromeV2 / Ramses</a>
+              <a href="#velodromev2--ramses">VelodromeV2 / Ramses / Aerodrome</a>
             </li>
         </ul>
     </li>
@@ -378,12 +378,12 @@ const result = await pool.increaseLiquidity(
 const tx = await pool.claimFees(Dapp.UNISWAPV3, tokenId);
 ```
 
-#### VelodromeV2 / Ramses
+#### VelodromeV2 / Ramses / Aerodrome
 
-For VelodromeV2 / Ramses, we use `addLiquidityV2`, `stakeInGauge`, `unstakeFromGauge`, `removeLiquidityV2`, and `claimFees`.
+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). see example in the [arrakis test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/ramses.test.ts) and [velodromeV2 test](https://github.com/dhedge/dhedge-v2-sdk/blob/master/src/test/velodromeV2.test.ts)
+(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(
@@ -427,3 +427,37 @@ const tx = await pool.borrow(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
 ```ts
 const tx = await pool.repay(Dapp.AAVE, WETH_TOKEN_ADDRESS, "100000000000000");
 ```
+
+<br>
+
+### The Flat Money Protocol
+
+---
+
+##### 1. Minting UNIT : deposit 1 rETH to mint UNIT
+
+```ts
+      const depositAmount = new BigNumber(1).times(1e18).toString();
+      const tx = await pool.mintUnitViaFlatMoney(
+        depositAmount,
+        0.5,  // slippage, 0.5%
+        5,  // maxKeeperFeeInUsd, $5
+      );
+```
+
+##### 2. Redeeming UNIT : Redeem 1 UNIT for rETH
+
+```ts
+      const withdrawAmount = new BigNumber(1).times(1e18).toString();
+      const tx = await pool.redeemUnitViaFlatMoney(
+        withdrawAmount,
+        0.5,  // slippage, 0.5%
+        5, // maxKeeperFeeInUsd, $5
+      );
+```
+
+##### 3. Cancel announced order
+
+```ts
+      await pool.cancelOrderViaFlatMoney();
+```

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import { AddressNetworkMap, AddressDappNetworkMap, LyraNetworkMap } from "./types";
+import { AddressNetworkMap, Network, AddressDappNetworkMap, LyraNetworkMap } from "./types";
 import { NetworkChainIdMap } from ".";
 export declare const factoryAddress: AddressNetworkMap;
 export declare const routerAddress: AddressDappNetworkMap;
@@ -13,3 +13,9 @@ export declare const lyraNetworkMap: LyraNetworkMap;
 export declare const MaxUint128 = "0xffffffffffffffffffffffffffffffff";
 export declare const UNISWAPV3_QUOTER_ADDRESS = "0xb27308f9F90D607463bb33eA1BeBb41C27CE5AB6";
 export declare const SYNTHETIX_TRACKING_CODE = "0x4448454447450000000000000000000000000000000000000000000000000000";
+export declare const flatMoneyContractAddresses: Readonly<Partial<Record<Network, {
+    DelayedOrder: string;
+    FlatcoinVault: string;
+    StableModule: string;
+    RETH: string;
+}>>>;

package/dist/entities/pool.d.ts

@@ -1,4 +1,4 @@
-import { Contract, Wallet, BigNumber } from "ethers";
+import { Contract, ethers, Wallet, BigNumber } from "ethers";
 import { Dapp, FundComposition, AssetEnabled, Network, LyraOptionMarket, LyraOptionType, LyraTradeType, LyraPosition } from "../types";
 import { Utils } from "./utils";
 import { FeeAmount } from "@uniswap/v3-sdk";
@@ -368,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
@@ -378,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
@@ -390,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
@@ -468,4 +468,25 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     exitVestedToken(tokenAddress: string, id: number, options?: any, estimateGas?: boolean): Promise<any>;
+    /** deposit rETH to mint UNIT via the Flat Money protocol
+     *
+     * @param { BigNumber | string } depositAmount Amount of rETH to deposit
+     * @param { number } slippage slippage, 0.5 represents 0.5%
+     * @param { number | null } maxKeeperFeeInUsd 5 represents $5; null will skip the maxKeeperFee check
+     * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
+     * @returns {Promise<any>} Transaction
+     */
+    mintUnitViaFlatMoney(depositAmount: ethers.BigNumber | string, slippage: number | undefined, maxKeeperFeeInUsd: number | null, options?: any, estimateGas?: boolean): Promise<any>;
+    /** redeem UNIT via the Flat Money protocol
+     *
+     * @param { BigNumber | string } depositAmount Amount of UNIT to withdraw
+     * @param { number } slippage slippage, 0.5 represents 0.5%
+     * @param { number | null } maxKeeperFeeInUsd 5 represents $5; null will skip the maxKeeperFee check
+     * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
+     * @returns {Promise<any>} Transaction
+     */
+    redeemUnitViaFlatMoney(withdrawAmount: ethers.BigNumber | string, slippage: number | undefined, maxKeeperFeeInUsd: number | null, options?: any, estimateGas?: boolean): Promise<any>;
+    cancelOrderViaFlatMoney(options?: any, estimateGas?: boolean): Promise<any>;
 }

package/dist/services/flatmoney/keeperFee.d.ts

@@ -0,0 +1,6 @@
+import { Contract, ethers } from "ethers";
+import { Pool } from "../../entities";
+import BigNumber from "bignumber.js";
+export declare const getKeeperFeeContract: (pool: Pool) => Promise<Contract>;
+export declare const getKeeperFee: (pool: Pool, maxKeeperFeeInUsd: number | null) => Promise<ethers.BigNumber>;
+export declare const getKeeperFeeInUsd: (pool: Pool, keeperFee: ethers.BigNumber) => Promise<BigNumber>;

package/dist/services/flatmoney/stableLp.d.ts

@@ -0,0 +1,9 @@
+import { Pool, ethers } from "../..";
+export declare function getAnnounceStableDepositTxData(depositAmount: ethers.BigNumber | string, minAmountOut: ethers.BigNumber | string, keeperFee: ethers.BigNumber | string): string;
+export declare function getAnnounceStableWithdrawTxData(withdrawAmount: ethers.BigNumber | string, minAmountOut: ethers.BigNumber | string, keeperFee: ethers.BigNumber | string): string;
+export declare function getCancelExistingOrderTxData(account: string): string;
+export declare function mintUnitViaFlatMoney(pool: Pool, depositAmount: ethers.BigNumber | string, slippage: number, // 0.5 means 0.5%
+maxKeeperFeeInUsd: number | null, options?: any, estimateGas?: boolean): Promise<any>;
+export declare function redeemUnitViaFlatMoney(pool: Pool, withdrawAmount: ethers.BigNumber | string, slippage: number, // 0.5 means 0.5%
+maxKeeperFeeInUsd: number | null, options?: any, estimateGas?: boolean): Promise<any>;
+export declare function cancelOrderViaFlatMoney(pool: Pool, options?: any, estimateGas?: boolean): Promise<any>;

package/dist/services/flatmoney/stableModule.d.ts

@@ -0,0 +1,4 @@
+import { BigNumber } from "ethers";
+import { Pool } from "../../entities";
+export declare const getStableDepositQuote: (pool: Pool, depositAmount: string | BigNumber) => Promise<BigNumber>;
+export declare const getStableWithdrawQuote: (pool: Pool, withdrawAmount: string | BigNumber) => Promise<BigNumber>;

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

@@ -5,6 +5,7 @@ export declare type TestingRunParams = {
     network: Network;
     wallet: ethers.Wallet;
     provider: ethers.providers.JsonRpcProvider;
+    rpcUrl: string;
 };
 declare type TestHelperParams = {
     testingRun: (testingRunParams: TestingRunParams) => void;
@@ -21,7 +22,7 @@ export declare const setTokenAmount: ({ amount, userAddress, tokenAddress, slot,
     amount: string;
     userAddress: string;
     tokenAddress: string;
-    slot: number;
+    slot: number | string;
     provider: ethers.providers.JsonRpcProvider;
 }) => Promise<void>;
 export declare const setUSDCAmount: ({ provider, userAddress, amount, network }: {

package/dist/test/wallet.d.ts

@@ -10,4 +10,5 @@ export declare const networkPortMap: {
 export declare const getWalletData: (network: Network) => {
     wallet: ethers.Wallet;
     provider: ethers.providers.JsonRpcProvider;
+    rpcUrl: string;
 };

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",