@dhedge/v2-sdk 1.2.1 → 1.4.1

package/dist/config.d.ts

@@ -4,6 +4,11 @@ export declare const factoryAddress: AddressNetworkMap;
 export declare const routerAddress: AddressDappNetworkMap;
 export declare const dappFactoryAddress: AddressDappNetworkMap;
 export declare const stakingAddress: AddressDappNetworkMap;
+export declare const nonfungiblePositionManagerAddress: AddressNetworkMap;
 export declare const networkChainIdMap: NetworkChainIdMap;
 export declare const balancerSubgraph: AddressNetworkMap;
 export declare const multiCallAddress: AddressNetworkMap;
+export declare const deadline: number;
+export declare const MaxUint128 = "0xffffffffffffffffffffffffffffffff";
+export declare const UNISWAPV3_QUOTER_ADDRESS = "0xb27308f9F90D607463bb33eA1BeBb41C27CE5AB6";
+export declare const SYNTHETIX_TRACKING_CODE = "0x4448454447450000000000000000000000000000000000000000000000000000";

package/dist/entities/pool.d.ts

@@ -1,14 +1,16 @@
 import { Contract, Wallet, BigNumber } from "ethers";
 import { Dapp, FundComposition, AssetEnabled, Network } from "../types";
 import { Utils } from "./utils";
