[core] Implement CrestVault
#2
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughAdds a new core package implementing a multi-contract vault system (Vault, Accountant, Teller, Manager), supporting scripts, tests, mocks, Foundry config, TypeScript index fetcher, remappings, tooling configs, and three git submodules for dependencies. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Teller as CrestTeller
participant Vault as CrestVault
participant Accountant as CrestAccountant
participant Manager as CrestManager
participant HL as HyperliquidCore
rect #E8F4F1
User->>+Teller: deposit(assets, receiver)
Teller->>Accountant: previewDeposit / compute shares
Teller-->>Vault: enter(from, asset, amount, to, shares)
Vault-->>User: emit Enter / Deposit
end
rect #F3F3FF
Curator/Admin->>+Manager: allocate(spotIndex, perpIndex)
Manager->>Vault: request assets / transfer
Manager->>HL: bridge funds, place orders (spot/perp)
HL-->>Manager: order confirmations / indices
Manager-->>Vault: emit Allocated
end
rect #FFF7E6
Curator/Admin->>Manager: rebalance() / closeAllPositions()
Manager->>HL: close positions, retrieve assets
Manager-->>Vault: emit Rebalanced / PositionClosed
Manager->>Accountant: trigger rate update (optional)
end
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120 minutes Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Free 📒 Files selected for processing (1)
Note 🎁 Summarized by CodeRabbit FreeYour organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login. Comment |
Comment on lines
+1
to
+59
| class HyperliquidAPI { | ||
| async _requestInfo<T extends object>(request: { type: string }): Promise<T> { | ||
| const response = await fetch('https://api.hyperliquid.xyz/info', { | ||
| method: 'POST', | ||
| headers: { 'Content-Type': 'application/json' }, | ||
| body: JSON.stringify(request), | ||
| }); | ||
| return response.json(); | ||
| } | ||
|
|
||
| async _getSpotIndex(symbol: string) { | ||
| const { tokens, universe } = await this._requestInfo<{ | ||
| tokens: { name: string; index: number }[]; | ||
| universe: { | ||
| index: number; | ||
| tokens: [tokenIndex: number, quoteTokenIndex: number]; | ||
| }[]; | ||
| }>({ type: 'spotMeta' }); | ||
|
|
||
| const token = tokens.find((token) => token.name === symbol); | ||
| if (token?.index === undefined) { | ||
| throw new Error(`Token ${symbol} not found`); | ||
| } | ||
| const spot = universe.find((asset) => asset.tokens[0] === token.index); | ||
| if (spot?.index === undefined) { | ||
| throw new Error(`Spot ${symbol} not found`); | ||
| } | ||
| return { | ||
| tokenIndex: token.index, | ||
| spotIndex: spot.index, | ||
| meta: { token, spot }, | ||
| }; | ||
| } | ||
|
|
||
| async _getPerpIndex(symbol: string) { | ||
| const { universe } = await this._requestInfo<{ | ||
| universe: { | ||
| szDecimals: number; | ||
| name: string; | ||
| maxLeverage: number; | ||
| marginTableId: number; | ||
| }[]; | ||
| }>({ type: 'meta' }); | ||
|
|
||
| const perpIndex = universe.findIndex((asset) => asset.name === symbol); | ||
| return { perpIndex, meta: universe[perpIndex] }; | ||
| } | ||
|
|
||
| async getIndexesBySymbol(symbol: string) { | ||
| const spot = await this._getSpotIndex(symbol); | ||
| const perp = await this._getPerpIndex(symbol); | ||
| return { | ||
| symbol, | ||
| tokenIndex: spot.tokenIndex, | ||
| spotIndex: spot.spotIndex, | ||
| perpIndex: perp.perpIndex, | ||
| }; | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
이거는 다른 모듈에다 가져다 써도 되겠다
Member
Author
There was a problem hiding this comment.
allocate (vault 에 남아 있는 USDC 를 가지고 기존 포지션 확장) 및 rebalance (포지션 변경 체크) 시에 자산의 spot/perp index 넣어줘야 함!
Contributor
There was a problem hiding this comment.
지금 쌓고 있는 데이터에 자산의 spot/perp index을 추가로 더 쌓아야 하나? 아니면 컨트랙트 안에서만 사용하는거야?
Member
Author
There was a problem hiding this comment.
spot/perp index 는 immutable (아마) 해서, 컨트랙트의 allocate/rebalance 호출하기 전에 가져오면 될 듯
junhoyeo
changed the title
CrestVaultCrestVault
- Fixed arithmetic overflow in P&L calculations by adding proper type casting - Changed minimum balance requirement from 200 to 50 USDT0 for better capital efficiency - Replaced simplified market maker comments with actual order placement - Updated outdated comment about closeAllPositions using placeholder amounts - All 27 tests now pass with proper rate limiting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit