@curvefi/api 1.16.1 → 1.18.0

package/README.md

@@ -717,3 +717,101 @@ console.log(await pool.gaugeClaimableRewards());
 // ]
 await pool.gaugeClaimRewards();
 ```
+
+## Deposit&Stake
+Add liquidity and deposit into gauge in one transaction.
+
+### Underlying
+```ts
+(async () => {
+    const pool = new curve.Pool('compound');
+    const amounts = ['1000', '1000'];
+
+    console.log(await pool.underlyingCoinBalances());
+    // { DAI: '10000.0', USDC: '10000.0' }
+    console.log(await pool.lpTokenBalances());
+    // { lpToken: '0.0', gauge: '0.0' }
+    
+    console.log(await pool.depositAndStakeExpected(amounts));
+    // 1820.604572902286288394
+    console.log(await pool.depositAndStakeSlippage(amounts));
+    // -0.0000036435051742755193
+
+    console.log(await pool.depositAndStakeIsApproved(amounts));
+    // false
+    
+    await pool.depositAndStakeApprove(amounts);
+    await pool.depositAndStake(amounts);
+
+    console.log(await pool.underlyingCoinBalances());
+    // { DAI: '9000.0', USDC: '9000.0' }
+    console.log(await pool.lpTokenBalances());
+    // { lpToken: '0.0', gauge: '1820.556829935710883568' }
+})();
+```
+
+### Wrapped
+```ts
+(async () => {
+    const pool = new curve.Pool('compound');
+    const amounts = ['1000', '1000'];
+
+    console.log(await pool.coinBalances());
+    // { cDAI: '10000.0', cUSDC: '10000.0' }
+    console.log(await pool.lpTokenBalances());
+    // { lpToken: '0.0', gauge: '1820.556829935710883568' }
+    
+    console.log(await pool.depositAndStakeWrappedExpected(amounts));
+    // 40.328408669183101673
+    console.log(await pool.depositAndStakeWrappedSlippage(amounts));
+    // -0.0020519915272297325
+
+    console.log(await pool.depositAndStakeWrappedIsApproved(amounts));
+    // false
+    
+    await pool.depositAndStakeWrappedApprove(amounts);
+    await pool.depositAndStakeWrapped(amounts);
+
+    console.log(await pool.coinBalances());
+    // { cDAI: '9000.0', cUSDC: '9000.0' }
+    console.log(await pool.lpTokenBalances());
+    // { lpToken: '0.0', gauge: '1860.884096082215274556' }
+})();
+```
+
+## Factory
+All the methods above can be used for factory pools. It's only needed to fetch them.
+
+### Stable factory pools
+```ts
+import curve from "@curvefi/api";
+
+(async () => {
+    await curve.init('JsonRpc', {}, { chainId: 1 });
+    await curve.fetchFactoryPools();
+
+    const factoryPools = curve.getFactoryPoolList();
+    // [
+    //     'ibEUR+sEUR',    'ibKRW+sKRW',    'ibEUR+sEUR-2',  'crvCRVsCRV',
+    //     'jGBP+TGBP',     '2CRV',          'crvCRV',        'ibbtc/sbtcCRV',
+    //     'OUSD3CRV',      'aUSDC+aDAI',    'FEI3CRV3CRV',   'GrapeFUSD3CRV',
+    //     'SifuETH3CRV',   'RC_INV3CRV',    'RC_xRULER3CRV', 'RC_xCOVER3CRV',
+    //     'nUSD3CRV',      'cvxcrv',        'USDM3CRV',      'mEUR',
+    //     'waUSD3CRV',     'waBTC/sbtcCRV', 'DOLA3POOL3CRV', 'ibJPY+sJPY',
+    //     'ibAUD+sAUD',    'ibGBP+sGBP',    'ibCHF+sCHF',    'OPEN MATIC',
+    //     'EURN/EURT',     'sdCRV',         'BTCpx/sbtcCRV', 'PWRD3CRV3CRV',
+    //     'sansUSDT',      'alETH+ETH',     '17PctCypt3CRV', '17PctCypt3CRV-2',
+    //     'tbtc2/sbtcCRV', 'kusd3pool3CRV', 'tusd3pool3CRV', 'PWRD3CRV',
+    //     'fUSD3CRV',      'TPD3CRV',       'DEI3CRV',       'MIM-UST',
+    //     'ETH/vETH2',     'QBITWELLS3CRV', 'QWell13CRV',    'bveCVX-CVX',
+    //     'UST_whv23CRV',  'DSU+3Crv3CRV',  'DSU3CRV',       'aETHb',
+    //     'D3',            'aMATICb',       'pax-usdp3CRV',  'ibbtc/sbtcCRV-2',
+    //     'fxEUR_CRV',     'ORK/sbtcCRV',   'agEUR/sEUR',    'ibZAR+ZARP',
+    //     '3DYDX3CRV',     '3EURpool',      'tWETH+WETH',    'XSTUSD3CRV',
+    //     'XIM3CRV3CRV',   'XIM3CRV',       'RAMP rUSD3CRV', 'bhome3CRV',
+    //     'JPYC+ibJPY',    'UST-FRAX',      'FEIPCV-1',      'bentcvx',
+    //     'USX3CRV3CRV',   'ag+ib-EUR',     'tFRAX+FRAX',    'ELONXSWAP3CRV',
+    //     'BEAN3CRV',      'USDV3CRV',      'PARUSDC3CRV',   'baoUSD-3CRV'
+    // ]
+
+})()

package/lib/constants/abis/abis-ethereum.js