+import { FeeAmount } from "@uniswap/v3-sdk";
 export declare class Pool {
     readonly poolLogic: Contract;
     readonly managerLogic: Contract;
+    readonly factory: Contract;
     readonly signer: Wallet;
     readonly address: string;
     readonly utils: Utils;
     readonly network: Network;
-    constructor(network: Network, signer: Wallet, poolLogic: Contract, mangerLogic: Contract, utils: Utils);
+    constructor(network: Network, signer: Wallet, poolLogic: Contract, mangerLogic: Contract, utils: Utils, factory: Contract);
     /**
      * Return the assets with balances and deposit info of a pool
      * @returns {Promise<FundComposition[]>} Composition of assets with balance, deposit info
@@ -55,13 +57,31 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     approveStaking(dapp: Dapp, asset: string, amount: BigNumber | string, options?: any): Promise<any>;
+    /**
+     * Approve the liquidity pool token for staking
+     * @param {Dapp} dapp Platform like Sushiswap or Uniswap
+     * @param {string} asset Address of liquidity pool token
+     * @param {BigNumber | string} amount Aamount to be approved
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    approveUniswapV3Liquidity(asset: string, amount: BigNumber | string, options?: any): Promise<any>;
+    /**
+     * Approve the asset for provided spender address
+     * @param {string} spender Spender address
+     * @param {string} asset Address of asset
+     * @param {BigNumber | string} amount to be approved
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    approveSpender(spender: string, asset: string, amount: BigNumber | string, options?: any): Promise<any>;
     /**
      * Trade an asset into another asset
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
      * @param {string} assetFrom Asset to trade from
      * @param {string} assetTo Asset to trade into
      * @param {BigNumber | string} amountIn Amount
-     * @param {BigNumber | string} minAmountOut Minumum amount to receive
+     * @param {number} slippage Slippage tolerance in %
      * @param {any} options Transaction options
      * @returns {Promise<any>} Transaction
      */
@@ -96,6 +116,14 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     stake(dapp: Dapp, asset: string, amount: BigNumber | string, options?: any): Promise<any>;
+    /**
+     * Stake liquidity pool tokens in gauge contract
+     * @param {string} gauge Gauge contract address
+     * @param {BigNumber | string} amount Amount of liquidity pool tokens
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    stakeInGauge(gauge: string, amount: BigNumber | string, options?: any): Promise<any>;
     /**
      * Unstake liquidity pool tokens from a yield farm
      * @param {Dapp} dapp Platform like Sushiswap or Uniswap
@@ -105,16 +133,24 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     unStake(dapp: Dapp, asset: string, amount: BigNumber | string, options?: any): Promise<any>;
+    /**
+     * Unstake liquidity pool tokens from gauge contract
+     * @param {string} gauge Gauge contract address
+     * @param {BigNumber | string} amount Amount of liquidity pool tokens
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    unstakeFromGauge(gauge: string, amount: BigNumber | string, options?: any): Promise<any>;
     /**
      * Lend asset to a lending pool
      * @param {Dapp} dapp Platform like Aave
      * @param {string} asset Asset
      * @param {BigNumber | string} amount Amount of asset to lend
-     * @param {number} referrralCode Code from Aave referral program
+     * @param {number} referralCode Code from Aave referral program
      * @param {any} options Transaction options
      * @returns {Promise<any>} Transaction
      */
-    lend(dapp: Dapp, asset: string, amount: BigNumber | string, referrralCode?: number, options?: any): Promise<any>;
+    lend(dapp: Dapp, asset: string, amount: BigNumber | string, referralCode?: number, options?: any): Promise<any>;
     /**
      * Witdraw asset from a lending pool
      * @param {Dapp} dapp Platform like Aave
@@ -129,11 +165,11 @@ export declare class Pool {
      * @param {Dapp} dapp Platform like Aave
      * @param {string} asset Asset
      * @param  {BigNumber | string} amount Amount of asset to lend
-     * @param {number} referrralCode Code from Aave referral program
+     * @param {number} referralCode Code from Aave referral program
      * @param {any} options Transaction options
      * @returns {Promise<any>} Transaction
      */
-    borrow(dapp: Dapp, asset: string, amount: BigNumber | string, referrralCode?: number, options?: any): Promise<any>;
+    borrow(dapp: Dapp, asset: string, amount: BigNumber | string, referralCode?: number, options?: any): Promise<any>;
     /**
      * Repays borrowed asset to a lending pool
      * @param {Dapp} dapp Platform like Aave
@@ -179,10 +215,11 @@ export declare class Pool {
      * @param {string} poolId Balancer pool id
      * @param {string[] | } assets Array of balancer pool assets
      * @param {BigNumber | string } amount Amount of pool tokens to withdraw
+     * @param { null | number } singleExitAssetIndex Index of asset to withdraw to
      * @param {any} options Transaction options
      * @returns {Promise<any>} Transaction
      */
-    exitBalancerPool(poolId: string, assets: string[], amount: string | BigNumber, options?: any): Promise<any>;
+    exitBalancerPool(poolId: string, assets: string[], amount: string | BigNumber, singleExitAssetIndex?: number | null, options?: any): Promise<any>;
     /**
      * Claim rewards from Balancer pools
      * @param {string[]} assets Array of tokens being claimed
@@ -197,4 +234,58 @@ export declare class Pool {
      * @returns {Promise<any>} Transaction
      */
     harvestAaveRewards(assets: string[], options?: any): Promise<any>;
+    /**
+     * Create UniswapV3 liquidity pool
+     * @param {string} assetA First asset
+     * @param {string} assetB Second asset
+     * @param {BigNumber | string} amountA Amount first asset
+     * @param {BigNumber | string} amountB Amount second asset
+     * @param { number } minPrice Lower price range (assetB per assetA)
+     * @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 {any} options Transaction options
+     * @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): Promise<any>;
+    /**
+     * Remove liquidity from an UniswapV3 or Arrakis liquidity pool
+     * @param {Dapp} dapp Platform either UniswapV3 or Arrakis
+     * @param {string} tokenId Token Id of UniswapV3 position
+     * @param {number} amount Amount in percent of assets to be removed
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    decreaseLiquidity(dapp: Dapp, tokenId: string, amount?: number, options?: any): Promise<any>;
+    /**
+     * Increase liquidity of an UniswapV3 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
+     * @param {BigNumber | string} amountB Amount second asset
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    increaseLiquidity(dapp: Dapp, tokenId: string, amountA: BigNumber | string, amountB: BigNumber | string, options?: any): Promise<any>;
+    /**
+     * Claim fees of an UniswapV3 liquidity or Arrakis pool
+     * @param {Dapp} dapp Platform either UniswapV3 or Arrakis
+     * @param {string} tokenId Token Id of UniswapV3 or Gauge address
+     * @param {any} options Transaction option
+     * @returns {Promise<any>} Transaction
+     */
+    claimFees(dapp: Dapp, tokenId: string, options?: any): Promise<any>;
+    /**
+     * Trade an asset into another asset
+     * @param {Dapp} dapp Platform like Sushiswap or Uniswap
+     * @param {string} assetFrom Asset to trade from
+     * @param {string} assetTo Asset to trade into
+     * @param {BigNumber | string} amountIn Amount
+     * @param { FeeAmount } feeAmount Fee tier (Low 0.05%, Medium 0.3%, High 1%)
+     * @param {number} slippage Slippage tolerance in %
+     * @param {any} options Transaction options
+     * @returns {Promise<any>} Transaction
+     */
+    tradeUniswapV3(assetFrom: string, assetTo: string, amountIn: BigNumber | string, feeAmount: FeeAmount, slippage?: number, options?: any): Promise<any>;
 }

