@dripfi/drip-sdk 1.3.1 → 1.3.2

package/README.md

@@ -10,7 +10,6 @@ The Drip SDK is a TypeScript library designed to interact with the Drip protocol
 - [Methods](#methods)
 - [Examples](#examples)
 - [Types](#types)
-- [Abis](#abis)
 
 # Installation
 
@@ -74,9 +73,13 @@ 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 currently owned loyalty card of the connected wallet.
+| `getOwnedLoyaltyCard(): 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.
 
+
+> [!IMPORTANT]
+> **You must authenticate once for every wallet you want to use**
+
 ---
 
 # Examples
@@ -206,7 +209,7 @@ type Vault = {
   depositToken: VaultDepositToken
   type: VaultType
   rewards: VaultReward[]
-  rewardType: RewardType
+  rewardType: RewardType 
   liveUntil: string
   liveFrom: string
   liveUntilFormatted: string
@@ -220,15 +223,9 @@ type Vault = {
   coingeckoId?: string
   depositTokenId: string
   expectedTge?: string
-  tokenPrice: number
-  change24h: number
-  volume24h: number
-  projectFeatured: boolean
-  avgTvl: string
-  peakTvl: string
-  amountOfDepositors: number
-  boostedTvl: number
-  projectVAPY?: number
+  tokenPrice: number,
+  change24h: number,
+  volume24h: number,
 };
 
 type VaultType = 'launch' | 'earn' | 'airdrop'
@@ -369,49 +366,38 @@ 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/DripApi.d.ts

@@ -11,7 +11,7 @@ import { LoyaltyCard } from './types/LoyaltyCard';
 import { BeansBalance } from './types/BeansBalance';
 import { PerqToBeansSwapInfo } from './types/PerqToBeansSwapInfo';
 import BeanEntry from './types/BeanEntry';
-import { SignedPayload } from './types/SignedPayload';
+import { NonceEnrichedSignedPayload, NonceEnrichedPayload } from './types/SignedPayload';
 import { UpgradeLoyaltyCardPayload } from './types/UpgradeLoyaltyCardPayload';
 export default class DripApi {
     route: string;
@@ -37,8 +37,9 @@ export default class DripApi {
     fetchAllLoyaltyCards(): Promise<LoyaltyCard[]>;
     fetchOwnedLoyaltyCard(walletAddress: string): Promise<LoyaltyCard>;
     fetchBeansBalance(walletAddress: string): Promise<BeansBalance>;
-    upgradeLoyaltyCard(signedPayload: SignedPayload<UpgradeLoyaltyCardPayload>): Promise<LoyaltyCard>;
+    upgradeLoyaltyCard(signedPayload: NonceEnrichedSignedPayload<UpgradeLoyaltyCardPayload>): Promise<LoyaltyCard>;
     fetchMyPerqData(userAddress: string): Promise<MyPerqData>;
     getSwapPerqForBeansInfo(): Promise<PerqToBeansSwapInfo>;
     fetchBeansHistory(walletAddress: string): Promise<BeanEntry[]>;
+    getNonceEnrichedPayload<T>(payload: T): Promise<NonceEnrichedPayload<T>>;
 }

package/dist/DripApi.js

@@ -378,5 +378,22 @@ class DripApi {
             }
         });
     }
+    getNonceEnrichedPayload(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.route}/api-be/api/nonce`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ payload }), // Wrap in payload property for BE
+            });
+            if (!res.ok) {
+                throw new Error('Failed to get nonce-enriched payload');
+            }
+            const enrichedPayload = yield res.json();
+            // Return the enriched payload without the extra nesting
+            return enrichedPayload.payload;
+        });
+    }
 }
 exports.default = DripApi;

package/dist/DripSdk.d.ts

@@ -12,7 +12,7 @@ import { BeansBalance } from './types/BeansBalance';
 import { PerqToBeansSwapInfo } from './types/PerqToBeansSwapInfo';
 import BeanEntry from './types/BeanEntry';
 import { VestingInfo } from './types/VestingInfo';
-import { SignedPayload } from './types/SignedPayload';
+import { NonceEnrichedSignedPayload } from './types/SignedPayload';
 export default class DripSdk {
     private dripApi;
     private dripTokenContract;
@@ -72,7 +72,8 @@ export default class DripSdk {
     getAllVestingInfo(beneficiaryAddress: string): Promise<VestingInfo>;
     claimVestedPerq(amount: string): Promise<string>;
     burnVestedPerq(amount: string, price: string, deadline: string, signature: string): Promise<string>;
-    signPayload<T extends Record<string, unknown>>(payload: T): Promise<SignedPayload<T>>;
+    signPayload<T>(payload: T): Promise<NonceEnrichedSignedPayload<T>>;
+    private getEnrichedPayload;
     private generateRedeemBagStruct;
     private getERC20Precission;
     private calculatePendingDeposits;

package/dist/DripSdk.js

@@ -347,7 +347,9 @@ class DripSdk {
     }
     upgradeLoyaltyCard(index) {
         return __awaiter(this, void 0, void 0, function* () {
-            const payload = { index };
+            const payload = {
+                index
+            };
             const signedPayload = yield this.signPayload(payload);
             return this.dripApi.upgradeLoyaltyCard(signedPayload);
         });
@@ -557,20 +559,31 @@ class DripSdk {
     signPayload(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.signer) {
-                throw Error('No signer provided');
+                throw new Error('No signer provided');
             }
+            // Wrap the payload in a Basepayload to enrich it later on
+            const basePayload = {
+                payload
+            };
             const signerAddress = yield this.signer.getAddress();
+            // Get enriched payload with nonce before signing
+            const enrichedPayload = yield this.getEnrichedPayload(basePayload);
             // Create message to sign
-            const message = JSON.stringify(payload);
+            const message = JSON.stringify(enrichedPayload);
             // Sign the message
             const signature = yield this.signer.signMessage(message);
             return {
                 signature,
                 signerAddress,
-                payload,
+                payload: enrichedPayload,
             };
         });
     }
+    getEnrichedPayload(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.dripApi.getNonceEnrichedPayload(payload.payload);
+        });
+    }
     generateRedeemBagStruct(vault, signerAddress, amountToWithdraw) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.spoolSdk) {

package/dist/contracts/abi/DripSwapAndRecyclerAbi.json

@@ -1,4 +1,368 @@
 [
+    {
+        "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": [
             {
@@ -91,5 +455,62 @@
         ],
         "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"
     }
 ]