@dripfi/drip-sdk 1.0.7 → 1.0.8

package/README.md

@@ -133,35 +133,35 @@ type SwapInfo = {
 
 ## 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<AuthenticationStatus>**  
+- `isUserAuthenticated(): Promise<AuthenticationStatus>`  
   Checks if the user is authenticated and returns authentication status along with relevant information.
 
-- **updateSigner(newSigner: Signer): Promise<void>**  
+- `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<void>**  
+- `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<void>**  
+- `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<void>**  
+- `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<void>**  
+- `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<void>**  
+- `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/package.json

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