Custody Account

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

The Custody account is a struct which represents a set of parameters and states associated to custodies (tokens) managed by the JLP pool which consists of the following custodies.

Custodies
SOL	ETH	BTC	USDC	USDT

Example Typescript Repository

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

You can also find the Custody Account fields in the repository or on a blockchain explorer.

Account Details

Each Custody account contains the following data:

Field	Description
pool	Type: publicKey The public key for the pool that this custody belongs to (i.e. the JLP pool).
mint	Type: publicKey The public key for the custody's token mint account.
tokenAccount	Type: publicKey The associated token account of the custody which holds the tokens under management for the pool.
decimals	Type: u8 The number of decimals used for the token which is the same as the number of decimals specified in the token mint account. This is stored for convenience.
isStable	Type: bool A boolean flag indicating if the token in custody is a stable asset.
oracle	Type: OracleParams Contains data for the price oracle used for the custody.
pricing	Type: PricingParams Contains data for the custody's price-related logic.
permissions	Type: Permissions A set of global flags that can be set by the protocol's administrator to enable or disable trade actions which is useful during program upgrades or black swan events.
targetRatioBps	Type: u64 The target weightage (in basis points) for the custody in the JLP pool.
assets	Type: Assets Contains data used to calculate PNL, AUM, and core business logic for the program.
fundingRateState	Type: FundingRateState Contains data used to calculate borrow fees for open positions.
jumpRateState	Type: JumpRateState Contains data used to calculate borrow fees for open positions.

PricingParams

Field	Description
tradeImpactFeeScalar	Type: u64 Sets the base value when calculating price impact fees when opening or closing positions.
maxLeverage	Type: u64 Sets the max leverage for this custody's positions. The max leverage for all custodies is 500x at the time of writing.
maxGlobalLongSizes	Type: u64 The maximum total position size (USD) for long positions.
maxGlobalShortSizes	Type: u64 The maximum total position size (USD) for short positions.

Assets

Field	Description
feesReserves	Type: u64 The fees collected by all open positions for the custody. feesReserves resets to zero when the fees are distributed to the pool and protocol.
owned	Type: u64 The number of tokens owned by the pool for the custody. - The owned value is increased either by providing liquidity to the pool or depositing collateral when opening or updating positions. - Conversely, the owned value decreases when liquidity is removed from the pool or collateral is withdrawn from closing positions.
locked	Type: u64 The number of tokens locked by the pool for the custody to pay off potential profits for open positions.
guaranteedUsd	Type: u64 This value represents the total amount borrowed in USD (position size - collateral) across all long positions. It is updated whenever traders modify their collateral through deposits or withdrawals. The system uses this aggregated figure to efficiently calculate the total profit and loss (PNL) for all long positions, which in turn is used to calculate the AUM of the JLP pool.
globalShortSizes	Type: u64 Stores the total amount (USD) position sizes for all short positions.
globalShortAveragePrices	Type: u64 Stores the average price (USD) for all short positions. This value and globalShortSizes are used to calculate the PNL for all short positions efficiently, and is again used to calculate the AUM of the JLP pool.

FundingRateState

Field	Description
cumulativeInterestRate	Type: u128 Traders are required to pay hourly borrow fees for opening leveraged positions. This fee is calculated based on two primary factors: the size of the trader's position and the current utilization of the pool for the custody. To calculate borrow fees more efficiently, each custody account contains a value called cumulativeInterestRate. Correspondingly, each position account stores a cumulativeInterestSnapshot which captures the value of cumulativeInterestRate at the time of the position's last update. Whenever there's a change in either the borrowed assets or the total assets within a custody, the cumulativeInterestRate for the custody is updated. The difference between the custody's cumulativeInterestRate and the position's cumulativeInterestSnapshot is then used to calculate the position's borrow fees.
lastUpdate	Type: i64 The UNIX timestamp for when the custody's borrow fee data was last updated.
hourlyFundingDbps	Type: u64 NOTE: This will be deprecated in the near future. A constant used to calculate the hourly borrow fees for the custody. The Jupiter Perpetuals exchange works with Gauntlet and Chaos Labs to update and fine tune the hourlyFundingDbps to respond to traders' feedback and market conditions.

JumpRateState

Field	Description
minRateBps	Type: u64 The lowest borrow rate, applied at 0% utilization.
maxRateBps	Type: u64 The highest borrow rate, applied at 100% utilization.
targetRateBps	Type: u64 The borrow rate when utilization reaches its target level.
targetUtilizationRate	Type: u64 The optimal utilization level for the custody.