@dhedge/v2-sdk 1.9.8 → 1.9.9

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,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";
@@ -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;
 };