Skip to content

Change docs links #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Cast0001 merged 1 commit into from
Mar 18, 2026
Merged

Change docs links #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/services/boost/requests/getData/getData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getData
slug: /boost/requests/getdata
slug: sdk/api/boost/requests/getdata
description: Use the StakeWise SDK boost getData method to retrieve boost and leverage strategy data for a vault user.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/boost/requests/getLeverageStrategyData/getLeverageStrategyData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getLeverageStrategyData
slug: /boost/requests/getleveragestrategydata
slug: sdk/api/boost/requests/getleveragestrategydata
description: Use the StakeWise SDK getLeverageStrategyData method to check the leverage strategy version and upgrade status.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/boost/requests/getLeverageStrategyProxy/getLeverageStrategyProxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getLeverageStrategyProxy
slug: /boost/requests/getleveragestrategyproxy
slug: sdk/api/boost/requests/getleveragestrategyproxy
description: Use the StakeWise SDK getLeverageStrategyProxy method to get the leverage strategy proxy contract address for boosting.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/boost/requests/getQueuePosition/getQueuePosition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getQueuePosition
slug: /boost/requests/getqueueposition
slug: sdk/api/boost/requests/getqueueposition
description: Use the StakeWise SDK boost getQueuePosition method to retrieve unlock queue position data for a user's boosted osTokens.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/boost/transactions/claimQueue/claimQueue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: claimQueue
slug: /boost/transactions/claimqueue
slug: sdk/api/boost/transactions/claimqueue
description: Use the StakeWise SDK boost claimQueue method to claim assets from the unboost queue after unlocking osTokens.
---

Expand Down
8 changes: 4 additions & 4 deletions src/services/boost/transactions/lock/lock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: lock
slug: /boost/transactions/lock
slug: sdk/api/boost/transactions/lock
description: Use the StakeWise SDK boost lock method to boost osToken APY through leverage staking with a vault's strategy proxy.
---

Expand All @@ -15,10 +15,10 @@ Boost your osToken apy using leverage staking
| amount | `bigint` | **Yes** | Boost amount |
| userAddress | `string` | **Yes** | The user address |
| vaultAddress | `string` | **Yes** | The address of the vault that will mint osTokens for leverage staking |
| boostAddress | `string` | **Yes** | The address of the strategy proxy using the [sdk.boost.getLeverageStrategyProxy](/boost/requests/getleveragestrategyproxy) method |
| boostAddress | `string` | **Yes** | The address of the strategy proxy using the [sdk.boost.getLeverageStrategyProxy](/sdk/api/boost/requests/getleveragestrategyproxy) method |
| referrerAddress | `string` | **No** | The address of the referrer |
| permitParams | `PermitParams` | **No** | The permit signature is required if there isn’t enough osToken allowance for the strategy proxy contract.<br /><br />**For MultiSig**<br />The permit signature is not necessary for Multi Sig (e.g. Safe Wallet), as it should use `sdk.contracts.mintToken.approve(boostAddress, MaxUint256)` instead of a permit call to set up osToken allowance. This will be called in the action if needed.<br /><br />**For other wallets**<br />The permit signature is optional since it will be obtained automatically using the [utils.getPermitSignature](/utils/getpermitsignature) method. |
| leverageStrategyData | `LeverageStrategyData` | **No** | Leverage strategy data from [sdk.boost.getLeverageStrategyData](/boost/requests/getleveragestrategydata). If not provided, it will be fetched automatically during the transaction |
| permitParams | `PermitParams` | **No** | The permit signature is required if there isn’t enough osToken allowance for the strategy proxy contract.<br /><br />**For MultiSig**<br />The permit signature is not necessary for Multi Sig (e.g. Safe Wallet), as it should use `sdk.contracts.mintToken.approve(boostAddress, MaxUint256)` instead of a permit call to set up osToken allowance. This will be called in the action if needed.<br /><br />**For other wallets**<br />The permit signature is optional since it will be obtained automatically using the [utils.getPermitSignature](/sdk/api/utils/getpermitsignature) method. |
| leverageStrategyData | `LeverageStrategyData` | **No** | Leverage strategy data from [sdk.boost.getLeverageStrategyData](/sdk/api/boost/requests/getleveragestrategydata). If not provided, it will be fetched automatically during the transaction |

