@curvefi/api 1.13.0 → 1.16.0

package/README.md

@@ -122,12 +122,36 @@ const WalletProvider: FunctionComponent = ({ children }) => {
     ...
 ```
 
+## Available pools
+```ts
+import curve from "@curvefi/api";
+
+(async () => {
+    await curve.init('JsonRpc', {}, {gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0});
+
+    console.log(curve.getPoolList());
+    // [
+    //     'compound', 'usdt',   'y',          'busd',
+    //     'susd',     'pax',    'ren',        'sbtc',
+    //     'hbtc',     '3pool',  'gusd',       'husd',
+    //     'usdk',     'usdn',   'musd',       'rsv',
+    //     'tbtc',     'dusd',   'pbtc',       'bbtc',
+    //     'obtc',     'seth',   'eurs',       'ust',
+    //     'aave',     'steth',  'saave',      'ankreth',
+    //     'usdp',     'ib',     'link',       'tusd',
+    //     'frax',     'lusd',   'busdv2',     'reth',
+    //     'alusd',    'mim',    'tricrypto2', 'eurt',
+    //     'eurtusd',  'crveth', 'cvxeth'
+    // ]
+})()
+````
+
 ## Balances
 ```ts
 import curve from "@curvefi/api";
 
 (async () => {
-    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0 });
 
     console.log(await curve.getBalances(['DAI', 'sUSD']));
     // OR console.log(await curve.getBalances(['0x6B175474E89094C44Da98b954EedeAC495271d0F', '0x57Ab1ec28D129707052df4dF418D58a2D46d5f51']));
@@ -211,6 +235,58 @@ import curve from "@curvefi/api";
 })()
 ```
 
+## Stats
+```ts
+import curve from "@curvefi/api";
+
+(async () => {
+    await curve.init('JsonRpc', {}, {gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0});
+
+    const aave = new curve.Pool('aave');
+
+    console.log(await aave.stats.getParameters());
+    // {
+    //     virtualPrice: '1.082056814810440924',
+    //     fee: '0.04',
+    //     adminFee: '0.02',
+    //     A: '2000',
+    //     future_A: '2000',
+    //     initial_A: '200',
+    //     future_A_time: 1628525830000,
+    //     initial_A_time: 1627923611000,
+    //     gamma: undefined
+    // }
+
+
+    console.log(await aave.stats.getPoolBalances());
+    // [ '19619514.600802512613372364', '18740372.790339', '16065974.167437' ]
+    
+    console.log(await aave.stats.getPoolWrappedBalances());
+    // [ '19619514.600802512613372364', '18740372.790339', '16065974.167437' ]
+    
+    console.log(await aave.stats.getTotalLiquidity());
+    // 54425861.55857851
+    
+    console.log(await aave.stats.getVolume());
+    // 175647.68180084194
+    
+    console.log(await aave.stats.getBaseApy());
+    // { day: '3.2015', week: '3.1185', month: '3.1318', total: '7.7286' }
+    
+    console.log(await aave.stats.getTokenApy());
+    // [ '0.4093', '1.0233' ]
+
+    console.log(await aave.stats.getRewardsApy());
+    // [
+    //     {
+    //         token: '0x4da27a545c0c5B758a6BA100e3a049001de870f5',
+    //         symbol: 'stkAAVE',
+    //         apy: '0.4978306501849664'
+    //     }
+    // ]
+})()
+````
+
 ## Add/remove liquidity
 
 ```ts
@@ -620,3 +696,24 @@ await curve.estimateGas.crossAssetExchange('DAI', "WBTC", "1000", 0.01)
 
 await curve.boosting.estimateGas.createLock('1000', 365)
 ```
+
+## Rewards
+```ts
+const pool = new curve.Pool('susd');
+
+// CRV
+console.log(await pool.gaugeClaimableTokens());
+// 0.006296257916265276
+await pool.gaugeClaimTokens();
+
+// Additional rewards
+console.log(await pool.gaugeClaimableRewards());
+// [
+//     {
+//         token: '0xC011a73ee8576Fb46F5E1c5751cA3B9Fe0af2a6F',
+//         symbol: 'SNX',
+//         amount: '0.000596325465987726'
+//     }
+// ]
+await pool.gaugeClaimRewards();
+```