Skip to content

Support self-appreciating vote-lock vaults (vlRSR) #29

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
lcamargof merged 1 commit into from
Jul 31, 2026
Merged

Support self-appreciating vote-lock vaults (vlRSR) #29

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
6 changes: 6 additions & 0 deletions .changeset/vote-lock-self-appreciating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@reserve-protocol/sdk": patch
"@reserve-protocol/react-sdk": patch
---

Support self-appreciating vote-lock vaults (vlRSR): `prepareVoteLockRedeem` builder for shares-denominated unlocks, `VoteLockState.shareBalance` + `VoteLockState.exchangeRate` (same single multicall), and `useIndexDtfVoteLockPreviewDeposit` / `useIndexDtfVoteLockPreviewRedeem` hooks for lock/unlock quotes.
60 changes: 31 additions & 29 deletions apps/docs/src/pages/react-sdk/index-dtf-hooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,35 +40,37 @@ const price = useIndexDtfPrice({ address, chainId });

## Product And Analytics Reads

| Hook | Core SDK method |
| ----------------------------------- | ------------------------------------- |
| `useIndexDtfStatus` | `sdk.index.getStatus` |
| `useIndexDtfExposure` | `sdk.index.getExposure` |
| `useIndexDtfHolders` | `sdk.index.getHolders` |
| `useIndexDtfAccountBalanceSnapshot` | `sdk.index.getAccountBalanceSnapshot` |
| `useIndexDtfTransactions` | `sdk.index.getTransactions` |
| `useIndexDtfRevenue` | `sdk.index.getRevenue` |
| `useIndexDtfPlatformFee` | `sdk.index.getPlatformFee` |
| `useIndexDtfPendingFeeShares` | `sdk.index.getPendingFeeShares` |
| `useIndexDtfApprovedRevenueTokens` | `sdk.index.getApprovedRevenueTokens` |
| `useIndexDtfIssuanceState` | `sdk.index.getIssuanceState` |
| `useIndexDtfBidsEnabled` | `sdk.index.getBidsEnabled` |
| `useIndexDtfRebalanceControl` | `sdk.index.getRebalanceControl` |
| `useIndexDtfRebalances` | `sdk.index.getRebalances` |
| `useIndexDtfRebalance` | `sdk.index.getRebalance` |
| `useIndexDtfCurrentRebalance` | `sdk.index.getCurrentRebalance` |
| `useIndexDtfRebalanceLiquidity` | `sdk.index.getRebalanceLiquidity` |
| `useIndexDtfRebalanceAuctions` | `sdk.index.getRebalanceAuctions` |
| `useIndexDtfActiveAuction` | `sdk.index.getActiveAuction` |
| `useIndexDtfLatestAuction` | `sdk.index.getLatestAuction` |
| `useIndexDtfBidQuote` | `sdk.index.getBidQuote` |
| `useIndexDtfCompletedRebalance` | `sdk.index.getCompletedRebalance` |
| `useIndexDtfCompletedRebalances` | `sdk.index.getCompletedRebalances` |
| `useIndexDtfVoteLockState` | `sdk.index.getVoteLockState` |
| `useIndexDtfVoteLockVaultState` | `sdk.index.getVoteLockVaultState` |
| `useAccountPortfolio` | `sdk.portfolio.get` |
| `useAccountPortfolioHistory` | `sdk.portfolio.getHistory` |
| `useAccountPortfolioTransactions` | `sdk.portfolio.getTransactions` |
| Hook | Core SDK method |
| ----------------------------------- | -------------------------------------- |
| `useIndexDtfStatus` | `sdk.index.getStatus` |
| `useIndexDtfExposure` | `sdk.index.getExposure` |
| `useIndexDtfHolders` | `sdk.index.getHolders` |
| `useIndexDtfAccountBalanceSnapshot` | `sdk.index.getAccountBalanceSnapshot` |
| `useIndexDtfTransactions` | `sdk.index.getTransactions` |
| `useIndexDtfRevenue` | `sdk.index.getRevenue` |
| `useIndexDtfPlatformFee` | `sdk.index.getPlatformFee` |
| `useIndexDtfPendingFeeShares` | `sdk.index.getPendingFeeShares` |
| `useIndexDtfApprovedRevenueTokens` | `sdk.index.getApprovedRevenueTokens` |
| `useIndexDtfIssuanceState` | `sdk.index.getIssuanceState` |
| `useIndexDtfBidsEnabled` | `sdk.index.getBidsEnabled` |
| `useIndexDtfRebalanceControl` | `sdk.index.getRebalanceControl` |
| `useIndexDtfRebalances` | `sdk.index.getRebalances` |
| `useIndexDtfRebalance` | `sdk.index.getRebalance` |
| `useIndexDtfCurrentRebalance` | `sdk.index.getCurrentRebalance` |
| `useIndexDtfRebalanceLiquidity` | `sdk.index.getRebalanceLiquidity` |
| `useIndexDtfRebalanceAuctions` | `sdk.index.getRebalanceAuctions` |
| `useIndexDtfActiveAuction` | `sdk.index.getActiveAuction` |
| `useIndexDtfLatestAuction` | `sdk.index.getLatestAuction` |
| `useIndexDtfBidQuote` | `sdk.index.getBidQuote` |
| `useIndexDtfCompletedRebalance` | `sdk.index.getCompletedRebalance` |
| `useIndexDtfCompletedRebalances` | `sdk.index.getCompletedRebalances` |
| `useIndexDtfVoteLockState` | `sdk.index.getVoteLockState` |
| `useIndexDtfVoteLockVaultState` | `sdk.index.getVoteLockVaultState` |
| `useIndexDtfVoteLockPreviewDeposit` | `sdk.index.readVoteLockPreviewDeposit` |
| `useIndexDtfVoteLockPreviewRedeem` | `sdk.index.readVoteLockPreviewRedeem` |
| `useAccountPortfolio` | `sdk.portfolio.get` |
| `useAccountPortfolioHistory` | `sdk.portfolio.getHistory` |
| `useAccountPortfolioTransactions` | `sdk.portfolio.getTransactions` |

