@dripfi/drip-sdk 1.4.17 → 1.4.19

package/README.md

@@ -19,7 +19,7 @@ The Drip SDK is a TypeScript library designed to interact with the Perq protocol
 - [Types](#types)
 - [Abis](#abis)
 
-# Installation
+## Installation
 
 To use the Drip SDK in your project, you can install it via npm or yarn:
 
@@ -27,7 +27,7 @@ To use the Drip SDK in your project, you can install it via npm or yarn:
 npm i @dripfi/drip-sdk
 ```
 
-# Usage
+## Usage
 
 ```typescript
 import PerqSdk from '@drip/sdk';
@@ -50,9 +50,9 @@ const provider: ethers.providers.JsonRpcProvider = /* your Web3Provider instance
 const perqSdk = new PerqSdk(perqConfig, perqSupportedChainId, provider?: ethers.providers.JsonRpcProvider);
 ```
 
-# Modules
+## Modules
 
-## Core SDK
+### Core SDK
 
 Core methods available directly on the SDK instance:
 
@@ -60,7 +60,7 @@ Core methods available directly on the SDK instance:
 | ------------------------------------------------ | ------------------------------------------------------------ |
 | `updateSigner(newSigner: Signer): Promise<void>` | Updates the signer for the SDK instance and all its modules. |
 
-## Lite Vaults
+### Lite Vaults
 
 Access Lite vault methods through `sdk.lite`:
 
@@ -76,7 +76,7 @@ Access Lite vault methods through `sdk.lite`:
 | `approveSwapAndDeposit(tokenAddress: string, amount: string): Promise<string>`                                                                           | Approves a token for swap and deposit operations.                       |
 | `getExpectedSwapResult(fromTokenAddress: string,toTokenAddress: string,amount: string,decimals: number, chainId: PerqSupportedChainId): Promise<string>` | Calculates the expected result of a swap operation on a specific chain. |
 
-## Loyalty Cards
+### Loyalty Cards
 
 Access loyalty card methods through `sdk.loyaltyCards`:
 
@@ -89,7 +89,7 @@ Access loyalty card methods through `sdk.loyaltyCards`:
 | `getOwnedLoyaltyCard(): Promise<LoyaltyCard>`             | Gets user's owned loyalty card.   |
 | `getAllLoyaltyCards(): Promise<LoyaltyCard[]>`            | Gets all available loyalty cards. |
 
-## Vesting
+### Vesting
 
 Access vesting methods through `sdk.vesting`:
 
@@ -104,7 +104,7 @@ Access vesting methods through `sdk.vesting`:
 | `claimVestedPerq(amount: string): Promise<string>`                                                    | Claims vested Perq.           |
 | `burnVestedPerq(amount: string, price: string, deadline: string, signature: string): Promise<string>` | Burns vested Perq.            |
 
-## Pools
+### Pools
 
 Access pools methods through `sdk.pools`:
 
@@ -121,17 +121,18 @@ Access pools methods through `sdk.pools`:
 | `getUserBoostedNfts(vaultAddress: string): Promise<string[]>`                         | Fetches the user's boosted NFTs for a specific pool. |
 | `getRewards(): Promise<UserRewards>`                                                  | Fetches the user's rewards.                          |
 
-## User
+### User
 
 Access user methods through `sdk.user`:
 
-| Method                                                                   | Description                                                            |
-| ------------------------------------------------------------------------ | ---------------------------------------------------------------------- |
-| `linkSuiWalletWithEthWallet(suiWalletAddress: string): Promise<boolean>` | Links a Sui wallet with an Ethereum wallet.                            |
-| `getLinkedSuiWallet(): Promise<string>`                                  | Retrieves the Sui wallet address linked to the user's Ethereum wallet. |
-| `getEarnings(projectName: string): Promise<Earnings>`                    | Retrieves the user earnings for each project's vaults                  |
+| Method                                                                     | Description                                                 |
+| -------------------------------------------------------------------------- | ----------------------------------------------------------- |
+| `linkSuiWalletWithEthWallet(suiWalletAddress: string): Promise<boolean>`   | Links a Sui wallet with an Ethereum wallet.                 |
+| `linkNearWalletWithEthWallet(nearWalletAddress: string): Promise<boolean>` | Links a Near wallet with an Ethereum wallet.                |
+| `getLinkedPodWallets(): Promise<LinkedPodWallets>`                         | Retrieves all wallets linked to the user's Ethereum wallet. |
+| `getEarnings(projectName: string): Promise<Earnings>`                      | Retrieves the user earnings for each project's vaults       |
 
-## Recycler
+### Recycler
 
 Access recycler methods through `sdk.recycler`:
 
@@ -145,10 +146,12 @@ Access recycler methods through `sdk.recycler`:
 | `approveTokenForRecycler(tokenAddress: string, amount: string): Promise<string>`                                                                                                                                                    | Approves a token for use with the recycler contract.                            |
 | `approveTokenForSwapAndRecycler(tokenAddress: string, amount: string): Promise<string>`                                                                                                                                             | Approves a token for use with the swap and recycler contract.                   |
 
-## Token Utils
+### Token Utils
 
 Access token utils methods through `sdk.tokenUtils`:
+
 | Method | Description |
+
 | -------------------------------------------------------------------- | -------------------------------------- |
 | `getTokenPrice(tokenName: string): Promise<number>` | Fetches the current price of a given token."perq", "weth" "eth" and "wbtc" are supported |
 | `getAllowance(tokenAddress: string, spender: string): Promise<string>` | Retrieves the current allowance for a token. |
@@ -158,7 +161,7 @@ Access token utils methods through `sdk.tokenUtils`:
 | `getERC20TokenAllowance(spender: string, tokenAddress: string): Promise<BigNumber>` | Retrieves the allowance for a specific ERC20 token. |
 | `getPerqTokenContractAddress(): string` | Returns the contract address of the Perq token. |
 
-## Sign Handler
+### Sign Handler
 
 Access signing methods through `sdk.signHandler`:
 
@@ -166,7 +169,7 @@ Access signing methods through `sdk.signHandler`:
 | -------------------------------------------------------------------- | -------------------------------------- |
 | `signPayload<T>(payload: T): Promise<NonceEnrichedSignedPayload<T>>` | Signs a payload with nonce enrichment. |
 
-# Examples
+## Examples
 
 ### `deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise<string>`
 
@@ -191,78 +194,54 @@ const txHash = await deposit(USDC_TOKEN_ADDRESS, VAULT_ADDRESS, '100')
 
 > [!NOTE]
 > Allowance is calculated by the deposit method, based on the current allowance and the required
-
+>
 > [!IMPORTANT]
 > Amount should be formatted, not parsed. In the example we want to deposit 100 USDC so we just input that value instead of adding 6 decimals (100000000)
 
 ---
 
-### `swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise<string>`
+### `swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, onChainProjectId: number): Promise<string>`
 
-I want to deposit 1.5ETH in a WETH vault:
+I want to deposit 1.5 ETH in a WETH vault:
 
 ```typescript
-WETH_TOKEN_ADDRESS = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"    --> WETH contract address in tenderly environment
+WETH_TOKEN_ADDRESS = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"    --> WETH contract address example
 
+// For depositing ETH into WETH pool you have to provide the WETH tokens address as a toTokenAddress as ETH itself doesn't have an address
 const txHash = await swapAndDeposit(WETH_TOKEN_ADDRESS, WETH_TOKEN_ADDRESS, '0', vaultAddress, '1.5')
 ```
 
-you can get vault token address from the vault.depositToken.tokenAddress
-
-> [!IMPORTANT]
-> ethAmount and fromTokenAmount should be formatted, not parsed. In the example we want to deposit 1.5 WETH so we just input that value instead of adding 18 decimals (1500000000000000000)
-
----
-
-### `withdraw(vault: Vault, amountToWithdraw?: string): Promise<string>`
+I want to deposit 100 DAI in a USDC vault:
 
 ```typescript
-const userBalanceObject = await getUserBalance();
-const balance = userBalanceObject.userbalance;
-```
+DAI_TOKEN_ADDRESS = "0x6b175474e89094c44da98b954eedeac495271d0f"    --> DAI contract address example
 
-> [!NOTE]
-> If i check balance, that is the max amount I can withdraw
-
-I want to withdraw 100 USDC from the 1st vault fetched. ---> Let's assume the first vault is a USDC vault for simplicity
-Fetch vaults returned by getAllVault() and pass the vault you want to withdraw from, and the amount to withdraw (100 in this example)
-
-```typescript
-const vaults = await getAllVaults();
-const vaultToWithdrawFrom = vaults[0];
-
-const txHash = await withdraw(vaultToWithdrawFrom, '100');
-```
-
-if you want to withdraw all funds in the vault, don't specify the amountToWithdraw:
-
-```typescript
-const txHash = await withdraw(vaultToWithdrawFrom);
+// Assuming you already have the data of the vault
+const txHash = await swapAndDeposit(DAI_TOKEN_ADDRESS, vault.depositToken.tokenAdrress, '100', vault.vaultAddress, vault.onChainProjectId)
 ```
 
 > [!IMPORTANT]
-> you will have to claim your withdraws after DHW is processed to transfer the withdrawn funds to your wallet
+> ethAmount and fromTokenAmount should be formatted, not parsed. In the example we want to deposit 1.5 WETH so we just input that value instead of adding 18 decimals (1500000000000000000)
 
 ---
 
-### `claimWithdraws(vaultAddress: string): Promise<string>`
+### `migrateDepositToOtherProject(tokenAddress: string, vaultAddress: string, onChainProjectId: number, targetOnChainProjectId, amount: string): Promise<string>`
 
-```typescript
-const userBalanceObject = await getUserBalance();
-const hasWithdrawsToClaim = userBalanceObject.hasWithdrawsToClaim;
-```
-
-if hasWithdrawsToClaim is true you have available funds to transfer to your address
+I want to migrate 50 USDC from projectA to projectB. ---> Let's assume we already fetched the data for these projects and selected the USDC pool of projectA which is called selectedPool in this example
 
 ```typescript
-const txHash = await claimWithdraws();
+const txHash = await lite.migrateDepositToOtherProject(
+	selectedPool.depositToken.tokenAddress,
+	selectedPool.vaultAddress,
+	selectedPool.onChainProjectId,
+	projectB.onChainProjectId || -1,
+	'50',
+);
 ```
 
-It will transfer all available funds withdrawn with withdraw() function, to your address
-
 ---
 
-### `fastWithdraw(vault: Vault, amountToWithdraw?: string): Promise<string>`
+### `withdraw(tokenAddress: string, vaultAddress: string, onChainProjectId: number, amount: string): Promise<string>`
 
 ```typescript
 const userBalanceObject = await getUserBalance();
@@ -272,23 +251,34 @@ const balance = userBalanceObject.userbalance;
 > [!NOTE]
 > If i check balance, that is the max amount I can withdraw
 
-I want to withdraw 3.55 WETH from the 1st vault fetched. ---> Let's assume the first vault is a WETH vault for simplicity
-Fetch vaults returned by getAllVault() and pass the vault you want to withdraw from, and the amount to withdraw (3.55 in this example)
+I want to withdraw 100 USDC from the 1st vault fetched. ---> Let's assume the first vault is a USDC vault for simplicity
+Fetch vaults returned by getAllVault() and pass the vault you want to withdraw from, and the amount to withdraw (100 in this example)
 
 ```typescript
-const vaults = await getAllVaults();
-const vaultToWithdrawFrom = vaults[0];
-
-const txHash = await fastWithdraw(vaultToWithdrawFrom, '3.55');
+const txHash = await lite.withdraw(
+	vaultToWithdrawFrom.depositToken.tokenAddress,
+	vaultToWithdrawFrom.vaultAddress,
+	vaultToWithdrawFrom.onChainProjectId,
+	'100',
+);
 ```
 
-if you want to withdraw all funds in the vault, don't specify the amountToWithdraw, like:
+I want to withdraw 3.55 WETH from the 1st vault fetched. ---> Let's assume the first vault is a WETH vault for simplicity
+Fetch vaults returned by getAllVault() and pass the vault you want to withdraw from, and the amount to withdraw (3.55 in this example)
 
 ```typescript
-const txHash = await fastWithdraw(vaultToWithdrawFrom);
+const vaults = await sdk.pools.getAllPools();
+const vaultToWithdrawFrom = vaults[0];
+
+const txHash = await lite.withdraw(
+	vaultToWithdrawFrom.depositToken.tokenAddress,
+	vaultToWithdrawFrom.vaultAddress,
+	vaultToWithdrawFrom.onChainProjectId,
+	'3.55',
+);
 ```
 
-# Types
+## Types
 
 ```typescript
 type Asset = {
@@ -376,6 +366,28 @@ type DepositToken = {
 	tokenAddress: string;
 };
 
+type VaultTvl = {
+	average: number;
+	averageUsd: number;
+	peak: number;
+	peakUsd: number;
+	current: number;
+	currentUsd: number;
+	historical: {
+		[timestamp: number]: {
+			amount: number;
+			amountUsd: number;
+		};
+	};
+};
+
+type ProjectTvl = {
+	averageUsd: number;
+	peakUsd: number;
+	currentUsd: number;
+	historical: { [timestamp: number]: number };
+};
+
 enum ELoyaltyCardTier {
 	White = 'White',
 	Ivory = 'Ivory',
@@ -397,6 +409,7 @@ type LoyaltyCard = {
 type MyPerqBalance = {
 	currentlyDeposited: number;
 	earnedRewards: number;
+	earnedRewardsUsd: number;
 	rewardsPerHour: number;
 };
 
@@ -420,6 +433,11 @@ type BasePayload<T> = {
 	payload: T;
 };
 
+type LinkedPodWallets = {
+	suiWalletAddr: string;
+	nearWalletAddr: string;
+};
+
 type NonceEnrichedPayload<T> = T & {
 	deadline: number;
 	signature: string;
@@ -504,6 +522,7 @@ type UserRewards = {
 };
 
 type VaultData = {
+	tvl?: VaultTvl;
 	depositToken: DepositToken;
 	vaultAddress: string;
 	projectName: string;
@@ -512,14 +531,10 @@ type VaultData = {
 	liveFrom: string;
 	liveUntil: string;
 	apy: number;
-	tvlUsd: number;
-	avgTvl: number;
 	tokenPrice: number;
 	change24h: number;
 	volume24h: number;
-	peakTvl: number;
 	onChainProjectId: number;
-	combinedTvl: number;
 	isActive: boolean;
 	owners: string[];
 	coingeckoId?: string;
@@ -640,7 +655,7 @@ type Earnings = {
 };
 ```
 
-# Abis
+## Abis
 
 - PERQ_SWAP_AND_RECYCLER_ABI
 

package/dist/types/MyPerqData.d.ts

@@ -3,7 +3,9 @@ import VaultType from './VaultType';
 type MyPerqBalance = {
     currentlyDeposited: number;
     earnedRewards: number;
+    earnedRewardsUsd: number;
     rewardsPerHour: number;
+    rewardsPerHourUsd: number;
 };
 type MyPerqData = VaultData & MyPerqBalance & {
     ethPrice: number;

package/dist/types/ProjectTvl.d.ts

@@ -0,0 +1,9 @@
+type ProjectTvl = {
+    averageUsd: number;
+    peakUsd: number;
+    currentUsd: number;
+    historical: {
+        [timestamp: number]: number;
+    };
+};
+export default ProjectTvl;

package/dist/types/ReducedProjectData.d.ts

@@ -1,6 +1,8 @@
 import DepositToken from './DepositToken';
+import ProjectTvl from './ProjectTvl';
 import VaultType from './VaultType';
 export type ReducedProjectData = {
+    tvl?: ProjectTvl;
     projectName: string;
     logo: string;
     bannerImage: string;
@@ -11,10 +13,7 @@ export type ReducedProjectData = {
     distributionType: VaultType;
     liveUntil: string;
     liveFrom: string;
-    tvlUsd: number;
-    tvl: number;
     vAPY: number;
-    peakTVL: number;
     chainIds: number[];
     isFeatured: boolean;
     currencies: DepositToken[];

package/dist/types/VaultData.d.ts

@@ -3,7 +3,9 @@ import DepositToken from './DepositToken';
 import Strategy from './Strategy';
 import StretchGoal from './StretchGoal';
 import VaultReward from './VaultReward';
+import VaultTvl from './VaultTvl';
 type VaultData = {
+    tvl?: VaultTvl;
     depositToken: DepositToken;
     vaultAddress: string;
     projectName: string;
@@ -12,14 +14,10 @@ type VaultData = {
     liveFrom: string;
     liveUntil: string;
     apy: number;
-    tvlUsd: number;
-    avgTvl: number;
     tokenPrice: number;
     change24h: number;
     volume24h: number;
-    peakTvl: number;
     onChainProjectId: number;
-    combinedTvl: number;
     isActive: boolean;
     owners: string[];
     coingeckoId?: string;

package/dist/types/VaultTvl.d.ts

@@ -0,0 +1,15 @@
+type VaultTvl = {
+    average: number;
+    averageUsd: number;
+    peak: number;
+    peakUsd: number;
+    current: number;
+    currentUsd: number;
+    historical: {
+        [timestamp: number]: {
+            amount: number;
+            amountUsd: number;
+        };
+    };
+};
+export default VaultTvl;

package/dist/types/VaultTvl.js

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

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 Vault from './Vault';
 import VaultData from './VaultData';
 import VaultReward, { RewardType } from './VaultReward';
 import VaultStats from './VaultStats';
@@ -30,4 +29,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, 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, VaultData, VaultReward, VaultStats, VaultType, VestingInfo, YelayVersion, Earnings, };

package/package.json

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

package/dist/types/Vault.d.ts

@@ -1,35 +0,0 @@
-import { DepositToken, VaultType, NFTBoost, Strategy, DeployedProject, VaultReward, RewardType } from './index';
-type Vault = {
-    vaultName: string;
-    vaultAddress: string;
-    apy: number;
-    tvr: number;
-    protocols: string[];
-    depositToken: DepositToken;
-    type: VaultType;
-    rewards: VaultReward[];
-    rewardType: RewardType;
-    liveUntil: 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;
-    tokenPrice: number;
-    change24h: number;
-    volume24h: number;
-    projectFeatured: boolean;
-    avgTvl: string;
-    peakTvl: string;
-    amountOfDepositors: number;
-    boostedTvl: number;
-    projectVAPY?: number;
-};
-export default Vault;