@dripfi/drip-sdk 1.0.5 → 1.0.6

package/README.md

@@ -45,3 +45,21 @@ const dripSdk = new DripSdk(dripConfig, signer);
 
 - **getUserBalance(vault: Vault): Promise<UserBalance>**  
   Fetches the user's balance for a specific Drip Vault.
+
+- **deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise**  
+  The deposit function allows you to deposit tokens into a specific vault.
+
+- **swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise**  
+  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**  
+  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**  
+  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**  
+  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/DripSdk.d.ts

@@ -19,10 +19,11 @@ export default class DripSdk {
     }>;
     updateSigner(newSigner: Signer): void;
     getUserBalance(vault: Vault): Promise<UserBalance>;
-    private fastWithdraw;
-    private deposit;
-    private swapAndDeposit;
-    private withdraw;
+    fastWithdraw(vault: Vault, amountToWithdraw?: string): Promise<void>;
+    deposit(tokenAddress: string, vaultAddress: string, amount: string): Promise<void>;
+    swapAndDeposit(fromTokenAddress: string, toTokenAddress: string, fromTokenAmount: string, vaultAddress: string, ethAmount?: string): Promise<void>;
+    withdraw(vault: Vault, amountToWithdraw?: string): Promise<void>;
+    claimWithdraws(vaultAddress: string): Promise<void>;
     private generateOldRedeemBagStruct;
     private generateNewRedeemBagStruct;
     private getAllSvts;

package/dist/DripSdk.js

@@ -133,108 +133,102 @@ class DripSdk {
     }
     fastWithdraw(vault, amountToWithdraw) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            if (!this.signer)
-                throw Error('No signer provided');
-            try {
-                const signerAddress = yield this.signer.getAddress();
-                if (!signerAddress)
-                    throw Error('Error fetching address');
-                const redeemBagStruct = this.shouldUseNewWithdrawLogic(signerAddress, vault)
-                    ? yield this.generateNewRedeemBagStruct(vault, signerAddress, amountToWithdraw)
-                    : yield this.generateOldRedeemBagStruct(vault, signerAddress, amountToWithdraw);
-                const currentBlockNumber = yield ((_a = this.signer.provider) === null || _a === void 0 ? void 0 : _a.getBlockNumber());
-                if (!currentBlockNumber)
-                    throw Error('Error fetching block number');
-                const redeemTx = yield ((_b = this.spoolSdk) === null || _b === void 0 ? void 0 : _b.redeemFast(redeemBagStruct, signerAddress.toLowerCase(), currentBlockNumber));
-                const redeemTxReceipt = yield redeemTx.wait();
-            }
-            catch (error) {
-                console.log(error);
-            }
+            // if (!this.signer) throw Error('No signer provided')
+            // try {
+            //     const signerAddress = await this.signer.getAddress()
+            //     if (!signerAddress) throw Error('Error fetching address')
+            //     const redeemBagStruct: RedeemBagStruct = this.shouldUseNewWithdrawLogic(signerAddress, vault)
+            //         ? await this.generateNewRedeemBagStruct(vault, signerAddress, amountToWithdraw)
+            //         : await this.generateOldRedeemBagStruct(vault, signerAddress, amountToWithdraw)
+            //     const currentBlockNumber = await this.signer.provider?.getBlockNumber()
+            //     if (!currentBlockNumber) throw Error('Error fetching block number')
+            //     const redeemTx = await this.spoolSdk?.redeemFast(
+            //         redeemBagStruct,
+            //         signerAddress.toLowerCase(),
+            //         currentBlockNumber,
+            //     )
+            //     const redeemTxReceipt = await redeemTx!.wait()
+            // } catch (error) {
+            //     console.log(error)
+            // }
         });
     }
     deposit(tokenAddress, vaultAddress, amount) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.signer)