`useIndexDtfStatus` is synchronous and returns the catalog status directly. Query-backed hooks accept TanStack Query options; `useIndexDtfPerformance` reserves `select` for its raw-cache-preserving composition. Use `usePrefetchIndexDtfPriceHistory` to warm canonical price-history keys.

Expand Down
23 changes: 12 additions & 11 deletions apps/docs/src/pages/sdk/vote-lock.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,18 @@ The SDK exposes raw read helpers for vote-lock contracts.

## Builders

| Method | Use |
| ----------------------------------- | ----------------------------------------------------------- |
| `prepareVoteLockDeposit` | Deposit underlying into a vote-lock vault. |
| `prepareVoteLockDepositPlan` | Deposit plan with optional underlying approval. |
| `prepareVoteLockDelegate` | Delegate normal voting power. |
| `prepareVoteLockDelegateOptimistic` | Delegate optimistic voting power. |
| `prepareVoteLockWithdraw` | Start or execute withdraw flow depending on vault behavior. |
| `prepareVoteLockClaimRewards` | Claim reward tokens. |
| `prepareVoteLockClaimLock` | Claim an unstaking lock. |
| `prepareVoteLockCancelLock` | Cancel an unstaking lock. |
| `prepareVoteLockPoke` | Poke reward/account accounting. |
| Method | Use |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `prepareVoteLockDeposit` | Deposit underlying into a vote-lock vault. |
| `prepareVoteLockDepositPlan` | Deposit plan with optional underlying approval. |
| `prepareVoteLockDelegate` | Delegate normal voting power. |
| `prepareVoteLockDelegateOptimistic` | Delegate optimistic voting power. |
| `prepareVoteLockWithdraw` | Start or execute withdraw flow depending on vault behavior. |
| `prepareVoteLockRedeem` | Shares-denominated unlock (`redeem`). Correct for every vault (legacy 1:1 and self-appreciating); Register uses it universally. |
| `prepareVoteLockClaimRewards` | Claim reward tokens. |
| `prepareVoteLockClaimLock` | Claim an unstaking lock. |
| `prepareVoteLockCancelLock` | Cancel an unstaking lock. |
| `prepareVoteLockPoke` | Poke reward/account accounting. |

```ts
const plan = sdk.index.prepareVoteLockDepositPlan({
Expand Down
8 changes: 4 additions & 4 deletions docs/index-dtf/vote-lock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Users must delegate voting power for votes to count.

Unlock behavior:

1. User chooses amount to unlock.
2. Register checks `amount <= maxWithdraw`.
3. User calls `withdraw(amount, account, account)` to begin unlock.
4. Rewards stop according to vault behavior.
1. User chooses the share amount to unlock (input/balance are vault shares).
2. Register checks `shares <= balanceOf(account)` and quotes the underlying out via `previewRedeem(shares)`.
3. User calls `redeem(shares, account, account)` to begin unlock (`prepareVoteLockRedeem`). This is the universal path for every vault — legacy 1:1 and self-appreciating alike; the contract converts shares to underlying at the current rate and escrows that fixed underlying amount.
4. Rewards stop according to vault behavior; the escrowed amount no longer appreciates.
5. User waits unlock delay.
6. User returns to claim/withdraw unlocked underlying when available.

Expand Down
Loading