Merge pull request #11 from curvefi/rewards

Rewards
curvefi · Dec 28, 2021 · 3edb354 · 3edb354
2 parents 11df1e1 + 7638349
commit 3edb354
Show file tree

Hide file tree

Showing 35 changed files with 5,965 additions and 445 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -18,8 +18,6 @@ jobs:
       - name: Changelog
         id: Changelog
         uses: scottbrenner/generate-changelog-action@master
-        with:
-          to-tag: HEAD
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1

diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ node_modules
 dist/**/*
 lib/**/*
 package-lock.json
+test/temp.test.ts
diff --git a/README.md b/README.md
@@ -246,6 +246,15 @@ import curve from "@curvefi/api";
 
     console.log(await saave.stats.getTokenApy());
     // [ '0.0167', '0.0417' ]
+
+    console.log(await saave.stats.getRewardsApy());
+    // [
+    //     {
+    //         token: '0x4da27a545c0c5B758a6BA100e3a049001de870f5',
+    //         symbol: 'stkAAVE',
+    //         apy: '0.5807714739298449'
+    //     }
+    // ]
 })()
 ````
 
@@ -658,3 +667,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();
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/api",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "JavaScript library for curve.fi",
   "main": "lib/index.js",
   "scripts": {