package/dist/entities/utils.d.ts

@@ -30,6 +30,12 @@ export declare class Utils {
      * @returns { BigNumber } Balance of asset
      */
     getBalance(asset: string, owner: string): Promise<ethers.BigNumber>;
+    /**
+     * Returns the decimals of an asset (ERC20) token
+     * @param {string} asset string token address
+     * @returns { number } Balance of asset
+     */
+    getDecimals(asset: string): Promise<number>;
     /**
      * Return the minimum amount out for a trade between two assets
      * given the trade amount and slippage
@@ -43,5 +49,5 @@ export declare class Utils {
     getMinAmountOut(dapp: Dapp, assetFrom: string, assetTo: string, amountIn: string | ethers.BigNumber, slippage: number): Promise<ethers.BigNumber>;
     getBalancerSwapTx(pool: Pool, assetFrom: string, assetTo: string, amountIn: ethers.BigNumber | string, slippage: number): Promise<any>;
     getBalancerJoinPoolTx(pool: Pool, balancerPoolId: string, assets: string[], amountsIn: string[] | ethers.BigNumber[]): Promise<any>;
-    getBalancerExitPoolTx(pool: Pool, balancerPoolId: string, assets: string[], amount: string | ethers.BigNumber): Promise<any>;
+    getBalancerExitPoolTx(pool: Pool, balancerPoolId: string, assets: string[], singleExitAssetIndex: null | number, amount: string | ethers.BigNumber): Promise<any>;
 }

package/dist/services/uniswap/V3Liquidity.d.ts

@@ -0,0 +1,9 @@
+import { Price, Token } from "@uniswap/sdk-core";
+import { FeeAmount } from "@uniswap/v3-sdk";
+import { ethers } from "ethers";
+import { Pool } from "../..";
+import { UniswapV3MintParams } from "./types";
+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>;

package/dist/services/uniswap/V3Trade.d.ts

@@ -0,0 +1,4 @@
+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>;

package/dist/services/uniswap/types.d.ts

@@ -0,0 +1,3 @@
+import { FeeAmount } from "@uniswap/v3-sdk";
+import { ethers } from "ethers";
+export declare type UniswapV3MintParams = [string, string, FeeAmount, number, number, ethers.BigNumber | string, ethers.BigNumber | string, ethers.BigNumber | string, ethers.BigNumber | string, string, number];

package/dist/test/constants.d.ts

@@ -1,12 +1,15 @@
 export declare const USDC = "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174";
+export declare const WETH = "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619";
 export declare const USDT = "0xc2132D05D31c914a87C6611C10748AEb04B58e8F";
 export declare const DAI = "0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063";
 export declare const TUSD = "0x2e1ad108ff1d8c782fcbbb89aad783ac49586756";
-export declare const WETH = "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619";
 export declare const WBTC = "0x1BFD67037B42Cf73acF2047067bd4F2C47D9BfD6";
 export declare const SUSHI = "0x0b3f868e0be5597d5db7feb59e1cadbb0fdda50a";
 export declare const WMATIC = "0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270";
 export declare const BAL = "0x9a71012B13CA4d3D0Cdc72A177DF3ef03b0E76A3";
 export declare const AMUSDC = "0x1a13f4ca1d028320a707d99520abfefca3998b7f";
 export declare const VDEBTWETH = "0xede17e9d79fc6f9ff9250d9eefbdb88cc18038b5";
-export declare const TEST_POOL = "0x3deeba9ca29e2dd98d32eed8dd559dac55014615";
+export declare const ARRAKIS_USDC_WETH_GAUGE = "0x33d1ad9Cd88A509397CD924C2d7613C285602C20";
+export declare const STMATIC = "0x3A58a54C066FdC0f2D55FC9C89F0415C92eBf3C4";
+export declare const WMATIC_STMATIC_LP = "0xaF5E0B5425dE1F5a630A8cB5AA9D97B8141C908D";
+export declare const TEST_POOL = "TEST_POOL_ADDRESS";

package/dist/test/txOptions.d.ts

@@ -0,0 +1 @@
+export declare const getTxOptions: () => Promise<any>;

package/dist/types.d.ts

@@ -1,14 +1,18 @@
-import { ChainId } from "@sushiswap/sdk";
 import { BigNumber } from "ethers";
 export declare enum Network {
-    POLYGON = "polygon"
+    POLYGON = "polygon",
+    OPTIMISM = "optimism"
 }
 export declare enum Dapp {
     SUSHISWAP = "sushiswap",
     AAVE = "aave",
     ONEINCH = "1inch",
     QUICKSWAP = "quickswap",
-    BALANCER = "balancer"
+    BALANCER = "balancer",
+    UNISWAPV3 = "uniswapV3",
+    SYNTHETIX = "synthetix",
+    AAVEV3 = "aavev3",
+    ARRAKIS = "arrakis"
 }
 export declare enum Transaction {
     SWAP = "swapExactTokensForTokens",
@@ -18,17 +22,22 @@ export declare enum Transaction {
     CLAIM_DISTRIBIUTIONS = "claimDistributions",
     CLAIM_REWARDS = "claimRewards",
     REMOVE_LIQUIDITY = "removeLiquidity",
+    DECREASE_LIQUIDITY = "decreaseLiquidity",
+    INCREASE_LIQUIDITY = "increaseLiquidity",
+    COLLECT = "collect",
+    MULTI_CALL = "multicall",
     BORROW = "borrow",
     REPAY = "repay",
-    WITHDRAW = "withdraw"
+    WITHDRAW = "withdraw",
+    MINT = "mint",
+    BURN = "burn",
+    SWAP_SYNTHS = "exchangeWithTracking",
+    ADD_LIQUIDITY_STAKE = "addLiquidityAndStake",
+    REMOVE_LIQUIDITY_UNSTAKE = "removeLiquidityAndUnstake"
 }
 export declare type AddressNetworkMap = Readonly<Record<Network, string>>;
 export declare type AddressDappMap = {
-    [Dapp.SUSHISWAP]?: string;
-    [Dapp.AAVE]?: string;
-    [Dapp.ONEINCH]?: string;
-    [Dapp.QUICKSWAP]?: string;
-    [Dapp.BALANCER]?: string;
+    [key in Dapp]?: string;
 };
 export declare type AddressDappNetworkMap = Readonly<Record<Network, AddressDappMap>>;
 export declare type SupportedAsset = [string, boolean];
@@ -46,4 +55,4 @@ export declare type Reserves = {
     assetA: BigNumber;
     assetB: BigNumber;
 };
-export declare type NetworkChainIdMap = Readonly<Record<Network, ChainId>>;
+export declare type NetworkChainIdMap = Readonly<Record<Network, number>>;