-                throw Error('No signer provided');
-            const currentTokenAllowance = yield this.getTokenAllowanceForDeposit(tokenAddress);
-            const decimals = yield this.getERC20Precission(tokenAddress);
-            let amountToWithdrawFixedDecimals = parseFloat(amount).toFixed(decimals);
-            const amountToDeposit = ethers_1.ethers.utils.parseUnits(amountToWithdrawFixedDecimals, decimals);
-            if (amountToDeposit.gt(currentTokenAllowance)) {
-                const requiredTokenAllowance = amountToDeposit.sub(currentTokenAllowance);
-                yield this.approveTokenForDeposit(tokenAddress, requiredTokenAllowance);
-            }
-            const signerAddress = yield this.signer.getAddress();
-            if (!signerAddress)
-                throw Error('Error fetching address');
-            const depositBagStruct = {
-                smartVault: vaultAddress,
-                assets: [amountToDeposit],
-                receiver: signerAddress,
-                referral: ethers_1.ethers.constants.AddressZero,
-                doFlush: false,
-            };
-            const depositTx = yield this.spoolSdk.deposit(depositBagStruct);
-            yield depositTx.wait();
+            // if (!this.signer) throw Error('No signer provided')
+            // const currentTokenAllowance = await this.getTokenAllowanceForDeposit(tokenAddress)
+            // const decimals = await this.getERC20Precission(tokenAddress)
+            // let amountToWithdrawFixedDecimals = parseFloat(amount).toFixed(decimals)
+            // const amountToDeposit = ethers.utils.parseUnits(amountToWithdrawFixedDecimals, decimals)
+            // if (amountToDeposit.gt(currentTokenAllowance)) {
+            //     const requiredTokenAllowance = amountToDeposit.sub(currentTokenAllowance)
+            //     await this.approveTokenForDeposit(tokenAddress, requiredTokenAllowance)
+            // }
+            // const signerAddress = await this.signer.getAddress()
+            // if (!signerAddress) throw Error('Error fetching address')
+            // const depositBagStruct: DepositBagStruct = {
+            //     smartVault: vaultAddress,
+            //     assets: [amountToDeposit],
+            //     receiver: signerAddress,
+            //     referral: ethers.constants.AddressZero,
+            //     doFlush: false,
+            // }
+            // const depositTx = await this.spoolSdk!.deposit(depositBagStruct)
+            // await depositTx.wait()
         });
     }
     swapAndDeposit(fromTokenAddress, toTokenAddress, fromTokenAmount, vaultAddress, ethAmount) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            if (!this.signer)
