@dripfi/drip-sdk 1.2.20 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -41
- package/package.json +1 -1
package/README.md
CHANGED
@@ -73,13 +73,9 @@ const dripSdk = new DripSdk(chain, signer);
|
|
73
73
|
| `getMyPerqBalance(): Promise<MyPerqData>` | YES | This function retrieves the user's Perq balance data.
|
74
74
|
| `getVaultsClaimableData(): Promise<VaultClaimData> ` | YES | This function fetches claimable data for the user's vaults.
|
75
75
|
| `upgradeLoyaltyCard(index: number): Promise<LoyaltyCard>` | YES | This function upgrades the user's loyalty card.
|
76
|
-
| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>` | YES | This function fetches the
|
76
|
+
| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>` | YES | This function fetches the currently owned loyalty card of the connected wallet.
|
77
77
|
| `getAllLoyaltyCards(): Promise<LoyaltyCard[]>` | YES | This function fetches all available loyalty cards.
|
78
78
|
|
79
|
-
|
80
|
-
> [!IMPORTANT]
|
81
|
-
> **You must authenticate once for every wallet you want to use**
|
82
|
-
|
83
79
|
---
|
84
80
|
|
85
81
|
# Examples
|
@@ -209,7 +205,7 @@ type Vault = {
|
|
209
205
|
depositToken: VaultDepositToken
|
210
206
|
type: VaultType
|
211
207
|
rewards: VaultReward[]
|
212
|
-
rewardType: RewardType
|
208
|
+
rewardType: RewardType
|
213
209
|
liveUntil: string
|
214
210
|
liveFrom: string
|
215
211
|
liveUntilFormatted: string
|
@@ -223,9 +219,15 @@ type Vault = {
|
|
223
219
|
coingeckoId?: string
|
224
220
|
depositTokenId: string
|
225
221
|
expectedTge?: string
|
226
|
-
tokenPrice: number
|
227
|
-
change24h: number
|
228
|
-
volume24h: number
|
222
|
+
tokenPrice: number
|
223
|
+
change24h: number
|
224
|
+
volume24h: number
|
225
|
+
projectFeatured: boolean
|
226
|
+
avgTvl: string
|
227
|
+
peakTvl: string
|
228
|
+
amountOfDepositors: number
|
229
|
+
boostedTvl: number
|
230
|
+
projectVAPY?: number
|
229
231
|
};
|
230
232
|
|
231
233
|
type VaultType = 'launch' | 'earn' | 'airdrop'
|
@@ -366,38 +368,35 @@ enum ELoyaltyCardTier {
|
|
366
368
|
|
367
369
|
export type MyPerqData = {
|
368
370
|
[key: string]: {
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
371
|
+
vaultAddress: string,
|
372
|
+
projectName: string,
|
373
|
+
projectType: string,
|
374
|
+
projectFeatured: boolean,
|
375
|
+
liveUntil: string,
|
376
|
+
coingeckoId?: string,
|
377
|
+
depositTokenId: 'WETH' | 'USDC' | 'DAI',
|
378
|
+
type: 'earn' | 'launch' | 'airdrop',
|
379
|
+
rewardType: 'points' | 'token' | 'pnode shards',
|
380
|
+
amountOfTokens?: number
|
381
|
+
vaultName: string,
|
382
|
+
protocols: string[],
|
383
|
+
apy: number,
|
384
|
+
tvr: number,
|
385
|
+
tokenPrice: number,
|
386
|
+
change24h: number,
|
387
|
+
volume24h: number,
|
388
|
+
rewards: CacheVaultRewards[]
|
389
|
+
strategies: Strategy[],
|
390
|
+
boosters: NFTBoost[],
|
391
|
+
depositToken: DepositToken
|
392
|
+
avgTvl: string
|
393
|
+
peakTvl: string
|
394
|
+
pendingDeposits: number;
|
395
|
+
currentlyDeposited: number;
|
396
|
+
pendingWithdraws: number;
|
397
|
+
claimable: number;
|
398
|
+
ethPrice: number;
|
399
|
+
tokenRewards: {[token_address: string]: Asset & { amount: number, rewardsPerHour: number }};
|
398
400
|
}
|
399
401
|
};
|
400
|
-
|
401
|
-
|
402
|
-
|
403
402
|
```
|