@dripfi/drip-sdk 1.3.2 → 1.3.3

package/README.md

@@ -10,6 +10,7 @@ The Drip SDK is a TypeScript library designed to interact with the Drip protocol
 - [Methods](#methods)
 - [Examples](#examples)
 - [Types](#types)
+- [Abis](#abis)
 
 # Installation
 
@@ -73,13 +74,9 @@ const dripSdk = new DripSdk(chain, signer);
 | `getMyPerqBalance(): Promise<MyPerqData>` | YES | This function retrieves the user's Perq balance data.
 | `getVaultsClaimableData(): Promise<VaultClaimData> ` | YES | This function fetches claimable data for the user's vaults.
 | `upgradeLoyaltyCard(index: number): Promise<LoyaltyCard>` | YES | This function upgrades the user's loyalty card.
-| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>` | YES |  This function fetches the next loyalty card for the authenticated user based on the currently owned one
+| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>` | YES |  This function fetches the currently owned loyalty card of the connected wallet.
 | `getAllLoyaltyCards(): Promise<LoyaltyCard[]>` | YES |  This function fetches all available loyalty cards.
 
-
-> [!IMPORTANT]
-> **You must authenticate once for every wallet you want to use**
-
 ---
 
 # Examples
@@ -209,7 +206,7 @@ type Vault = {
   depositToken: VaultDepositToken
   type: VaultType
   rewards: VaultReward[]
-  rewardType: RewardType 
+  rewardType: RewardType
   liveUntil: string
   liveFrom: string
   liveUntilFormatted: string
@@ -223,9 +220,15 @@ type Vault = {
   coingeckoId?: string
   depositTokenId: string
   expectedTge?: string
-  tokenPrice: number,
-  change24h: number,
-  volume24h: number,
+  tokenPrice: number
+  change24h: number
+  volume24h: number
+  projectFeatured: boolean
+  avgTvl: string
+  peakTvl: string
+  amountOfDepositors: number
+  boostedTvl: number
+  projectVAPY?: number
 };
 
 type VaultType = 'launch' | 'earn' | 'airdrop'
@@ -366,38 +369,49 @@ enum ELoyaltyCardTier {
 
 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 }};
+      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 }};
 	}
 };
+```
 
+# Abis
+
+ - DRIP_SWAP_AND_RECYCLER_ABI
+
+ - WETH_TOKEN_ABI
+
+ - DRIP_TOKEN_ABI
+
+ - TOKEN_RECYCLER_ABI
+
+ - PERQ_VESTING_ABI
 
 
-```

package/dist/DripSdk.js

@@ -167,21 +167,57 @@ class DripSdk {
     }
     getUserVaultBalance(vaultAddress) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw Error('No signer provided');
+            }
             const userAddress = yield this.signer.getAddress();
-            const vault = yield this.getVaultDetails(vaultAddress);
-            const dnfts = yield this.dripApi.fetchAllUserDNFTForVault(vaultAddress, userAddress);
-            const wnfts = yield this.dripApi.fetchAllUserWNFTForVault(vaultAddress, userAddress);
+            // Parallel fetch of vault, user dnfts and user wnfts
+            const [vault, userDnftsForVault, userWnftsForVault] = yield Promise.all([
+                this.getVaultDetails(vaultAddress),
+                this.dripApi.fetchAllUserDNFTForVault(vaultAddress, userAddress),
+                this.dripApi.fetchAllUserWNFTForVault(vaultAddress, userAddress),
+            ]);
             const decimals = yield this.getERC20Precission(vault.depositToken.tokenAddress);
-            const [estimatedPendingWithdrawalBalance, estimatedWithdrawableBalance] = yield this.calculateAllWithdrawalBalances(wnfts, vaultAddress, decimals);
-            const hasWithdrawsToClaim = this.checkIfUserHasWithdrawsToClaim(wnfts);
-            const pendingDeposits = this.calculatePendingDeposits(dnfts, decimals);
-            const userBalance = this.calculateAllDeposits(dnfts, decimals).sub(pendingDeposits);
+            // Calculate deposits
+            let pendingDeposits = ethers_1.BigNumber.from(0);
+            let currentlyDeposited = ethers_1.BigNumber.from(0);
+            for (const dnft of userDnftsForVault) {
+                if (dnft.assets && dnft.assets[0]) {
+                    const amount = ethers_1.ethers.utils.parseUnits(dnft.assets[0].toString(), decimals);
+                    if (!dnft.isDHWFinished) {
+                        // Pending deposits (not yet processed)
+                        pendingDeposits = pendingDeposits.add(amount);
+                    }
+                    else {
+                        // Processed deposits
+                        currentlyDeposited = currentlyDeposited.add(amount);
+                    }
+                }
+            }
+            // Calculate withdrawals
+            let pendingWithdraws = ethers_1.BigNumber.from(0);
+            let claimable = ethers_1.BigNumber.from(0);
+            for (const wnft of userWnftsForVault) {
+                if (!wnft.isBurned && wnft.svtWithdrawn) {
+                    const currentBlockNumber = wnft.blockNumber - 1;
+                    const assetsPerSvtAtBlock = yield this.dripApi.fetchAssetPerSvtAtBlock(vaultAddress, currentBlockNumber);
+                    const estimatedValueOfNFT = ethers_1.BigNumber.from(ethers_1.ethers.utils.formatUnits(ethers_1.BigNumber.from(wnft.svtWithdrawn).mul(assetsPerSvtAtBlock), 36).split('.')[0]);
+                    if (wnft.isDHWFinished) {
+                        // Processed and claimable
+                        claimable = claimable.add(estimatedValueOfNFT);
+                    }
+                    else {
+                        // Not processed, pending withdrawal
+                        pendingWithdraws = pendingWithdraws.add(estimatedValueOfNFT);
+                    }
+                }
+            }
             return {
-                hasWithdrawsToClaim,
-                userBalance: ethers_1.ethers.utils.formatUnits(userBalance, decimals),
+                hasWithdrawsToClaim: claimable.gt(0),
+                userBalance: ethers_1.ethers.utils.formatUnits(currentlyDeposited, decimals),
                 pendingUserBalance: ethers_1.ethers.utils.formatUnits(pendingDeposits, decimals),
-                pendingWithdrawalBalance: ethers_1.ethers.utils.formatUnits(estimatedPendingWithdrawalBalance, decimals),
-                withdrawableBalance: ethers_1.ethers.utils.formatUnits(estimatedWithdrawableBalance, decimals),
+                pendingWithdrawalBalance: ethers_1.ethers.utils.formatUnits(pendingWithdraws, decimals),
+                withdrawableBalance: ethers_1.ethers.utils.formatUnits(claimable, decimals),
             };
         });
     }

