Class PerpetualsClient

Index

Constructors

Properties

admin authority eventAuthority minimumBalanceForRentExemptAccountLamports multisig perpetuals poolAddressLookupTables poolPusherAddressLookupTables postSendTxCallback? prioritizationFee program programId provider pusherAddressLookupTables txConfirmationCommitment useExtOracleAccount viewHelper

Methods

addCollateral addCompoundingLiquidity addCustody addCustodyToken22 addInternalOracle addLiquidity addLiquidityAndStake addMarket addPool addReferral adjustTokenRatios cancelAllTriggerOrders cancelTriggerOrder cancelUnstakeTokenRequest checkIfPriceStaleOrCustom closeAndSwap closePosition collectRebate collectRevenue collectStakeFees collectTokenReward compoundingFee createWhitelist decreaseSize depositStake depositTokenStake distributeTokenReward editCustody editLimitOrder editTriggerOrder executeLimitOrder executeLimitWithSwap executeTriggerOrder executeTriggerWithSwap findProgramAddress findProgramAddressFromProgramId forceSettleOrder forceSettlePosition getAccountDiscriminator getAddCollateralQuote getAddCompoundingLiquidityAmountAndFeeView getAddLiquidityAmountAndFeeSync getAddLiquidityAmountAndFeeView getAllActivePositions getAllActivePositionsByMarket getAllOrderAccounts getAllPositions getAllPositionsByMarket getApyPercentageUi getAssetsUnderManagement getAssetsUnderManagementUsdContractHelper getAssetsUnderManagementUsdSync getAveragePriceSync getBorrowRateSync getClosePositionQuote getCollateralAmountWithFeeFromLeverageAndSize getCollateralAmountWithSwapSync getCompoundingLPTokenPrice getCompoundingTokenDataView getCumulativeLockFeeSync getCustodyKey getCustodyTokenAccountKey getDecreaseSizeCollateralAndFeeSync getEntryPriceAndFeeSyncV2 getEntryPriceUsdSync getEstimateProfitLossforTpSlEntry getExitFeeSync getExitOraclePriceSync getExitPriceAndFeeSync getFeeDiscount getFeeHelper getFinalCloseAmountUsdSync getIndexPriceAtParticularTime getLeverageAtAmountEntryWithSwapSync getLeverageContractHelper getLeverageSync getLiquidationPriceContractHelper getLiquidationPriceSync getLiquidationPriceView getLiquidationPriceWithOrder getLiquidationStateView getLockFeeAndUnsettledUsdForPosition getLockedUsd getLpTokenPriceView getMarketPk getMaxAddableCollateralSync getMaxProfitPriceSync getMaxWithdrawableAmountSync getMaxWithdrawableAmountSyncInternal getMinAndMaxOraclePriceSync getMinAndMaxPriceSync getNewRatioHelper getOpenPositionQuote getOrLoadAddressLookupTable getOrderAccount getOrderAccountKey getPerpetuals getPnlContractHelper getPnlSync getPool getPoolCompoundingTokenKey getPoolKey getPoolLpTokenKey getPools getPosition getPositionData getPositionKey getPositionMetrics getPositionsMetricsBatch getPriceAfterSlippage getRemoveCollateralQuote getRemoveCompoundingLiquidityAmountAndFeeView getRemoveLiquidityAmountAndFeeSync getRemoveLiquidityAmountAndFeeView getSizeAmountFromLeverageAndCollateral getSizeAmountWithSwapSync getStakedLpTokenPrice getSwapAmountAndFeesSync getTokenStakeAccount getTradeSpread getTriggerPriceFromPnlSync getTriggerPriceFromRoiSync getUserClaimableRevenueAmount getUserOrderAccount getUserOrderAccounts getUserOrderAccountsMultiPool getUserPosition getUserPositions getUserPositionsMultiPool getUserUnstakingStatus increaseSize init initCompounding initRebateVault initRevenueTokenAccount initStake initTokenVault liquidate loadAddressLookupTable log migrateFlp migrateMarketOrder migrateMarketPosition migrateStake moveProtocolFees openPosition placeLimitOrder placeTriggerOrder prettyPrint protocolWithdrawFees refreshOrdersStatus refreshPositionsStatus refreshStakeWithAllFlpStakeAccounts refreshStakeWithTokenStake refreshTokenStake reimburse removeCollateral removeCollateralAndSwap removeCompoundingLiquidity removeCustody removeLiquidity removeMarket removePool renameFlp resizeInternalOracle resizeTokenStake sendTransaction sendTransactionV3 setAdminSigners setCustody setCustodyTokenMultiplier setFeeShareBps setInternalLazerPriceBatch setInternalOracleEmaPriceBatch setInternalOraclePriceBatch setLpTokenPrice setMarket setPermissions setPerpetualsConfig setPoolConfig setPositionPriceImpact setPrioritizationFee setProtocolFeeShareBps setTokenReward setTokenStakeLevel setTokenVaultConfig setWhitelistConfig settleRebates swap swapAndAddCollateral swapAndOpen swapFeeInternal unstakeInstant unstakeRequest unstakeTokenRequest withdrawInstantFee withdrawStake withdrawToken withdrawUnclaimedTokens

Constructors

constructor

new PerpetualsClient(provider, programId, composabilityProgramId, fbNftRewardProgramId, rewardDistributionProgramId, opts, useExtOracleAccount?): PerpetualsClient
Parameters
- provider: AnchorProvider
- programId: PublicKey
- composabilityProgramId: PublicKey
- fbNftRewardProgramId: PublicKey
- rewardDistributionProgramId: PublicKey
- opts: PerpClientOptions
- useExtOracleAccount: boolean = false
Returns PerpetualsClient
- Defined in src/PerpetualsClient.ts:109

Properties

admin

admin: PublicKey

authority

authority: {
bump: number;
publicKey: PublicKey;
}

Type declaration

bump: number
publicKey: PublicKey

eventAuthority

eventAuthority: {
bump: number;
publicKey: PublicKey;
}

Type declaration

bump: number
publicKey: PublicKey

minimumBalanceForRentExemptAccountLamports

minimumBalanceForRentExemptAccountLamports: number

multisig

multisig: {
bump: number;
publicKey: PublicKey;
}

Type declaration

bump: number
publicKey: PublicKey

perpetuals

perpetuals: {
bump: number;
publicKey: PublicKey;
}

Type declaration

bump: number
publicKey: PublicKey

`Private` poolAddressLookupTables

poolAddressLookupTables: Map<string, AddressLookupTableAccount> = ...

`Private` poolPusherAddressLookupTables

poolPusherAddressLookupTables: Map<string, AddressLookupTableAccount> = ...

`Private` `Optional` postSendTxCallback

postSendTxCallback?: ((__namedParameters) => void)

Type declaration

- (__namedParameters): void
- Parameters
  - __namedParameters: {
    txid: any;
    }
    - txid: any
  Returns void

prioritizationFee

prioritizationFee: number

program

program: Program<Perpetuals>

programId

programId: PublicKey

provider

provider: AnchorProvider

pusherAddressLookupTables

pusherAddressLookupTables: AddressLookupTableAccount

`Private` txConfirmationCommitment

txConfirmationCommitment: Commitment

`Private` useExtOracleAccount

useExtOracleAccount: boolean

`Private` viewHelper

viewHelper: ViewHelper

Methods

addCollateral

addCollateral(collateralWithFee, targetSymbol, collateralSymbol, side, positionPubKey, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- collateralWithFee: BN
- targetSymbol: string
- collateralSymbol: string
- side: Side
- positionPubKey: PublicKey
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5073

addCompoundingLiquidity

addCompoundingLiquidity(amountIn, minCompoundingAmountOut, inTokenSymbol, rewardTokenMint, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?, userPublicKey?, enableHeapSizeIx?, isWhitelistedUser?, includeRemainingAccounts?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- amountIn: BN
- minCompoundingAmountOut: BN
- inTokenSymbol: string
- rewardTokenMint: PublicKey
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
- userPublicKey: PublicKey = undefined
- enableHeapSizeIx: boolean = true
- isWhitelistedUser: boolean = false
- includeRemainingAccounts: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6962

addCustody

addCustody(poolName, tokenMint, isToken22, isStable, isVirtual, oracle, pricing, permissions, fees, borrowRate, ratios, depegAdjustment, tokenAmountMultiplier, minReserveUsd, limitPriceBufferBps, inversePrice): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
- isToken22: boolean
- isStable: boolean
- isVirtual: boolean
- oracle: OracleParams
- pricing: PricingParams
- permissions: Permissions
- fees: Fees
- borrowRate: BorrowRateParams
- ratios: TokenRatios[]
- depegAdjustment: boolean
- tokenAmountMultiplier: BN
- minReserveUsd: BN
- limitPriceBufferBps: BN
- inversePrice: boolean
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9772

addCustodyToken22

addCustodyToken22(poolName, tokenMint, tokenAccountSpace, token22): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
- tokenAccountSpace: BN
- token22: boolean
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11485

addInternalOracle

addInternalOracle(exponent, lazerFeedId, tokenMint, intOracleAccount): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- exponent: number
- lazerFeedId: number
- tokenMint: PublicKey
- intOracleAccount: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11693

addLiquidity

addLiquidity(payTokenSymbol, tokenAmountIn, minLpAmountOut, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?, isWhitelistedUser?, includeRemainingAccounts?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- payTokenSymbol: string
- tokenAmountIn: BN
- minLpAmountOut: BN
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
- isWhitelistedUser: boolean = false
- includeRemainingAccounts: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5813

addLiquidityAndStake

addLiquidityAndStake(inputSymbol, amountIn, minLpAmountOut, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?, userPublicKey?, isWhitelistedUser?, includeRemainingAccounts?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- inputSymbol: string
- amountIn: BN
- minLpAmountOut: BN
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
- userPublicKey: PublicKey = undefined
- isWhitelistedUser: boolean = false
- includeRemainingAccounts: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6001

addMarket

addMarket(poolName, targetCustody, collateralCustody, side, correlation, maxPayoffBps, permissions): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
- correlation: boolean
- maxPayoffBps: BN
- permissions: MarketPermissions
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11534

addPool

addPool(name, oracleAuthority, maxAumUsd, permissions, metadataSymbol, metadataTitle, metadataUri, stakingFeeShareBps, vpVolumeFactor, stakingFeeBoostBps, minLpPriceUsd, maxLpPriceUsd, thresholdUsd): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- name: string
- oracleAuthority: PublicKey
- maxAumUsd: BN
- permissions: Permissions
- metadataSymbol: string
- metadataTitle: string
- metadataUri: string
- stakingFeeShareBps: BN
- vpVolumeFactor: number
- stakingFeeBoostBps: BN[]
- minLpPriceUsd: BN
- maxLpPriceUsd: BN
- thresholdUsd: BN
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9669

addReferral

addReferral(tokenStakeAccount, nftReferralAccount): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- tokenStakeAccount: PublicKey
- nftReferralAccount: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6376

adjustTokenRatios

adjustTokenRatios(ratios): TokenRatios[]
Parameters
- ratios: TokenRatios[]
Returns TokenRatios[]
- Defined in src/PerpetualsClient.ts:231

cancelAllTriggerOrders

cancelAllTriggerOrders(targetSymbol, collateralSymbol, side, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- side: Side
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8781

cancelTriggerOrder

cancelTriggerOrder(targetSymbol, collateralSymbol, side, orderId, isStopLoss, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- side: Side
- orderId: number
- isStopLoss: boolean
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8731

cancelUnstakeTokenRequest

cancelUnstakeTokenRequest(owner, withdrawRequestId, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- withdrawRequestId: number
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7839

checkIfPriceStaleOrCustom

checkIfPriceStaleOrCustom(price, emaPrice, custodyAccount, timestampInSeconds): boolean
Parameters
- price: OraclePrice
- emaPrice: OraclePrice
- custodyAccount: CustodyAccount
- timestampInSeconds: BN
Returns boolean
- Defined in src/PerpetualsClient.ts:860

closeAndSwap

closeAndSwap(targetTokenSymbol, userOutputTokenSymbol, collateralTokenSymbol, priceWithSlippage, side, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetTokenSymbol: string
- userOutputTokenSymbol: string
- collateralTokenSymbol: string
- priceWithSlippage: ContractOraclePrice
- side: Side
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:4884

closePosition

closePosition(marketSymbol, collateralSymbol, priceWithSlippage, side, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?, createUserATA?, closeUsersWSOLATA?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- marketSymbol: string
- collateralSymbol: string
- priceWithSlippage: ContractOraclePrice
- side: Side
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
- createUserATA: boolean = true
- closeUsersWSOLATA: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:4511

collectRebate

collectRebate(owner, rebateSymbol, poolConfig, createUserATA?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- rebateSymbol: string
- poolConfig: PoolConfig
- createUserATA: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8053

collectRevenue

collectRevenue(owner, rewardSymbol, poolConfig, createUserATA?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- rewardSymbol: string
- poolConfig: PoolConfig
- createUserATA: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7949

collectStakeFees

collectStakeFees(rewardSymbol, poolConfig, tokenStakeAccount?, createUserATA?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rewardSymbol: string
- poolConfig: PoolConfig
- Optional tokenStakeAccount: PublicKey
- createUserATA: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6870

collectTokenReward

collectTokenReward(owner, poolConfig, createUserATA?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- poolConfig: PoolConfig
- createUserATA: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7883

compoundingFee

compoundingFee(poolConfig, rewardTokenSymbol?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolConfig: PoolConfig
- rewardTokenSymbol: string = 'USDC'
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7592

createWhitelist

createWhitelist(isSwapFeeExempt, isDepositFeeExempt, isWithdrawalFeeExempt, poolAddress, owner): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- isSwapFeeExempt: boolean
- isDepositFeeExempt: boolean
- isWithdrawalFeeExempt: boolean
- poolAddress: PublicKey
- owner: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11288

decreaseSize

decreaseSize(targetSymbol, collateralSymbol, side, positionPubKey, poolConfig, priceWithSlippage, sizeDelta, privilege, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- side: Side
- positionPubKey: PublicKey
- poolConfig: PoolConfig
- priceWithSlippage: ContractOraclePrice
- sizeDelta: BN
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5710

depositStake

depositStake(owner, feePayer, depositAmount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- feePayer: PublicKey
- depositAmount: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6412

depositTokenStake

depositTokenStake(owner, feePayer, depositAmount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- feePayer: PublicKey
- depositAmount: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7660

distributeTokenReward

distributeTokenReward(amount, epochCount, rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- amount: BN
- epochCount: number
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11053

editCustody

editCustody(poolName, tokenMint, isStable, oracle, pricing, permissions, fees, borrowRate, ratios): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
- isStable: boolean
- oracle: OracleParams
- pricing: PricingParams
- permissions: Permissions
- fees: Fees
- borrowRate: BorrowRateParams
- ratios: TokenRatios[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9844

editLimitOrder

editLimitOrder(targetSymbol, collateralSymbol, reserveSymbol, receiveSymbol, side, orderId, limitPrice, sizeAmount, stopLossPrice, takeProfitPrice, poolConfig, createUserATA?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- reserveSymbol: string
- receiveSymbol: string
- side: Side
- orderId: number
- limitPrice: ContractOraclePrice
- sizeAmount: BN
- stopLossPrice: ContractOraclePrice
- takeProfitPrice: ContractOraclePrice
- poolConfig: PoolConfig
- createUserATA: boolean = true
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8315

editTriggerOrder

editTriggerOrder(targetSymbol, collateralSymbol, receiveSymbol, side, orderId, triggerPrice, deltaSizeAmount, isStopLoss, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- receiveSymbol: string
- side: Side
- orderId: number
- triggerPrice: ContractOraclePrice
- deltaSizeAmount: BN
- isStopLoss: boolean
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8663

executeLimitOrder

executeLimitOrder(userPubkey, targetSymbol, collateralSymbol, side, orderId, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- userPubkey: PublicKey
- targetSymbol: string
- collateralSymbol: string
- side: Side
- orderId: number
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8449

executeLimitWithSwap

executeLimitWithSwap(userPubkey, targetSymbol, collateralSymbol, reserveSymbol, side, orderId, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- userPubkey: PublicKey
- targetSymbol: string
- collateralSymbol: string
- reserveSymbol: string
- side: Side
- orderId: number
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8520

executeTriggerOrder

executeTriggerOrder(owner, targetSymbol, collateralSymbol, side, orderId, isStopLoss, privilege, poolConfig, createUserATA?, ephemeralSignerPubkey?, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- targetSymbol: string
- collateralSymbol: string
- side: Side
- orderId: number
- isStopLoss: boolean
- privilege: Privilege
- poolConfig: PoolConfig
- createUserATA: boolean = true
- ephemeralSignerPubkey: any = undefined
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9000

executeTriggerWithSwap

executeTriggerWithSwap(owner, targetSymbol, collateralSymbol, receivingSymbol, side, orderId, isStopLoss, privilege, poolConfig, createUserATA?, ephemeralSignerPubkey?, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- targetSymbol: string
- collateralSymbol: string
- receivingSymbol: string
- side: Side
- orderId: number
- isStopLoss: boolean
- privilege: Privilege
- poolConfig: PoolConfig
- createUserATA: boolean = true
- ephemeralSignerPubkey: any = undefined
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8823

findProgramAddress

findProgramAddress(label, extraSeeds?): {
bump: number;
publicKey: PublicKey;
}
Parameters
- label: string
- extraSeeds: any = null
Returns {
bump: number;
publicKey: PublicKey;
}
- bump: number
- publicKey: PublicKey
- Defined in src/PerpetualsClient.ts:196

findProgramAddressFromProgramId

findProgramAddressFromProgramId(label, extraSeeds?, programId?): {
bump: number;
publicKey: PublicKey;
}
Parameters
- label: string
- extraSeeds: any = null
- programId: PublicKey = ...
Returns {
bump: number;
publicKey: PublicKey;
}
- bump: number
- publicKey: PublicKey
- Defined in src/PerpetualsClient.ts:213

forceSettleOrder

forceSettleOrder(market, owner, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- market: PublicKey
- owner: PublicKey
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:12075

forceSettlePosition

forceSettlePosition(market, owner, receivingAccount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- market: PublicKey
- owner: PublicKey
- receivingAccount: PublicKey
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:12000

getAccountDiscriminator

getAccountDiscriminator(name): Buffer
Parameters
- name: string
Returns Buffer
- Defined in src/PerpetualsClient.ts:508

getAddCollateralQuote

getAddCollateralQuote(amountIn, positionPk, positionAccount, poolConfig, receivingCustodyConfig?, userPublicKey?): Promise<AddCollateralQuoteData>
Parameters
- amountIn: BN
- positionPk: PublicKey
- positionAccount: PositionAccount
- poolConfig: PoolConfig
- Optional receivingCustodyConfig: CustodyConfig
- userPublicKey: PublicKey = undefined
Returns Promise<AddCollateralQuoteData>
- Defined in src/PerpetualsClient.ts:3574

getAddCompoundingLiquidityAmountAndFeeView

getAddCompoundingLiquidityAmountAndFeeView(amount, poolKey, depositCustodyKey, POOL_CONFIG, userPublicKey?, enableBackupOracle?, whitelist?): Promise<{
amount: BN;
fee: BN;
}>
Parameters
- amount: BN
- poolKey: PublicKey
- depositCustodyKey: PublicKey
- POOL_CONFIG: PoolConfig
- userPublicKey: PublicKey = undefined
- enableBackupOracle: boolean = false
- whitelist: PublicKey = PublicKey.default
Returns Promise<{
amount: BN;
fee: BN;
}>
- Defined in src/PerpetualsClient.ts:4073

getAddLiquidityAmountAndFeeSync

getAddLiquidityAmountAndFeeSync(amountIn, poolAccount, inputTokenPrice, inputTokenEmaPrice, inputTokenCustodyAccount, lpTokenSupplyAmount, poolAumUsdMax, poolConfig): AddLiquidityAmountAndFee
Parameters
- amountIn: BN
- poolAccount: PoolAccount
- inputTokenPrice: OraclePrice
- inputTokenEmaPrice: OraclePrice
- inputTokenCustodyAccount: CustodyAccount
- lpTokenSupplyAmount: BN
- poolAumUsdMax: BN
- poolConfig: PoolConfig
Returns AddLiquidityAmountAndFee
- Defined in src/PerpetualsClient.ts:547

getAddLiquidityAmountAndFeeView

getAddLiquidityAmountAndFeeView(amount, poolKey, depositCustodyKey, POOL_CONFIG, userPublicKey?, enableBackupOracle?, whitelist?): Promise<{
    amount: BN;
    error?: string;
    fee: BN;
}>
Parameters
- amount: BN
- poolKey: PublicKey
- depositCustodyKey: PublicKey
- POOL_CONFIG: PoolConfig
- userPublicKey: PublicKey = undefined
- enableBackupOracle: boolean = false
- whitelist: PublicKey = undefined
Returns Promise<{
    amount: BN;
    error?: string;
    fee: BN;
}>
- Defined in src/PerpetualsClient.ts:3889

getAllActivePositions

getAllActivePositions(): Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
Returns Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
- Defined in src/PerpetualsClient.ts:465

getAllActivePositionsByMarket

getAllActivePositionsByMarket(marketKey): Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
Parameters
- marketKey: PublicKey
Returns Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
- Defined in src/PerpetualsClient.ts:487

getAllOrderAccounts

getAllOrderAccounts(): Promise<ProgramAccount<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: any[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    referenceTimestamp: BN;
    stopLossOrders: any[];
    takeProfitOrders: any[];
}>[]>
Returns Promise<ProgramAccount<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: any[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    referenceTimestamp: BN;
    stopLossOrders: any[];
    takeProfitOrders: any[];
}>[]>
- Defined in src/PerpetualsClient.ts:504

getAllPositions

getAllPositions(): Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
Returns Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
- Defined in src/PerpetualsClient.ts:461

getAllPositionsByMarket

getAllPositionsByMarket(marketKey): Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
Parameters
- marketKey: PublicKey
Returns Promise<ProgramAccount<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>[]>
- Defined in src/PerpetualsClient.ts:473

getApyPercentageUi

getApyPercentageUi(rewardCustodyAccount, previousSnapShotRewardPerLpStaked, lpTokenUsdPrice): string
Parameters
- rewardCustodyAccount: CustodyAccount
- previousSnapShotRewardPerLpStaked: BN
- lpTokenUsdPrice: BN
Returns string
- Defined in src/PerpetualsClient.ts:532

getAssetsUnderManagement

getAssetsUnderManagement(poolKey, POOL_CONFIG): Promise<string>
Parameters
- poolKey: PublicKey
- POOL_CONFIG: PoolConfig
Returns Promise<string>
- Defined in src/PerpetualsClient.ts:3840

getAssetsUnderManagementUsdContractHelper

getAssetsUnderManagementUsdContractHelper(poolAccount, tokenPrices, tokenEmaPrices, custodies, markets, aumCalcMode, currentTime, poolConfig): {
poolAmountUsd: BN;
poolEquityUsd: BN;
}
Parameters
- poolAccount: PoolAccount
- tokenPrices: OraclePrice[]
- tokenEmaPrices: OraclePrice[]
- custodies: CustodyAccount[]
- markets: MarketAccount[]
- aumCalcMode: "includePnl" | "excludePnl"
- currentTime: BN
- poolConfig: PoolConfig
Returns {
poolAmountUsd: BN;
poolEquityUsd: BN;
}
- poolAmountUsd: BN
- poolEquityUsd: BN
- Defined in src/PerpetualsClient.ts:3170

getAssetsUnderManagementUsdSync

getAssetsUnderManagementUsdSync(poolAccount, tokenPrices, tokenEmaPrices, custodies, markets, aumCalcMode, currentTime, poolConfig): {
poolAmountUsd: BN;
poolEquityUsd: BN;
}
Parameters
- poolAccount: PoolAccount
- tokenPrices: OraclePrice[]
- tokenEmaPrices: OraclePrice[]
- custodies: CustodyAccount[]
- markets: MarketAccount[]
- aumCalcMode: "includePnl" | "excludePnl"
- currentTime: BN
- poolConfig: PoolConfig
Returns {
poolAmountUsd: BN;
poolEquityUsd: BN;
}
- poolAmountUsd: BN
- poolEquityUsd: BN
- Defined in src/PerpetualsClient.ts:3148

getAveragePriceSync

getAveragePriceSync(price1, size1, price2, size2): BN
Parameters
- price1: BN
- size1: BN
- price2: BN
- size2: BN
Returns BN
- Defined in src/PerpetualsClient.ts:894

getBorrowRateSync

getBorrowRateSync(custodyAccount, currentUtilization): BN
Parameters
- custodyAccount: CustodyAccount
- currentUtilization: BN
Returns BN
- Defined in src/PerpetualsClient.ts:2180

getClosePositionQuote

getClosePositionQuote(positionPk, positionAccount, poolConfig, sizeDeltaUsd?, privilege?, dispensingCustodyConfig?, discountIndex?, triggerPrice?, userPublicKey?): Promise<ClosePositionQuoteData>
Parameters
- positionPk: PublicKey
- positionAccount: PositionAccount
- poolConfig: PoolConfig
- sizeDeltaUsd: BN = ...
- privilege: Privilege = ...
- Optional dispensingCustodyConfig: CustodyConfig
- discountIndex: number = null
- triggerPrice: {
  exponent: number;
  price: BN;
  } = null
  - exponent: number
  - price: BN
- userPublicKey: PublicKey = undefined
Returns Promise<ClosePositionQuoteData>
- Defined in src/PerpetualsClient.ts:3517

getCollateralAmountWithFeeFromLeverageAndSize

getCollateralAmountWithFeeFromLeverageAndSize(sizeAmount, leverage, marketToken, collateralToken, side, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, discountBps?): BN
Parameters
- sizeAmount: BN
- leverage: string
- marketToken: Token
- collateralToken: Token
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- discountBps: BN = BN_ZERO
Returns BN
- Defined in src/PerpetualsClient.ts:1568

getCollateralAmountWithSwapSync

getCollateralAmountWithSwapSync(sizeAmount, leverage, side, poolAccount, inputTokenPrice, inputTokenEmaPrice, inputTokenCustodyAccount, swapOutTokenPrice, swapOutTokenEmaPrice, swapOutTokenCustodyAccount, collateralTokenPrice, collateralTokenEmaPrice, collateralTokenCustodyAccount, targetTokenPrice, targetTokenEmaPrice, targetTokenCustodyAccount, swapPoolAumUsdMax, poolConfig): BN
Parameters
- sizeAmount: BN
- leverage: string
- side: Side
- poolAccount: PoolAccount
- inputTokenPrice: OraclePrice
- inputTokenEmaPrice: OraclePrice
- inputTokenCustodyAccount: CustodyAccount
- swapOutTokenPrice: OraclePrice
- swapOutTokenEmaPrice: OraclePrice
- swapOutTokenCustodyAccount: CustodyAccount
- collateralTokenPrice: OraclePrice
- collateralTokenEmaPrice: OraclePrice
- collateralTokenCustodyAccount: CustodyAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetTokenCustodyAccount: CustodyAccount
- swapPoolAumUsdMax: BN
- poolConfig: PoolConfig
Returns BN
- Defined in src/PerpetualsClient.ts:1623

getCompoundingLPTokenPrice

getCompoundingLPTokenPrice(poolKey, POOL_CONFIG, includeRemainingAccounts?): Promise<string>
Parameters
- poolKey: PublicKey
- POOL_CONFIG: PoolConfig
- includeRemainingAccounts: boolean = true
Returns Promise<string>
- Defined in src/PerpetualsClient.ts:3781

getCompoundingTokenDataView

getCompoundingTokenDataView(poolConfig): Promise<any>
Parameters
- poolConfig: PoolConfig
Returns Promise<any>
- Defined in src/PerpetualsClient.ts:4323

getCumulativeLockFeeSync

getCumulativeLockFeeSync(custodyAccount, currentTimestamp): BN
Parameters
- custodyAccount: CustodyAccount
- currentTimestamp: BN
Returns BN
- Defined in src/PerpetualsClient.ts:2162

getCustodyKey

getCustodyKey(poolName, tokenMint): PublicKey
Parameters
- poolName: string
- tokenMint: PublicKey
Returns PublicKey
- Defined in src/PerpetualsClient.ts:279

getCustodyTokenAccountKey

getCustodyTokenAccountKey(poolName, tokenMint): PublicKey
Parameters
- poolName: string
- tokenMint: PublicKey
Returns PublicKey
- Defined in src/PerpetualsClient.ts:286

getDecreaseSizeCollateralAndFeeSync

getDecreaseSizeCollateralAndFeeSync(positionAccount, marketCorrelation, maxPayOffBps, sizeDeltaUsd, keepLevSame, targetPrice, targetEmaPrice, marketConfig, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, side, poolConfig, discountBps?, debugLogs?): RemoveCollateralData
Parameters
- positionAccount: PositionAccount
- marketCorrelation: boolean
- maxPayOffBps: BN
- sizeDeltaUsd: BN
- keepLevSame: boolean
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- marketConfig: MarketConfig
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- side: Side
- poolConfig: PoolConfig
- discountBps: BN = BN_ZERO
- debugLogs: boolean = false
Returns RemoveCollateralData
- Defined in src/PerpetualsClient.ts:1688

getEntryPriceAndFeeSyncV2

getEntryPriceAndFeeSyncV2(positionAccount, marketCorrelation, collateralDeltaAmount, sizeDeltaAmount, side, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, discountBps?, enableLogs?): EntryPriceAndFeeV2
Parameters
- positionAccount: PositionAccount
- marketCorrelation: boolean
- collateralDeltaAmount: BN
- sizeDeltaAmount: BN
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- discountBps: BN = BN_ZERO
- enableLogs: boolean = false
Returns EntryPriceAndFeeV2
- Defined in src/PerpetualsClient.ts:1094

getEntryPriceUsdSync

getEntryPriceUsdSync(side, targetPrice, targetEmaPrice, targetCustodyAccount, sizeUsd): OraclePrice
Parameters
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- sizeUsd: BN
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:1232

getEstimateProfitLossforTpSlEntry

getEstimateProfitLossforTpSlEntry(positionAccount, isTakeProfit, userEntrytpSlOraclePrice, collateralDeltaAmount, sizeDeltaAmount, side, marketCorrelation, maxPayOffBps, marketAccountPk, targetTokenPrice, targetTokenEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, poolConfig): {
pnlPercentage: BN;
pnlUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- isTakeProfit: boolean
- userEntrytpSlOraclePrice: OraclePrice
- collateralDeltaAmount: BN
- sizeDeltaAmount: BN
- side: Side
- marketCorrelation: boolean
- maxPayOffBps: BN
- marketAccountPk: PublicKey
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- poolConfig: PoolConfig
Returns {
pnlPercentage: BN;
pnlUsd: BN;
}
- pnlPercentage: BN
- pnlUsd: BN
- Defined in src/PerpetualsClient.ts:2469

getExitFeeSync

getExitFeeSync(positionAccount, targetCustody, collateralCustodyAccount, collateralPrice, collateralEmaPrice, discountBps?): {
exitFeeAmount: BN;
exitFeeUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetCustody: CustodyAccount
- collateralCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- discountBps: BN = BN_ZERO
Returns {
exitFeeAmount: BN;
exitFeeUsd: BN;
}
- exitFeeAmount: BN
- exitFeeUsd: BN
- Defined in src/PerpetualsClient.ts:1303

getExitOraclePriceSync

getExitOraclePriceSync(side, targetPrice, targetEmaPrice, targetCustodyAccount, sizeUsd): OraclePrice
Parameters
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- sizeUsd: BN
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:1429

getExitPriceAndFeeSync

getExitPriceAndFeeSync(positionAccount, marketCorrelation, collateralDeltaAmount, sizeDeltaAmount, side, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, discountBps?): ExitPriceAndFee
Parameters
- positionAccount: PositionAccount
- marketCorrelation: boolean
- collateralDeltaAmount: BN
- sizeDeltaAmount: BN
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- discountBps: BN = BN_ZERO
Returns ExitPriceAndFee
- Defined in src/PerpetualsClient.ts:1331

getFeeDiscount

getFeeDiscount(perpetualsAccount, tokenStakeAccount, currentTime): {
discountBn: BN;
}
Parameters
- perpetualsAccount: Perpetuals
- tokenStakeAccount: TokenStake
- currentTime: BN
Returns {
discountBn: BN;
}
- discountBn: BN
- Defined in src/PerpetualsClient.ts:3241

getFeeHelper

getFeeHelper(action, amountAdd, amountRemove, inputTokenCustodyAccount, maxOraclePrice, poolAumUsdMax, poolAccount, poolConfig): {
feeAmount: BN;
feeBps: BN;
}
Parameters
- action: FeesAction
- amountAdd: BN
- amountRemove: BN
- inputTokenCustodyAccount: CustodyAccount
- maxOraclePrice: OraclePrice
- poolAumUsdMax: BN
- poolAccount: PoolAccount
- poolConfig: PoolConfig
Returns {
feeAmount: BN;
feeBps: BN;
}
- feeAmount: BN
- feeBps: BN
- Defined in src/PerpetualsClient.ts:683

getFinalCloseAmountUsdSync

getFinalCloseAmountUsdSync(positionAccount, marketCorrelation, side, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, poolConfig): {
closeAmountUsd: BN;
feesAmountUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- marketCorrelation: boolean
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- poolConfig: PoolConfig
Returns {
closeAmountUsd: BN;
feesAmountUsd: BN;
}
- closeAmountUsd: BN
- feesAmountUsd: BN
- Defined in src/PerpetualsClient.ts:1971

getIndexPriceAtParticularTime

getIndexPriceAtParticularTime(poolConfig, targetPricesAtT1Ui, targetPricesAtT2Ui, tokenRatiosAtT2BN): string
Parameters
- poolConfig: PoolConfig
- targetPricesAtT1Ui: Number[]
- targetPricesAtT2Ui: Number[]
- tokenRatiosAtT2BN: BN[]
Returns string
- Defined in src/PerpetualsClient.ts:3256

getLeverageAtAmountEntryWithSwapSync

getLeverageAtAmountEntryWithSwapSync(positionAccount, inputDeltaAmount, sizeDeltaAmount, side, poolAccount, inputTokenPrice, inputTokenEmaPrice, inputTokenCustodyAccount, collateralTokenPrice, collateralTokenEmaPrice, collateralTokenCustodyAccount, targetTokenPrice, targetTokenEmaPrice, targetTokenCustodyAccount, swapPoolAumUsdMax, poolConfig, pnlUsd, enableDebuglogs?): BN
Parameters
- positionAccount: PositionAccount
- inputDeltaAmount: BN
- sizeDeltaAmount: BN
- side: Side
- poolAccount: PoolAccount
- inputTokenPrice: OraclePrice
- inputTokenEmaPrice: OraclePrice
- inputTokenCustodyAccount: CustodyAccount
- collateralTokenPrice: OraclePrice
- collateralTokenEmaPrice: OraclePrice
- collateralTokenCustodyAccount: CustodyAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetTokenCustodyAccount: CustodyAccount
- swapPoolAumUsdMax: BN
- poolConfig: PoolConfig
- pnlUsd: BN
- enableDebuglogs: boolean = false
Returns BN
- Defined in src/PerpetualsClient.ts:981

getLeverageContractHelper

getLeverageContractHelper(positionAccount, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, isInitial, poolConfig): BN
Parameters
- positionAccount: PositionAccount
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- isInitial: boolean
- poolConfig: PoolConfig
Returns BN
- Defined in src/PerpetualsClient.ts:906

getLeverageSync

getLeverageSync(positionAccount, finalCollateralUsd, finalSizeUsd, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, isInitial, poolConfig): BN
Parameters
- positionAccount: PositionAccount
- finalCollateralUsd: BN
- finalSizeUsd: BN
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- isInitial: boolean
- poolConfig: PoolConfig
Returns BN
- Defined in src/PerpetualsClient.ts:948

getLiquidationPriceContractHelper

getLiquidationPriceContractHelper(entryOraclePrice, lockAndUnsettledFeeUsd, side, targetCustodyAccount, positionAccount): OraclePrice
Parameters
- entryOraclePrice: OraclePrice
- lockAndUnsettledFeeUsd: BN
- side: Side
- targetCustodyAccount: CustodyAccount
- positionAccount: PositionAccount
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2235

getLiquidationPriceSync

getLiquidationPriceSync(collateralUsd, entryOraclePrice, lockAndUnsettledFeeUsd, side, targetCustodyAccount, positionAccount): OraclePrice
Parameters
- collateralUsd: BN
- entryOraclePrice: OraclePrice
- lockAndUnsettledFeeUsd: BN
- side: Side
- targetCustodyAccount: CustodyAccount
- positionAccount: PositionAccount
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2317

getLiquidationPriceView

getLiquidationPriceView(positionAccountKey, poolConfig): Promise<any>
Parameters
- positionAccountKey: PublicKey
- poolConfig: PoolConfig
Returns Promise<any>
- Defined in src/PerpetualsClient.ts:4252

getLiquidationPriceWithOrder

getLiquidationPriceWithOrder(collateralUsd, sizeAmount, sizeUsd, sizeDecimals, limitOraclePrice, side, targetCustodyAccount): OraclePrice
Parameters
- collateralUsd: BN
- sizeAmount: BN
- sizeUsd: BN
- sizeDecimals: number
- limitOraclePrice: OraclePrice
- side: Side
- targetCustodyAccount: CustodyAccount
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2341

getLiquidationStateView

getLiquidationStateView(positionAccount, poolName, tokenMint, collateralMint, poolConfig): Promise<any>
Parameters
- positionAccount: PublicKey
- poolName: string
- tokenMint: PublicKey
- collateralMint: PublicKey
- poolConfig: PoolConfig
Returns Promise<any>
- Defined in src/PerpetualsClient.ts:4294

getLockFeeAndUnsettledUsdForPosition

getLockFeeAndUnsettledUsdForPosition(position, collateralCustodyAccount, currentTimestamp): BN
Parameters
- position: PositionAccount
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
Returns BN
- Defined in src/PerpetualsClient.ts:2204

getLockedUsd

getLockedUsd(sizeUsd, collateralUsd, side, marketCorrelation, maxPayOffBps): BN
Parameters
- sizeUsd: BN
- collateralUsd: BN
- side: Side
- marketCorrelation: boolean
- maxPayOffBps: BN
Returns BN
- Defined in src/PerpetualsClient.ts:2218

getLpTokenPriceView

getLpTokenPriceView(poolConfig, includeRemainingAccounts?): Promise<any>
Parameters
- poolConfig: PoolConfig
- includeRemainingAccounts: boolean = true
Returns Promise<any>
- Defined in src/PerpetualsClient.ts:3676

getMarketPk

getMarketPk(targetCustody, collateralCustody, side): PublicKey
Parameters
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
Returns PublicKey
- Defined in src/PerpetualsClient.ts:293

getMaxAddableCollateralSync

getMaxAddableCollateralSync(positionAccount, targetCustodyAccount, collateralCustodyAccount, collateralPrice, collateralEmaPrice, errorBandwidthPercentageUi?): {
maxAddableAmount: BN;
maxAddableAmountUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetCustodyAccount: CustodyAccount
- collateralCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- errorBandwidthPercentageUi: number = 5
Returns {
maxAddableAmount: BN;
maxAddableAmountUsd: BN;
}
- maxAddableAmount: BN
- maxAddableAmountUsd: BN
- Defined in src/PerpetualsClient.ts:2024

getMaxProfitPriceSync

getMaxProfitPriceSync(entryPrice, marketCorrelation, side, collateralPrice, collateralDecimals, positionAccount): OraclePrice
Parameters
- entryPrice: OraclePrice
- marketCorrelation: boolean
- side: Side
- collateralPrice: OraclePrice
- collateralDecimals: number
- positionAccount: PositionAccount
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2421

getMaxWithdrawableAmountSync

getMaxWithdrawableAmountSync(positionAccount, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, poolConfig, errorBandwidthPercentageUi?): {
maxWithdrawableAmount: BN;
maxWithdrawableAmountUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- poolConfig: PoolConfig
- errorBandwidthPercentageUi: number = 5
Returns {
maxWithdrawableAmount: BN;
maxWithdrawableAmountUsd: BN;
}
- maxWithdrawableAmount: BN
- maxWithdrawableAmountUsd: BN
- Defined in src/PerpetualsClient.ts:2074

getMaxWithdrawableAmountSyncInternal

getMaxWithdrawableAmountSyncInternal(positionAccount, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, poolConfig, errorBandwidthPercentageUi?): {
    diffUsd: BN;
    maxWithdrawableAmount: BN;
    maxWithdrawableAmountUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- poolConfig: PoolConfig
- errorBandwidthPercentageUi: number = 5
Returns {
    diffUsd: BN;
    maxWithdrawableAmount: BN;
    maxWithdrawableAmountUsd: BN;
}
- diffUsd: BN
- maxWithdrawableAmount: BN
- maxWithdrawableAmountUsd: BN
- Defined in src/PerpetualsClient.ts:1881

getMinAndMaxOraclePriceSync

getMinAndMaxOraclePriceSync(price, emaPrice, custodyAccount): {
max: OraclePrice;
min: OraclePrice;
}
Parameters
- price: OraclePrice
- emaPrice: OraclePrice
- custodyAccount: CustodyAccount
Returns {
max: OraclePrice;
min: OraclePrice;
}
- max: OraclePrice
- min: OraclePrice
- Defined in src/PerpetualsClient.ts:762

getMinAndMaxPriceSync

getMinAndMaxPriceSync(price, emaPrice, custodyAccount): MinAndMaxPrice
Parameters
- price: OraclePrice
- emaPrice: OraclePrice
- custodyAccount: CustodyAccount
Returns MinAndMaxPrice
- Defined in src/PerpetualsClient.ts:821

`Private` getNewRatioHelper

getNewRatioHelper(amountAdd, amountRemove, custodyAccount, maxPriceOracle, poolAumUsdMax): BN
Parameters
- amountAdd: BN
- amountRemove: BN
- custodyAccount: CustodyAccount
- maxPriceOracle: OraclePrice
- poolAumUsdMax: BN
Returns BN
- Defined in src/PerpetualsClient.ts:651

getOpenPositionQuote

getOpenPositionQuote(amountIn, leverage, marketConfig, poolConfig, privilege?, receivingCustodyConfig?, existingPositionPk?, discountIndex?, limitPrice?, userPublicKey?, takeProfitPrice?, stopLossPrice?): Promise<OpenPositionQuoteData>
Parameters
- amountIn: BN
- leverage: BN
- marketConfig: MarketConfig
- poolConfig: PoolConfig
- privilege: Privilege = ...
- Optional receivingCustodyConfig: CustodyConfig
- Optional existingPositionPk: PublicKey
- discountIndex: number = null
- limitPrice: {
  exponent: number;
  price: BN;
  } = null
  - exponent: number
  - price: BN
- userPublicKey: PublicKey = undefined
- takeProfitPrice: {
  exponent: number;
  price: BN;
  } = null
  - exponent: number
  - price: BN
- stopLossPrice: {
  exponent: number;
  price: BN;
  } = null
  - exponent: number
  - price: BN
Returns Promise<OpenPositionQuoteData>
- Defined in src/PerpetualsClient.ts:3452

getOrLoadAddressLookupTable

getOrLoadAddressLookupTable(poolConfig): Promise<{
addressLookupTables: AddressLookupTableAccount[];
}>
Parameters
- poolConfig: PoolConfig
Returns Promise<{
addressLookupTables: AddressLookupTableAccount[];
}>
- Defined in src/PerpetualsClient.ts:157

getOrderAccount

getOrderAccount(orderAccountKey): Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: any[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    referenceTimestamp: BN;
    stopLossOrders: any[];
    takeProfitOrders: any[];
}>
Parameters
- orderAccountKey: PublicKey
Returns Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: any[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    referenceTimestamp: BN;
    stopLossOrders: any[];
    takeProfitOrders: any[];
}>
- Defined in src/PerpetualsClient.ts:341

getOrderAccountKey

getOrderAccountKey(owner, targetCustody, collateralCustody, side): PublicKey
Parameters
- owner: PublicKey
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
Returns PublicKey
- Defined in src/PerpetualsClient.ts:324

getPerpetuals

getPerpetuals(): Promise<any>
Returns Promise<any>
- Defined in src/PerpetualsClient.ts:250

getPnlContractHelper

getPnlContractHelper(positionAccount, targetTokenPrice, targetTokenEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, delay, poolConfig): {
    lossUsd: BN;
    priceImpactUsd: BN;
    profitUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- delay: BN
- poolConfig: PoolConfig
Returns {
    lossUsd: BN;
    priceImpactUsd: BN;
    profitUsd: BN;
}
- lossUsd: BN
- priceImpactUsd: BN
- profitUsd: BN
- Defined in src/PerpetualsClient.ts:2691

getPnlSync

getPnlSync(positionAccount, targetTokenPrice, targetTokenEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, delay, poolConfig): {
    lossUsd: BN;
    priceImpactUsd: BN;
    profitUsd: BN;
}
Parameters
- positionAccount: PositionAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- delay: BN
- poolConfig: PoolConfig
Returns {
    lossUsd: BN;
    priceImpactUsd: BN;
    profitUsd: BN;
}
- lossUsd: BN
- priceImpactUsd: BN
- profitUsd: BN
- Defined in src/PerpetualsClient.ts:2665

getPool

getPool(name): Promise<{
    buffer: BN;
    bump: number;
    compoundingLpPrice: BN;
    compoundingLpVault: PublicKey;
    compoundingLpVaultBump: number;
    compoundingMint: PublicKey;
    compoundingMintBump: number;
    compoundingStats: any;
    custodies: PublicKey[];
    equityUsd: BN;
    feesObligationUsd: BN;
    inceptionTime: BN;
    lastUpdatedTimestamp: BN;
    lpMint: PublicKey;
    lpMintBump: number;
    lpPrice: BN;
    markets: PublicKey[];
    maxAumUsd: BN;
    maxLpPriceUsd: BN;
    minLpPriceUsd: BN;
    name: string;
    oracleAuthority: PublicKey;
    padding: number[];
    permissions: any;
    ratios: any[];
    rawAumUsd: BN;
    rebateObligationUsd: BN;
    rewardCustody: PublicKey;
    stakedLpVault: PublicKey;
    stakedLpVaultBump: number;
    stakingFeeBoostBps: BN[];
    stakingFeeShareBps: BN;
    thresholdUsd: BN;
    totalStaked: any;
    uniqueCustodyCount: number;
    vpVolumeFactor: number;
}>
Parameters
- name: string
Returns Promise<{
    buffer: BN;
    bump: number;
    compoundingLpPrice: BN;
    compoundingLpVault: PublicKey;
    compoundingLpVaultBump: number;
    compoundingMint: PublicKey;
    compoundingMintBump: number;
    compoundingStats: any;
    custodies: PublicKey[];
    equityUsd: BN;
    feesObligationUsd: BN;
    inceptionTime: BN;
    lastUpdatedTimestamp: BN;
    lpMint: PublicKey;
    lpMintBump: number;
    lpPrice: BN;
    markets: PublicKey[];
    maxAumUsd: BN;
    maxLpPriceUsd: BN;
    minLpPriceUsd: BN;
    name: string;
    oracleAuthority: PublicKey;
    padding: number[];
    permissions: any;
    ratios: any[];
    rawAumUsd: BN;
    rebateObligationUsd: BN;
    rewardCustody: PublicKey;
    stakedLpVault: PublicKey;
    stakedLpVaultBump: number;
    stakingFeeBoostBps: BN[];
    stakingFeeShareBps: BN;
    thresholdUsd: BN;
    totalStaked: any;
    uniqueCustodyCount: number;
    vpVolumeFactor: number;
}>
- Defined in src/PerpetualsClient.ts:259

getPoolCompoundingTokenKey

getPoolCompoundingTokenKey(name): PublicKey
Parameters
- name: string
Returns PublicKey
- Defined in src/PerpetualsClient.ts:274

getPoolKey

getPoolKey(name): PublicKey
Parameters
- name: string
Returns PublicKey
- Defined in src/PerpetualsClient.ts:255

getPoolLpTokenKey

getPoolLpTokenKey(name): PublicKey
Parameters
- name: string
Returns PublicKey
- Defined in src/PerpetualsClient.ts:269

getPools

getPools(): Promise<{
    buffer: BN;
    bump: number;
    compoundingLpPrice: BN;
    compoundingLpVault: PublicKey;
    compoundingLpVaultBump: number;
    compoundingMint: PublicKey;
    compoundingMintBump: number;
    compoundingStats: any;
    custodies: PublicKey[];
    equityUsd: BN;
    feesObligationUsd: BN;
    inceptionTime: BN;
    lastUpdatedTimestamp: BN;
    lpMint: PublicKey;
    lpMintBump: number;
    lpPrice: BN;
    markets: PublicKey[];
    maxAumUsd: BN;
    maxLpPriceUsd: BN;
    minLpPriceUsd: BN;
    name: string;
    oracleAuthority: PublicKey;
    padding: number[];
    permissions: any;
    ratios: any[];
    rawAumUsd: BN;
    rebateObligationUsd: BN;
    rewardCustody: PublicKey;
    stakedLpVault: PublicKey;
    stakedLpVaultBump: number;
    stakingFeeBoostBps: BN[];
    stakingFeeShareBps: BN;
    thresholdUsd: BN;
    totalStaked: any;
    uniqueCustodyCount: number;
    vpVolumeFactor: number;
}[]>
Returns Promise<{
    buffer: BN;
    bump: number;
    compoundingLpPrice: BN;
    compoundingLpVault: PublicKey;
    compoundingLpVaultBump: number;
    compoundingMint: PublicKey;
    compoundingMintBump: number;
    compoundingStats: any;
    custodies: PublicKey[];
    equityUsd: BN;
    feesObligationUsd: BN;
    inceptionTime: BN;
    lastUpdatedTimestamp: BN;
    lpMint: PublicKey;
    lpMintBump: number;
    lpPrice: BN;
    markets: PublicKey[];
    maxAumUsd: BN;
    maxLpPriceUsd: BN;
    minLpPriceUsd: BN;
    name: string;
    oracleAuthority: PublicKey;
    padding: number[];
    permissions: any;
    ratios: any[];
    rawAumUsd: BN;
    rebateObligationUsd: BN;
    rewardCustody: PublicKey;
    stakedLpVault: PublicKey;
    stakedLpVaultBump: number;
    stakingFeeBoostBps: BN[];
    stakingFeeShareBps: BN;
    thresholdUsd: BN;
    totalStaked: any;
    uniqueCustodyCount: number;
    vpVolumeFactor: number;
}[]>
- Defined in src/PerpetualsClient.ts:263

getPosition

getPosition(postionKey): Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
Parameters
- postionKey: PublicKey
Returns Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
- Defined in src/PerpetualsClient.ts:336

getPositionData

getPositionData(position, poolConfig, userPublicKey?): Promise<PositionData>
Parameters
- position: PositionAccount
- poolConfig: PoolConfig
- userPublicKey: PublicKey = undefined
Returns Promise<PositionData>
- Defined in src/PerpetualsClient.ts:3410

getPositionKey

getPositionKey(owner, targetCustody, collateralCustody, side): PublicKey
Parameters
- owner: PublicKey
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
Returns PublicKey
- Defined in src/PerpetualsClient.ts:312

getPositionMetrics

getPositionMetrics(positionAccount, targetTokenPrice, targetTokenEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, currentTimestamp, poolConfig): PositionMetrics
Computes all position metrics in a single pass for UI display. This method consolidates 5 separate SDK calls into one, reducing redundant computation:
- getLockFeeAndUnsettledUsdForPosition()
- getExitFeeSync()
- getPnlSync()
- getLiquidationPriceSync()
- getLeverageSync()
Key optimizations:
- Single entry/exit price computation (reused across PnL and liquidation)
- No position cloning (pass by reference since we don't modify)
- Side computed once (used by PnL and liquidation)
- Shared fee calculations (lockAndUnsettledFeeUsd used by both PnL display and liquidation)
Parameters
- positionAccount: PositionAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- currentTimestamp: BN
- poolConfig: PoolConfig
Returns PositionMetrics
- Defined in src/PerpetualsClient.ts:2826

getPositionsMetricsBatch

getPositionsMetricsBatch(positions, priceMap, currentTimestamp): Map<string, PositionMetrics>
Batch computation of position metrics for multiple positions. Useful when updating multiple positions at once to reduce overhead.
Parameters
- positions: {
      collateralCustodyAccount: CustodyAccount;
      poolConfig: PoolConfig;
      positionAccount: PositionAccount;
      targetCustodyAccount: CustodyAccount;
  }[]
- priceMap: Map<string, {
  emaPrice: OraclePrice;
  price: OraclePrice;
  }>
- currentTimestamp: BN
Returns Map<string, PositionMetrics>
- Defined in src/PerpetualsClient.ts:2955

getPriceAfterSlippage

getPriceAfterSlippage(isEntry, slippageBps, targetPrice, side): ContractOraclePrice
Parameters
- isEntry: boolean
- slippageBps: BN
- targetPrice: OraclePrice
- side: Side
Returns ContractOraclePrice
- Defined in src/PerpetualsClient.ts:1254

getRemoveCollateralQuote

getRemoveCollateralQuote(collateralDeltaUsd, positionPk, positionAccount, poolConfig, dispensingCustodyConfig?, userPublicKey?): Promise<RemoveCollateralQuoteData>
Parameters
- collateralDeltaUsd: BN
- positionPk: PublicKey
- positionAccount: PositionAccount
- poolConfig: PoolConfig
- Optional dispensingCustodyConfig: CustodyConfig
- userPublicKey: PublicKey = undefined
Returns Promise<RemoveCollateralQuoteData>
- Defined in src/PerpetualsClient.ts:3625

getRemoveCompoundingLiquidityAmountAndFeeView

getRemoveCompoundingLiquidityAmountAndFeeView(amount, poolKey, removeTokenCustodyKey, POOL_CONFIG, userPublicKey?, enableBackupOracle?, whitelist?): Promise<{
amount: BN;
fee: BN;
}>
Parameters
- amount: BN
- poolKey: PublicKey
- removeTokenCustodyKey: PublicKey
- POOL_CONFIG: PoolConfig
- userPublicKey: PublicKey = undefined
- enableBackupOracle: boolean = false
- whitelist: PublicKey = PublicKey.default
Returns Promise<{
amount: BN;
fee: BN;
}>
- Defined in src/PerpetualsClient.ts:4159

getRemoveLiquidityAmountAndFeeSync

getRemoveLiquidityAmountAndFeeSync(lpAmountIn, poolAccount, outputTokenPrice, outputTokenEmaPrice, outputTokenCustodyAccount, lpTokenSupply, poolAumUsdMax, poolConfig): RemoveLiquidityAmountAndFee
Parameters
- lpAmountIn: BN
- poolAccount: PoolAccount
- outputTokenPrice: OraclePrice
- outputTokenEmaPrice: OraclePrice
- outputTokenCustodyAccount: CustodyAccount
- lpTokenSupply: BN
- poolAumUsdMax: BN
- poolConfig: PoolConfig
Returns RemoveLiquidityAmountAndFee
- Defined in src/PerpetualsClient.ts:604

getRemoveLiquidityAmountAndFeeView

getRemoveLiquidityAmountAndFeeView(amount, poolKey, removeTokenCustodyKey, POOL_CONFIG, userPublicKey?, enableBackupOracle?, whitelist?): Promise<{
    amount: BN;
    error?: string;
    fee: BN;
}>
Parameters
- amount: BN
- poolKey: PublicKey
- removeTokenCustodyKey: PublicKey
- POOL_CONFIG: PoolConfig
- userPublicKey: PublicKey = undefined
- enableBackupOracle: boolean = false
- whitelist: PublicKey = PublicKey.default
Returns Promise<{
    amount: BN;
    error?: string;
    fee: BN;
}>
- Defined in src/PerpetualsClient.ts:3980

getSizeAmountFromLeverageAndCollateral

getSizeAmountFromLeverageAndCollateral(collateralAmtWithFee, leverage, marketToken, collateralToken, side, targetPrice, targetEmaPrice, targetCustodyAccount, collateralPrice, collateralEmaPrice, collateralCustodyAccount, discountBps?): BN
Parameters
- collateralAmtWithFee: BN
- leverage: string
- marketToken: Token
- collateralToken: Token
- side: Side
- targetPrice: OraclePrice
- targetEmaPrice: OraclePrice
- targetCustodyAccount: CustodyAccount
- collateralPrice: OraclePrice
- collateralEmaPrice: OraclePrice
- collateralCustodyAccount: CustodyAccount
- discountBps: BN = BN_ZERO
Returns BN
- Defined in src/PerpetualsClient.ts:1451

getSizeAmountWithSwapSync

getSizeAmountWithSwapSync(amountIn, leverage, side, poolAccount, inputTokenPrice, inputTokenEmaPrice, inputTokenCustodyAccount, collateralTokenPrice, collateralTokenEmaPrice, collateralTokenCustodyAccount, swapOutTokenPrice, swapOutTokenEmaPrice, swapOutTokenCustodyAccount, targetTokenPrice, targetTokenEmaPrice, targetTokenCustodyAccount, swapPoolAumUsdMax, poolConfig, discountBps?): BN
Parameters
- amountIn: BN
- leverage: string
- side: Side
- poolAccount: PoolAccount
- inputTokenPrice: OraclePrice
- inputTokenEmaPrice: OraclePrice
- inputTokenCustodyAccount: CustodyAccount
- collateralTokenPrice: OraclePrice
- collateralTokenEmaPrice: OraclePrice
- collateralTokenCustodyAccount: CustodyAccount
- swapOutTokenPrice: OraclePrice
- swapOutTokenEmaPrice: OraclePrice
- swapOutTokenCustodyAccount: CustodyAccount
- targetTokenPrice: OraclePrice
- targetTokenEmaPrice: OraclePrice
- targetTokenCustodyAccount: CustodyAccount
- swapPoolAumUsdMax: BN
- poolConfig: PoolConfig
- discountBps: BN = BN_ZERO
Returns BN
- Defined in src/PerpetualsClient.ts:1500

getStakedLpTokenPrice

getStakedLpTokenPrice(poolKey, POOL_CONFIG, includeRemainingAccounts?): Promise<string>
Parameters
- poolKey: PublicKey
- POOL_CONFIG: PoolConfig
- includeRemainingAccounts: boolean = true
Returns Promise<string>
- Defined in src/PerpetualsClient.ts:3722

getSwapAmountAndFeesSync

getSwapAmountAndFeesSync(amountIn, amountOut, poolAccount, inputTokenPrice, inputTokenEmaPrice, inputTokenCustodyAccount, outputTokenPrice, outputTokenEmaPrice, outputTokenCustodyAccount, poolAumUsdMax, poolConfig, whitelistedUserAccount?): {
    feeIn: BN;
    feeOut: BN;
    minAmountIn: BN;
    minAmountOut: BN;
}
Parameters
- amountIn: BN
- amountOut: BN
- poolAccount: PoolAccount
- inputTokenPrice: OraclePrice
- inputTokenEmaPrice: OraclePrice
- inputTokenCustodyAccount: CustodyAccount
- outputTokenPrice: OraclePrice
- outputTokenEmaPrice: OraclePrice
- outputTokenCustodyAccount: CustodyAccount
- poolAumUsdMax: BN
- poolConfig: PoolConfig
- whitelistedUserAccount: Whitelist = null
Returns {
    feeIn: BN;
    feeOut: BN;
    minAmountIn: BN;
    minAmountOut: BN;
}
- feeIn: BN
- feeOut: BN
- minAmountIn: BN
- minAmountOut: BN
- Defined in src/PerpetualsClient.ts:2999

getTokenStakeAccount

getTokenStakeAccount(poolConfig, userPublicKey): Promise<TokenStakeAccount>
Parameters
- poolConfig: PoolConfig
- userPublicKey: PublicKey
Returns Promise<TokenStakeAccount>
- Defined in src/PerpetualsClient.ts:3362

getTradeSpread

getTradeSpread(targetCustodyAccount, sizeUsd): BN
Parameters
- targetCustodyAccount: CustodyAccount
- sizeUsd: BN
Returns BN
- Defined in src/PerpetualsClient.ts:1417

getTriggerPriceFromPnlSync

getTriggerPriceFromPnlSync(pnlUsd, exitFeeUsd, positionSize, sizeDecimals, entryPrice, side): OraclePrice
Parameters
- pnlUsd: BN
- exitFeeUsd: BN
- positionSize: BN
- sizeDecimals: number
- entryPrice: OraclePrice
- side: Side
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2583

getTriggerPriceFromRoiSync

getTriggerPriceFromRoiSync(roi, collateralUsd, exitFeeUsd, positionSize, sizeDecimals, entryPrice, side): OraclePrice
Parameters
- roi: BN
- collateralUsd: BN
- exitFeeUsd: BN
- positionSize: BN
- sizeDecimals: number
- entryPrice: OraclePrice
- side: Side
Returns OraclePrice
- Defined in src/PerpetualsClient.ts:2622

getUserClaimableRevenueAmount

getUserClaimableRevenueAmount(POOL_CONFIG, userPublicKey, enableDebuglogs?): Promise<BN>
Parameters
- POOL_CONFIG: PoolConfig
- userPublicKey: PublicKey
- enableDebuglogs: boolean = false
Returns Promise<BN>
- Defined in src/PerpetualsClient.ts:3302

getUserOrderAccount

getUserOrderAccount(owner, targetCustody, collateralCustody, side): Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
Parameters
- owner: PublicKey
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
Returns Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
- Defined in src/PerpetualsClient.ts:356

getUserOrderAccounts

getUserOrderAccounts(wallet, poolConfig): Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: LimitOrder[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    pubkey: PublicKey;
    referenceTimestamp: BN;
    stopLossOrders: TriggerOrder[];
    takeProfitOrders: TriggerOrder[];
}[]>
Parameters
- wallet: PublicKey
- poolConfig: PoolConfig
Returns Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: LimitOrder[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    pubkey: PublicKey;
    referenceTimestamp: BN;
    stopLossOrders: TriggerOrder[];
    takeProfitOrders: TriggerOrder[];
}[]>
- Defined in src/PerpetualsClient.ts:415

getUserOrderAccountsMultiPool

getUserOrderAccountsMultiPool(wallet, poolConfigs): Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: LimitOrder[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    pubkey: PublicKey;
    referenceTimestamp: BN;
    stopLossOrders: TriggerOrder[];
    takeProfitOrders: TriggerOrder[];
}[]>
Parameters
- wallet: PublicKey
- poolConfigs: PoolConfig[]
Returns Promise<{
    activeOrders: number;
    bump: number;
    executionCount: BN;
    inactiveSl: number;
    inactiveTp: number;
    isActive: boolean;
    isInitialised: boolean;
    limitOrders: LimitOrder[];
    market: PublicKey;
    openSl: number;
    openTp: number;
    owner: PublicKey;
    padding: BN[];
    pubkey: PublicKey;
    referenceTimestamp: BN;
    stopLossOrders: TriggerOrder[];
    takeProfitOrders: TriggerOrder[];
}[]>
- Defined in src/PerpetualsClient.ts:435

getUserPosition

getUserPosition(owner, targetCustody, collateralCustody, side): Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
Parameters
- owner: PublicKey
- targetCustody: PublicKey
- collateralCustody: PublicKey
- side: Side
Returns Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: any;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    referencePrice: any;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}>
- Defined in src/PerpetualsClient.ts:345

getUserPositions

getUserPositions(wallet, poolConfig): Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: ContractOraclePrice;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    pubkey: PublicKey;
    referencePrice: ContractOraclePrice;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}[]>
Parameters
- wallet: PublicKey
- poolConfig: PoolConfig
Returns Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: ContractOraclePrice;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    pubkey: PublicKey;
    referencePrice: ContractOraclePrice;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}[]>
- Defined in src/PerpetualsClient.ts:368

getUserPositionsMultiPool

getUserPositionsMultiPool(wallet, poolConfigs): Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: ContractOraclePrice;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    pubkey: PublicKey;
    referencePrice: ContractOraclePrice;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}[]>
Parameters
- wallet: PublicKey
- poolConfigs: PoolConfig[]
Returns Promise<{
    buffer: number[];
    bump: number;
    collateralDecimals: number;
    collateralUsd: BN;
    cumulativeLockFeeSnapshot: BN;
    degenSizeUsd: BN;
    delegate: PublicKey;
    entryPrice: ContractOraclePrice;
    isActive: boolean;
    lockedAmount: BN;
    lockedDecimals: number;
    lockedUsd: BN;
    market: PublicKey;
    openTime: BN;
    owner: PublicKey;
    padding: number[];
    priceImpactSet: number;
    priceImpactUsd: BN;
    pubkey: PublicKey;
    referencePrice: ContractOraclePrice;
    sizeAmount: BN;
    sizeDecimals: number;
    sizeUsd: BN;
    unsettledFeesUsd: BN;
    unsettledValueUsd: BN;
    updateTime: BN;
}[]>
- Defined in src/PerpetualsClient.ts:388

getUserUnstakingStatus

getUserUnstakingStatus(poolConfig, userPublicKey): Promise<{
    activeStakeAmount: BN;
    requests: {
        lockedAmount: BN;
        requestId: number;
        timeRemaining: BN;
        totalAmount: BN;
        withdrawableAmount: BN;
    }[];
    revenueEligibleAmount: BN;
    totalLocked: BN;
    totalWithdrawable: BN;
}>
Parameters
- poolConfig: PoolConfig
- userPublicKey: PublicKey
Returns Promise<{
    activeStakeAmount: BN;
    requests: {
        lockedAmount: BN;
        requestId: number;
        timeRemaining: BN;
        totalAmount: BN;
        withdrawableAmount: BN;
    }[];
    revenueEligibleAmount: BN;
    totalLocked: BN;
    totalWithdrawable: BN;
}>
- Defined in src/PerpetualsClient.ts:3382

increaseSize

increaseSize(targetSymbol, collateralSymbol, positionPubKey, side, poolConfig, priceWithSlippage, sizeDelta, privilege, tokenStakeAccount?, userReferralAccount?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- positionPubKey: PublicKey
- side: Side
- poolConfig: PoolConfig
- priceWithSlippage: ContractOraclePrice
- sizeDelta: BN
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5643

init

init(admins, config): Promise<void>
Parameters
- admins: PublicKey[]
- config: any
Returns Promise<void>
- Defined in src/PerpetualsClient.ts:9602

initCompounding

initCompounding(feeShareBps, metadataTitle, metadataSymbol, metadataUri, rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- feeShareBps: BN
- metadataTitle: string
- metadataSymbol: string
- metadataUri: string
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10647

initRebateVault

initRebateVault(allowRebatePayout, rebateSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- allowRebatePayout: boolean
- rebateSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11000

initRevenueTokenAccount

initRevenueTokenAccount(feeShareBps, rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- feeShareBps: BN
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10947

initStake

initStake(stakingFeeShareBps, rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- stakingFeeShareBps: BN
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10590

initTokenVault

initTokenVault(token_permissions, tokens_to_distribute, withdrawTimeLimit, withdrawInstantFee, stakeLevel, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- token_permissions: TokenPermissions
- tokens_to_distribute: BN
- withdrawTimeLimit: BN
- withdrawInstantFee: BN
- stakeLevel: BN[]
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10720

liquidate

liquidate(positionAccount, poolConfig, tokenMint, collateralMint, marketPk): Promise<TransactionInstruction>
Parameters
- positionAccount: PublicKey
- poolConfig: PoolConfig
- tokenMint: PublicKey
- collateralMint: PublicKey
- marketPk: PublicKey
Returns Promise<TransactionInstruction>
- Defined in src/PerpetualsClient.ts:5781

loadAddressLookupTable

loadAddressLookupTable(poolConfig): Promise<void>
Parameters
- poolConfig: PoolConfig
Returns Promise<void>
- Defined in src/PerpetualsClient.ts:141

log

log(...message): void
Parameters
- Rest ...message: string[]
Returns void
- Defined in src/PerpetualsClient.ts:513

migrateFlp

migrateFlp(amount, rewardTokenMint, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- amount: BN
- rewardTokenMint: PublicKey
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7495

migrateMarketOrder

migrateMarketOrder(poolName, oldMarket, newMarket, oldCollateralCustody, newCollateralCustody, owner?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- oldMarket: PublicKey
- newMarket: PublicKey
- oldCollateralCustody: PublicKey
- newCollateralCustody: PublicKey
- owner: PublicKey = ...
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11946

migrateMarketPosition

migrateMarketPosition(poolName, oldMarket, newMarket, oldCollateralCustody, newCollateralCustody, owner): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- oldMarket: PublicKey
- newMarket: PublicKey
- oldCollateralCustody: PublicKey
- newCollateralCustody: PublicKey
- owner: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11887

migrateStake

migrateStake(amount, rewardTokenMint, poolConfig, createUserATA?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- amount: BN
- rewardTokenMint: PublicKey
- poolConfig: PoolConfig
- createUserATA: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7366

moveProtocolFees

moveProtocolFees(rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10041

openPosition

openPosition(targetSymbol, collateralSymbol, priceWithSlippage, collateralWithfee, size, side, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?, skipBalanceChecks?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- priceWithSlippage: ContractOraclePrice
- collateralWithfee: BN
- size: BN
- side: Side
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:4371

placeLimitOrder

placeLimitOrder(targetSymbol, collateralSymbol, reserveSymbol, receiveSymbol, side, limitPrice, reserveAmount, sizeAmount, stopLossPrice, takeProfitPrice, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- reserveSymbol: string
- receiveSymbol: string
- side: Side
- limitPrice: ContractOraclePrice
- reserveAmount: BN
- sizeAmount: BN
- stopLossPrice: ContractOraclePrice
- takeProfitPrice: ContractOraclePrice
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8169

placeTriggerOrder

placeTriggerOrder(targetSymbol, collateralSymbol, receiveSymbol, side, triggerPrice, deltaSizeAmount, isStopLoss, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- receiveSymbol: string
- side: Side
- triggerPrice: ContractOraclePrice
- deltaSizeAmount: BN
- isStopLoss: boolean
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8595

prettyPrint

prettyPrint(object): void
Parameters
- object: object
Returns void
- Defined in src/PerpetualsClient.ts:520

protocolWithdrawFees

protocolWithdrawFees(rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9992

refreshOrdersStatus

refreshOrdersStatus(orderAccounts): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- orderAccounts: PublicKey[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11853

refreshPositionsStatus

refreshPositionsStatus(positionAccounts): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- positionAccounts: PublicKey[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11819

refreshStakeWithAllFlpStakeAccounts

refreshStakeWithAllFlpStakeAccounts(rewardSymbol, poolConfig, flpStakeAccountPks): Promise<TransactionInstruction>
Parameters
- rewardSymbol: string
- poolConfig: PoolConfig
- flpStakeAccountPks: PublicKey[]
Returns Promise<TransactionInstruction>
- Defined in src/PerpetualsClient.ts:6479

refreshStakeWithTokenStake

refreshStakeWithTokenStake(rewardSymbol, poolConfig, flpStakeAccountPk, userPublicKey?): Promise<TransactionInstruction>
Parameters
- rewardSymbol: string
- poolConfig: PoolConfig
- flpStakeAccountPk: PublicKey
- userPublicKey: PublicKey = undefined
Returns Promise<TransactionInstruction>
- Defined in src/PerpetualsClient.ts:6542

refreshTokenStake

refreshTokenStake(tokenStakeAccounts, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- tokenStakeAccounts: PublicKey[]
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8016

reimburse

reimburse(tokenMint, amountIn, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- tokenMint: PublicKey
- amountIn: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10156

removeCollateral

removeCollateral(collateralDeltaUsd, marketSymbol, collateralSymbol, side, positionPubKey, poolConfig, createUserATA?, closeUsersWSOLATA?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- collateralDeltaUsd: BN
- marketSymbol: string
- collateralSymbol: string
- side: Side
- positionPubKey: PublicKey
- poolConfig: PoolConfig
- createUserATA: boolean = true
- closeUsersWSOLATA: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5349

removeCollateralAndSwap

removeCollateralAndSwap(targetSymbol, collateralSymbol, outputSymbol, collateralDeltaUsd, side, poolConfig, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- collateralSymbol: string
- outputSymbol: string
- collateralDeltaUsd: BN
- side: Side
- poolConfig: PoolConfig
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5484

removeCompoundingLiquidity

removeCompoundingLiquidity(compoundingAmountIn, minAmountOut, outTokenSymbol, rewardTokenMint, poolConfig, createUserATA?, ephemeralSignerPubkey?, userPublicKey?, enableHeapSizeIx?, isWhitelistedUser?, includeRemainingAccounts?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- compoundingAmountIn: BN
- minAmountOut: BN
- outTokenSymbol: string
- rewardTokenMint: PublicKey
- poolConfig: PoolConfig
- createUserATA: boolean = true
- ephemeralSignerPubkey: any = undefined
- userPublicKey: PublicKey = undefined
- enableHeapSizeIx: boolean = true
- isWhitelistedUser: boolean = false
- includeRemainingAccounts: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7182

removeCustody

removeCustody(poolName, tokenMint, ratios, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
- ratios: TokenRatios[]
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9903

removeLiquidity

removeLiquidity(recieveTokenSymbol, liquidityAmountIn, minTokenAmountOut, poolConfig, closeLpATA?, createUserATA?, closeUsersWSOLATA?, ephemeralSignerPubkey?, userPublicKey?, isWhitelistedUser?, includeRemainingAccounts?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- recieveTokenSymbol: string
- liquidityAmountIn: BN
- minTokenAmountOut: BN
- poolConfig: PoolConfig
- closeLpATA: boolean = false
- createUserATA: boolean = true
- closeUsersWSOLATA: boolean = false
- ephemeralSignerPubkey: any = undefined
- userPublicKey: PublicKey = undefined
- isWhitelistedUser: boolean = false
- includeRemainingAccounts: boolean = true
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6195

removeMarket

removeMarket(poolName, market, targetMint, collateralMint): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- market: PublicKey
- targetMint: PublicKey
- collateralMint: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11777

removePool

removePool(name): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- name: string
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9740

renameFlp

renameFlp(flag, lpTokenName, lpTokenSymbol, lpTokenUri, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- flag: BN
- lpTokenName: string
- lpTokenSymbol: string
- lpTokenUri: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10535

resizeInternalOracle

resizeInternalOracle(lazerFeedId, tokenMint, intOracleAccount): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- lazerFeedId: number
- tokenMint: PublicKey
- intOracleAccount: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11248

resizeTokenStake

resizeTokenStake(tokenStakeAccounts): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- tokenStakeAccounts: PublicKey[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11160

sendTransaction

sendTransaction(ixs, opts?): Promise<string>
Parameters
- ixs: TransactionInstruction[]
- opts: SendTransactionOpts = {}
Returns Promise<string>
- Defined in src/PerpetualsClient.ts:9134

sendTransactionV3

sendTransactionV3(ixs, opts?): Promise<{
signature: string;
versionedTransaction: VersionedTransaction;
}>
Parameters
- ixs: TransactionInstruction[]
- opts: SendTransactionOpts = {}
Returns Promise<{
signature: string;
versionedTransaction: VersionedTransaction;
}>
- Defined in src/PerpetualsClient.ts:9149

setAdminSigners

setAdminSigners(admins, minSignatures): Promise<void>
Parameters
- admins: PublicKey[]
- minSignatures: number
Returns Promise<void>
- Defined in src/PerpetualsClient.ts:9638

setCustody

setCustody(poolName, tokenMint, isVirtual, depegAdjustment, inversePrice, oracle, pricingConfig, permissions, fees, borrowRate, ratios, minReserveUsd, limitPriceBufferBps, token22): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
- isVirtual: boolean
- depegAdjustment: boolean
- inversePrice: boolean
- oracle: OracleParams
- pricingConfig: PricingParams
- permissions: Permissions
- fees: Fees
- borrowRate: BorrowRateParams
- ratios: TokenRatios[]
- minReserveUsd: BN
- limitPriceBufferBps: BN
- token22: boolean
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11594

setCustodyTokenMultiplier

setCustodyTokenMultiplier(poolName, tokenMint): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- tokenMint: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11659

setFeeShareBps

setFeeShareBps(poolConfig, flpStakeAccountPks): Promise<TransactionInstruction>
Parameters
- poolConfig: PoolConfig
- flpStakeAccountPks: PublicKey[]
Returns Promise<TransactionInstruction>
- Defined in src/PerpetualsClient.ts:6688

setInternalLazerPriceBatch

setInternalLazerPriceBatch(messageData, tokenMintList, pythStorage, pythTreasury, POOL_CONFIGS): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- messageData: Buffer
- tokenMintList: PublicKey[]
- pythStorage: PublicKey
- pythTreasury: PublicKey
- POOL_CONFIGS: PoolConfig[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10289

setInternalOracleEmaPriceBatch

setInternalOracleEmaPriceBatch(tokenMintList, tokenInternalEmaPrices, POOL_CONFIGS): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- tokenMintList: PublicKey[]
- tokenInternalEmaPrices: InternalEmaPrice[]
- POOL_CONFIGS: PoolConfig[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10344

setInternalOraclePriceBatch

setInternalOraclePriceBatch(useCurrentTime, tokenMintList, tokenInternalPrices, POOL_CONFIGS): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- useCurrentTime: number
- tokenMintList: PublicKey[]
- tokenInternalPrices: InternalPrice[]
- POOL_CONFIGS: PoolConfig[]
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10232

setLpTokenPrice

setLpTokenPrice(poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9544

setMarket

setMarket(poolName, targetCustody, collateralCustody, marketAccount, maxPayoffBps, permissions, correlation): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolName: string
- targetCustody: PublicKey
- collateralCustody: PublicKey
- marketAccount: PublicKey
- maxPayoffBps: BN
- permissions: MarketPermissions
- correlation: boolean
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11733

setPermissions

setPermissions(permissions): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- permissions: Permissions
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10117

setPerpetualsConfig

setPerpetualsConfig(allowUngatedTrading, voltageMultiplier, tradingDiscount, referralRebate, defaultRebate, tradeLimit, triggerOrderLimit, rebateLimitUsd): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- allowUngatedTrading: boolean
- voltageMultiplier: VoltageMultiplier
- tradingDiscount: BN[]
- referralRebate: BN[]
- defaultRebate: BN
- tradeLimit: number
- triggerOrderLimit: number
- rebateLimitUsd: number
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11387

setPoolConfig

setPoolConfig(name, permissions, maxAumUsd, oracleAuthority, stakingFeeShareBps, vpVolumeFactor, stakingFeeBoostBps, minLpPriceUsd, maxLpPriceUsd, thresholdUsd): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- name: string
- permissions: Permissions
- maxAumUsd: BN
- oracleAuthority: PublicKey
- stakingFeeShareBps: BN
- vpVolumeFactor: number
- stakingFeeBoostBps: BN[]
- minLpPriceUsd: BN
- maxLpPriceUsd: BN
- thresholdUsd: BN
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11431

setPositionPriceImpact

setPositionPriceImpact(positionPubkey, priceImpactUsd, penaltyAuthority): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- positionPubkey: PublicKey
- priceImpactUsd: BN
- penaltyAuthority: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10500

setPrioritizationFee

setPrioritizationFee(fee): void
Parameters
- fee: number
Returns void
- Defined in src/PerpetualsClient.ts:137

setProtocolFeeShareBps

setProtocolFeeShareBps(feeShareBps, poolConfig): Promise<TransactionInstruction>
Parameters
- feeShareBps: BN
- poolConfig: PoolConfig
Returns Promise<TransactionInstruction>
- Defined in src/PerpetualsClient.ts:10088

setTokenReward

setTokenReward(owner, amount, epochCount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- amount: BN
- epochCount: number
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11199

setTokenStakeLevel

setTokenStakeLevel(owner, stakeLevel, poolConfig, rebateRate?, maxRebateUsd?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- stakeLevel: number
- poolConfig: PoolConfig
- rebateRate: BN = ...
- maxRebateUsd: BN = ...
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11114

setTokenVaultConfig

setTokenVaultConfig(token_permissions, withdrawTimeLimit, withdrawInstantFee, stakeLevel, unlockPeriod, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- token_permissions: TokenPermissions
- withdrawTimeLimit: BN
- withdrawInstantFee: BN
- stakeLevel: BN[]
- unlockPeriod: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10783

setWhitelistConfig

setWhitelistConfig(isSwapFeeExempt, isDepositFeeExempt, isWithdrawalFeeExempt, poolAddress, owner): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- isSwapFeeExempt: boolean
- isDepositFeeExempt: boolean
- isWithdrawalFeeExempt: boolean
- poolAddress: PublicKey
- owner: PublicKey
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:11338

settleRebates

settleRebates(rebateSymbol, rewardSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rebateSymbol: string
- rewardSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:8121

swap

swap(userInputTokenSymbol, userOutputTokenSymbol, amountIn, minAmountOut, poolConfig, useFeesPool?, createUserATA?, unWrapSol?, skipBalanceChecks?, ephemeralSignerPubkey?, isWhitelistedUser?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- userInputTokenSymbol: string
- userOutputTokenSymbol: string
- amountIn: BN
- minAmountOut: BN
- poolConfig: PoolConfig
- useFeesPool: boolean = false
- createUserATA: boolean = true
- unWrapSol: boolean = false
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
- isWhitelistedUser: boolean = false
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9171

swapAndAddCollateral

swapAndAddCollateral(targetSymbol, inputSymbol, collateralSymbol, amountIn, side, positionPubKey, poolConfig, skipBalanceChecks?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetSymbol: string
- inputSymbol: string
- collateralSymbol: string
- amountIn: BN
- side: Side
- positionPubKey: PublicKey
- poolConfig: PoolConfig
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:5193

swapAndOpen

swapAndOpen(targetTokenSymbol, collateralTokenSymbol, userInputTokenSymbol, amountIn, priceWithSlippage, sizeAmount, side, poolConfig, privilege, tokenStakeAccount?, userReferralAccount?, skipBalanceChecks?, ephemeralSignerPubkey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- targetTokenSymbol: string
- collateralTokenSymbol: string
- userInputTokenSymbol: string
- amountIn: BN
- priceWithSlippage: ContractOraclePrice
- sizeAmount: BN
- side: Side
- poolConfig: PoolConfig
- privilege: Privilege
- tokenStakeAccount: PublicKey = PublicKey.default
- userReferralAccount: PublicKey = PublicKey.default
- skipBalanceChecks: boolean = false
- ephemeralSignerPubkey: any = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:4645

swapFeeInternal

swapFeeInternal(rewardTokenSymbol, swapTokenSymbol, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rewardTokenSymbol: string
- swapTokenSymbol: string
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:9469

unstakeInstant

unstakeInstant(rewardSymbol, unstakeAmount, poolConfig, userPublicKey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- rewardSymbol: string
- unstakeAmount: BN
- poolConfig: PoolConfig
- userPublicKey: PublicKey = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6614

unstakeRequest

unstakeRequest(unstakeAmount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- unstakeAmount: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6743

unstakeTokenRequest

unstakeTokenRequest(owner, unstakeAmount, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- unstakeAmount: BN
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7729

withdrawInstantFee

withdrawInstantFee(poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10830

withdrawStake

withdrawStake(poolConfig, pendingActivation?, deactivated?, createUserLPTA?, userPublicKey?): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolConfig: PoolConfig
- pendingActivation: boolean = true
- deactivated: boolean = true
- createUserLPTA: boolean = true
- userPublicKey: PublicKey = undefined
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:6793

withdrawToken

withdrawToken(owner, withdrawRequestId, poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- owner: PublicKey
- withdrawRequestId: number
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:7772

withdrawUnclaimedTokens

withdrawUnclaimedTokens(poolConfig): Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
Parameters
- poolConfig: PoolConfig
Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>
- Defined in src/PerpetualsClient.ts:10889

Class PerpetualsClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PerpetualsClient

Properties

admin

authority

Type declaration

bump: number

publicKey: PublicKey

eventAuthority

Type declaration

bump: number

publicKey: PublicKey

minimumBalanceForRentExemptAccountLamports

multisig

Type declaration

bump: number

publicKey: PublicKey

perpetuals

Type declaration

bump: number

publicKey: PublicKey

Private poolAddressLookupTables

Private poolPusherAddressLookupTables

Private Optional postSendTxCallback

Type declaration

Parameters

txid: any

Returns void

prioritizationFee

program

programId

provider

pusherAddressLookupTables

Private txConfirmationCommitment

Private useExtOracleAccount

Private viewHelper

Methods

addCollateral

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addCompoundingLiquidity

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addCustody

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addCustodyToken22

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addInternalOracle

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addLiquidity

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addLiquidityAndStake

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addMarket

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addPool

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

addReferral

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

adjustTokenRatios

Parameters

Returns TokenRatios[]

cancelAllTriggerOrders

Parameters

Returns Promise<{ additionalSigners: Signer[]; instructions: TransactionInstruction[]; }>

`Private` poolAddressLookupTables

`Private` poolPusherAddressLookupTables

`Private` `Optional` postSendTxCallback

`Private` txConfirmationCommitment

`Private` useExtOracleAccount

`Private` viewHelper

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns Promise<{
additionalSigners: Signer[];
instructions: TransactionInstruction[];
}>

Returns {
bump: number;
publicKey: PublicKey;
}