@dripfi/drip-sdk 1.2.10 → 1.2.12

package/README.md

@@ -51,7 +51,7 @@ const dripSdk = new DripSdk(chain, signer);
 | `isUserAuthenticated(): Promise<AuthenticationStatus>` | NO | Checks if the user is authenticated and returns authentication status along with relevant information. |
 | `authenticate(): Promise<boolean>` | NO | Initiates the user authentication process and returns a boolean indicating success. |
 | `deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise<string>` | NO | The deposit function allows you to deposit tokens into a specific vault. Returns txHash. |
-| `getExpectedSwapResult(fromTokenAddress: string, toTokenAddress: string, amount: string, decimals: number): Promise<string>`| YES | Returns the expected amount of tokens to get from a swap |
+| `getExpectedSwapResult(fromTokenAddress: string, toTokenAddress: string, amount: string, decimals: number): Promise<string>`| NO | Returns the expected amount of tokens to get from a swap |
 | `getUserBalance(): Promise<UserBalance>` | YES | Returns overall user balance information |
 | `getUserBoostedNfts(vaultAddress: string): Promise<string[]>` | YES | Returns an array of boosted nfts addresses owned by the user  |
 | `getRewardsPerHour(vaultAddress: string): Promise<string[]>` | YES | Returns an estimated amount of tokens the user will receive in 1 hour as reward. It considers boost nfts the user owns for the estimation. |
@@ -61,6 +61,26 @@ const dripSdk = new DripSdk(chain, signer);
 | `swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise<string>` | YES | The swapAndDeposit function allows you to deposit a different token or ether and it will take care of swapping to the correct token before making the deposit. Returns txHash. |
 | `withdraw(vault: Vault, amountToWithdraw?: string): Promise<string>` | YES | Withdraws tokens from a vault. After withdrawing, you must wait for the withdrawal to be processed by the 'DoHardWork' function, and then you can claim those tokens using claimWithdraws(). Returns txHash. |
 | `claimWithdraws(vaultAddress: string): Promise<string>` | YES | After the withdrawal has been processed by the 'DoHardWork' function, the 'claimWithdraws' function transfers the withdrawn tokens to their personal account. Returns txHash. |
+| `getTokenAllowanceForCurrency(tokenAddress: string): Promise<string>` | NO | This function retrieves the token allowance for a specific currency. |
+| `getTokenAllowanceForRecycler(tokenAddress: string): Promise<BigNumber>` | NO | This function retrieves the token allowance for the recycler contract. |
+| `getTokenAllowanceForSwapAndRecycler(tokenAddress: string): Promise<BigNumber>` | NO | This function retrieves the token allowance for the swap and recycler contract. |
+| `getUserBoostedNfts(vaultAddress: string, headers?: Headers): Promise<string[]>` | YES | This function retrieves an array of boosted NFT addresses owned by the user. |
+| `getRewardsPerHour(vaultAddress: string): Promise<number> ` | YES | This function returns an estimated amount of tokens the user will receive in one hour as a reward for the given vault |
+| `newDeposit(tokenAddress: string, vaultAddress: string, amount: string): Promise<string>` | YES | This function allows for a new deposit without checking for allowance.
+| `newSwapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise<string> ` | YES | This function allows for a new swap and deposit without checking for allowance. |
+| `getAllVestingInfo(beneficiaryAddress: string): Promise<VestingInfo>` | YES | This function retrieves all vesting information for a specified beneficiary. |
+| `getVestingStart(): Promise<string>` | YES | This function retrieves the start time of the vesting period. |
+| `getVestingEnd(): Promise<string>` | YES | This function retrieves the end time of the vesting period.
+| `getBeansHistory(): Promise<BeanEntry[]> ` | YES | This function retrieves the user's beans history of tx
+| `getBeansBalance(headers?: Headers): Promise<BeansBalance>  ` | YES | This function retrieves the user's beans balance.
+| `getMyPerqBalance(headers?: Headers): Promise<MyPerqData>` | YES | This function retrieves the user's Perq balance data.
+| `getVaultsClaimableData(headers?: Headers): Promise<VaultClaimData> ` | YES | This function fetches claimable data for the user's vaults.
+| `upgradeLoyaltyCard(): Promise<LoyaltyCard>` | YES | This function upgrades the user's loyalty card.
+| `getNextLoyaltyCard(headers?: Headers): Promise<LoyaltyCard> ` | YES |  This function fetches the next loyalty card for the authenticated user based on the currently owned one
+| `getOwnedLoyaltyCards(headers?: Headers): Promise<LoyaltyCard>` | YES |  This function fetches the next loyalty card for the authenticated user based on the currently owned one
+| `getAllLoyaltyCards(): Promise<LoyaltyCard[]>` | YES |  This function fetches all available loyalty cards.
+| `getLoyaltyCardBoost(rewardId: string, headers?: Headers): Promise<number>` | YES | This function retrieves the boost value for a specific loyalty card.
+
 
 
 > [!IMPORTANT]
@@ -324,6 +344,73 @@ type VaultStats = {
     totalUsers: number
     activeVaults: number
   };
