@dripfi/drip-sdk 1.4.16 → 1.4.17

package/README.md

@@ -10,7 +10,6 @@ The Drip SDK is a TypeScript library designed to interact with the Perq protocol
 - [Usage](#usage)
 - [Modules](#modules)
    - [Core SDK](#core-sdk)
-   - [V2 Vaults](#v2-vaults)
    - [Lite Vaults](#lite-vaults)
    - [Loyalty Cards](#loyalty-cards)
    - [Vesting](#vesting)
@@ -109,18 +108,18 @@ Access vesting methods through `sdk.vesting`:
 
 Access pools methods through `sdk.pools`:
 
-| Method                                                                                          | Description                                          |
-| ----------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
-| `getUserPoolBalance(vaultAddress: string, onChainProjectId: number): Promise<UserVaultBalance>` | Fetches the user's balance in a specific pool.       |
-| `getAllPools(): Promise<VaultData[]>`                                                           | Fetches all available pools.                         |
-| `getMyPerqBalance(): Promise<MyPerqData[]>`                                                     | Fetches the user's Perq balance.                     |
-| `getPoolDetails(vaultAddress: string, onChainProjectId: number): Promise<VaultData>`            | Fetches the details of a specific pool.              |
-| `getAllProjects(): Promise<ReducedProjectData[]>`                                               | Fetches all available projects.                      |
-| `getProjectDetails(projectName: string): Promise<DetailedProjectData>`                          | Fetches the details of a specific project.           |
-| `getPoolStats(): Promise<VaultStats>`                                                           | Fetches the statistics of a pool.                    |
-| `getRewardsPerHour(vaultAddress: string): Promise<number>`                                      | Calculates the rewards per hour for a specific pool. |
-| `getUserBoostedNfts(vaultAddress: string): Promise<string[]>`                                   | Fetches the user's boosted NFTs for a specific pool. |
-| `getRewards(): Promise<UserRewards>`                                                            | Fetches the user's rewards.                          |
+| Method                                                                                | Description                                          |
+| ------------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| `getUserPoolBalance(vaultAddress: string, onChainProjectId: number): Promise<string>` | Fetches the user's balance in a specific pool.       |
+| `getAllPools(): Promise<VaultData[]>`                                                 | Fetches all available pools.                         |
+| `getMyPerqBalance(): Promise<MyPerqData[]>`                                           | Fetches the user's Perq balance.                     |
+| `getPoolDetails(vaultAddress: string, onChainProjectId: number): Promise<VaultData>`  | Fetches the details of a specific pool.              |
+| `getAllProjects(): Promise<ReducedProjectData[]>`                                     | Fetches all available projects.                      |
+| `getProjectDetails(projectName: string): Promise<DetailedProjectData>`                | Fetches the details of a specific project.           |
+| `getPoolStats(): Promise<VaultStats>`                                                 | Fetches the statistics of a pool.                    |
+| `getRewardsPerHour(vaultAddress: string): Promise<number>`                            | Calculates the rewards per hour for a specific pool. |
+| `getUserBoostedNfts(vaultAddress: string): Promise<string[]>`                         | Fetches the user's boosted NFTs for a specific pool. |
+| `getRewards(): Promise<UserRewards>`                                                  | Fetches the user's rewards.                          |
 
 ## User
 
@@ -395,13 +394,16 @@ type LoyaltyCard = {
 	boost: number;
 };
 
-type MyPerqData = Vault & {
-	claimable: number;
-	pendingDeposits: number;
-	pendingWithdraws: number;
+type MyPerqBalance = {
 	currentlyDeposited: number;
+	earnedRewards: number;
+	rewardsPerHour: number;
+};
+
+type MyPerqData = VaultData & MyPerqBalance {
 	ethPrice: number;
-	tokenRewards: { [token_address: string]: Asset & { amount: number; rewardsPerHour?: number } };
+	btcPrice: number;
+	distributionType: VaultType;
 };
 
 type NFTBoost = {
@@ -501,14 +503,6 @@ type UserRewards = {
 	[vaultAddress: string]: { [rewardPointsName: string]: number };
 };
 
-type UserVaultBalance = {
-	hasWithdrawsToClaim: boolean;
-	userBalance: string;
-	pendingUserBalance: string;
-	pendingWithdrawalBalance: string;
-	claimableBalance: string;
-};
-
 type VaultData = {
 	depositToken: DepositToken;
 	vaultAddress: string;
@@ -537,38 +531,32 @@ type VaultData = {
 	stretchGoals: StretchGoal[];
 };
 
-type Vault = {
-	vaultName: string;
-	vaultAddress: string;
-	apy: number;
-	tvr: number;
-	protocols: string[];
+type VaultData = {
 	depositToken: DepositToken;
-	type: VaultType;
-	rewards: VaultReward[];
-	rewardType: RewardType;
-	liveUntil: string;
+	vaultAddress: string;
+	projectName: string;
+	projectLogo: string;
+	projectType: string;
 	liveFrom: string;
-	liveUntilFormatted: string;
-	hasPoolEnded: boolean;
-	boosters: NFTBoost[];
-	strategies: Strategy[];
-	tgePrice?: number;
-	maxAmountOfTokens?: number;
-	project: DeployedProject;
-	projectId: number;
-	coingeckoId?: string;
-	depositTokenId: string;
-	expectedTge?: string;
+	liveUntil: string;
+	apy: number;
+	tvlUsd: number;
+	avgTvl: number;
 	tokenPrice: number;
 	change24h: number;
 	volume24h: number;
-	projectFeatured: boolean;
-	avgTvl: string;
-	peakTvl: string;
-	amountOfDepositors: number;
-	boostedTvl: number;
-	projectVAPY?: number;
+	peakTvl: number;
+	onChainProjectId: number;
+	combinedTvl: number;
+	isActive: boolean;
+	owners: string[];
+	coingeckoId?: string;
+	expectedTge?: string;
+	chainId: ChainId;
+	strategies: Strategy[];
+	stretchGoals: StretchGoal[];
+	rewards: VaultReward[];
+	rewardTooltipName: string;
 };
 
 type VaultReward = {

package/dist/PerqApi.d.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers';
-import { SwapInfo, UserRewards, VaultStats, MyPerqData, LoyaltyCard, BeansBalance, PerqToBeansSwapInfo, BeanEntry, NonceEnrichedSignedPayload, NonceEnrichedPayload, UpgradeLoyaltyCardPayload, ReducedProjectData, DetailedProjectData, UserVaultBalance, Earnings, LinkedPodWallets, SuiWalletPayload, NearWalletPayload } from './types';
+import { SwapInfo, UserRewards, VaultStats, MyPerqData, LoyaltyCard, BeansBalance, PerqToBeansSwapInfo, BeanEntry, NonceEnrichedSignedPayload, NonceEnrichedPayload, UpgradeLoyaltyCardPayload, ReducedProjectData, DetailedProjectData, Earnings, LinkedPodWallets, SuiWalletPayload, NearWalletPayload } from './types';
 import VaultData from './types/VaultData';
 import PerqSdk from './PerqSdk';
 import MigrationOption from './types/MigrationOption';
@@ -31,8 +31,7 @@ export default class PerqApi {
     linkNearWalletWithEthWallet(signedPayload: NonceEnrichedSignedPayload<NearWalletPayload>): Promise<boolean>;
     getPodWallets(walletAddress: string): Promise<LinkedPodWallets>;
     getNonceEnrichedPayload<T>(payload: T): Promise<NonceEnrichedPayload<T>>;
-    fetchV2PoolUserBalance(userAddress: string, vaultAddress: string): Promise<UserVaultBalance>;
-    fetchLitePoolUserBalance(userAddress: string, vaultAddress: string, onChainProjectId: number): Promise<UserVaultBalance>;
+    fetchLitePoolUserBalance(userAddress: string, vaultAddress: string, onChainProjectId: number): Promise<string>;
     fetchEarnings(userAddress: string, projectName: string): Promise<Earnings>;
     fetchMigrationOptions(vaultAddress: string, onChainProjectId: number): Promise<MigrationOption[]>;
 }

package/dist/PerqApi.js

@@ -336,26 +336,11 @@ class PerqApi {
         // Return the enriched payload without the extra nesting
         return enrichedPayload.payload;
     }
-    async fetchV2PoolUserBalance(userAddress, vaultAddress) {
-        const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/v2/balance/${userAddress}/${vaultAddress}`);
-        if (res.ok) {
-            return await res.json();
-        }
-        else {
-            throw Error(`${await res.text()}`);
-        }
-    }
     async fetchLitePoolUserBalance(userAddress, vaultAddress, onChainProjectId) {
         const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/lite/balance/${userAddress}/${vaultAddress}/${onChainProjectId}`);
         if (res.ok) {
             const data = await res.json();
-            return {
-                hasWithdrawsToClaim: false,
-                userBalance: data.userBalance,
-                pendingUserBalance: '0',
-                pendingWithdrawalBalance: '0',
-                claimableBalance: '0',
-            };
+            return data.userBalance;
         }
         else {
             throw Error(`${await res.text()}`);

package/dist/subpackages/PoolsPackage.d.ts

@@ -1,9 +1,9 @@
 import PerqSdk from '../PerqSdk';
-import { DetailedProjectData, MyPerqData, ReducedProjectData, UserRewards, UserVaultBalance, VaultData, VaultStats } from '../types';
+import { DetailedProjectData, MyPerqData, ReducedProjectData, UserRewards, VaultData, VaultStats } from '../types';
 export default class PoolsPackage {
     private perqSdk;
     constructor(perqSdk: PerqSdk);
-    getUserPoolBalance(vaultAddress: string, onChainProjectId: number): Promise<UserVaultBalance>;
+    getUserPoolBalance(vaultAddress: string, onChainProjectId: number): Promise<string>;
     getAllPools(): Promise<VaultData[]>;
     getMyPerqBalance(): Promise<MyPerqData[]>;
     getPoolDetails(vaultAddress: string, onChainProjectId: number): Promise<VaultData>;

package/dist/types/MyPerqData.d.ts

@@ -1,10 +1,7 @@
 import VaultData from './VaultData';
 import VaultType from './VaultType';
 type MyPerqBalance = {
-    pendingDeposits: number;
     currentlyDeposited: number;
-    pendingWithdraws: number;
-    claimable: number;
     earnedRewards: number;
     rewardsPerHour: number;
 };

package/dist/types/index.d.ts

@@ -20,7 +20,6 @@ import StretchGoal from './StretchGoal';
 import SwapInfo from './SwapInfo';
 import UpgradeLoyaltyCardPayload from './UpgradeLoyaltyCardPayload';
 import UserRewards from './UserRewards';
-import UserVaultBalance from './UserVaultBalance';
 import Vault from './Vault';
 import VaultData from './VaultData';
 import VaultReward, { RewardType } from './VaultReward';
@@ -31,4 +30,4 @@ import YelayVersion from './YelayVersion';
 import Earnings from './Earnings';
 import LinkedPodWallets from './LinkedPodWallets';
 import MigrationOption from './MigrationOption';
-export { Asset, BasePayload, BeanEntry, BeansBalance, DeployedProject, DeployedVault, DepositToken, DetailedProjectData, ELoyaltyCardTier, NearWalletPayload, SuiWalletPayload, LinkedPodWallets, LoyaltyCard, MigrationOption, MyPerqData, NFTBoost, NonceEnrichedPayload, NonceEnrichedSignedPayload, PerqConfig, PerqToBeansSwapInfo, ProjectBacker, QLFastRedeem, ReducedProjectData, RewardType, Strategy, StretchGoal, SwapInfo, UpgradeLoyaltyCardPayload, UserRewards, UserVaultBalance, Vault, VaultData, VaultReward, VaultStats, VaultType, VestingInfo, YelayVersion, Earnings, };
+export { Asset, BasePayload, BeanEntry, BeansBalance, DeployedProject, DeployedVault, DepositToken, DetailedProjectData, ELoyaltyCardTier, NearWalletPayload, SuiWalletPayload, LinkedPodWallets, LoyaltyCard, MigrationOption, MyPerqData, NFTBoost, NonceEnrichedPayload, NonceEnrichedSignedPayload, PerqConfig, PerqToBeansSwapInfo, ProjectBacker, QLFastRedeem, ReducedProjectData, RewardType, Strategy, StretchGoal, SwapInfo, UpgradeLoyaltyCardPayload, UserRewards, Vault, VaultData, VaultReward, VaultStats, VaultType, VestingInfo, YelayVersion, Earnings, };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dripfi/drip-sdk",
-	"version": "1.4.16",
+	"version": "1.4.17",
 	"description": "Drip SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/dist/types/UserVaultBalance.d.ts

@@ -1,8 +0,0 @@
-type UserVaultBalance = {
-    hasWithdrawsToClaim: boolean;
-    userBalance: string;
-    pendingUserBalance: string;
-    pendingWithdrawalBalance: string;
-    claimableBalance: string;
-};
-export default UserVaultBalance;

package/dist/types/UserVaultBalance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });