@dripfi/drip-sdk 1.0.6 → 1.0.8

package/.prettierignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

package/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 120,
+  "useTabs": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "semi": false,
+  "trailingComma": "all",
+  "arrowParens": "always",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

package/README.md

@@ -15,51 +15,153 @@ npm i @dripfi/drip-sdk
 ## Usage
 
 ```typescript
-import DripSdk from '@drip/sdk';
+import DripSdk from '@drip/sdk'
 ```
 
 Initialize the SDK with your Drip configuration and an optional signer:
 
 ```typescript
-const dripConfig = new DripConfig(/* configuration */);
-const signer = /* your Signer instance */;
+const dripConfig = new DripConfig(
+    subgraphUrl: string,
+    priceFeedApiUrl: string,
+    rewardsUrl: string,
+    fastRedeemApi: string,
+    contracts: Record<number, ContractAddresses>,
+    dripRoute: string);
+const signer: ethers.Signer = /* your Signer instance */;
 const dripSdk = new DripSdk(dripConfig, signer);
+
+type Vault = {
+  vaultName: string
+  vaultAddress: string
+  apy: number
+  tvr: number
+  protocols: string[]
+  projectName: string
+  depositToken: VaultDepositToken
+  type: VaultType
+  rewards: VaultReward[]
+  liveUntil: string
+  liveUntilFormatted: string
+  hasPoolEnded: boolean
+  boosters: NFTBoost[]
+  stretchGoals: StretchGoal[]
+  strategies: Strategy[]
+  newWithdraw: boolean
+  tgePrice?: number
+  maxAmountOfTokens?: number
+  rewardsInformation: RewardsInformation
+}
+
+type VaultType = 'launch' | 'earn' | 'airdrop'
+
+type VaultDepositToken = {
+  name: string
+  symbol: string
+  roundingDecimals: number
+  precisionDecimals: number
+  tokenAddress: string
+}
+
+type VaultReward = {
+  type: 'token' | 'points'
+  name: string
+  symbol: string
+  decimals: number
+  tokenAddress: string
+  monthlyEmissionRate?: number
+}
+
+type NFTBoost = {
+  url: string
+  tokenAddress: string
+  multiplier: number
+  nftAddress: string
+  network: string
+  initialBlock: number // needs to be the block when rewards was deployed
+  imagePath: string
+}
+
+interface StretchGoal {
+  threshhold: number
+  threshholdDescription: string
+  rewardTooltip: string
+  rewardDescription: string
+  amountOfTokens: number
+}
+
+type RewardsInformation = {
+  [tokenAddress: string]: { blockNumber: string; rewardrate: string; timestamp: string; endTime: string }
+}
+
+type Strategy = {
+  address: string
+  lastDoHardWorkTime: number | null
+  lastDoHardWorkBlock: number | null
+}
+
+type AuthenticationStatus = {
+  isAuthenticated: boolean
+  address?: string
+  token?: string
+  message?: string
+}
+
+interface QLFastRedeem {
+  assetsWithdrawn: {
+    asset: {
+      decimals: number
+      id: string
+      name: string
+      symbol: string
+    }
+    claimed: string
+    id: string
+  }[]
+  blockNumber: number
+  id: string
+  svtWithdrawn: string
+}
+
+type SwapInfo = {
+  swapTarget: any
+  token: string
+  swapCallData: any
+}
+
 ```
 
 ## Methods
 
-- **getAllVaults(): Promise<Vault[]>**  
+- `getAllVaults(): Promise<Vault[]>`  
   Fetches details of all Drip Vaults.
 
-- **getVaultDetails(vaultAddress: string): Promise<Vault>**  
+- `getVaultDetails(vaultAddress: string): Promise<Vault> `
   Fetches details of a specific Drip Vault identified by its address.
 
-- **authenticate(): Promise<boolean>**  
+- `authenticate(): Promise<boolean>`  
   Initiates the user authentication process and returns a boolean indicating success.
 