-  
+
+type BeanEntry = {
+    address: string
+    reason: string
+    recycledAmount: string
+    beansAmount: string
+    beansSum: string
+    amountDepositedInUsd: string
+    createdAt: string
+    chainId: number
+    nonce: number
+};
+
+export type BeansBalance = {
+    balance: string
+    bonusesClaimed: string[]
+};
+
+enum Chain {
+  MAINNET = 'mainnet',
+  SEPOLIA = 'sepolia'
+}
+
+enum ELoyaltyCardTier {
+    White = 'White',
+    Ivory = 'Ivory',  
+    Dune = 'Dune',  
+    Amber = 'Amber',  
+    Sienna = 'Sienna', 
+    Umber = 'Umber',  
+    Black = 'Black'
+}
+
+export type MyPerqData = { 
+    [key: string]: {
+        vaultAddress: string,
+        projectName: string,
+        projectType: string,
+        projectFeatured: boolean,
+        liveUntil: string,
+        coingeckoId?: string,
+        depositTokenId: 'WETH' | 'USDC' | 'DAI',
+        type: 'earn' | 'launch' | 'airdrop',
+        rewardType: 'points' | 'token' | 'pnode shards',
+        amountOfTokens?: number
+        vaultName: string,
+        protocols: string[],
+        apy: number,
+        tvr: number,
+        tokenPrice: number,
+        change24h: number,
+        volume24h: number,
+        rewards: CacheVaultRewards[]
+        strategies: Strategy[],
+        boosters: NFTBoost[],
+        depositToken: DepositToken
+        avgTvl: string
+        peakTvl: string
+		pendingDeposits: number;
+		currentlyDeposited: number;
+		pendingWithdraws: number;
+		claimable: number;
+		ethPrice: number;
+        tokenRewards: {[token_address: string]: Asset & { amount: number, rewardsPerHour: number }};
+	}
+};
+
+
 
 ```

package/dist/DripConfig.js

@@ -23,12 +23,12 @@ const RECYCLER_ADDRESS_SEPOLIA = '0x07F2264E199D62afe07E8288eC9D36d155fc3f24';
 const SWAP_AND_RECYCLER_ADDRESS_SEPOLIA = '0xA4ed357FF233731860Ec8D0446FD95756d564014';
 const VESTING_ADDRESS_SEPOLIA = '0x1d3B9E32a7139718f94BE32c797682fFf2D1bE60';
 const DRIP_TOKEN_ADDRESS_SEPOLIA = '0x707B4Cc05645713d8Ea04FBC7192A0f2c1503d6E';
+const DEV_BACKEND_ROUTE = 'https://dev.drip.fi.io';
 const SUBGRAPH_URL_MAINNET = 'https://subgraph.satsuma-prod.com/49eb322da234/solidant/spool-v2/api';
-// const RECYCLER_ADDRESS_MAINNET = '';
-// const SWAP_AND_RECYCLER_ADDRESS_MAINNET = '0xA4ed357FF233731860Ec8D0446FD95756d564014';
-// const VESTING_ADDRESS_MAINNET = '0x1234'
+const RECYCLER_ADDRESS_MAINNET = '0x2FdcdB17799557Dce6f26921f12B7FA1DbcD79FA';
+const SWAP_AND_RECYCLER_ADDRESS_MAINNET = '0x15ED53964E6a5EcbEBAb80A0Fc68c2297b0eaA8D';
+const VESTING_ADDRESS_MAINNET = '0x5e19C155C30bDEB83FCFE20a3b6f6Eda34B746c5';
 const DRIP_TOKEN_ADDRESS_MAINNET = '0x2a414884a549ef5716bc1a4e648d3dc03f08b2cf';
-const DEV_BACKEND_ROUTE = 'https://dev.drip.fi.io';
 const PROD_BACKEND_ROUTE = 'https://perq.finance';
 class DripConfig {
     constructor(chain, dripRoute) {
@@ -37,9 +37,9 @@ class DripConfig {
                 this.internalConfig = (0, spool_v2_sdk_1.getMainnetConfig)(SUBGRAPH_URL_MAINNET);
                 this.dripRoute = dripRoute !== undefined ? dripRoute : PROD_BACKEND_ROUTE;
                 this.dripTokenAddress = DRIP_TOKEN_ADDRESS_MAINNET;
-                this.dripTokenRecyclerAddress = exports.NULL_ADDRESS;
-                this.dripSwapAndRecyclerAddress = exports.NULL_ADDRESS;
-                this.perqVestingAddress = exports.NULL_ADDRESS;
+                this.dripTokenRecyclerAddress = RECYCLER_ADDRESS_MAINNET;
+                this.dripSwapAndRecyclerAddress = SWAP_AND_RECYCLER_ADDRESS_MAINNET;
+                this.perqVestingAddress = VESTING_ADDRESS_MAINNET;
                 break;
             case Chain.SEPOLIA:
                 this.internalConfig = (0, spool_v2_sdk_1.getSepoliaConfig)(SUBGRAPH_URL_SEPOLIA);

package/dist/DripSdk.js

@@ -424,7 +424,7 @@ class DripSdk {
             if (this.dripConfig.dripSwapAndRecyclerAddress === DripConfig_1.NULL_ADDRESS) {
                 throw Error('Recycler contract address not defined');
             }
-            console.log("swap and recycle ERC-20 with this: ", {
+            console.log('swap and recycle ERC-20 with this: ', {
                 beneficiary,
                 path,
                 amountInWithDecimals,
@@ -532,7 +532,8 @@ class DripSdk {
             if (!this.signer) {
                 throw Error('No signer provided');
             }
-            const decimals = yield this.getERC20Precission(tokenAddress);
+            //TODO: Temporary fix for Base L2 Deposits getting decimals does crash for some reason
+            const decimals = tokenAddress === '0x4200000000000000000000000000000000000006' ? 18 : yield this.getERC20Precission(tokenAddress);
             const erc20Instance = spool_v2_sdk_1.ERC20__factory.connect(tokenAddress, this.signer);
             const approveTx = yield erc20Instance.transfer(receiver, ethers_1.ethers.utils.parseUnits(amount, decimals));
             const receipt = yield approveTx.wait();

package/package.json

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