-                throw Error('No signer provided');
-            const decimals = yield this.getERC20Precission(fromTokenAddress);
-            const amountToWithdrawFixedDecimals = parseFloat(fromTokenAmount).toFixed(decimals);
-            const fromToken = ethers_1.ethers.utils.parseUnits(amountToWithdrawFixedDecimals, decimals);
-            const signerAddress = yield this.signer.getAddress();
-            if (fromToken.gt(ethers_1.BigNumber.from(0))) {
-                const currentTokenAllowance = yield this.getTokenAllowanceForSwapAndDepositContractAddress(fromTokenAddress);
-                if (fromToken.gt(currentTokenAllowance)) {
-                    yield this.approveTokenForSwapAndDepositContract(fromTokenAddress, fromToken.sub(currentTokenAllowance));
-                }
-            }
-            const swapInfo = yield this.dripApi.getSwapInfo(fromTokenAddress, toTokenAddress, fromToken, signerAddress);
-            const swapDepositBagStruct = {
-                inTokens: [fromTokenAddress],
-                inAmounts: [fromToken],
-                smartVault: vaultAddress,
-                swapInfo,
-                receiver: signerAddress,
-                referral: ethers_1.ethers.constants.AddressZero,
-                doFlush: false,
-            };
-            let swapAndDepositRequest;
-            if (ethAmount) {
-                const eth = ethers_1.ethers.utils.parseEther(ethAmount);
-                swapAndDepositRequest = yield ((_a = this.spoolSdk) === null || _a === void 0 ? void 0 : _a.swapAndDeposit(swapDepositBagStruct, { value: eth }));
-            }
-            else {
-                swapAndDepositRequest = yield ((_b = this.spoolSdk) === null || _b === void 0 ? void 0 : _b.swapAndDeposit(swapDepositBagStruct));
-            }
-            yield (swapAndDepositRequest === null || swapAndDepositRequest === void 0 ? void 0 : swapAndDepositRequest.wait());
+            // if (!this.signer) throw Error('No signer provided')
+            // const decimals = await this.getERC20Precission(fromTokenAddress)
+            // const amountToWithdrawFixedDecimals = parseFloat(fromTokenAmount).toFixed(decimals)
+            // const fromToken = ethers.utils.parseUnits(amountToWithdrawFixedDecimals, decimals)
+            // const signerAddress = await this.signer.getAddress()
+            // if (fromToken.gt(BigNumber.from(0))) {
+            //     const currentTokenAllowance = await this.getTokenAllowanceForSwapAndDepositContractAddress(fromTokenAddress)
+            //     if (fromToken.gt(currentTokenAllowance)) {
+            //         await this.approveTokenForSwapAndDepositContract(fromTokenAddress, fromToken.sub(currentTokenAllowance))
+            //     }
+            // }
+            // const swapInfo = await this.dripApi.getSwapInfo(fromTokenAddress, toTokenAddress, fromToken, signerAddress)
+            // const swapDepositBagStruct = {
+            //     inTokens: [fromTokenAddress],
+            //     inAmounts: [fromToken],
+            //     smartVault: vaultAddress,
+            //     swapInfo,
+            //     receiver: signerAddress,
+            //     referral: ethers.constants.AddressZero,
+            //     doFlush: false,
+            // }
+            // let swapAndDepositRequest: ethers.ContractTransaction | undefined
+            // if (ethAmount) {
+            //     const eth = ethers.utils.parseEther(ethAmount)
+            //     swapAndDepositRequest = await this.spoolSdk?.swapAndDeposit(swapDepositBagStruct, { value: eth })
+            // } else {
+            //     swapAndDepositRequest = await this.spoolSdk?.swapAndDeposit(swapDepositBagStruct)
+            // }
+            // await swapAndDepositRequest?.wait()
         });
     }
     withdraw(vault, amountToWithdraw) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.signer)
-                throw Error('No signer provided');
-            try {
-                const signerAddress = yield this.signer.getAddress();
-                if (!signerAddress)
-                    throw Error('Error fetching address');
-                const redeemBagStruct = this.shouldUseNewWithdrawLogic(signerAddress, vault)
-                    ? yield this.generateNewRedeemBagStruct(vault, signerAddress, amountToWithdraw)
-                    : yield this.generateOldRedeemBagStruct(vault, signerAddress, amountToWithdraw);
-                const redeemTx = yield this.spoolSdk.redeem(redeemBagStruct, signerAddress.toLowerCase(), false);
-                const redeemTxReceipt = yield redeemTx.wait();
-            }
-            catch (error) {
-                console.log(error);
-            }
+            // if (!this.signer) throw Error('No signer provided')
+            // try {
+            //     const signerAddress = await this.signer.getAddress()
+            //     if (!signerAddress) throw Error('Error fetching address')
+            //     const redeemBagStruct: RedeemBagStruct = this.shouldUseNewWithdrawLogic(signerAddress, vault)
+            //         ? await this.generateNewRedeemBagStruct(vault, signerAddress, amountToWithdraw)
+            //         : await this.generateOldRedeemBagStruct(vault, signerAddress, amountToWithdraw)
+            //     const redeemTx = await this.spoolSdk!.redeem(redeemBagStruct, signerAddress.toLowerCase(), false)
+            //     const redeemTxReceipt = await redeemTx.wait()
+            // } catch (error) {
+            //     console.log(error)
+            // }
         });
     }
+    claimWithdraws(vaultAddress) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
     generateOldRedeemBagStruct(vault, signerAddress, amountToWithdraw) {
         return __awaiter(this, void 0, void 0, function* () {
             const token = yield this.generateToken();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dripfi/drip-sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Drip SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",