package/dist/contracts/abi/DripSwapAndRecyclerAbi.json

@@ -1,368 +1,4 @@
 [
-    {
-        "inputs": [
-            {
-                "internalType": "contract IUniswapV2Router02",
-                "name": "swapRouter_",
-                "type": "address"
-            },
-            {
-                "internalType": "contract ITokenRecycler",
-                "name": "tokenRecycler_",
-                "type": "address"
-            },
-            {
-                "internalType": "address",
-                "name": "admin_",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "nonpayable",
-        "type": "constructor"
-    },
-    {
-        "inputs": [],
-        "name": "AccessControlBadConfirmation",
-        "type": "error"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            },
-            {
-                "internalType": "bytes32",
-                "name": "neededRole",
-                "type": "bytes32"
-            }
-        ],
-        "name": "AccessControlUnauthorizedAccount",
-        "type": "error"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "target",
-                "type": "address"
-            }
-        ],
-        "name": "AddressEmptyCode",
-        "type": "error"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            }
-        ],
-        "name": "AddressInsufficientBalance",
-        "type": "error"
-    },
-    {
-        "inputs": [],
-        "name": "FailedInnerCall",
-        "type": "error"
-    },
-    {
-        "inputs": [],
-        "name": "ReentrancyGuardReentrantCall",
-        "type": "error"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "token",
-                "type": "address"
-            }
-        ],
-        "name": "SafeERC20FailedOperation",
-        "type": "error"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "indexed": true,
-                "internalType": "bytes32",
-                "name": "previousAdminRole",
-                "type": "bytes32"
-            },
-            {
-                "indexed": true,
-                "internalType": "bytes32",
-                "name": "newAdminRole",
-                "type": "bytes32"
-            }
-        ],
-        "name": "RoleAdminChanged",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "sender",
-                "type": "address"
-            }
-        ],
-        "name": "RoleGranted",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "sender",
-                "type": "address"
-            }
-        ],
-        "name": "RoleRevoked",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "sender",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "rewardBeneficiary",
-                "type": "address"
-            },
-            {
-                "indexed": false,
-                "internalType": "address[]",
-                "name": "path",
-                "type": "address[]"
-            },
-            {
-                "indexed": false,
-                "internalType": "uint256[]",
-                "name": "swapAmounts",
-                "type": "uint256[]"
-            },
-            {
-                "indexed": false,
-                "internalType": "uint256",
-                "name": "minAmountOut",
-                "type": "uint256"
-            },
-            {
-                "indexed": false,
-                "internalType": "uint256",
-                "name": "deadline",
-                "type": "uint256"
-            },
-            {
-                "indexed": false,
-                "internalType": "uint256",
-                "name": "rewardAmount",
-                "type": "uint256"
-            }
-        ],
-        "name": "SwappedAndRecycled",
-        "type": "event"
-    },
-    {
-        "inputs": [],
-        "name": "ADMIN_ROLE",
-        "outputs": [
-            {
-                "internalType": "bytes32",
-                "name": "",
-                "type": "bytes32"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "DEFAULT_ADMIN_ROLE",
-        "outputs": [
-            {
-                "internalType": "bytes32",
-                "name": "",
-                "type": "bytes32"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            }
-        ],
-        "name": "getRoleAdmin",
-        "outputs": [
-            {
-                "internalType": "bytes32",
-                "name": "",
-                "type": "bytes32"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            }
-        ],
-        "name": "grantRole",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            }
-        ],
-        "name": "hasRole",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "recycledToken",
-        "outputs": [
-            {
-                "internalType": "contract IERC20",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "internalType": "address",
-                "name": "callerConfirmation",
-                "type": "address"
-            }
-        ],
-        "name": "renounceRole",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "role",
-                "type": "bytes32"
-            },
-            {
-                "internalType": "address",
-                "name": "account",
-                "type": "address"
-            }
-        ],
-        "name": "revokeRole",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes4",
-                "name": "interfaceId",
-                "type": "bytes4"
-            }
-        ],
-        "name": "supportsInterface",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
     {
         "inputs": [
             {
@@ -455,62 +91,5 @@
         ],
         "stateMutability": "payable",
         "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "swapRouter",
-        "outputs": [
-            {
-                "internalType": "contract IUniswapV2Router02",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "tokenRecycler",
-        "outputs": [
-            {
-                "internalType": "contract ITokenRecycler",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint256",
-                "name": "amount_",
-                "type": "uint256"
-            }
-        ],
-        "name": "withdrawETH",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "contract IERC20",
-                "name": "token_",
-                "type": "address"
-            },
-            {
-                "internalType": "uint256",
-                "name": "amount_",
-                "type": "uint256"
-            }
-        ],
-        "name": "withdrawToken",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
     }
 ]