[docs] add converters

Author: Cast0001

README.md

@@ -62,7 +62,7 @@ const sdk = new StakeWiseSDK({ network: Network.Mainnet })
 | network | `Network` | **Require** | Chain id |
 | provider | `any` | **Optional** | You can provide your implementation of the provender for ethers |
 | endpoints.subgraph | `string` | **Optional** | stakewise sbugraph url |
-| endpoints.web3 | `number` | **Require** | Your url for connect to blockchian |
+| endpoints.web3 | `number` | **Optional** | Your url for connect to blockchian |
 | endpoints.api | `string` | **Optional** | stakewise backend url |
 
 ## Quick Links
@@ -71,8 +71,8 @@ const sdk = new StakeWiseSDK({ network: Network.Mainnet })
 | [sdk.vault.getAllocatorActions](#sdkvaultgetallocatoractions) | [sdk.osToken.getBurnAmount](#sdkostokengetburnamount) | [sdk.utils.getRewardsPerYear](#sdkutilsgetrewardsperyear) |
 | [sdk.vault.getDaySnapshots](#sdkvaultgetdaysnapshots) | [sdk.osToken.getHealthFactor](#sdkostokengethealthfactor) | [sdk.utils.getSwiseUsdPrice](#sdkutilsgetswiseusdprice) |
 | [sdk.vault.getExitQueue](#sdkvaultgetexitqueue) | [sdk.osToken.getAPY](#sdkostokengetapy) | [sdk.utils.getTransactions](#sdkutilsgettransactions) |
-| [sdk.vault.getValidators](#sdkvaultgetvalidators) | [sdk.osToken.getPosition](#sdkostokengetposition) |
-| [sdk.vault.getVault](#sdkvaultgetvault) | [sdk.osToken.getMaxMint](#sdkostokengetmaxmint) |
+| [sdk.vault.getValidators](#sdkvaultgetvalidators) | [sdk.osToken.getPosition](#sdkostokengetposition) | [sdk.utils.getAssetsFromShares](#sdkutilsgetassetsfromshares) |
+| [sdk.vault.getVault](#sdkvaultgetvault) | [sdk.osToken.getMaxMint](#sdkostokengetmaxmint) | [sdk.utils.getSharesFromAssets](#sdkutilsgetsharesfromassets) |
 | [sdk.vault.getWithdrawData](#sdkvaultgetwithdrawdata) | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
 | [sdk.vault.getHarvestParams](#sdkvaultgetharvestparams) |
 | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
@@ -708,6 +708,54 @@ type Output = Array<{
 await sdk.utils.getTransactions({ hash: '0x...' })
 ```
 ---
+### `sdk.utils.getAssetsFromShares`
+
+#### Description:
+
+Convert osToken to ETH
+
+#### Arguments:
+
+| Name | Type | Type |
+|------|------|-------------|
+| amount | `bigint` | **Require** |
+
+#### Returns:
+
+```ts
+type Output = bigint
+```
+
+#### Example:
+
+```ts
+await sdk.utils.getAssetsFromShares({ amount: 0n })
+```
+---
+### `sdk.utils.getSharesFromAssets`
+
+#### Description:
+
+Convert ETH to osToken
+
+#### Arguments:
+
+| Name | Type | Type |
+|------|------|-------------|
+| amount | `bigint` | **Require** |
+
+#### Returns:
+
+```ts
+type Output = bigint
+```
+
+#### Example:
+
+```ts
+await sdk.utils.getSharesFromAssets({ amount: 0n })
+```
+---
 ## Description of other parts of the api
 
 To retrieve the storage data, you just need the method above. Other parts of the api are needed for specific tasks.

src/methods/utils/getAssetsFromShares.ts

@@ -0,0 +1,15 @@
+type GetAssetsFromSharesInput = {
+  contracts: StakeWise.Contracts
+  amount: bigint
+}
+
+const getAssetsFromShares = async (values: GetAssetsFromSharesInput) => {
+  const { contracts, amount } = values
+
+  const result = await contracts.tokens.mintToken.convertToAssets(amount)
+
+  return result || 0n
+}
+
+
+export default getAssetsFromShares

src/methods/utils/getSharesFromAssets.ts

@@ -0,0 +1,15 @@
+type GetSharesFromAssetsInput = {
+  contracts: StakeWise.Contracts
+  amount: bigint
+}
+
+const getSharesFromAssets = async (values: GetSharesFromAssetsInput) => {
+  const { contracts, amount } = values
+
+  const result = await contracts.tokens.mintToken.convertToShares(amount)
+
+  return result || 0n
+}
+
+
+export default getSharesFromAssets

src/methods/utils/index.ts

@@ -1,3 +1,5 @@
+export { default as getSharesFromAssets } from './getSharesFromAssets'
+export { default as getAssetsFromShares } from './getAssetsFromShares'
 export { default as getRewardsPerYear } from './getRewardsPerYear'
 export { default as getSwiseUsdPrice } from './getSwiseUsdPrice'
 export { default as getTransactions } from './getTransactions'