@@ -1233,7 +1233,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         gauge_abi: gauge_v2_json_1.default,
     },
     frax: {
@@ -1278,7 +1278,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         sCurveRewards_abi: rewards_json_2.default,
         sCurveRewards_address: '0xBBbAf1adf4d39B2843928CCa1E65564e5ce99ccC',
         reward_tokens: ['0x3432b6a60d23ca0dfca7761b7ab56459d9c964d0'],
@@ -1326,7 +1326,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         sCurveRewards_abi: rewards_json_2.default,
         sCurveRewards_address: '0xeb31da939878d1d780fdbcc244531c0fb80a2cf3',
         reward_tokens: ['0x6dea81c8171d0ba574754ef6f8b412f2ed88c54d'],
@@ -1374,7 +1374,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         gauge_abi: gauge_v2_json_1.default,
     },
     reth: {
@@ -1447,7 +1447,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         sCurveRewards_abi: rewards_json_2.default,
         sCurveRewards_address: '0xb76256d1091e93976c61449d6e500d9f46d827d4',
         reward_tokens: ['0xdbdb4d16eda451d0503b854cf79d55697f90c8df'],
@@ -1495,7 +1495,7 @@ exports.POOLS_DATA_ETHEREUM = {
             '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
         ],
-        is_factory: true,
+        is_meta_factory: true,
         sCurveRewards_abi: rewards_json_2.default,
         sCurveRewards_address: '0xb76256d1091e93976c61449d6e500d9f46d827d4',
         reward_tokens: ['0x090185f2135308BaD17527004364eBcC2D37e5F6'],

package/lib/constants/abis/json/deposit_and_stake.json

@@ -0,0 +1,51 @@
+[
+    {
+        "stateMutability": "payable",
+        "type": "function",
+        "name": "deposit_and_stake",
+        "inputs": [
+            {
+                "name": "deposit",
+                "type": "address"
+            },
+            {
+                "name": "lp_token",
+                "type": "address"
+            },
+            {
+                "name": "gauge",
+                "type": "address"
+            },
+            {
+                "name": "n_coins",
+                "type": "uint256"
+            },
+            {
+                "name": "coins",
+                "type": "address[5]"
+            },
+            {
+                "name": "amounts",
+                "type": "uint256[5]"
+            },
+            {
+                "name": "min_mint_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "use_underlying",
+                "type": "bool"
+            },
+            {
+                "name": "pool",
+                "type": "address"
+            }
+        ],
+        "outputs": [],
+        "gas": "409532"
+    },
+    {
+        "stateMutability": "payable",
+        "type": "fallback"
+    }
+]

package/lib/constants/abis/json/factory-v2/DepositZapMetaBtcPolygon.json

@@ -0,0 +1,197 @@
+[
+    {
+        "stateMutability": "nonpayable",
+        "type": "constructor",
+        "inputs": [],
+        "outputs": []
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "add_liquidity",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_deposit_amounts",
+                "type": "uint256[3]"
+            },
+            {
+                "name": "_min_mint_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_burn_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "_min_amounts",
+                "type": "uint256[3]"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256[3]"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity_one_coin",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_burn_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "i",
+                "type": "int128"
+            },
+            {
+                "name": "_min_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity_imbalance",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_amounts",
+                "type": "uint256[3]"
+            },
+            {
+                "name": "_max_burn_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "view",
+        "type": "function",
+        "name": "calc_withdraw_one_coin",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_token_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "i",
+                "type": "int128"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "gas": "5753"
+    },
+    {
+        "stateMutability": "view",
+        "type": "function",
+        "name": "calc_token_amount",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_amounts",
+                "type": "uint256[3]"
+            },
+            {
+                "name": "_is_deposit",
+                "type": "bool"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "gas": "6289"
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "exchange_underlying",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_i",
+                "type": "int128"
+            },
+            {
+                "name": "_j",
+                "type": "int128"
+            },
+            {
+                "name": "_dx",
+                "type": "uint256"
+            },
+            {
+                "name": "_min_dy",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    }
+]

package/lib/constants/abis/json/factory-v2/DepositZapMetaUsdPolygon.json

@@ -0,0 +1,197 @@
+[
+    {
+        "stateMutability": "nonpayable",
+        "type": "constructor",
+        "inputs": [],
+        "outputs": []
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "add_liquidity",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_deposit_amounts",
+                "type": "uint256[4]"
+            },
+            {
+                "name": "_min_mint_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_burn_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "_min_amounts",
+                "type": "uint256[4]"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256[4]"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity_one_coin",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_burn_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "i",
+                "type": "int128"
+            },
+            {
+                "name": "_min_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "remove_liquidity_imbalance",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_amounts",
+                "type": "uint256[4]"
+            },
+            {
+                "name": "_max_burn_amount",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    },
+    {
+        "stateMutability": "view",
+        "type": "function",
+        "name": "calc_withdraw_one_coin",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_token_amount",
+                "type": "uint256"
+            },
+            {
+                "name": "i",
+                "type": "int128"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "gas": "5753"
+    },
+    {
+        "stateMutability": "view",
+        "type": "function",
+        "name": "calc_token_amount",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_amounts",
+                "type": "uint256[4]"
+            },
+            {
+                "name": "_is_deposit",
+                "type": "bool"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "gas": "6666"
+    },
+    {
+        "stateMutability": "nonpayable",
+        "type": "function",
+        "name": "exchange_underlying",
+        "inputs": [
+            {
+                "name": "_pool",
+                "type": "address"
+            },
+            {
+                "name": "_i",
+                "type": "int128"
+            },
+            {
+                "name": "_j",
+                "type": "int128"
+            },
+            {
+                "name": "_dx",
+                "type": "uint256"
+            },
+            {
+                "name": "_min_dy",
+                "type": "uint256"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ]
+    }
+]