```ts
type LeverageStrategyData = {
Expand Down
4 changes: 2 additions & 2 deletions src/services/boost/transactions/unlock/unlock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: unlock
slug: /boost/transactions/unlock
slug: sdk/api/boost/transactions/unlock
description: Use the StakeWise SDK boost unlock method to unboost previously boosted osTokens by specifying a percentage to release.
---

Expand All @@ -15,7 +15,7 @@ Unboost your boosted osToken
| percent | `number` | **Yes** | The percent to unboost (100 at max) |
| userAddress | `string` | **Yes** | The user address |
| vaultAddress | `string` | **Yes** | The address of the vault where the osTokens boosted |
| leverageStrategyData | `LeverageStrategyData` | **No** | Leverage strategy data from [sdk.boost.getLeverageStrategyData](/boost/requests/getleveragestrategydata). If not provided, it will be fetched automatically during the transaction |
| leverageStrategyData | `LeverageStrategyData` | **No** | Leverage strategy data from [sdk.boost.getLeverageStrategyData](/sdk/api/boost/requests/getleveragestrategydata). If not provided, it will be fetched automatically during the transaction |

```ts
type LeverageStrategyData = {
Expand Down
2 changes: 1 addition & 1 deletion src/services/boost/transactions/upgradeLeverageStrategy/upgradeLeverageStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: upgradeLeverageStrategy
slug: /boost/transactions/upgradeleveragestrategy
slug: sdk/api/boost/transactions/upgradeleveragestrategy
description: Use the StakeWise SDK upgradeLeverageStrategy method to upgrade the leverage strategy contract for a vault's boost system.
---

Expand Down
8 changes: 4 additions & 4 deletions src/services/distributorRewards/requests/getRewards/getRewards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getRewards
slug: /distributorRewards/requests/getrewards
slug: sdk/api/distributorRewards/requests/getrewards
description: Use the StakeWise SDK distributorRewards getRewards method to fetch currently claimable distributor reward tokens for a user.
---

Expand Down Expand Up @@ -28,10 +28,10 @@ type Output =

| Name | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------|
| `proof` | The Merkle tree proof. Used in [sdk.distributorRewards.claim](/distributorRewards/transactions/claim) |
| `tokens` | An array of addresses of the tokens. Used in [sdk.distributorRewards.claim](/distributorRewards/transactions/claim) |
| `proof` | The Merkle tree proof. Used in [sdk.distributorRewards.claim](/sdk/api/distributorRewards/transactions/claim) |
| `tokens` | An array of addresses of the tokens. Used in [sdk.distributorRewards.claim](/sdk/api/distributorRewards/transactions/claim) |
| `unclaimedAmounts` | An array of unclaimed amounts of the tokens. A claim is available if at least one amount in the array is greater than zero. |
| `cumulativeAmounts` | An array of cumulative amounts of the tokens. Used in [sdk.distributorRewards.claim](/distributorRewards/transactions/claim) |
| `cumulativeAmounts` | An array of cumulative amounts of the tokens. Used in [sdk.distributorRewards.claim](/sdk/api/distributorRewards/transactions/claim) |

#### Example:

Expand Down
8 changes: 4 additions & 4 deletions src/services/distributorRewards/transactions/claim/claim.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: create
slug: /distributorRewards/transactions/claim
slug: sdk/api/distributorRewards/transactions/claim
description: Use the StakeWise SDK distributorRewards claim method to claim token rewards from the merkle distributor V2 contract.
---

Expand All @@ -15,9 +15,9 @@ Claims rewards from the merkle distributor V2 contract.
| Name | Type | Required | Description |
|-------------------|------------|----------|----------------------------------------------------------------------------------------------------------------------------------------|
| userAddress | `string` | **Yes** | The address of the user initiating the action. This address will become the owner of the reward splitter and must be the vault admin |
| proof | `string[]` | **Yes** | The Merkle tree proof. Get it from [sdk.distributorRewards.getRewards](/distributorRewards/requests/getrewards) |
| tokens | `string[]` | **Yes** | An array of addresses of the tokens. Get it from [sdk.distributorRewards.getRewards](/distributorRewards/requests/getrewards) |
| cumulativeAmounts | `string[]` | **Yes** | An array of cumulative amounts of the tokens. Get it from [sdk.distributorRewards.getRewards](/distributorRewards/requests/getrewards) |
| proof | `string[]` | **Yes** | The Merkle tree proof. Get it from [sdk.distributorRewards.getRewards](/sdk/api/distributorRewards/requests/getrewards) |
| tokens | `string[]` | **Yes** | An array of addresses of the tokens. Get it from [sdk.distributorRewards.getRewards](/sdk/api/distributorRewards/requests/getrewards) |
| cumulativeAmounts | `string[]` | **Yes** | An array of cumulative amounts of the tokens. Get it from [sdk.distributorRewards.getRewards](/sdk/api/distributorRewards/requests/getrewards) |

#### Example:

Expand Down
8 changes: 4 additions & 4 deletions src/services/osToken/helpers/getBurnAmount/getBurnAmount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getBurnAmount
title: getBurnAmount
slug: /osToken/helpers/getburnamount
slug: sdk/api/osToken/helpers/getburnamount
description: "StakeWise SDK getBurnAmount helper (deprecated): calculates how many osTokens to burn to fully withdraw your deposit."
---

Expand All @@ -16,9 +16,9 @@ How many osToken burn do you need to make to withdraw all deposit.
| Name | Type | Required | Description |
|-----------------|----------|----------|--------------------------------------------------------------|
| vaultAddress | `string` | **Yes** | The address of the vault |
| ltvPercent | `bigint` | **Yes** | [sdk.vault.getVault](/vault/requests/getvault) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/osToken/requests/getposition) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/vault/requests/getstakebalance) |
| ltvPercent | `bigint` | **Yes** | [sdk.vault.getVault](/sdk/api/vault/requests/getvault) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/sdk/api/osToken/requests/getposition) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/sdk/api/vault/requests/getstakebalance) |
| newStakedAssets | `bigint` | **Yes** | The future amount of stake after the deposit |

#### Returns:
Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/helpers/getBurnAmountForUnstake/getBurnAmountForUnstake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getBurnAmountForUnstake
slug: /osToken/helpers/getburnamountforunstake
slug: sdk/api/osToken/helpers/getburnamountforunstake
description: Use the StakeWise SDK getBurnAmountForUnstake helper to calculate osTokens that must be burned to enable full unstaking.
---

Expand Down
8 changes: 4 additions & 4 deletions src/services/osToken/helpers/getHealthFactor/getHealthFactor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getHealthFactor
slug: /osToken/helpers/gethealthfactor
slug: sdk/api/osToken/helpers/gethealthfactor
description: Use the StakeWise SDK getHealthFactor helper to assess the health of an osToken position relative to liquidation thresholds.
---

Expand All @@ -11,9 +11,9 @@ Get the health of the position
#### Arguments:
| Name | Type | Required | Description |
|------------------|----------|----------|------------------------------------------------------|
| liqThresholdPercent | `bigint` | **Yes** | [sdk.vault.getVault](/vault/requests/getvault) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/osToken/requests/getposition) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/vault/requests/getstakebalance) |
| liqThresholdPercent | `bigint` | **Yes** | [sdk.vault.getVault](/sdk/api/vault/requests/getvault) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/sdk/api/osToken/requests/getposition) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/sdk/api/vault/requests/getstakebalance) |

#### Returns:

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getAssetsFromShares/getAssetsFromShares.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getAssetsFromShares
slug: /osToken/requests/getassetsfromshares
slug: sdk/api/osToken/requests/getassetsfromshares
description: Use the StakeWise SDK getAssetsFromShares method to convert an osToken share amount to its equivalent ETH value.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getBalance/getBalance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getBalance
slug: /osToken/requests/getbalance
slug: sdk/api/osToken/requests/getbalance
description: Use the StakeWise SDK osToken getBalance method to retrieve a user's osToken balance for a specific vault.
---

