@ichidao/ichi-vaults-sdk 0.1.42 → 2.0.0

package/README.md

@@ -7,6 +7,8 @@ This sdk contains collection of functions to interact with IchiVault's smart con
 ## Table of Contents
 
 * [__Installation__](#Installation)
+    * [Version Compatibility](#version-compatibility)
+    * [Migration from v1 to v2](#migration-from-v1-to-v2)
 * [__Subgraphs__](#Subgraphs)
 * [__Usage__](#Usage)
      * [__Vault Functions__](#Vault)
@@ -18,11 +20,6 @@ This sdk contains collection of functions to interact with IchiVault's smart con
         * [`withdraw()`](#6-withdraw)
         * [`withdrawWithSlippage()`](#7-withdraw)
         * [`withdrawNativeToken()`](#8-withdraw)
-        * [`approveToken()`](#8a-approveToken)
-        * [`isTokenApproved()`](#8b-isTokenApproved)
-        * [`getActualDepositToken()`](#8c-getActualDepositToken)
-        * [`depositWithHtsWrapping()`](#8d-depositWithHtsWrapping)
-        * [`withdrawWithErc20Wrapping()`](#8e-withdrawWithErc20Wrapping)
         * [`isDepositTokenApproved()`](#9-isDepositTokenApproved)
         * [`isTokenAllowed()`](#10-isTokenAllowed)
         * [`getMaxDepositAmount()`](#11-getMaxDepositAmount)
@@ -59,12 +56,69 @@ or
 npm install @ichidao/ichi-vaults-sdk
 ```
 
+### Version Compatibility
+
+| SDK Version | Ethers.js Version | Status |
+|-------------|-------------------|--------|
+| 2.x.x       | v6                | Active |
+| 0.1.x       | v5                | Maintenance |
+
+**Version 2.x (ethers v6)** - Current default version. If you're using ethers v6 in your project, install the latest version:
+```bash
+yarn add @ichidao/ichi-vaults-sdk
+# or
+npm install @ichidao/ichi-vaults-sdk
+```
+
+**Version 0.1.x (ethers v5)** - For projects still using ethers v5, install the legacy version:
+```bash
+yarn add @ichidao/ichi-vaults-sdk@ethers5
+# or
+npm install @ichidao/ichi-vaults-sdk@ethers5
+```
+
+To install a specific version:
+```bash
+yarn add @ichidao/ichi-vaults-sdk@0.1.x
+# or
+npm install @ichidao/ichi-vaults-sdk@0.1.x
+```
+
+### Migration from v0.1 to v2
+
+The main breaking change in v2 is that functions requiring transaction signing now accept a `Signer` instead of `JsonRpcProvider`. This aligns with ethers v6's architecture where signers are explicitly passed rather than obtained from providers.
+
+**Before (v0.1 with ethers v5):**
+```typescript
+import { JsonRpcProvider } from '@ethersproject/providers';
+const provider = new JsonRpcProvider(rpcUrl);
+await deposit(account, amount0, amount1, vaultAddress, provider, dex);
+```
+
+**After (v2 with ethers v6):**
+```typescript
+import { JsonRpcProvider, Wallet } from 'ethers';
+const provider = new JsonRpcProvider(rpcUrl);
+const signer = new Wallet(privateKey, provider);
+await deposit(account, amount0, amount1, vaultAddress, signer, dex);
+```
+
+Functions affected by this change:
+- `approveDepositToken()`
+- `deposit()`
+- `depositNativeToken()`
+- `approveVaultToken()`
+- `withdraw()`
+- `withdrawWithSlippage()`
+- `withdrawNativeToken()`
+- `claimRewards()`
+
+Read-only functions continue to accept `JsonRpcProvider`.
+
 ## Usage
 ### Subgraphs
 This SDK uses subgraphs to obtain information about ICHI vaults. The subgraphs are deployed in the Subgraph Studio and published on Arbitrum One. If you prefer to use published subgraphs, you need to add your [subgraph API key](https://thegraph.com/studio/apikeys/) to the SUBGRAPH_API_KEY environment variable. Otherwise, the SDK will use the subgraph's Studio endpoint.
 
-**Note for Flow users:** The Flow blockchain uses Alchemy subgraph instead of Subgraph Studio. If you're using this SDK on Flow, you need to provide your own Alchemy subgraph API key by adding it to the ALCHEMY_SUBGRAPH_API_KEY environment variable.
-
 ### Vault
 
 #### 1. `approveDepositToken()`
@@ -387,206 +441,6 @@ const txnDetails = await withdraw(
 )
 ```
 
-#### 8a. `approveToken()`
-
-| param | type |  default | required
-| -------- | -------- | -------- | --------
-| accountAddress   | string | - | true
-| tokenAddress   | string | - | true
-| vaultAddress   | string | - | true |
-| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true |
-| amount   | string \| number \| BigNumber | undefined | false |
-| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
-
-<br/>
-
-This function approves a specific token for deposit into the vault by token address. Unlike `approveDepositToken()` which uses a token index (0 or 1), this function accepts the actual token address. This is particularly useful when working with HTS wrapped tokens where the actual deposit token may differ from the vault's token. Use `getActualDepositToken()` to determine the correct token address to approve.
-
-```typescript
-import { Web3Provider } from '@ethersproject/providers';
-import { approveToken, getActualDepositToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';
-
-const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
-const vaultAddress = "0x3ac9...a5f132"
-const accountAddress = "0xaaaa...aaaaaa"
-const depositToken = "0xbbbb...bbbbbb" // original deposit token from vault
-const dex = SupportedDex.Bonzo
-
-// Get the actual token to approve (may be ERC20 counterpart of HTS token)
-const actualToken = await getActualDepositToken(depositToken, web3Provider);
-
-const txnDetails = await approveToken(
-    accountAddress,
-    actualToken,
-    vaultAddress,
-    web3Provider,
-    dex,
-    100 // amount (optional)
-);
-
-await txnDetails.wait();
-```
-
-#### 8b. `isTokenApproved()`
-
-| param | type |  default | required
-| -------- | -------- | -------- | --------
-| accountAddress   | string | - | true
-| tokenAddress   | string | - | true
-| amount   | string \| number \| BigNumber | - | true |
-| vaultAddress   | string | - | true |
-| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true |
-
-<br/>
-
-This function returns true if the specified token's allowance is non-zero and greater than or equal to the specified amount. Use this to check approval status for the actual deposit token (which may be the ERC20 counterpart of an HTS token for vaults on Hedera).
-
-```typescript
-import { Web3Provider } from '@ethersproject/providers';
-import { isTokenApproved, getActualDepositToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';
-
-const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
-const vaultAddress = "0x3ac9...a5f132"
-const accountAddress = "0xaaaa...aaaaaa"
-const depositToken = "0xbbbb...bbbbbb"
-const amount = 100
-const dex = SupportedDex.Bonzo
-
-// Get the actual token to check (may be ERC20 counterpart of HTS token)
-const actualToken = await getActualDepositToken(depositToken, web3Provider);
-
-const isApproved: boolean = await isTokenApproved(
-    accountAddress,
-    actualToken,
-    amount,
-    vaultAddress,
-    web3Provider,
-    dex
-)
-```
-
-#### 8c. `getActualDepositToken()` - Bonzo on Hedera Only
-
-| param | type |  default | required
-| -------- | -------- | -------- | --------
-| depositToken   | string | - | true
-| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-
-<br/>
-
-> **Note:** This function is only available for Bonzo vaults on the Hedera chain.
-
-This helper function checks if the deposit token is an HTS wrapped token and returns its ERC20 counterpart if one exists. If no ERC20 counterpart exists, it returns the original token address. Use this function to determine the correct token address for approval and deposit operations.
-
-```typescript
-import { Web3Provider } from '@ethersproject/providers';
-import { getActualDepositToken } from '@ichidao/ichi-vaults-sdk';
-
-const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
-const depositToken = "0xbbbb...bbbbbb" // HTS wrapped token
-
-const actualToken = await getActualDepositToken(depositToken, web3Provider);
-// actualToken will be the ERC20 counterpart if one exists, otherwise the original token
-```
-
-#### 8d. `depositWithHtsWrapping()` - Bonzo on Hedera Only
-
-| param | type |  default | required
-| -------- | -------- | -------- | --------
-| accountAddress   | string | - | true
-| amount0           | string \| number \| BigNumber | - | true
-| amount1           | string \| number \| BigNumber | - | true
-| vaultAddress   | string | - | true
-| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true
-| percentSlippage   | number | 1 | false
-| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
-
-<br/>
-
-> **Note:** This function is only available for Bonzo vaults on the Hedera chain. Using it with other vaults or chains will throw an error.
-
-This function facilitates deposits into Bonzo vaults on Hedera with automatic HTS token wrapping. If the deposit token is an HTS wrapped token, the function automatically finds and uses its ERC20 counterpart for the deposit. The vault tokens received will be wrapped to HTS format. Use `approveToken()` with `getActualDepositToken()` to approve the correct token before calling this function.
-
-```typescript
-import { Web3Provider } from '@ethersproject/providers';
-import { depositWithHtsWrapping, approveToken, getActualDepositToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';
-
-const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
-const vaultAddress = "0x3ac9...a5f132"
-const dex = SupportedDex.Bonzo
-const accountAddress = "0xaaaa...aaaaaa"
-const depositToken = "0xbbbb...bbbbbb" // token from vault
-
-// First, get the actual token and approve it
-const actualToken = await getActualDepositToken(depositToken, web3Provider);
-await approveToken(accountAddress, actualToken, vaultAddress, web3Provider, dex);
-
-const amount0 = 100
-const amount1 = 0
-
-const txnDetails = await depositWithHtsWrapping(
-    accountAddress,
-    amount0,
-    amount1,
-    vaultAddress,
-    web3Provider,
-    dex,
-    1 // acceptable slippage (percent)
-)
-```
-
-#### 8e. `withdrawWithErc20Wrapping()` - Bonzo on Hedera Only
-
-| param | type |  default | required
-| -------- | -------- | -------- | --------
-| accountAddress   | string | - | true
-| shares           | string \| number \| BigNumber | - | true
-| vaultAddress   | string | - | true
-| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true
-| percentSlippage   | number | 1 | false
-| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
-
-<br/>
-
-> **Note:** This function is only available for Bonzo vaults on the Hedera chain. Using it with other vaults or chains will throw an error.
-
-This function facilitates withdrawals from Bonzo vaults on Hedera with automatic unwrapping of HTS tokens to their ERC20 counterparts. If the vault tokens are HTS wrapped, they will be automatically converted to ERC20 tokens during withdrawal. Ensure to use the `approveVaultToken()` function before invoking this function.
-
-```typescript
-import { Web3Provider } from '@ethersproject/providers';
-import { getUserBalance, withdrawWithErc20Wrapping, approveVaultToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';
-
-const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
-const vaultAddress = "0x3ac9...a5f132"
-const dex = SupportedDex.Bonzo
-const accountAddress = "0xaaaa...aaaaaa"
-
-const totalUserShares: string = await getUserBalance(
-    accountAddress,
-    vaultAddress,
-    web3Provider,
-    dex
-)
-
-let shares = Number(totalUserShares) * 0.5 // 50% of user share balance
-
-// Approve vault tokens first
-await approveVaultToken(accountAddress, vaultAddress, web3Provider, dex, shares);
-
-const txnDetails = await withdrawWithErc20Wrapping(
-    accountAddress,
-    shares,
-    vaultAddress,
-    web3Provider,
-    dex,
-    1 // acceptable slippage (percent)
-)
-```
-
 #### 9. `isDepositTokenApproved()`
 
 | param | type |  default | required
@@ -1446,7 +1300,6 @@ enum SupportedDex {
   Linehub = 'Linehub',
   Lynex = 'Lynex',
   Metavault = 'Metavault',
-  Nest = 'Nest',
   Nile = 'Nile',
   Ocelex = 'Ocelex',
   Pancakeswap = 'PancakeSwap',