@dripfi/drip-sdk 1.4.23 → 1.4.24

package/README.md

@@ -80,14 +80,17 @@ Access Lite vault methods through `sdk.lite`:
 
 Access loyalty card methods through `sdk.loyaltyCards`:
 
-| Method                                                    | Description                       |
-| --------------------------------------------------------- | --------------------------------- |
-| `getBeansBalance(): Promise<BeansBalance>`                | Gets user's beans balance.        |
-| `getBeansHistory(): Promise<BeanEntry[]>`                 | Gets user's beans history.        |
-| `getSwapPerqForBeansInfo(): Promise<PerqToBeansSwapInfo>` | Gets swap info for Perq to beans. |
-| `upgradeLoyaltyCard(index: number): Promise<LoyaltyCard>` | Upgrades loyalty card.            |
-| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>`             | Gets user's owned loyalty card.   |
-| `getAllLoyaltyCards(): Promise<LoyaltyCard[]>`            | Gets all available loyalty cards. |
+| Method                                                                        | Description                                       |
+| ----------------------------------------------------------------------------- | ------------------------------------------------- |
+| `getBeansBalance(): Promise<BeansBalance>`                                    | Gets user's beans balance.                        |
+| `getBeansHistory(): Promise<BeanEntry[]>`                                     | Gets user's beans history.                        |
+| `getSwapPerqForBeansInfo(): Promise<PerqToBeansSwapInfo>`                     | Gets swap info for Perq to beans.                 |
+| `upgradeLoyaltyCard(index: number): Promise<LoyaltyCard>`                     | Upgrades loyalty card.                            |
+| `claimSpecialEditionCard(cardId: string): Promise<SpecialEditionLoyaltyCard>` | Claims special edition loyalty card.              |
+| `getOwnedLoyaltyCard(): Promise<LoyaltyCard>`                                 | Gets user's owned loyalty card.                   |
+| `getOwnedSpecialEditionCards(): Promise<SpecialEditionLoyaltyCard[]>`         | Gets user's owned special edition loyalty cards.  |
+| `getAllLoyaltyCards(): Promise<LoyaltyCard[]>`                                | Gets all available loyalty cards.                 |
+| `getAllSpecialEditionCards(): Promise<SpecialEditionLoyaltyCard[]>`           | Gets all available special edition loyalty cards. |
 
 ### Vesting
 
@@ -471,6 +474,15 @@ type QLFastRedeem = {
 	svtWithdrawn: string;
 };
 
+type SpecialEditionLoyaltyCard = {
+	id: string;
+	name: string;
+	boost: number;
+	projects: string[];
+	startDate: Date;
+	endDate: Date;
+};
+
 type Strategy = {
 	address: string;
 	lastDoHardWorkTime: number | null;
@@ -495,6 +507,10 @@ type UpgradeLoyaltyCardPayload = {
 	index: number;
 };
 
+type ClaimSpecialEditionLoyaltyCardPayload = {
+	cardId: string;
+};
+
 type UserRewards = {
 	// vaultAddress => pointsName => rewardsAmount
 	[vaultAddress: string]: { [rewardPointsName: string]: number };

package/dist/PerqApi.d.ts

@@ -1,9 +1,10 @@
 import { BigNumber } from 'ethers';
-import { SwapInfo, UserRewards, VaultStats, MyPerqData, LoyaltyCard, BeansBalance, PerqToBeansSwapInfo, BeanEntry, NonceEnrichedSignedPayload, NonceEnrichedPayload, UpgradeLoyaltyCardPayload, ReducedProjectData, DetailedProjectData, Earnings, LinkedPodWallets, SuiWalletPayload, NearWalletPayload } from './types';
+import { SwapInfo, UserRewards, VaultStats, MyPerqData, LoyaltyCard, BeansBalance, PerqToBeansSwapInfo, BeanEntry, NonceEnrichedSignedPayload, NonceEnrichedPayload, UpgradeLoyaltyCardPayload, ReducedProjectData, DetailedProjectData, Earnings, LinkedPodWallets, SuiWalletPayload, NearWalletPayload, SpecialEditionLoyaltyCard } from './types';
 import VaultData from './types/VaultData';
 import PerqSdk from './PerqSdk';
 import MigrationOption from './types/MigrationOption';
 import ProjectHistoricalTvl from './types/ProjectHistoricalTvl';
+import ClaimSpecialEditionLoyaltyCardPayload from './types/ClaimSpecialEditionLoyaltyCardPayload';
 export default class PerqApi {
     private perqSdk;
     constructor(perqSdk: PerqSdk);
@@ -22,9 +23,12 @@ export default class PerqApi {
     fetchAssetPerSvtAtBlock(vaultAddress: string, blocknumber: number): Promise<BigNumber>;
     fetchUserRewards(walletAddress: string): Promise<UserRewards>;
     fetchAllLoyaltyCards(): Promise<LoyaltyCard[]>;
+    fetchAllSpecialEditionLoyaltyCards(): Promise<SpecialEditionLoyaltyCard[]>;
     fetchOwnedLoyaltyCard(walletAddress: string): Promise<LoyaltyCard>;
+    fetchOwnedSpecialEditionLoyaltyCards(walletAddress: string): Promise<SpecialEditionLoyaltyCard[]>;
     fetchBeansBalance(walletAddress: string): Promise<BeansBalance>;
     upgradeLoyaltyCard(signedPayload: NonceEnrichedSignedPayload<UpgradeLoyaltyCardPayload>): Promise<LoyaltyCard>;
+    claimSpecialEditionCard(signedPayload: NonceEnrichedSignedPayload<ClaimSpecialEditionLoyaltyCardPayload>): Promise<SpecialEditionLoyaltyCard>;
     fetchMyPerqData(userAddress: string): Promise<MyPerqData[]>;
     getSwapPerqForBeansInfo(): Promise<PerqToBeansSwapInfo>;
     fetchBeansHistory(walletAddress: string): Promise<BeanEntry[]>;

package/dist/PerqApi.js

@@ -181,6 +181,16 @@ class PerqApi {
             throw Error(`${await res.text()}`);
         }
     }
+    async fetchAllSpecialEditionLoyaltyCards() {
+        const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/specialEditions/all`);
+        if (res.ok) {
+            const data = await res.json();
+            return data;
+        }
+        else {
+            throw Error(`${await res.text()}`);
+        }
+    }
     async fetchOwnedLoyaltyCard(walletAddress) {
         const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/${walletAddress}/loyaltyCards/owned`);
         if (res.status === 204) {
@@ -200,6 +210,16 @@ class PerqApi {
             throw Error(`${await res.text()}`);
         }
     }
+    async fetchOwnedSpecialEditionLoyaltyCards(walletAddress) {
+        const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/${walletAddress}/specialEditions/owned`);
+        if (res.ok) {
+            const data = await res.json();
+            return data;
+        }
+        else {
+            throw Error(`${await res.text()}`);
+        }
+    }
     async fetchBeansBalance(walletAddress) {
         const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/${walletAddress}/beans/balance`);
         if (res.ok) {
@@ -237,6 +257,23 @@ class PerqApi {
             throw Error(`${await res.text()}`);
         }
     }
+    async claimSpecialEditionCard(signedPayload) {
+        const { signerAddress } = signedPayload;
+        const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/${signerAddress}/specialEditions/claim`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(signedPayload),
+        });
+        if (res.ok) {
+            const data = await res.json();
+            return data;
+        }
+        else {
+            throw Error(`${await res.text()}`);
+        }
+    }
     async fetchMyPerqData(userAddress) {
         const res = await fetch(`${this.perqSdk.perqConfig.route}/api-be/api/user/${userAddress}/myperq`);
         if (res.ok) {

package/dist/subpackages/LoyaltyCardsPackage.d.ts

@@ -1,4 +1,4 @@
-import { BeansBalance, BeanEntry, PerqToBeansSwapInfo, LoyaltyCard } from '../types';
+import { BeansBalance, BeanEntry, PerqToBeansSwapInfo, LoyaltyCard, SpecialEditionLoyaltyCard } from '../types';
 import PerqSdk from '../PerqSdk';
 export default class LoyaltyPackage {
     private perqSdk;
@@ -9,4 +9,7 @@ export default class LoyaltyPackage {
     upgradeLoyaltyCard(index: number): Promise<LoyaltyCard>;
     getOwnedLoyaltyCard(): Promise<LoyaltyCard>;
     getAllLoyaltyCards(): Promise<LoyaltyCard[]>;
+    claimSpecialEditionCard(cardId: string): Promise<SpecialEditionLoyaltyCard>;
+    getOwnedSpecialEditionCards(): Promise<SpecialEditionLoyaltyCard[]>;
+    getAllSpecialEditionCards(): Promise<SpecialEditionLoyaltyCard[]>;
 }

package/dist/subpackages/LoyaltyCardsPackage.js

@@ -30,5 +30,19 @@ class LoyaltyPackage {
     async getAllLoyaltyCards() {
         return this.perqSdk.perqApi.fetchAllLoyaltyCards();
     }
+    async claimSpecialEditionCard(cardId) {
+        const payload = {
+            cardId,
+        };
+        const signedPayload = await this.perqSdk.signHandler.signPayload(payload);
+        return this.perqSdk.perqApi.claimSpecialEditionCard(signedPayload);
+    }
+    async getOwnedSpecialEditionCards() {
+        const signerAddress = await this.perqSdk.signer.getAddress();
+        return this.perqSdk.perqApi.fetchOwnedSpecialEditionLoyaltyCards(signerAddress);
+    }
+    async getAllSpecialEditionCards() {
+        return this.perqSdk.perqApi.fetchAllSpecialEditionLoyaltyCards();
+    }
 }
 exports.default = LoyaltyPackage;

package/dist/types/ClaimSpecialEditionLoyaltyCardPayload.d.ts

@@ -0,0 +1,4 @@
+type ClaimSpecialEditionLoyaltyCardPayload = {
+    cardId: string;
+};
+export default ClaimSpecialEditionLoyaltyCardPayload;

package/dist/types/ClaimSpecialEditionLoyaltyCardPayload.js

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

package/dist/types/SpecialEditionLoyaltyCard.d.ts

@@ -0,0 +1,9 @@
+type SpecialEditionLoyaltyCard = {
+    id: string;
+    name: string;
+    boost: number;
+    projects: string[];
+    startDate: string;
+    endDate: string;
+};
+export default SpecialEditionLoyaltyCard;

package/dist/types/SpecialEditionLoyaltyCard.js

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

package/dist/types/index.d.ts

@@ -15,6 +15,7 @@ import PerqToBeansSwapInfo from './PerqToBeansSwapInfo';
 import QLFastRedeem from './QLFastRedeem';
 import { BasePayload, NonceEnrichedPayload, NonceEnrichedSignedPayload } from './SignedPayload';
 import { ReducedProjectData } from './ReducedProjectData';
+import SpecialEditionLoyaltyCard from './SpecialEditionLoyaltyCard';
 import Strategy from './Strategy';
 import StretchGoal from './StretchGoal';
 import SwapInfo from './SwapInfo';
@@ -29,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, 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, SpecialEditionLoyaltyCard, 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.23",
+	"version": "1.4.24",
 	"description": "Drip SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",