Expand Down
8 changes: 4 additions & 4 deletions src/services/osToken/requests/getMaxMint/getMaxMint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getMaxMint
title: getMaxMint
slug: /osToken/requests/getmaxmint
slug: sdk/api/osToken/requests/getmaxmint
description: "StakeWise SDK getMaxMint method (deprecated): returns the maximum number of osToken shares available for minting."
---

Expand All @@ -16,9 +16,9 @@ Maximum number of **shares** for minting
| Name | Type | Required | Description |
|--------------|----------|----------|--------------------------------------------------------------|
| vaultAddress | `string` | **Yes** | The address of the vault |
| ltvPercent | `bigint` | **Yes** | [sdk.vault.getVault](/vault/requests/getvault) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/vault/requests/getstakebalance) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/osToken/requests/getposition) |
| ltvPercent | `bigint` | **Yes** | [sdk.vault.getVault](/sdk/api/vault/requests/getvault) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/sdk/api/vault/requests/getstakebalance) |
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](/sdk/api/osToken/requests/getposition) |

#### Returns:

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getMaxMintAmount/getMaxMintAmount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getMaxMintAmount
slug: /osToken/requests/getmaxmintamount
slug: sdk/api/osToken/requests/getmaxmintamount
description: Use the StakeWise SDK getMaxMintAmount method to calculate the maximum number of osToken shares a user can mint.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getOsTokenAPY/getOsTokenAPY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getAPY
slug: /osToken/requests/getostokenapy
slug: sdk/api/osToken/requests/getostokenapy
description: Use the StakeWise SDK getOsTokenAPY method to retrieve the current annual percentage yield and fee for osToken.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getOsTokenRate/getOsTokenRate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getRate
slug: /osToken/requests/getostokenrate
slug: sdk/api/osToken/requests/getostokenrate
description: Use the StakeWise SDK getOsTokenRate method to get the current ETH to osToken exchange rate for conversions.
---

Expand Down
8 changes: 4 additions & 4 deletions src/services/osToken/requests/getPosition/getPosition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getPosition
title: getPosition
slug: /osToken/requests/getposition
slug: sdk/api/osToken/requests/getposition
description: "StakeWise SDK getPosition method (deprecated): retrieves user osToken position data including minted assets and health factor."
---

Expand All @@ -15,8 +15,8 @@ User position data
#### Arguments:
| Name | Type | Required | Description |
|------------------|----------|----------|--------------------------------------------------------------|
| liqThresholdPercent | `bigint` | **Yes** | [sdk.vault.getVault](/vault/requests/getvault) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/vault/requests/getstakebalance) |
| liqThresholdPercent | `bigint` | **Yes** | [sdk.vault.getVault](/sdk/api/vault/requests/getvault) |
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](/sdk/api/vault/requests/getstakebalance) |
| userAddress | `string` | **Yes** | The user address |
| vaultAddress | `string` | **Yes** | The address of the vault |

Expand All @@ -40,7 +40,7 @@ type Output = {
|----------------------|-----------------------------------------------------------------|
| `minted.shares` | Balance |
| `minted.assets` | Balance in ETH |
| `healthFactor` | [sdk.osToken.getHealthFactor](/osToken/helpers/gethealthfactor) |
| `healthFactor` | [sdk.osToken.getHealthFactor](/sdk/api/osToken/helpers/gethealthfactor) |
| `protocolFeePercent` | Usage fee percent |

#### Example:
Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getSharesFromAssets/getSharesFromAssets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getSharesFromAssets
slug: /osToken/requests/getsharesfromassets
slug: sdk/api/osToken/requests/getsharesfromassets
description: Use the StakeWise SDK getSharesFromAssets method to convert an ETH amount to its equivalent osToken share value.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/osToken/transactions/burn/burn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: burn
slug: /osToken/transactions/burn
slug: sdk/api/osToken/transactions/burn
description: Use the StakeWise SDK osToken burn method to burn osTokens and reduce your minted position in a vault.
---

Expand Down
Loading
Loading