Contract Relationships
Read Functions
poolEquity
totalAssets adjusted for aggregate unrealized PnL across all open positions. This is the effective pool value that RiskManager uses for cap calculations.
netExposure
sum(long notional) - sum(short notional). Positive means pool is net long, negative means net short.
grossNotional
utilization
grossNotional * 10000 / totalAssets.
notionalUtilization
maxWithdrawable
isAllowlisted
allowlistEnabled
pairNetExposure
pairGrossNotional
ERC-4626 Standard
PoolVault inherits all standard ERC-4626 view functions:| Function | Returns |
|---|---|
totalAssets() | Total USDC held by the vault |
convertToShares(assets) | Shares for a given USDC deposit |
convertToAssets(shares) | USDC for a given share redemption |
maxDeposit(receiver) | Maximum USDC depositable |
maxMint(receiver) | Maximum shares mintable |
maxWithdraw(owner) | Maximum USDC withdrawable |
maxRedeem(owner) | Maximum shares redeemable |
Write Functions
deposit (ERC-4626)
receiver. Requires prior ERC-20 approval.
| Name | Type | Description |
|---|---|---|
assets | uint256 | USDC amount to deposit (6 decimals) |
receiver | address | Address to receive pool shares |
withdraw (ERC-4626)
| Name | Type | Description |
|---|---|---|
assets | uint256 | USDC amount to withdraw (6 decimals) |
receiver | address | Address to receive USDC |
owner | address | Share owner (must be caller or have allowance) |
Admin Functions
setAllowlisted
setAllowlistEnabled
Protocol Functions
applyPnl
updateExposure
| Name | Type | Description |
|---|---|---|
pairId | bytes32 | Currency pair identifier |
notionalDelta | int256 | Notional change (positive for open, negative for close) |
isLong | bool | Whether the trader position is long |
Events
| Event | When Emitted |
|---|---|
Deposit | LP deposits USDC (ERC-4626 standard) |
Withdraw | LP withdraws USDC (ERC-4626 standard) |
AllowlistUpdated | LP allowlist status changed |
ExposureUpdated | Aggregate exposure changed |
PairExposureUpdated | Per-pair exposure changed |
PnlApplied | Trader PnL applied to pool |
Related Pages
Vault Mechanics
How the ERC-4626 vault works for LPs.
Share Price
Share price calculation and PnL impact.
Pool Utilization
Utilization caps and withdrawal limits.