-- **isUserAuthenticated(): Promise<{ isAuthenticated: boolean, address?: string, token?: string, message?: string }>**  
+- `isUserAuthenticated(): Promise<AuthenticationStatus>`  
   Checks if the user is authenticated and returns authentication status along with relevant information.
 
-- **updateSigner(newSigner: Signer)**  
+- `updateSigner(newSigner: Signer): Promise<void>`  
   Updates the signer for the SDK instance.
 
-- **getUserBalance(vault: Vault): Promise<UserBalance>**  
+- `getUserBalance(vault: Vault): Promise<UserBalance>`  
   Fetches the user's balance for a specific Drip Vault.
 
-- **deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise**  
+- `deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise<void>`  
   The deposit function allows you to deposit tokens into a specific vault.
 
-- **swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise**  
+- `swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise<void>`  
   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
 
-- **withdraw(vault: Vault, amountToWithdraw?: string): Promise**  
+- `withdraw(vault: Vault, amountToWithdraw?: string): Promise<void>`  
   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()
 
-- **claimWithdraws(vaultAddress: string): Promise**  
+- `claimWithdraws(vaultAddress: string): Promise<void>`  
   After the withdrawal has been processed by the 'DoHardWork' function, the 'claimWithdraws' function transfers the withdrawn tokens to their personal account.
 
-- **fastWithdraw(vault: Vault, amountToWithdraw?: string): Promise**  
+- `fastWithdraw(vault: Vault, amountToWithdraw?: string): Promise<void>`  
   For users who prefer not to wait for withdrawals to be processed, there is a Fast Withdrawal method. While this approach is more gas-intensive, as users bear the cost of executing the withdrawal process themselves, it allows for instant access to the withdrawn tokens. When utilizing Fast Withdrawal, users immediately receive the tokens, eliminating the need to initiate the 'claimWithdrawal' process separately.
-
-
-

package/dist/DripApi.d.ts

@@ -1,7 +1,7 @@
-import { BigNumber } from "ethers";
-import { Vault } from "./types/Vault";
-import { SwapInfo } from "./types/SwapInfo";
-import { QLFastRedeem } from "./types/QLFastRedeem";
+import { BigNumber } from 'ethers';
+import { Vault } from './types/Vault';
+import { SwapInfo } from './types/SwapInfo';
+import { QLFastRedeem } from './types/QLFastRedeem';
 export default class DripApi {
     route: string;
     constructor(route: string);

package/dist/DripApi.js

@@ -17,14 +17,14 @@ class DripApi {
     fetchAllVaults() {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield fetch(`${this.route}/api-be/api/vault`);
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
     fetchVaultDetails(vaultAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield fetch(`${this.route}/api-be/api/vault/${vaultAddress}`);
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -35,13 +35,13 @@ class DripApi {
             }
             const url = `${this.route}/oneinch?getRequest=/swap/v5.2/1/swap?fromTokenAddress=${fromTokenAddress}%26toTokenAddress=${toTokenAddress}%26amount=${amount.toString()}%26fromAddress=${fromAddress}%26slippage=0.1%26disableEstimate=true%26allowPartialFill=false%26includeTokensInfo=true`;
             const res = yield fetch(url);
-            const data = yield res.json();
+            const data = (yield res.json());
             return [
                 {
                     swapTarget: data.tx.to,
                     token: data.fromToken.address,
                     swapCallData: data.tx.data,
-                }
+                },
             ];
         });
     }
