Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getData
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getLeverageStrategyData
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getLeverageStrategyProxy
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getQueuePosition
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: claimQueue
slug: sdk/api/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
2 changes: 1 addition & 1 deletion src/services/boost/transactions/lock/lock.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: lock
slug: sdk/api/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 Down
2 changes: 1 addition & 1 deletion src/services/boost/transactions/unlock/unlock.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: unlock
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: upgradeLeverageStrategy
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getRewards
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: create
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getBurnAmount
title: getBurnAmount
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getBurnAmountForUnstake
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getHealthFactor
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getAssetsFromShares
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getBalance
slug: sdk/api/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
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getMaxMint/getMaxMint.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getMaxMint
title: getMaxMint
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getMaxMintAmount
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getAPY
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getRate
slug: sdk/api/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
2 changes: 1 addition & 1 deletion src/services/osToken/requests/getPosition/getPosition.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getPosition
title: getPosition
slug: sdk/api/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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getSharesFromAssets
slug: sdk/api/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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: burn
slug: sdk/api/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
2 changes: 1 addition & 1 deletion src/services/osToken/transactions/mint/mint.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: mint
slug: sdk/api/osToken/transactions/mint
slug: /sdk/api/osToken/transactions/mint
description: Use the StakeWise SDK osToken mint method to mint osTokens based on your vault deposit, with health factor checks.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getClaimAmount
slug: sdk/api/rewardSplitter/requests/getclaimamount
slug: /sdk/api/rewardSplitter/requests/getclaimamount
description: Use the StakeWise SDK getClaimAmount method to calculate claimable assets from active and inactive reward splitters.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: claimRewards
slug: sdk/api/rewardSplitter/transactions/claimrewards
slug: /sdk/api/rewardSplitter/transactions/claimrewards
description: Use the StakeWise SDK rewardSplitter claimRewards method to claim accumulated rewards from a reward splitter contract.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: create
slug: sdk/api/rewardSplitter/transactions/createrewardsplitter
slug: /sdk/api/rewardSplitter/transactions/createrewardsplitter
description: Use the StakeWise SDK createRewardSplitter method to deploy a contract that distributes vault rewards among fee recipients.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: setClaimer
slug: sdk/api/rewardSplitter/transactions/setclaimer
slug: /sdk/api/rewardSplitter/transactions/setclaimer
description: Use the StakeWise SDK setClaimer method to authorize an address to claim vault fees on behalf of reward splitter shareholders.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: updateFeeRecipients
slug: sdk/api/rewardSplitter/transactions/updatefeerecipients
slug: /sdk/api/rewardSplitter/transactions/updatefeerecipients
description: Use the StakeWise SDK updateFeeRecipients method to modify reward splitter fee recipients and their share proportions.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/utils/getFiatRates/getFiatRates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getFiatRates
slug: sdk/api/utils/getfiatrates
slug: /sdk/api/utils/getfiatrates
description: Use the StakeWise SDK getFiatRates utility to retrieve current fiat exchange rates (USD, EUR, GBP, CNY, JPY, KRW, AUD).
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getFiatRatesByDay
slug: sdk/api/utils/getfiatratesbyday
slug: /sdk/api/utils/getfiatratesbyday
description: Use the StakeWise SDK getFiatRatesByDay utility to retrieve historical daily fiat exchange rates for a date range.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getPermitSignature
slug: sdk/api/utils/getpermitsignature
slug: /sdk/api/utils/getpermitsignature
description: Use the StakeWise SDK getPermitSignature utility to generate an ERC20 permit signature for gasless token approvals.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getStakewiseStats
slug: sdk/api/utils/getstakewisestats
slug: /sdk/api/utils/getstakewisestats
description: Use the StakeWise SDK getStakewiseStats utility to fetch protocol-wide statistics including TVL, user count, and total rewards.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/utils/getTransactions/getTransactions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getTransactions
slug: sdk/api/utils/gettransactions
slug: /sdk/api/utils/gettransactions
description: Use the StakeWise SDK getTransactions utility to verify that a transaction has been indexed by the subgraph.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/vault/requests/getBlocklist/getBlocklist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getBlocklist
slug: sdk/api/vault/requests/getblocklist
slug: /sdk/api/vault/requests/getblocklist
description: Use the StakeWise SDK getBlocklist method to fetch the list of blocked addresses for blocklisted vaults.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getExitQueuePositions
slug: sdk/api/vault/requests/getexitqueuepositions
slug: /sdk/api/vault/requests/getexitqueuepositions
description: Use the StakeWise SDK getExitQueuePositions method to retrieve the withdrawal queue positions for a specific user.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getHarvestParams
slug: sdk/api/vault/requests/getharvestparams
slug: /sdk/api/vault/requests/getharvestparams
description: Use the StakeWise SDK getHarvestParams method to fetch the parameters needed to update vault state and harvest rewards.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: getMaxWithdraw
title: getMaxWithdraw
slug: sdk/api/vault/requests/getmaxwithdraw
slug: /sdk/api/vault/requests/getmaxwithdraw
description: "StakeWise SDK getMaxWithdraw method (deprecated): calculates the maximum withdrawal amount based on staked and minted assets."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getMaxWithdrawAmount
slug: sdk/api/vault/requests/getmaxwithdrawamount
slug: /sdk/api/vault/requests/getmaxwithdrawamount
description: Use the StakeWise SDK getMaxWithdrawAmount method to calculate the maximum amount a user can withdraw from a vault.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getOsTokenConfig
slug: sdk/api/vault/getostokenconfig
slug: /sdk/api/vault/getostokenconfig
description: Use the StakeWise SDK getOsTokenConfig method to retrieve osToken collateral parameters like LTV and liquidation threshold.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getPeriodicDistributions
slug: sdk/api/vault/requests/getperiodicdistributions
slug: /sdk/api/vault/requests/getperiodicdistributions
description: Use the StakeWise SDK getPeriodicDistributions method to fetch periodic distribution data for additional vault incentives.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getRewardSplitters
slug: sdk/api/vault/requests/getrewardsplitters
slug: /sdk/api/vault/requests/getrewardsplitters
description: Use the StakeWise SDK getRewardSplitters method to fetch reward splitter contracts that distribute vault rewards among recipients.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getStakeBalance
slug: sdk/api/vault/requests/getstakebalance
slug: /sdk/api/vault/requests/getstakebalance
description: Use the StakeWise SDK getStakeBalance method to retrieve a user's staked balance and related data in a specific vault.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getStakerActions
slug: sdk/api/vault/requests/getstakeractions
slug: /sdk/api/vault/requests/getstakeractions
description: Use the StakeWise SDK getStakerActions method to fetch a paginated list of user interactions and events for a vault.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/vault/requests/getUserApy/getUserApy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getUserApy
slug: sdk/api/vault/requests/getuserapy
slug: /sdk/api/vault/requests/getuserapy
description: Use the StakeWise SDK getUserApy method to get a user's current APY in a vault, accounting for minting and boost.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getUserRewards
slug: sdk/api/vault/requests/getuserrewards
slug: /sdk/api/vault/requests/getuserrewards
description: Use the StakeWise SDK getUserRewards method to fetch daily staking rewards for a user within a specified date range.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/vault/requests/getUserStats/getUserStats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getUserStats
slug: sdk/api/vault/requests/getuserstats
slug: /sdk/api/vault/requests/getuserstats
description: Use the StakeWise SDK getUserStats method to retrieve user stats for a vault, useful for building performance charts.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getValidators
slug: sdk/api/vault/requests/getvalidators
slug: /sdk/api/vault/requests/getvalidators
description: Use the StakeWise SDK getValidators method to retrieve the list of running validators for a specific vault.
---

Expand Down
2 changes: 1 addition & 1 deletion src/services/vault/requests/getVault/getVault.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getVault
slug: sdk/api/vault/requests/getvault
slug: /sdk/api/vault/requests/getvault
description: Use the StakeWise SDK getVault method to retrieve master data for a vault including APY, TVL, and configuration details.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getVaultFactory
slug: sdk/api/vault/requests/getvaultfactory
slug: /sdk/api/vault/requests/getvaultfactory
description: Use the StakeWise SDK getVaultFactory method to get the vault factory contract address needed for vault creation.
---

Expand Down
Loading
Loading