@dhedge/v2-sdk 1.9.8 → 1.10.0

package/README.md

@@ -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,11 +1,11 @@
-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;
 export declare const dappFactoryAddress: AddressDappNetworkMap;
 export declare const stakingAddress: AddressDappNetworkMap;
 export declare const aaveAddressProvider: AddressDappNetworkMap;
-export declare const nonfungiblePositionManagerAddress: AddressNetworkMap;
+export declare const nonfungiblePositionManagerAddress: AddressDappNetworkMap;
 export declare const networkChainIdMap: NetworkChainIdMap;
 export declare const balancerSubgraph: AddressNetworkMap;
 export declare const multiCallAddress: AddressNetworkMap;
@@ -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,7 +1,6 @@
-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";
 export declare class Pool {
     readonly poolLogic: Contract;
     readonly managerLogic: Contract;
@@ -82,6 +81,16 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     approveSpender(spender: string, asset: string, amount: BigNumber | string, options?: any, estimateGas?: boolean): Promise<any>;
+    /**
+     * Approve NFT for provided spender address
+     * @param {string} spender Spender address
+     * @param {string} asset Address of asset
+     * @param {string} tokenId NFT id
+     * @param {any} options Transaction options
+     * @param {boolean} estimateGas Simulate/estimate gas
+     * @returns {Promise<any>} Transaction
+     */
+    approveSpenderNFT(spender: string, asset: string, tokenId: string, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Trade an asset into another asset
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
@@ -131,7 +140,7 @@ export declare class Pool {
      * Stake liquidity pool tokens in gauge contract
      * @param {Dapp} dapp Platform like Balancer or Velodrome
      * @param {string} gauge Gauge contract address
-     * @param {BigNumber | string} amount Amount of liquidity pool tokens
+     * @param {BigNumber | string} amount Amount of liquidity pool tokens or token ID for Velodrome CL
      * @param {any} options Transaction options
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
@@ -150,7 +159,7 @@ export declare class Pool {
     /**
      * Unstake liquidity pool tokens from Velodrome or Balancer gauge
      * @param {string} gauge Gauge contract address
-     * @param {BigNumber | string} amount Amount of liquidity pool tokens
+     * @param {BigNumber | string} amount Amount of liquidity pool tokens or CL token ID
      * @param {any} options Transaction options
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
@@ -263,6 +272,7 @@ export declare class Pool {
     harvestAaveV3Rewards(assets: string[], rewardAsset: string, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Create UniswapV3 liquidity pool
+     * @param {dapp} Platform either UniswapV3 or VelodromeCL
      * @param {string} assetA First asset
      * @param {string} assetB Second asset
      * @param {BigNumber | string} amountA Amount first asset
@@ -271,12 +281,12 @@ export declare class Pool {
      * @param { number } maxPrice Upper price range (assetB per assetA)
      * @param { number } minTick Lower tick range
      * @param { number } maxTick Upper tick range
-     * @param { FeeAmount } feeAmount Fee tier (Low 0.05%, Medium 0.3%, High 1%)
+     * @param { number } feeAmountOrTickSpacing Fee tier UniswapV3 or tick spacing VelodromeCL
      * @param {any} options Transaction options
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    addLiquidityUniswapV3(assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, minPrice: number | null, maxPrice: number | null, minTick: number | null, maxTick: number | null, feeAmount: FeeAmount, options?: any, estimateGas?: boolean): Promise<any>;
+    addLiquidityUniswapV3(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL, 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
@@ -288,7 +298,7 @@ export declare class Pool {
      */
     decreaseLiquidity(dapp: Dapp, tokenId: string, amount?: number, options?: any, estimateGas?: boolean): Promise<any>;
     /**
-     * Increase liquidity of an UniswapV3 or Arrakis liquidity pool
+     * Increase liquidity of an UniswapV, VelodromeCL or Arrakis liquidity pool
      * @param {Dapp} dapp Platform either UniswapV3 or Arrakis
      * @param {string} tokenId Token Id of UniswapV3 position
      * @param {BigNumber | string} amountA Amount first asset
@@ -319,7 +329,7 @@ export declare class Pool {
      * @param {boolean} estimateGas Simulate/estimate gas
      * @returns {Promise<any>} Transaction
      */
-    tradeUniswapV3(assetFrom: string, assetTo: string, amountIn: BigNumber | string, feeAmount: FeeAmount, slippage?: number, options?: any, estimateGas?: boolean): Promise<any>;
+    tradeUniswapV3(assetFrom: string, assetTo: string, amountIn: BigNumber | string, feeAmount: number, slippage?: number, options?: any, estimateGas?: boolean): Promise<any>;
     /**
      * Add liquidity to Velodrome pool
      * @param {string} assetA First asset
@@ -468,4 +478,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/services/uniswap/V3Liquidity.d.ts

@@ -1,9 +1,10 @@
-import { Price, Token } from "@uniswap/sdk-core";
-import { FeeAmount } from "@uniswap/v3-sdk";
+import { Token, Price } from "@uniswap/sdk-core";
 import { ethers } from "ethers";
-import { Pool } from "../..";
-import { UniswapV3MintParams } from "./types";
+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: FeeAmount, value: string): number;
-export declare function getUniswapV3MintParams(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, feeAmount: FeeAmount): Promise<UniswapV3MintParams>;
-export declare function getUniswapV3Liquidity(tokenId: string, pool: Pool): Promise<ethers.BigNumber>;
+export declare function tryParseTick(baseToken: Token, quoteToken: Token, feeAmount: number, value: string): number;
+export declare function getUniswapV3MintTxData(dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL, 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, 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/services/uniswap/V3Trade.d.ts

@@ -1,4 +1,3 @@
-import { FeeAmount } from "@uniswap/v3-sdk";
 import { ethers } from "ethers";
 import { Pool } from "../..";
-export declare function getUniswapV3SwapTxData(pool: Pool, assetA: string, assetB: string, amountIn: string | ethers.BigNumber, slippage: number, feeAmount: FeeAmount): Promise<any>;
+export declare function getUniswapV3SwapTxData(pool: Pool, assetA: string, assetB: string, amountIn: string | ethers.BigNumber, slippage: number, feeAmount: number): Promise<any>;

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

@@ -1,4 +1,8 @@
-import { BigNumber } from "ethers";
+import { ethers } from "ethers";
 import { Pool } from "../../entities";
-export declare function getVelodromeAddLiquidityTxData(pool: Pool, assetA: string, assetB: string, amountA: BigNumber | string, amountB: BigNumber | string, isStable: boolean): Promise<any>;
-export declare function getVelodromeRemoveLiquidityTxData(pool: Pool, assetA: string, assetB: string, amount: BigNumber | string, isStable: boolean): Promise<any>;
+export declare function getVelodromeAddLiquidityTxData(pool: Pool, assetA: string, assetB: string, amountA: ethers.BigNumber | string, amountB: ethers.BigNumber | string, isStable: boolean): Promise<any>;
+export declare function getVelodromeRemoveLiquidityTxData(pool: Pool, assetA: string, assetB: string, amount: ethers.BigNumber | string, isStable: boolean): Promise<any>;
+export declare function getVelodromeCLDecreaseStakedLiquidityTxData(pool: Pool, tokenId: string, amount: number): Promise<any>;
+export declare function getVelodromeCLIncreaseStakedLiquidityTxData(pool: Pool, tokenId: string, amountA: ethers.BigNumber | string, amountB: ethers.BigNumber | string): Promise<any>;
+export declare function getVelodromeCLIncreaseLiquidityTxData(pool: Pool, tokenId: string, amountA: ethers.BigNumber | string, amountB: ethers.BigNumber | string): Promise<any>;
+export declare function getVelodromeClOwner(pool: Pool, tokenId: string): Promise<string>;

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

@@ -2,3 +2,4 @@ import { BigNumber } from "ethers";
 import { Pool } from "../../entities";
 export declare function getVelodromeStakeTxData(amount: BigNumber | string, v2: boolean): any;
 export declare function getVelodromeClaimTxData(pool: Pool, gauge: string, v2: boolean): Promise<any>;
+export declare function getVelodromeCLClaimTxData(tokenId: string): Promise<any>;

package/dist/test/constants.d.ts

@@ -31,6 +31,8 @@ export declare const CONTRACT_ADDRESS: {
         uniswapV3: {
             nonfungiblePositionManager: string;
         };
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        VELO: string;
     };
     optimism: {
         USDC: string;
@@ -45,6 +47,8 @@ export declare const CONTRACT_ADDRESS: {
         WMATIC: string;
         ARRAKIS_USDC_WETH_GAUGE: string;
         ARRAKIS_USDC_WETH_LP: string;
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        VELO: string;
     };
     arbitrum: {
         USDC: string;
@@ -60,6 +64,8 @@ export declare const CONTRACT_ADDRESS: {
         ARRAKIS_USDC_WETH_GAUGE: string;
         ARRAKIS_USDC_WETH_LP: string;
         WMATIC: string;
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        VELO: string;
     };
     base: {
         USDC: string;
@@ -72,6 +78,8 @@ export declare const CONTRACT_ADDRESS: {
         ARRAKIS_USDC_WETH_GAUGE: string;
         ARRAKIS_USDC_WETH_LP: string;
         WMATIC: string;
+        VELODROME_CL_USDC_WETH_GAUGE: string;
+        VELO: string;
     };
 };
 export declare const MAX_AMOUNT: ethers.BigNumber;
@@ -81,3 +89,9 @@ export declare const USDC_BALANCEOF_SLOT: {
     polygon: number;
     base: number;
 };
+export declare const WETH_BALANCEOF_SLOT: {
+    optimism: number;
+    arbitrum: number;
+    polygon: number;
+    base: number;
+};

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 }: {
@@ -30,5 +31,11 @@ export declare const setUSDCAmount: ({ provider, userAddress, amount, network }:
     provider: ethers.providers.JsonRpcProvider;
     network: Network;
 }) => Promise<void>;
+export declare const setWETHAmount: ({ provider, userAddress, amount, network }: {
+    amount: string;
+    userAddress: string;
+    provider: ethers.providers.JsonRpcProvider;
+    network: Network;
+}) => Promise<void>;
 export declare const wait: (seconds: number) => Promise<void>;
 export {};

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

@@ -19,6 +19,7 @@ export declare enum Dapp {
     TOROS = "toros",
     VELODROME = "velodrome",
     VELODROMEV2 = "velodromeV2",
+    VELODROMECL = "velodromeCL",
     LYRA = "lyra",
     ZEROEX = "0x",
     RAMSES = "ramses",