@@ -52,7 +52,7 @@ class DripApi {
             const res = yield fetch(`${this.route}/api-be/api/spool/user/svtBalance/${walletAddress}/${vaultAddress}`, {
                 headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -61,9 +61,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/userBalance/${walletAddress}/${vaultAddress}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -72,7 +72,7 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/dNft/${walletAddress}/${vaultAddress}`, {
-                headers
+                headers,
             });
             const data = yield res.json();
             return data;
@@ -83,9 +83,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/svtFromNft/${userAddress}/${vaultAddress}?dnfts=${dnfts.join(',')}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -94,9 +94,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/allWnft/${walletAddress}/${vaultAddress}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -105,9 +105,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/allDnft/${walletAddress}/${vaultAddress}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -116,9 +116,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/assetBalance/${blocknumber}/${vaultAddress}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }
@@ -127,9 +127,9 @@ class DripApi {
             const headers = new Headers();
             headers.append('Authorization', token);
             const res = yield fetch(`${this.route}/api-be/api/spool/user/fastWithdrawNft/${walletAddress}/${vaultAddress}`, {
-                headers
+                headers,
             });
-            const data = yield res.json();
+            const data = (yield res.json());
             return data;
         });
     }

package/dist/DripConfig.d.ts

@@ -1,5 +1,5 @@
-import { ContractAddresses, SDKConfig } from "@spool.fi/spool-v2-sdk";
-import { Signer } from "ethers";
+import { ContractAddresses, SDKConfig } from '@spool.fi/spool-v2-sdk';
+import { Signer } from 'ethers';
 export declare class DripConfig {
     internalConfig: SDKConfig;
     dripRoute: string;

package/dist/DripSdk.d.ts

@@ -1,7 +1,8 @@
-import { Vault } from "./types/Vault";
-import { Signer } from "ethers";
-import { DripConfig } from "./DripConfig";
-import { UserBalance } from "./types/UserBalance";
+import { Vault } from './types/Vault';
+import { Signer } from 'ethers';
+import { DripConfig } from './DripConfig';
+import { UserBalance } from './types/UserBalance';
+import { AuthenticationStatus } from './types/AuthenticationStatus';
 export default class DripSdk {
     private dripApi;
     private spoolSdk?;
@@ -11,12 +12,7 @@ export default class DripSdk {
     getAllVaults(): Promise<Vault[]>;
     getVaultDetails(vaultAddress: string): Promise<Vault>;
     authenticate(): Promise<boolean>;
-    isUserAuthenticated(): Promise<{
-        isAuthenticated: boolean;
-        address?: string;
-        token?: string;
-        message?: string;
-    }>;
+    isUserAuthenticated(): Promise<AuthenticationStatus>;
     updateSigner(newSigner: Signer): void;
     getUserBalance(vault: Vault): Promise<UserBalance>;
     fastWithdraw(vault: Vault, amountToWithdraw?: string): Promise<void>;

package/dist/DripSdk.js

@@ -18,7 +18,7 @@ const ethers_1 = require("ethers");
 const utils_1 = require("./utils");
 const DripApi_1 = __importDefault(require("./DripApi"));
 const js_cookie_1 = __importDefault(require("js-cookie"));
-const KASU_USDC_VAULT_ADDRESS = "0xd8aa8099a53eddebe6a49c98ca12746ff19aa502";
+const KASU_USDC_VAULT_ADDRESS = '0xd8aa8099a53eddebe6a49c98ca12746ff19aa502';
 class DripSdk {
     constructor(dripConfig, signer) {
         this.signer = signer;
@@ -62,18 +62,18 @@ class DripSdk {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (!this.signer) {
-                    return { isAuthenticated: false, message: "Signer not provided" };
+                    return { isAuthenticated: false, message: 'Signer not provided' };
                 }
                 const userAddress = yield this.signer.getAddress();
                 const cookieName = `auth_${userAddress.toLowerCase()}`;
                 const authToken = js_cookie_1.default.get(cookieName);
                 if (!authToken) {
-                    return { isAuthenticated: false, message: "Auth token not found" };
+                    return { isAuthenticated: false, message: 'Auth token not found' };
                 }
                 const { address } = web3_token_1.default.verify(authToken);
                 if (address.toLowerCase() !== userAddress.toLowerCase()) {
                     js_cookie_1.default.remove(cookieName);
-                    return { isAuthenticated: false, message: "Invalid token" };
+                    return { isAuthenticated: false, message: 'Invalid token' };
                 }
                 return { isAuthenticated: true, address: address.toLowerCase(), token: authToken };
             }
@@ -271,7 +271,7 @@ class DripSdk {
         return __awaiter(this, void 0, void 0, function* () {
             const token = yield this.generateToken();
             const decimals = yield this.getERC20Precission(vault.depositToken.tokenAddress.toLowerCase());
-            const withdrawAll = (!amountToWithdraw);
+            const withdrawAll = !amountToWithdraw;
             const initialAmountToWithdraw = ethers_1.ethers.utils.parseUnits(amountToWithdraw || '0', decimals);
             let totalAmountToWithdraw = initialAmountToWithdraw;
             let dnfts = yield this.dripApi.fetchEnrichedUserDNFTForVault(vault.vaultAddress.toLowerCase(), signerAddress, token);
@@ -309,7 +309,7 @@ class DripSdk {
                 smartVault: vault.vaultAddress.toLowerCase(),
                 shares: shares,
                 nftIds,
-                nftAmounts
+                nftAmounts,
             };
         });
     }
@@ -317,7 +317,9 @@ class DripSdk {
         return __awaiter(this, void 0, void 0, function* () {
             const token = yield this.generateToken();
             const svts = yield this.dripApi.fetchUserSVTFromNfts(vaultAddress, userAddress, dnfts.map((element) => parseInt(element.nftId)), token);
-            const result = dnfts.map((element, index) => { return { nftId: element.nftId, assets: element.assets, shares: element.shares, svts: svts[index] }; });
+            const result = dnfts.map((element, index) => {
+                return { nftId: element.nftId, assets: element.assets, shares: element.shares, svts: svts[index] };
+            });
             return result;
         });
     }
@@ -404,9 +406,10 @@ class DripSdk {
     shouldUseNewWithdrawLogic(userAddress, vault) {
         // Users that already withdrew using the old approach should keep using the same
         const usersWhoAlreadyWithdraw = {
-            '0x5ae62d2bc40e9119aee9cd4ed50e3d9378c9a191': KASU_USDC_VAULT_ADDRESS
+            '0x5ae62d2bc40e9119aee9cd4ed50e3d9378c9a191': KASU_USDC_VAULT_ADDRESS,
         };
-        if (usersWhoAlreadyWithdraw[userAddress.toLowerCase()] && usersWhoAlreadyWithdraw[userAddress.toLowerCase()] === vault.vaultAddress.toLowerCase()) {
+        if (usersWhoAlreadyWithdraw[userAddress.toLowerCase()] &&
+            usersWhoAlreadyWithdraw[userAddress.toLowerCase()] === vault.vaultAddress.toLowerCase()) {
             return false;
         }
         return vault.newWithdraw;

package/dist/test.d.ts

@@ -1,2 +1,2 @@
-import { ethers } from "ethers";
+import { ethers } from 'ethers';
 export declare const signer: ethers.Wallet;

package/dist/types/AuthenticationStatus.d.ts

@@ -0,0 +1,6 @@
+export type AuthenticationStatus = {
+    isAuthenticated: boolean;
+    address?: string;
+    token?: string;
+    message?: string;
+};

package/dist/types/AuthenticationStatus.js

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

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@dripfi/drip-sdk",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Drip SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "prepublish": "npm run build",
     "build": "tsc",
+    "format": "prettier --write .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
@@ -19,6 +20,8 @@
   "license": "ISC",
   "devDependencies": {
     "typescript": "^5.4.5",
-    "@types/js-cookie": "^3.0.6"
+    "@types/js-cookie": "^3.0.6",
+    "prettier": "3.2.5",
+    "prettier-plugin-tailwindcss": "^0.5.12"
   }
 }