Pool Account

This page contains an overview of the Solana account types used in the Jupiter Perpetuals Program, and specifically the Pool account.

The Pool account is a struct which represents a set of parameters and states associated to the data for JLP pool, including AUM and Custody data.

only one pool account

There is only one Pool account.

Example Typescript Repository

This repository contains Typescript code samples on interacting with the Jupiter Perpetuals program IDL with anchor and @solana/web3.js

Account Details

Each Pool account contains the following data:

Field	Description
`name`	Type: `string` The name for the account.
`custodies`	Type: `publicKey` An array containing the public keys for the custodies (tokens) managed by the JLP pool.
`aumUsd`	Type: `u128` The current AUM value (USD) for the JLP pool. The `aumUsd` value's calculation can be summarized by getting the USD value of the tokens managed by the pool minus the USD value reserved to pay off trader profits. Refer to the Custody account details for more details on AUM calculation.
`limit`	Type: `Limit` Contains values for the pool's limits.
`fees`	Type: `Fees` Sets the fee amounts or percentages for the Jupiter Perpetuals exchange.
`poolApr`	Type: `PoolApr` Contains data related to the pool's APR / APY calculations.

Field	Description
`maxAumUsd`	Type: `u128` The max AUM for the JLP pool. This acts as a max cap / ceiling as the JLP will not accept deposits when the cap is hit.
`tokenWeightageBufferBps`	Type: `u128` The token weightage buffer (in basis points) to calculate the token's maximum or minimum current weightage based on the target weightage. Currently, `tokenWeightageBufferBps` is set to `2000` which means the the current weightage cannot be lower or higher than + / - 20% of the token's target weightage. For example, if SOL's target weightage for the JLP pool is 50%, the current weightage cannot be less than 40% or exceed 60%. The pool will not allow deposits or withdrawals if the action causes the token to exceed its target weightage.
`maxPositionUsd`	Type: `u64` Sets the maximum position size. The current `maxPositionUsd` value is `2_500_000_000_000` which means a position's max size is $2,500,000.

Field	Description
`increasePositionBps`	Type: `string` A fixed fee of 6 BPS (0.06%) is charged for opening or increasing a position.
`decreasePositionBps`	Type: `publicKey` A fixed fee of 6 BPS (0.06%) is charged for closing or decreasing a position.
`addRemoveLiquidityBps`	Type: `u128` Fee charged when adding or removing liquidity to/from the pool.
`swapBps`	Type: `Limit` Swap fee for exchanging non-stablecoin tokens routed through the liquidity pool. `swap fee = swapBps ± swapTaxBps`
`taxBps`	Type: `PoolApr` Tax fee for non-stablecoins, determined based on the difference between the current and target weightage. A larger difference results in a higher tax fee, encouraging liquidity providers to rebalance the pool to the target weightage.
`stableSwapBps`	Type: `Limit` Swap fee for exchanges involving stablecoins, routed through the liquidity pool. `swap fee = stableSwapBps ± stableSwapTaxBps`
`stableSwapTaxBps`	Type: `Fees` Tax fee for stablecoin swaps. Similar to taxBps, this fee is determined by the difference between the current and target weightage.
`protocolShareBps`	Type: `PoolApr` Jupiter takes a share of 2500 BPS (25%) from the fees collected by the pool.

Field	Description
`lastUpdated`	Type: `i64` The UNIX timestamp when the pool's APR data was last updated.
`feeAprBps`	Type: `u64` The pool's APR in BPS format. The APR is calculated weekly by dividing the pool's realized fees (minus the 25% collected by the protocol) by the total pool value, adjusting for the 1 week time period to annualize the rate.
`realizedFeeUsd`	Type: `u64` The fees collected by the pool so far. This fee is reinvested back into the pool and is also used to calculate the APR as mentioned above. realizedFeeUsd resets to zero when the fee is reinvested into the pool hence causing the APR value to fluctuate weekly.