@ichidao/ichi-vaults-sdk 0.0.113 → 0.1.1

package/README.md

@@ -38,6 +38,11 @@ This sdk contains collection of functions to interact with IchiVault's smart con
         * [`getVaultPositions()`](#26-getVaultPositions)
         * [`getSupportedDexes()`](#27-getSupportedDexes)
         * [`getChainsForDex()`](#28-getChainsForDex)
+        * [`getRewardInfo()`](#29-getRewardInfo)
+        * [`getAllRewardInfo()`](#30-getAllRewardInfo)
+        * [`getAllUserRewards()`](#31-getAllUserRewards)
+        * [`getUserRewards()`](#32-getUserRewards)
+        * [`claimRewards()`](#33-claimRewards)
 
 ## Installation
 Install with
@@ -1036,6 +1041,116 @@ const dex = SupportedChainId.UniswapV3;
 const chains: SupportedChainId[] = getChainsForDex(dex);
 ```
 
+#### 29. `getRewardInfo()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| chainId   | SupportedChainId | - | true |
+| dex   | SupportedDex | - | true |
+| vaultAddress   | string | - | true |
+
+<br/>
+This function returns information about reward rates and farming contract for the specified vault. This functions is specific for the Velodrome vaults.
+
+```typescript
+import { getRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';
+
+const vaultAddress = "0x3e4...45a";
+const chainId = SupportedChainId.Ink;
+const dex = SupportedDex.Velodrome;
+
+const rewardInfo: RewardInfo = getRewardInfo(chainId, dex, vaultAddress);
+```
+
+#### 30. `getAllRewardInfo()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| chainId   | SupportedChainId | - | true |
+| dex   | SupportedDex | - | true |
+
+<br/>
+This function returns information about reward rates and farming contract for all vaults on the dex. This functions is specific for the Velodrome vaults.
+
+```typescript
+import { getAllRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';
+
+const chainId = SupportedChainId.Ink;
+const dex = SupportedDex.Velodrome;
+
+const chains: RewardInfo[] = getAllRewardInfo(chainId, dex);
+```
+
+#### 31. `getAllUserRewards()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| accountAddress   | string | - | true |
+| jsonProvider   | JsonRpcProvider | - | true |
+| dex   | SupportedDex | - | true |
+| raw   | true | undefined | - | false |
+
+<br/>
+This function returns user rewards for all vaults on the dex. This functions is specific for the Velodrome vaults.
+
+```typescript
+import { getAllUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';
+
+const account = "0x123...890";
+const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
+const dex = SupportedDex.Velodrome;
+
+const rewards: UserRewards[] = await getAllUserRewards(account, provider, dex);
+```
+
+#### 32. `getUserRewards()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| accountAddress   | string | - | true |
+| vaultAddress   | string | - | true |
+| jsonProvider   | JsonRpcProvider | - | true |
+| dex   | SupportedDex | - | true |
+| raw   | true | undefined | - | false |
+
+<br/>
+This function returns claimable reward amounts for the specified vault and user account. This functions is specific for the Velodrome vaults.
+
+```typescript
+import { getUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';
+
+const account = "0x123...890";
+const vaultAddress = "0x3e4...45a";
+const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
+const dex = SupportedDex.Velodrome;
+
+const rewards: UserRewardByToken[] = getUserRewards(account, vaultAddress, provider, dex);
+const rewardsBN: UserRewardByTokenBN[] = getUserRewards(account, vaultAddress, provider, dex, true);
+```
+
+#### 33. `claimRewards()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| accountAddress   | string | - | true |
+| vaultAddress   | string | - | true |
+| jsonProvider   | JsonRpcProvider | - | true |
+| dex   | SupportedDex | - | true |
+
+<br/>
+This function transfers rewards from the reward contract to the specified account. This functions is specific for the Velodrome vaults.
+
+```typescript
+import { claimRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';
+
+const account = "0x123...890";
+const vaultAddress = "0x3e4...45a";
+const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
+const dex = SupportedDex.Velodrome;
+
+await claimRewards(account, vaultAddress, provider, dex);
+```
+
 ## Types
 
 ### SupportedChainId
@@ -1150,6 +1265,12 @@ interface IchiVault {
   allowTokenB: boolean;
   holdersCount?: string // number of vault LP holders
   fee?: string
+  farmingContract?: string; // used for Velodrome vaults only
+  rewardTokens?: {
+    // used for Velodrome vaults only
+    token: string;
+    tokenDecimals: number;
+  }[];
 }
 ```
 
@@ -1251,6 +1372,7 @@ type UserAmountsInVaultBN = {
 type UserBalanceInVault = {
   vaultAddress: string;
   shares: string;
+  stakedShares?: string;
 };
 ```
 
@@ -1260,6 +1382,7 @@ type UserBalanceInVault = {
 type UserBalanceInVaultBN = {
   vaultAddress: string;
   shares: BigNumber;
+  stakedShares?: BigNumber;
 };
 ```
 
@@ -1282,3 +1405,71 @@ type VaultPositionsInfo = {
   } [],
 }
 ```
+
+### RewardToken
+used for Velodrome vaults only
+
+```typescript
+
+type RewardToken = {
+  rewardRatePerToken_1d: string;
+  rewardRatePerToken_3d: string;
+  token: string;
+  tokenDecimals: number;
+};
+```
+
+### UserRewardsByToken
+
+```typescript
+
+type UserRewardsByToken = {
+  token: string;
+  tokenDecimals: number;
+  rewardAmount: string;
+};
+```
+
+### UserRewardsByTokenBN
+
+```typescript
+
+type UserRewardsByTokenBN = {
+  token: string;
+  tokenDecimals: number;
+  rewardAmount: BigNumber;
+};
+```
+
+### RewardInfo
+
+```typescript
+
+type RewardInfo = {
+  id: string;
+  farmingContract: {
+    id: string;
+    rewardTokens: RewardToken[];
+  };
+};
+```
+
+### UserRewards
+
+```typescript
+
+type UserRewards = {
+  vaultAddress: string;
+  rewardTokens: UserRewardsByToken[];
+};
+```
+
+### UserRewardsBN
+
+```typescript
+
+type UserRewardsBN = {
+  vaultAddress: string;
+  rewardTokens: UserRewardsByTokenBN[];
+};
+```