Class AdminClient

DriftClient

This class is the main way to interact with Drift Protocol. It allows you to subscribe to the various accounts where the Market's state is stored, as well as: opening positions, liquidating, settling funding, depositing & withdrawing, and more.

Hierarchy

DriftClient
- AdminClient
  - TestClient

Index

Constructors

constructor

new AdminClient(config: DriftClientConfig): AdminClient
Parameters
- config: DriftClientConfig
Returns AdminClient
Inherited from DriftClient.constructor
- Defined in sdk/src/driftClient.ts:171

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: DriftClientAccountSubscriber

activeSubAccountId

activeSubAccountId: number

authority

authority: PublicKey

`Optional` authoritySubAccountMap

authoritySubAccountMap?: Map<string, number[]>

connection

connection: Connection

eventEmitter

`Optional` includeDelegates

includeDelegates?: boolean

lookupTableAccount

lookupTableAccount: AddressLookupTableAccount

marketLookupTable

marketLookupTable: PublicKey

mustIncludePerpMarketIndexes

mustIncludePerpMarketIndexes: Set<number> = ...

mustIncludeSpotMarketIndexes

mustIncludeSpotMarketIndexes: Set<number> = ...

`Optional` opts

opts?: ConfirmOptions

perpMarketLastSlotCache

perpMarketLastSlotCache: Map<number, number> = ...

program

program: Program<Idl>

provider

provider: AnchorProvider

`Optional` signerPublicKey

signerPublicKey?: PublicKey

`Optional` skipLoadUsers

skipLoadUsers?: boolean

spotMarketLastSlotCache

spotMarketLastSlotCache: Map<number, number> = ...

`Optional` statePublicKey

statePublicKey?: PublicKey

txParams

txParams: TxParams

txSender

txSender: TxSender

txVersion

txVersion: TransactionVersion

userAccountSubscriptionConfig

userAccountSubscriptionConfig: UserSubscriptionConfig

`Optional` userStats

userStats?: UserStats

userStatsAccountPublicKey

userStatsAccountPublicKey: PublicKey

userStatsAccountSubscriptionConfig

userStatsAccountSubscriptionConfig: UserStatsSubscriptionConfig

users

users: Map<string, User> = ...

wallet

wallet: IWallet

Accessors

isSubscribed

get isSubscribed(): boolean
Returns boolean
Inherited from DriftClient.isSubscribed
- Defined in sdk/src/driftClient.ts:163
set isSubscribed(val: boolean): void
Parameters
- val: boolean
Returns void
Inherited from DriftClient.isSubscribed
- Defined in sdk/src/driftClient.ts:167

Methods

addAndSubscribeToUsers

addAndSubscribeToUsers(): Promise<boolean>
Adds and subscribes to users based on params set by the constructor or by updateWallet.

Returns Promise<boolean>
Inherited from DriftClient.addAndSubscribeToUsers
- Defined in sdk/src/driftClient.ts:623

addInsuranceFundStake

addInsuranceFundStake(__namedParameters: {
    amount: BN;
    collateralAccountPublicKey: PublicKey;
    fromSubaccount?: boolean;
    initializeStakeAccount?: boolean;
    marketIndex: number;
}): Promise<string>
Add to an insurance fund stake and optionally initialize the account
Parameters
- __namedParameters: {
      amount: BN;
      collateralAccountPublicKey: PublicKey;
      fromSubaccount?: boolean;
      initializeStakeAccount?: boolean;
      marketIndex: number;
  }
  - amount: BN
  - collateralAccountPublicKey: PublicKey
    
    The account where the funds to stake come from. Usually an associated token account
  - Optional fromSubaccount?: boolean
    
    Optional -- withdraw from current subaccount to fund stake amount, instead of wallet balance
  - Optional initializeStakeAccount?: boolean
    
    Add instructions to initialize the staking account -- required if its the first time the currrent authority has staked in this market
  - marketIndex: number
    
    Spot market index
Returns Promise<string>
Inherited from DriftClient.addInsuranceFundStake
- Defined in sdk/src/driftClient.ts:5270

addPerpLpShares

addPerpLpShares(amount: BN, marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- amount: BN
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.addPerpLpShares
- Defined in sdk/src/driftClient.ts:2307

addPerpMarketToRemainingAccountMaps

addPerpMarketToRemainingAccountMaps(marketIndex: number, writable: boolean, oracleAccountMap: Map<string, AccountMeta>, spotMarketAccountMap: Map<number, AccountMeta>, perpMarketAccountMap: Map<number, AccountMeta>): void
Parameters
- marketIndex: number
- writable: boolean
- oracleAccountMap: Map<string, AccountMeta>
- spotMarketAccountMap: Map<number, AccountMeta>
- perpMarketAccountMap: Map<number, AccountMeta>
Returns void
Inherited from DriftClient.addPerpMarketToRemainingAccountMaps
- Defined in sdk/src/driftClient.ts:1384

addPhoenixRemainingAccounts

addPhoenixRemainingAccounts(marketIndex: number, remainingAccounts: AccountMeta[], fulfillmentConfig: PhoenixV1FulfillmentConfigAccount): void
Parameters
- marketIndex: number
- remainingAccounts: AccountMeta[]
- fulfillmentConfig: PhoenixV1FulfillmentConfigAccount
Returns void
Inherited from DriftClient.addPhoenixRemainingAccounts
- Defined in sdk/src/driftClient.ts:3335

addSerumRemainingAccounts

addSerumRemainingAccounts(marketIndex: number, remainingAccounts: AccountMeta[], fulfillmentConfig: SerumV3FulfillmentConfigAccount): void
Parameters
- marketIndex: number
- remainingAccounts: AccountMeta[]
- fulfillmentConfig: SerumV3FulfillmentConfigAccount
Returns void
Inherited from DriftClient.addSerumRemainingAccounts
- Defined in sdk/src/driftClient.ts:3244

addSpotFulfillmentAccounts

addSpotFulfillmentAccounts(marketIndex: number, remainingAccounts: AccountMeta[], fulfillmentConfig?: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount): void
Parameters
- marketIndex: number
- remainingAccounts: AccountMeta[]
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount
Returns void
Inherited from DriftClient.addSpotFulfillmentAccounts
- Defined in sdk/src/driftClient.ts:3207

addSpotMarketToRemainingAccountMaps

addSpotMarketToRemainingAccountMaps(marketIndex: number, writable: boolean, oracleAccountMap: Map<string, AccountMeta>, spotMarketAccountMap: Map<number, AccountMeta>): void
Parameters
- marketIndex: number
- writable: boolean
- oracleAccountMap: Map<string, AccountMeta>
- spotMarketAccountMap: Map<number, AccountMeta>
Returns void
Inherited from DriftClient.addSpotMarketToRemainingAccountMaps
- Defined in sdk/src/driftClient.ts:1410

addUser

addUser(subAccountId: number, authority?: PublicKey, userAccount?: UserAccount): Promise<boolean>
Parameters
- subAccountId: number
- Optional authority: PublicKey
- Optional userAccount: UserAccount
Returns Promise<boolean>
Inherited from DriftClient.addUser
- Defined in sdk/src/driftClient.ts:592

buildTransaction

buildTransaction(instructions: TransactionInstruction | TransactionInstruction[], txParams?: TxParams, txVersion?: TransactionVersion, lookupTables?: AddressLookupTableAccount[]): Promise<Transaction | VersionedTransaction>
Parameters
- instructions: TransactionInstruction | TransactionInstruction[]
- Optional txParams: TxParams
- Optional txVersion: TransactionVersion
- Optional lookupTables: AddressLookupTableAccount[]
Returns Promise<Transaction | VersionedTransaction>
Inherited from DriftClient.buildTransaction
- Defined in sdk/src/driftClient.ts:5691

cancelAndPlaceOrders

cancelAndPlaceOrders(cancelOrderParams: {
    direction?: PositionDirection;
    marketIndex?: number;
    marketType?: MarketType;
}, placeOrderParams: OrderParams[], txParams?: TxParams): Promise<string>
Parameters
- cancelOrderParams: {
      direction?: PositionDirection;
      marketIndex?: number;
      marketType?: MarketType;
  }
  - Optional direction?: PositionDirection
  - Optional marketIndex?: number
  - Optional marketType?: MarketType
- placeOrderParams: OrderParams[]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.cancelAndPlaceOrders
- Defined in sdk/src/driftClient.ts:2856

cancelOrder

cancelOrder(orderId?: number, txParams?: TxParams): Promise<string>
Parameters
- Optional orderId: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.cancelOrder
- Defined in sdk/src/driftClient.ts:2691

cancelOrderByUserId

cancelOrderByUserId(userOrderId: number, txParams?: TxParams): Promise<string>
Parameters
- userOrderId: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.cancelOrderByUserId
- Defined in sdk/src/driftClient.ts:2726

cancelOrders

cancelOrders(marketType?: MarketType, marketIndex?: number, direction?: PositionDirection, txParams?: TxParams): Promise<string>
Parameters
- Optional marketType: MarketType
- Optional marketIndex: number
- Optional direction: PositionDirection
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.cancelOrders
- Defined in sdk/src/driftClient.ts:2800

cancelOrdersByIds

cancelOrdersByIds(orderIds?: number[], txParams?: TxParams): Promise<string>
Parameters
- Optional orderIds: number[]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.cancelOrdersByIds
- Defined in sdk/src/driftClient.ts:2765

cancelRequestRemoveInsuranceFundStake

cancelRequestRemoveInsuranceFundStake(marketIndex: number): Promise<string>
Parameters
- marketIndex: number
Returns Promise<string>
Inherited from DriftClient.cancelRequestRemoveInsuranceFundStake
- Defined in sdk/src/driftClient.ts:5399

closePosition

closePosition(marketIndex: number, limitPrice?: BN): Promise<string>
Deprecated
use placePerpOrder or placeAndTakePerpOrder instead
Parameters
- marketIndex: number
- Optional limitPrice: BN
Returns Promise<string>
Inherited from DriftClient.closePosition
- Defined in sdk/src/driftClient.ts:4257

convertToPerpPrecision

convertToPerpPrecision(amount: any): BN
Converts an amount to the perp precision. The perp market precision is BASE_PRECISION (1e9).
Parameters
- amount: any
Returns BN
Inherited from DriftClient.convertToPerpPrecision
- Defined in sdk/src/driftClient.ts:1226

convertToPricePrecision

convertToPricePrecision(amount: any): BN
Converts an amount to the price precision. The perp market precision is PRICE_PRECISION (1e6).
Parameters
- amount: any
Returns BN
Inherited from DriftClient.convertToPricePrecision
- Defined in sdk/src/driftClient.ts:1235

convertToSpotPrecision

convertToSpotPrecision(marketIndex: number, amount: any): BN
Converts an amount to the spot precision for a given market. The spot market precision is based on the token mint decimals.
Parameters
- marketIndex: number
- amount: any
Returns BN
Inherited from DriftClient.convertToSpotPrecision
- Defined in sdk/src/driftClient.ts:1217

createAssociatedTokenAccountIdempotentInstruction

createAssociatedTokenAccountIdempotentInstruction(account: PublicKey, payer: PublicKey, owner: PublicKey, mint: PublicKey): TransactionInstruction
Parameters
- account: PublicKey
- payer: PublicKey
- owner: PublicKey
- mint: PublicKey
Returns TransactionInstruction
Inherited from DriftClient.createAssociatedTokenAccountIdempotentInstruction
- Defined in sdk/src/driftClient.ts:1512

createUser

createUser(subAccountId: number, accountSubscriptionConfig: UserSubscriptionConfig, authority?: PublicKey): User
Parameters
- subAccountId: number
- accountSubscriptionConfig: UserSubscriptionConfig
- Optional authority: PublicKey
Returns User
Inherited from DriftClient.createUser
- Defined in sdk/src/driftClient.ts:292

deleteInitializedPerpMarket

deleteInitializedPerpMarket(marketIndex: number): Promise<string>
Parameters
- marketIndex: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:282

deleteUser

deleteUser(subAccountId?: number, txParams?: TxParams): Promise<string>
Parameters
- subAccountId: number = 0
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.deleteUser
- Defined in sdk/src/driftClient.ts:1055

deposit

deposit(amount: BN, marketIndex: number, associatedTokenAccount: PublicKey, subAccountId?: number, reduceOnly?: boolean): Promise<string>
Deposit funds into the given spot market
Parameters
- amount: BN
- marketIndex: number
- associatedTokenAccount: PublicKey
  
  can be the wallet public key if using native sol
- Optional subAccountId: number
- reduceOnly: boolean = false
Returns Promise<string>
Inherited from DriftClient.deposit
- Defined in sdk/src/driftClient.ts:1545

depositIntoPerpMarketFeePool

depositIntoPerpMarketFeePool(perpMarketIndex: number, amount: BN, sourceVault: PublicKey): Promise<string>
Parameters
- perpMarketIndex: number
- amount: BN
- sourceVault: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:483

depositIntoSpotMarketRevenuePool

depositIntoSpotMarketRevenuePool(marketIndex: number, amount: BN, userTokenAccountPublicKey: PublicKey): Promise<string>
Parameters
- marketIndex: number
- amount: BN
- userTokenAccountPublicKey: PublicKey
Returns Promise<string>
Inherited from DriftClient.depositIntoSpotMarketRevenuePool
- Defined in sdk/src/driftClient.ts:5587

fetchAccounts

fetchAccounts(): Promise<void>
Forces the accountSubscriber to fetch account updates from rpc

Returns Promise<void>
Inherited from DriftClient.fetchAccounts
- Defined in sdk/src/driftClient.ts:332

fetchAllUserAccounts

fetchAllUserAccounts(includeIdle?: boolean): Promise<ProgramAccount<UserAccount>[]>
Parameters
- includeIdle: boolean = true
Returns Promise<ProgramAccount<UserAccount>[]>
Inherited from DriftClient.fetchAllUserAccounts
- Defined in sdk/src/driftClient.ts:953

fetchMarketLookupTableAccount

fetchMarketLookupTableAccount(): Promise<AddressLookupTableAccount>
Returns Promise<AddressLookupTableAccount>
Inherited from DriftClient.fetchMarketLookupTableAccount
- Defined in sdk/src/driftClient.ts:483

fetchReferrerNameAccount

fetchReferrerNameAccount(name: string): Promise<ReferrerNameAccount>
Parameters
- name: string
Returns Promise<ReferrerNameAccount>
Inherited from DriftClient.fetchReferrerNameAccount
- Defined in sdk/src/driftClient.ts:1124

fillPerpOrder

fillPerpOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Pick<Order, "orderId" | "marketIndex">, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- Optional order: Pick<Order, "orderId" | "marketIndex">
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.fillPerpOrder
- Defined in sdk/src/driftClient.ts:2929

fillSpotOrder

fillSpotOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Order, fulfillmentConfig?: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- Optional order: Order
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount
- Optional makerInfo: MakerInfo
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.fillSpotOrder
- Defined in sdk/src/driftClient.ts:3092

forceCancelOrders

forceCancelOrders(userAccountPublicKey: PublicKey, user: UserAccount, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.forceCancelOrders
- Defined in sdk/src/driftClient.ts:3798

forceGetPerpMarketAccount

forceGetPerpMarketAccount(marketIndex: number): Promise<PerpMarketAccount>
Forces a fetch to rpc before returning accounts. Useful for anchor tests.
Parameters
- marketIndex: number
Returns Promise<PerpMarketAccount>
Inherited from DriftClient.forceGetPerpMarketAccount
- Defined in sdk/src/driftClient.ts:401

forceGetSpotMarketAccount

forceGetSpotMarketAccount(marketIndex: number): Promise<SpotMarketAccount>
Forces a fetch to rpc before returning accounts. Useful for anchor tests.
Parameters
- marketIndex: number
Returns Promise<SpotMarketAccount>
Inherited from DriftClient.forceGetSpotMarketAccount
- Defined in sdk/src/driftClient.ts:433

forceGetStateAccount

forceGetStateAccount(): Promise<StateAccount>
Forces a fetch to rpc before returning accounts. Useful for anchor tests.

Returns Promise<StateAccount>
Inherited from DriftClient.forceGetStateAccount
- Defined in sdk/src/driftClient.ts:386

forceGetUserAccount

forceGetUserAccount(subAccountId?: number): Promise<UserAccount>
Forces a fetch to rpc before returning accounts. Useful for anchor tests.
Parameters
- Optional subAccountId: number
Returns Promise<UserAccount>
Inherited from DriftClient.forceGetUserAccount
- Defined in sdk/src/driftClient.ts:1168

getAddInsuranceFundStakeIx

getAddInsuranceFundStakeIx(marketIndex: number, amount: BN, collateralAccountPublicKey: PublicKey): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- amount: BN
- collateralAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getAddInsuranceFundStakeIx
- Defined in sdk/src/driftClient.ts:5226

getAddPerpLpSharesIx

getAddPerpLpSharesIx(amount: BN, marketIndex: number): Promise<TransactionInstruction>
Parameters
- amount: BN
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getAddPerpLpSharesIx
- Defined in sdk/src/driftClient.ts:2324

getAssociatedTokenAccount

getAssociatedTokenAccount(marketIndex: number, useNative?: boolean): Promise<PublicKey>
Get the associated token address for the given spot market
Parameters
- marketIndex: number
- useNative: boolean = true
Returns Promise<PublicKey>
Inherited from DriftClient.getAssociatedTokenAccount
- Defined in sdk/src/driftClient.ts:1500

getAssociatedTokenAccountCreationIx

getAssociatedTokenAccountCreationIx(tokenMintAddress: PublicKey, associatedTokenAddress: PublicKey): TransactionInstruction
Parameters
- tokenMintAddress: PublicKey
- associatedTokenAddress: PublicKey
Returns TransactionInstruction
Inherited from DriftClient.getAssociatedTokenAccountCreationIx
- Defined in sdk/src/driftClient.ts:1731

getCancelOrderByUserIdIx

getCancelOrderByUserIdIx(userOrderId: number): Promise<TransactionInstruction>
Parameters
- userOrderId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getCancelOrderByUserIdIx
- Defined in sdk/src/driftClient.ts:2741

getCancelOrderIx

getCancelOrderIx(orderId?: number): Promise<TransactionInstruction>
Parameters
- Optional orderId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getCancelOrderIx
- Defined in sdk/src/driftClient.ts:2706

getCancelOrdersByIdsIx

getCancelOrdersByIdsIx(orderIds?: number[]): Promise<TransactionInstruction>
Parameters
- Optional orderIds: number[]
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getCancelOrdersByIdsIx
- Defined in sdk/src/driftClient.ts:2780

getCancelOrdersIx

getCancelOrdersIx(marketType: MarketType, marketIndex: number, direction: PositionDirection): Promise<TransactionInstruction>
Parameters
- marketType: MarketType
- marketIndex: number
- direction: PositionDirection
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getCancelOrdersIx
- Defined in sdk/src/driftClient.ts:2817

getDepositInstruction

getDepositInstruction(amount: BN, marketIndex: number, userTokenAccount: PublicKey, subAccountId?: number, reduceOnly?: boolean, userInitialized?: boolean): Promise<TransactionInstruction>
Parameters
- amount: BN
- marketIndex: number
- userTokenAccount: PublicKey
- Optional subAccountId: number
- reduceOnly: boolean = false
- userInitialized: boolean = true
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getDepositInstruction
- Defined in sdk/src/driftClient.ts:1615

getFillPerpOrderIx

getFillPerpOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Pick<Order, "orderId" | "marketIndex">, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- order: Pick<Order, "orderId" | "marketIndex">
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getFillPerpOrderIx
- Defined in sdk/src/driftClient.ts:2954

getFillSpotOrderIx

getFillSpotOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order?: Order, fulfillmentConfig?: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- Optional order: Order
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount
- Optional makerInfo: MakerInfo
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getFillSpotOrderIx
- Defined in sdk/src/driftClient.ts:3121

getForceCancelOrdersIx

getForceCancelOrdersIx(userAccountPublicKey: PublicKey, userAccount: UserAccount): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getForceCancelOrdersIx
- Defined in sdk/src/driftClient.ts:3814

getInitializeInsuranceFundStakeIx

getInitializeInsuranceFundStakeIx(marketIndex: number): Promise<TransactionInstruction>
Parameters
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getInitializeInsuranceFundStakeIx
- Defined in sdk/src/driftClient.ts:5200

getInitializeUserInstructions

getInitializeUserInstructions(subAccountId?: number, name?: string, referrerInfo?: ReferrerInfo): Promise<[PublicKey, TransactionInstruction]>
Parameters
- subAccountId: number = 0
- name: string = DEFAULT_USER_NAME
- Optional referrerInfo: ReferrerInfo
Returns Promise<[PublicKey, TransactionInstruction]>
Inherited from DriftClient.getInitializeUserInstructions
- Defined in sdk/src/driftClient.ts:705

getInitializeUserStatsIx

getInitializeUserStatsIx(): Promise<TransactionInstruction>
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getInitializeUserStatsIx
- Defined in sdk/src/driftClient.ts:761

getJupiterSwapIx

getJupiterSwapIx(__namedParameters: {
    amount: BN;
    inAssociatedTokenAccount?: PublicKey;
    inMarketIndex: number;
    jupiterClient: JupiterClient;
    onlyDirectRoutes?: boolean;
    outAssociatedTokenAccount?: PublicKey;
    outMarketIndex: number;
    reduceOnly?: SwapReduceOnly;
    route?: Route;
    slippageBps?: number;
    swapMode?: SwapMode;
    userAccountPublicKey?: PublicKey;
}): Promise<{
    ixs: TransactionInstruction[];
    lookupTables: AddressLookupTableAccount[];
}>
Parameters
- __namedParameters: {
      amount: BN;
      inAssociatedTokenAccount?: PublicKey;
      inMarketIndex: number;
      jupiterClient: JupiterClient;
      onlyDirectRoutes?: boolean;
      outAssociatedTokenAccount?: PublicKey;
      outMarketIndex: number;
      reduceOnly?: SwapReduceOnly;
      route?: Route;
      slippageBps?: number;
      swapMode?: SwapMode;
      userAccountPublicKey?: PublicKey;
  }
  - amount: BN
  - Optional inAssociatedTokenAccount?: PublicKey
  - inMarketIndex: number
  - jupiterClient: JupiterClient
  - Optional onlyDirectRoutes?: boolean
  - Optional outAssociatedTokenAccount?: PublicKey
  - outMarketIndex: number
  - Optional reduceOnly?: SwapReduceOnly
  - Optional route?: Route
  - Optional slippageBps?: number
  - Optional swapMode?: SwapMode
  - Optional userAccountPublicKey?: PublicKey
Returns Promise<{
ixs: TransactionInstruction[];
lookupTables: AddressLookupTableAccount[];
}>
Inherited from DriftClient.getJupiterSwapIx
- Defined in sdk/src/driftClient.ts:3458

getLiquidateBorrowForPerpPnlIx

getLiquidateBorrowForPerpPnlIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: number, liabilityMarketIndex: number, maxLiabilityTransfer: BN, limitPrice?: BN): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- perpMarketIndex: number
- liabilityMarketIndex: number
- maxLiabilityTransfer: BN
- Optional limitPrice: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getLiquidateBorrowForPerpPnlIx
- Defined in sdk/src/driftClient.ts:4811

getLiquidatePerpIx

getLiquidatePerpIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, maxBaseAssetAmount: BN, limitPrice?: BN): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- maxBaseAssetAmount: BN
- Optional limitPrice: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getLiquidatePerpIx
- Defined in sdk/src/driftClient.ts:4673

getLiquidatePerpPnlForDepositIx

getLiquidatePerpPnlForDepositIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: number, assetMarketIndex: number, maxPnlTransfer: BN, limitPrice?: BN): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- perpMarketIndex: number
- assetMarketIndex: number
- maxPnlTransfer: BN
- Optional limitPrice: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getLiquidatePerpPnlForDepositIx
- Defined in sdk/src/driftClient.ts:4881

getLiquidateSpotIx

getLiquidateSpotIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, assetMarketIndex: number, liabilityMarketIndex: number, maxLiabilityTransfer: BN, limitPrice?: BN): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- assetMarketIndex: number
- liabilityMarketIndex: number
- maxLiabilityTransfer: BN
- Optional limitPrice: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getLiquidateSpotIx
- Defined in sdk/src/driftClient.ts:4741

getMarketIndexAndType

getMarketIndexAndType(name: string): {
marketIndex: number;
marketType: MarketType;
}
Returns the market index and type for a given market name E.g. "SOL-PERP" -> { marketIndex: 0, marketType: MarketType.PERP }
Parameters
- name: string
Returns {
marketIndex: number;
marketType: MarketType;
}
- marketIndex: number
- marketType: MarketType
Inherited from DriftClient.getMarketIndexAndType
- Defined in sdk/src/driftClient.ts:5642

getModifyOrderByUserIdIx

getModifyOrderByUserIdIx(__namedParameters: {
    auctionDuration?: number;
    auctionEndPrice?: BN;
    auctionStartPrice?: BN;
    immediateOrCancel?: boolean;
    maxTs?: BN;
    newBaseAmount?: BN;
    newDirection?: PositionDirection;
    newLimitPrice?: BN;
    newOraclePriceOffset?: number;
    newTriggerCondition?: OrderTriggerCondition;
    newTriggerPrice?: BN;
    policy?: ModifyOrderPolicy;
    postOnly?: boolean;
    reduceOnly?: boolean;
    txParams?: TxParams;
    userOrderId: number;
}): Promise<TransactionInstruction>
Parameters
- __namedParameters: {
      auctionDuration?: number;
      auctionEndPrice?: BN;
      auctionStartPrice?: BN;
      immediateOrCancel?: boolean;
      maxTs?: BN;
      newBaseAmount?: BN;
      newDirection?: PositionDirection;
      newLimitPrice?: BN;
      newOraclePriceOffset?: number;
      newTriggerCondition?: OrderTriggerCondition;
      newTriggerPrice?: BN;
      policy?: ModifyOrderPolicy;
      postOnly?: boolean;
      reduceOnly?: boolean;
      txParams?: TxParams;
      userOrderId: number;
  }
  - Optional auctionDuration?: number
  - Optional auctionEndPrice?: BN
  - Optional auctionStartPrice?: BN
  - Optional immediateOrCancel?: boolean
  - Optional maxTs?: BN
  - Optional newBaseAmount?: BN
  - Optional newDirection?: PositionDirection
  - Optional newLimitPrice?: BN
  - Optional newOraclePriceOffset?: number
  - Optional newTriggerCondition?: OrderTriggerCondition
  - Optional newTriggerPrice?: BN
  - Optional policy?: ModifyOrderPolicy
  - Optional postOnly?: boolean
  - Optional reduceOnly?: boolean
  - Optional txParams?: TxParams
  - userOrderId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getModifyOrderByUserIdIx
- Defined in sdk/src/driftClient.ts:4488

getModifyOrderIx

getModifyOrderIx(__namedParameters: {
    auctionDuration?: number;
    auctionEndPrice?: BN;
    auctionStartPrice?: BN;
    immediateOrCancel?: boolean;
    maxTs?: BN;
    newBaseAmount?: BN;
    newDirection?: PositionDirection;
    newLimitPrice?: BN;
    newOraclePriceOffset?: number;
    newTriggerCondition?: OrderTriggerCondition;
    newTriggerPrice?: BN;
    orderId: number;
    policy?: ModifyOrderPolicy;
    postOnly?: boolean;
    reduceOnly?: boolean;
}): Promise<TransactionInstruction>
Parameters
- __namedParameters: {
      auctionDuration?: number;
      auctionEndPrice?: BN;
      auctionStartPrice?: BN;
      immediateOrCancel?: boolean;
      maxTs?: BN;
      newBaseAmount?: BN;
      newDirection?: PositionDirection;
      newLimitPrice?: BN;
      newOraclePriceOffset?: number;
      newTriggerCondition?: OrderTriggerCondition;
      newTriggerPrice?: BN;
      orderId: number;
      policy?: ModifyOrderPolicy;
      postOnly?: boolean;
      reduceOnly?: boolean;
  }
  - Optional auctionDuration?: number
  - Optional auctionEndPrice?: BN
  - Optional auctionStartPrice?: BN
  - Optional immediateOrCancel?: boolean
  - Optional maxTs?: BN
  - Optional newBaseAmount?: BN
  - Optional newDirection?: PositionDirection
  - Optional newLimitPrice?: BN
  - Optional newOraclePriceOffset?: number
  - Optional newTriggerCondition?: OrderTriggerCondition
  - Optional newTriggerPrice?: BN
  - orderId: number
  - Optional policy?: ModifyOrderPolicy
  - Optional postOnly?: boolean
  - Optional reduceOnly?: boolean
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getModifyOrderIx
- Defined in sdk/src/driftClient.ts:4371

getNextSubAccountId

getNextSubAccountId(): Promise<number>
Returns Promise<number>
Inherited from DriftClient.getNextSubAccountId
- Defined in sdk/src/driftClient.ts:774

getOracleDataForPerpMarket

getOracleDataForPerpMarket(marketIndex: number): OraclePriceData
Parameters
- marketIndex: number
Returns OraclePriceData
Inherited from DriftClient.getOracleDataForPerpMarket
- Defined in sdk/src/driftClient.ts:5171

getOracleDataForSpotMarket

getOracleDataForSpotMarket(marketIndex: number): OraclePriceData
Parameters
- marketIndex: number
Returns OraclePriceData
Inherited from DriftClient.getOracleDataForSpotMarket
- Defined in sdk/src/driftClient.ts:5178

getOraclePriceDataAndSlot

getOraclePriceDataAndSlot(oraclePublicKey: PublicKey): DataAndSlot<OraclePriceData>
Parameters
- oraclePublicKey: PublicKey
Returns DataAndSlot<OraclePriceData>
Inherited from DriftClient.getOraclePriceDataAndSlot
- Defined in sdk/src/driftClient.ts:453

getOrder

getOrder(orderId: number): Order
Parameters
- orderId: number
Returns Order
Inherited from DriftClient.getOrder
- Defined in sdk/src/driftClient.ts:1483

getOrderByUserId

getOrderByUserId(userOrderId: number): Order
Parameters
- userOrderId: number
Returns Order
Inherited from DriftClient.getOrderByUserId
- Defined in sdk/src/driftClient.ts:1489

getPerpMarketAccount

getPerpMarketAccount(marketIndex: number): PerpMarketAccount
Parameters
- marketIndex: number
Returns PerpMarketAccount
Inherited from DriftClient.getPerpMarketAccount
- Defined in sdk/src/driftClient.ts:391

getPerpMarketAccounts

getPerpMarketAccounts(): PerpMarketAccount[]
Returns PerpMarketAccount[]
Inherited from DriftClient.getPerpMarketAccounts
- Defined in sdk/src/driftClient.ts:416

getPerpMarketExtendedInfo

getPerpMarketExtendedInfo(marketIndex: number): PerpMarketExtendedInfo
Parameters
- marketIndex: number
Returns PerpMarketExtendedInfo
Inherited from DriftClient.getPerpMarketExtendedInfo
- Defined in sdk/src/driftClient.ts:5611

getPhoenixV1FulfillmentConfig

getPhoenixV1FulfillmentConfig(phoenixMarket: PublicKey): Promise<PhoenixV1FulfillmentConfigAccount>
Parameters
- phoenixMarket: PublicKey
Returns Promise<PhoenixV1FulfillmentConfigAccount>
Inherited from DriftClient.getPhoenixV1FulfillmentConfig
- Defined in sdk/src/driftClient.ts:471

getPlaceAndMakePerpOrderIx

getPlaceAndMakePerpOrderIx(orderParams: OptionalOrderParams, takerInfo: TakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- takerInfo: TakerInfo
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceAndMakePerpOrderIx
- Defined in sdk/src/driftClient.ts:4028

getPlaceAndMakeSpotOrderIx

getPlaceAndMakeSpotOrderIx(orderParams: OptionalOrderParams, takerInfo: TakerInfo, fulfillmentConfig?: SerumV3FulfillmentConfigAccount, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- takerInfo: TakerInfo
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceAndMakeSpotOrderIx
- Defined in sdk/src/driftClient.ts:4197

getPlaceAndTakePerpOrderIx

getPlaceAndTakePerpOrderIx(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceAndTakePerpOrderIx
- Defined in sdk/src/driftClient.ts:3932

getPlaceAndTakeSpotOrderIx

getPlaceAndTakeSpotOrderIx(orderParams: OptionalOrderParams, fulfillmentConfig?: SerumV3FulfillmentConfigAccount, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount
- Optional makerInfo: MakerInfo
- Optional referrerInfo: ReferrerInfo
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceAndTakeSpotOrderIx
- Defined in sdk/src/driftClient.ts:4099

getPlaceOrdersIx

getPlaceOrdersIx(params: OrderParams[]): Promise<TransactionInstruction>
Parameters
- params: OrderParams[]
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceOrdersIx
- Defined in sdk/src/driftClient.ts:2893

getPlacePerpOrderIx

getPlacePerpOrderIx(orderParams: OptionalOrderParams): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlacePerpOrderIx
- Defined in sdk/src/driftClient.ts:2534

getPlaceSpotOrderIx

getPlaceSpotOrderIx(orderParams: OptionalOrderParams): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceSpotOrderIx
- Defined in sdk/src/driftClient.ts:3066

getQuoteAssetTokenAmount

getQuoteAssetTokenAmount(): BN
Returns BN
Inherited from DriftClient.getQuoteAssetTokenAmount
- Defined in sdk/src/driftClient.ts:1187

getQuoteSpotMarketAccount

getQuoteSpotMarketAccount(): SpotMarketAccount
Returns SpotMarketAccount
Inherited from DriftClient.getQuoteSpotMarketAccount
- Defined in sdk/src/driftClient.ts:447

getQuoteValuePerLpShare

getQuoteValuePerLpShare(marketIndex: number): BN
Parameters
- marketIndex: number
Returns BN
Inherited from DriftClient.getQuoteValuePerLpShare
- Defined in sdk/src/driftClient.ts:2345

getReferredUserStatsAccountsByReferrer

getReferredUserStatsAccountsByReferrer(referrer: PublicKey): Promise<UserStatsAccount[]>
Parameters
- referrer: PublicKey
Returns Promise<UserStatsAccount[]>
Inherited from DriftClient.getReferredUserStatsAccountsByReferrer
- Defined in sdk/src/driftClient.ts:1019

getReferrerNameAccountsForAuthority

getReferrerNameAccountsForAuthority(authority: PublicKey): Promise<ReferrerNameAccount[]>
Parameters
- authority: PublicKey
Returns Promise<ReferrerNameAccount[]>
Inherited from DriftClient.getReferrerNameAccountsForAuthority
- Defined in sdk/src/driftClient.ts:1037

getRemainingAccountMapsForUsers

getRemainingAccountMapsForUsers(userAccounts: UserAccount[]): {
    oracleAccountMap: Map<string, AccountMeta>;
    perpMarketAccountMap: Map<number, AccountMeta>;
    spotMarketAccountMap: Map<number, AccountMeta>;
}
Parameters
- userAccounts: UserAccount[]
Returns {
    oracleAccountMap: Map<string, AccountMeta>;
    perpMarketAccountMap: Map<number, AccountMeta>;
    spotMarketAccountMap: Map<number, AccountMeta>;
}
- oracleAccountMap: Map<string, AccountMeta>
- perpMarketAccountMap: Map<number, AccountMeta>
- spotMarketAccountMap: Map<number, AccountMeta>
Inherited from DriftClient.getRemainingAccountMapsForUsers
- Defined in sdk/src/driftClient.ts:1431

getRemainingAccounts

getRemainingAccounts(params: RemainingAccountParams): AccountMeta[]
Parameters
- params: RemainingAccountParams
Returns AccountMeta[]
Inherited from DriftClient.getRemainingAccounts
- Defined in sdk/src/driftClient.ts:1263

getRemovePerpLpSharesInExpiringMarket

getRemovePerpLpSharesInExpiringMarket(marketIndex: number, userAccountPublicKey: PublicKey, sharesToBurn?: BN): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- userAccountPublicKey: PublicKey
- Optional sharesToBurn: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getRemovePerpLpSharesInExpiringMarket
- Defined in sdk/src/driftClient.ts:2236

getRemovePerpLpSharesIx

getRemovePerpLpSharesIx(marketIndex: number, sharesToBurn?: BN): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- Optional sharesToBurn: BN
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getRemovePerpLpSharesIx
- Defined in sdk/src/driftClient.ts:2272

getResolvePerpBankruptcyIx

getResolvePerpBankruptcyIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getResolvePerpBankruptcyIx
- Defined in sdk/src/driftClient.ts:4943

getResolvePerpPnlDeficitIx

getResolvePerpPnlDeficitIx(spotMarketIndex: number, perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getResolvePerpPnlDeficitIx
- Defined in sdk/src/driftClient.ts:5557

getResolveSpotBankruptcyIx

getResolveSpotBankruptcyIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getResolveSpotBankruptcyIx
- Defined in sdk/src/driftClient.ts:5006

getRevertFillIx

getRevertFillIx(): Promise<TransactionInstruction>
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getRevertFillIx
- Defined in sdk/src/driftClient.ts:3035

getSerumV3FulfillmentConfig

getSerumV3FulfillmentConfig(serumMarket: PublicKey): Promise<SerumV3FulfillmentConfigAccount>
Parameters
- serumMarket: PublicKey
Returns Promise<SerumV3FulfillmentConfigAccount>
Inherited from DriftClient.getSerumV3FulfillmentConfig
- Defined in sdk/src/driftClient.ts:459

getSettleExpiredMarketIx

getSettleExpiredMarketIx(marketIndex: number): Promise<TransactionInstruction>
Parameters
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getSettleExpiredMarketIx
- Defined in sdk/src/driftClient.ts:2621

getSettleFundingPaymentIx

getSettleFundingPaymentIx(userAccountPublicKey: PublicKey): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getSettleFundingPaymentIx
- Defined in sdk/src/driftClient.ts:5139

getSettlePNLsIxs

getSettlePNLsIxs(users: {
settleeUserAccount: UserAccount;
settleeUserAccountPublicKey: PublicKey;
}[], marketIndexes: number[]): Promise<TransactionInstruction[]>
Parameters
- users: {
  settleeUserAccount: UserAccount;
  settleeUserAccountPublicKey: PublicKey;
  }[]
- marketIndexes: number[]
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getSettlePNLsIxs
- Defined in sdk/src/driftClient.ts:4581

getSignerPublicKey

getSignerPublicKey(): PublicKey
Returns PublicKey
Inherited from DriftClient.getSignerPublicKey
- Defined in sdk/src/driftClient.ts:371

getSpotMarketAccount

getSpotMarketAccount(marketIndex: number): SpotMarketAccount
Parameters
- marketIndex: number
Returns SpotMarketAccount
Inherited from DriftClient.getSpotMarketAccount
- Defined in sdk/src/driftClient.ts:423

getSpotMarketAccounts

getSpotMarketAccounts(): SpotMarketAccount[]
Returns SpotMarketAccount[]
Inherited from DriftClient.getSpotMarketAccounts
- Defined in sdk/src/driftClient.ts:440

getSpotPosition

getSpotPosition(marketIndex: number): SpotPosition
Parameters
- marketIndex: number
Returns SpotPosition
Inherited from DriftClient.getSpotPosition
- Defined in sdk/src/driftClient.ts:1181

getStakeForMSOLIx

getStakeForMSOLIx(__namedParameters: {
amount: BN;
userAccountPublicKey?: PublicKey;
}): Promise<TransactionInstruction[]>
Parameters
- __namedParameters: {
  amount: BN;
  userAccountPublicKey?: PublicKey;
  }
  - amount: BN
  - Optional userAccountPublicKey?: PublicKey
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getStakeForMSOLIx
- Defined in sdk/src/driftClient.ts:3691

getStateAccount

getStateAccount(): StateAccount
Returns StateAccount
Inherited from DriftClient.getStateAccount
- Defined in sdk/src/driftClient.ts:379

getStatePublicKey

getStatePublicKey(): Promise<PublicKey>
Returns Promise<PublicKey>
Inherited from DriftClient.getStatePublicKey
- Defined in sdk/src/driftClient.ts:360

getSwapIx

getSwapIx(__namedParameters: {
    amountIn: BN;
    inMarketIndex: number;
    inTokenAccount: PublicKey;
    limitPrice?: BN;
    outMarketIndex: number;
    outTokenAccount: PublicKey;
    reduceOnly?: SwapReduceOnly;
    userAccountPublicKey?: PublicKey;
}): Promise<{
    beginSwapIx: TransactionInstruction;
    endSwapIx: TransactionInstruction;
}>
Get the drift begin_swap and end_swap instructions
Parameters
- __namedParameters: {
      amountIn: BN;
      inMarketIndex: number;
      inTokenAccount: PublicKey;
      limitPrice?: BN;
      outMarketIndex: number;
      outTokenAccount: PublicKey;
      reduceOnly?: SwapReduceOnly;
      userAccountPublicKey?: PublicKey;
  }
  - amountIn: BN
  - inMarketIndex: number
  - inTokenAccount: PublicKey
  - Optional limitPrice?: BN
  - outMarketIndex: number
  - outTokenAccount: PublicKey
  - Optional reduceOnly?: SwapReduceOnly
  - Optional userAccountPublicKey?: PublicKey
Returns Promise<{
beginSwapIx: TransactionInstruction;
endSwapIx: TransactionInstruction;
}>
Inherited from DriftClient.getSwapIx
- Defined in sdk/src/driftClient.ts:3600

getTokenAmount

getTokenAmount(marketIndex: number): BN
Returns the token amount for a given market. The spot market precision is based on the token mint decimals. Positive if it is a deposit, negative if it is a borrow.
Parameters
- marketIndex: number
Returns BN
Inherited from DriftClient.getTokenAmount
- Defined in sdk/src/driftClient.ts:1196

getTransferDepositIx

getTransferDepositIx(amount: BN, marketIndex: number, fromSubAccountId: number, toSubAccountId: number): Promise<TransactionInstruction>
Parameters
- amount: BN
- marketIndex: number
- fromSubAccountId: number
- toSubAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getTransferDepositIx
- Defined in sdk/src/driftClient.ts:2073

getTriggerOrderIx

getTriggerOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- order: Order
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getTriggerOrderIx
- Defined in sdk/src/driftClient.ts:3762

getUpdateAMMsIx

getUpdateAMMsIx(marketIndexes: number[]): Promise<TransactionInstruction>
Parameters
- marketIndexes: number[]
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateAMMsIx
- Defined in sdk/src/driftClient.ts:2572

getUpdateFundingRateIx

getUpdateFundingRateIx(perpMarketIndex: number, oracle: PublicKey): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- oracle: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateFundingRateIx
- Defined in sdk/src/driftClient.ts:5059

getUpdatePerpBidAskTwapIx

getUpdatePerpBidAskTwapIx(perpMarketIndex: number, makers: [PublicKey, PublicKey][]): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- makers: [PublicKey, PublicKey][]
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdatePerpBidAskTwapIx
- Defined in sdk/src/driftClient.ts:5092

getUpdateUserIdleIx

getUpdateUserIdleIx(userAccountPublicKey: PublicKey, userAccount: UserAccount): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserIdleIx
- Defined in sdk/src/driftClient.ts:3852

getUpdateUserMarginTradingEnabledIx

getUpdateUserMarginTradingEnabledIx(marginTradingEnabled: boolean, subAccountId?: number, userAccountPublicKey?: PublicKey): Promise<TransactionInstruction>
Parameters
- marginTradingEnabled: boolean
- subAccountId: number = 0
- Optional userAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserMarginTradingEnabledIx
- Defined in sdk/src/driftClient.ts:866

getUpdateUserOpenOrdersCountIx

getUpdateUserOpenOrdersCountIx(userAccountPublicKey: PublicKey, userAccount: UserAccount): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserOpenOrdersCountIx
- Defined in sdk/src/driftClient.ts:3889

getUser

getUser(subAccountId?: number, authority?: PublicKey): User
Parameters
- Optional subAccountId: number
- Optional authority: PublicKey
Returns User
Inherited from DriftClient.getUser
- Defined in sdk/src/driftClient.ts:1087

getUserAccount

getUserAccount(subAccountId?: number, authority?: PublicKey): UserAccount
Parameters
- Optional subAccountId: number
- Optional authority: PublicKey
Returns UserAccount
Inherited from DriftClient.getUserAccount
- Defined in sdk/src/driftClient.ts:1157

getUserAccountAndSlot

getUserAccountAndSlot(subAccountId?: number): DataAndSlot<UserAccount>
Parameters
- Optional subAccountId: number
Returns DataAndSlot<UserAccount>
Inherited from DriftClient.getUserAccountAndSlot
- Defined in sdk/src/driftClient.ts:1175

getUserAccountPublicKey

getUserAccountPublicKey(subAccountId?: number, authority?: PublicKey): Promise<PublicKey>
Parameters
- Optional subAccountId: number
- Optional authority: PublicKey
Returns Promise<PublicKey>
Inherited from DriftClient.getUserAccountPublicKey
- Defined in sdk/src/driftClient.ts:1150

getUserAccountsAndAddressesForAuthority

getUserAccountsAndAddressesForAuthority(authority: PublicKey): Promise<ProgramAccount<UserAccount>[]>
Parameters
- authority: PublicKey
Returns Promise<ProgramAccount<UserAccount>[]>
Inherited from DriftClient.getUserAccountsAndAddressesForAuthority
- Defined in sdk/src/driftClient.ts:983

getUserAccountsForAuthority

getUserAccountsForAuthority(authority: PublicKey): Promise<UserAccount[]>
Parameters
- authority: PublicKey
Returns Promise<UserAccount[]>
Inherited from DriftClient.getUserAccountsForAuthority
- Defined in sdk/src/driftClient.ts:1001

getUserAccountsForDelegate

getUserAccountsForDelegate(delegate: PublicKey): Promise<UserAccount[]>
Parameters
- delegate: PublicKey
Returns Promise<UserAccount[]>
Inherited from DriftClient.getUserAccountsForDelegate
- Defined in sdk/src/driftClient.ts:965

getUserMapKey

getUserMapKey(subAccountId: number, authority: PublicKey): string
Parameters
- subAccountId: number
- authority: PublicKey
Returns string
Inherited from DriftClient.getUserMapKey
- Defined in sdk/src/driftClient.ts:288

getUserStats

getUserStats(): UserStats
Returns UserStats
Inherited from DriftClient.getUserStats
- Defined in sdk/src/driftClient.ts:1120

getUserStatsAccountPublicKey

getUserStatsAccountPublicKey(): PublicKey
Returns PublicKey
Inherited from DriftClient.getUserStatsAccountPublicKey
- Defined in sdk/src/driftClient.ts:1138

getUsers

getUsers(): User[]
Returns User[]
Inherited from DriftClient.getUsers
- Defined in sdk/src/driftClient.ts:1106

getWithdrawIx

getWithdrawIx(amount: BN, marketIndex: number, userTokenAccount: PublicKey, reduceOnly?: boolean): Promise<TransactionInstruction>
Parameters
- amount: BN
- marketIndex: number
- userTokenAccount: PublicKey
- reduceOnly: boolean = false
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getWithdrawIx
- Defined in sdk/src/driftClient.ts:1998

getWrappedSolAccountCreationIxs

getWrappedSolAccountCreationIxs(amount: BN, includeRent?: boolean): Promise<{
    ixs: TransactionInstruction[];
    pubkey: PublicKey;
    signers: Signer[];
}>
Parameters
- amount: BN
- Optional includeRent: boolean
Returns Promise<{
    ixs: TransactionInstruction[];
    pubkey: PublicKey;
    signers: Signer[];
}>
Inherited from DriftClient.getWrappedSolAccountCreationIxs
- Defined in sdk/src/driftClient.ts:1675

hasUser

hasUser(subAccountId?: number, authority?: PublicKey): boolean
Parameters
- Optional subAccountId: number
- Optional authority: PublicKey
Returns boolean
Inherited from DriftClient.hasUser
- Defined in sdk/src/driftClient.ts:1098

initialize

initialize(usdcMint: PublicKey, _adminControlsPrices: boolean): Promise<[string]>
Parameters
- usdcMint: PublicKey
- _adminControlsPrices: boolean
Returns Promise<[string]>
- Defined in sdk/src/adminClient.ts:38

initializeInsuranceFundStake

initializeInsuranceFundStake(marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.initializeInsuranceFundStake
- Defined in sdk/src/driftClient.ts:5185

initializePerpMarket

initializePerpMarket(marketIndex: number, priceOracle: PublicKey, baseAssetReserve: BN, quoteAssetReserve: BN, periodicity: BN, pegMultiplier?: BN, oracleSource?: OracleSource, marginRatioInitial?: number, marginRatioMaintenance?: number, liquidatorFee?: number, activeStatus?: boolean, name?: string): Promise<string>
Parameters
- marketIndex: number
- priceOracle: PublicKey
- baseAssetReserve: BN
- quoteAssetReserve: BN
- periodicity: BN
- pegMultiplier: BN = PEG_PRECISION
- oracleSource: OracleSource = OracleSource.PYTH
- marginRatioInitial: number = 2000
- marginRatioMaintenance: number = 500
- liquidatorFee: number = 0
- activeStatus: boolean = true
- name: string = DEFAULT_MARKET_NAME
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:218

initializePhoenixFulfillmentConfig

initializePhoenixFulfillmentConfig(marketIndex: number, phoenixMarket: PublicKey): Promise<string>
Parameters
- marketIndex: number
- phoenixMarket: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:186

initializeReferrerName

initializeReferrerName(name: string): Promise<string>
Parameters
- name: string
Returns Promise<string>
Inherited from DriftClient.initializeReferrerName
- Defined in sdk/src/driftClient.ts:789

initializeSerumFulfillmentConfig

initializeSerumFulfillmentConfig(marketIndex: number, serumMarket: PublicKey, serumProgram: PublicKey): Promise<string>
Parameters
- marketIndex: number
- serumMarket: PublicKey
- serumProgram: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:148

initializeSpotMarket

initializeSpotMarket(mint: PublicKey, optimalUtilization: number, optimalRate: number, maxRate: number, oracle: PublicKey, oracleSource: OracleSource, initialAssetWeight: number, maintenanceAssetWeight: number, initialLiabilityWeight: number, maintenanceLiabilityWeight: number, imfFactor?: number, liquidatorFee?: number, activeStatus?: boolean, name?: string): Promise<string>
Parameters
- mint: PublicKey
- optimalUtilization: number
- optimalRate: number
- maxRate: number
- oracle: PublicKey
- oracleSource: OracleSource
- initialAssetWeight: number
- maintenanceAssetWeight: number
- initialLiabilityWeight: number
- maintenanceLiabilityWeight: number
- imfFactor: number = 0
- liquidatorFee: number = 0
- activeStatus: boolean = true
- name: string = DEFAULT_MARKET_NAME
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:74

initializeUserAccount

initializeUserAccount(subAccountId?: number, name?: string, referrerInfo?: ReferrerInfo): Promise<[string, PublicKey]>
Parameters
- subAccountId: number = 0
- name: string = DEFAULT_USER_NAME
- Optional referrerInfo: ReferrerInfo
Returns Promise<[string, PublicKey]>
Inherited from DriftClient.initializeUserAccount
- Defined in sdk/src/driftClient.ts:677

initializeUserAccountAndDepositCollateral

initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<[string, PublicKey]>
Creates the User account for a user, and deposits some initial collateral

Returns
Parameters
- amount: BN
- userTokenAccount: PublicKey
- marketIndex: number = 0
- subAccountId: number = 0
- name: string = DEFAULT_USER_NAME
- Optional fromSubAccountId: number
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<[string, PublicKey]>
Inherited from DriftClient.initializeUserAccountAndDepositCollateral
- Defined in sdk/src/driftClient.ts:1753

initializeUserAccountForDevnet

initializeUserAccountForDevnet(subAccountId?: number, name?: string, marketIndex: number, tokenFaucet: TokenFaucet, amount: BN, referrerInfo?: ReferrerInfo): Promise<[string, PublicKey]>
Parameters
- subAccountId: number = 0
- name: string = DEFAULT_USER_NAME
- marketIndex: number
- tokenFaucet: TokenFaucet
- amount: BN
- Optional referrerInfo: ReferrerInfo
Returns Promise<[string, PublicKey]>
Inherited from DriftClient.initializeUserAccountForDevnet
- Defined in sdk/src/driftClient.ts:1862

liquidateBorrowForPerpPnl

liquidateBorrowForPerpPnl(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: number, liabilityMarketIndex: number, maxLiabilityTransfer: BN, limitPrice?: BN, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- perpMarketIndex: number
- liabilityMarketIndex: number
- maxLiabilityTransfer: BN
- Optional limitPrice: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.liquidateBorrowForPerpPnl
- Defined in sdk/src/driftClient.ts:4782

liquidatePerp

liquidatePerp(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, maxBaseAssetAmount: BN, limitPrice?: BN, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- maxBaseAssetAmount: BN
- Optional limitPrice: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.liquidatePerp
- Defined in sdk/src/driftClient.ts:4647

liquidatePerpPnlForDeposit

liquidatePerpPnlForDeposit(userAccountPublicKey: PublicKey, userAccount: UserAccount, perpMarketIndex: number, assetMarketIndex: number, maxPnlTransfer: BN, limitPrice?: BN, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- perpMarketIndex: number
- assetMarketIndex: number
- maxPnlTransfer: BN
- Optional limitPrice: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.liquidatePerpPnlForDeposit
- Defined in sdk/src/driftClient.ts:4852

liquidateSpot

liquidateSpot(userAccountPublicKey: PublicKey, userAccount: UserAccount, assetMarketIndex: number, liabilityMarketIndex: number, maxLiabilityTransfer: BN, limitPrice?: BN, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- assetMarketIndex: number
- liabilityMarketIndex: number
- maxLiabilityTransfer: BN
- Optional limitPrice: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.liquidateSpot
- Defined in sdk/src/driftClient.ts:4712

modifyOrder

modifyOrder(orderParams: {
    auctionDuration?: number;
    auctionEndPrice?: BN;
    auctionStartPrice?: BN;
    immediateOrCancel?: boolean;
    maxTs?: BN;
    newBaseAmount?: BN;
    newDirection?: PositionDirection;
    newLimitPrice?: BN;
    newOraclePriceOffset?: number;
    newTriggerCondition?: OrderTriggerCondition;
    newTriggerPrice?: BN;
    orderId: number;
    policy?: ModifyOrderPolicy;
    postOnly?: boolean;
    reduceOnly?: boolean;
}, txParams?: TxParams): Promise<string>
Modifies an open order (spot or perp) by closing it and replacing it with a new order.

Returns
Parameters
- orderParams: {
      auctionDuration?: number;
      auctionEndPrice?: BN;
      auctionStartPrice?: BN;
      immediateOrCancel?: boolean;
      maxTs?: BN;
      newBaseAmount?: BN;
      newDirection?: PositionDirection;
      newLimitPrice?: BN;
      newOraclePriceOffset?: number;
      newTriggerCondition?: OrderTriggerCondition;
      newTriggerPrice?: BN;
      orderId: number;
      policy?: ModifyOrderPolicy;
      postOnly?: boolean;
      reduceOnly?: boolean;
  }
  - Optional auctionDuration?: number
  - Optional auctionEndPrice?: BN
  - Optional auctionStartPrice?: BN
  - Optional immediateOrCancel?: boolean
  - Optional maxTs?: BN
  - Optional newBaseAmount?: BN
  - Optional newDirection?: PositionDirection
  - Optional newLimitPrice?: BN
  - Optional newOraclePriceOffset?: number
  - Optional newTriggerCondition?: OrderTriggerCondition
  - Optional newTriggerPrice?: BN
  - orderId: number
  - Optional policy?: ModifyOrderPolicy
  - Optional postOnly?: boolean
  - Optional reduceOnly?: boolean
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.modifyOrder
- Defined in sdk/src/driftClient.ts:4340

modifyOrderByUserOrderId

modifyOrderByUserOrderId(orderParams: {
    auctionDuration?: number;
    auctionEndPrice?: BN;
    auctionStartPrice?: BN;
    immediateOrCancel?: boolean;
    maxTs?: BN;
    newBaseAmount?: BN;
    newDirection?: PositionDirection;
    newLimitPrice?: BN;
    newOraclePriceOffset?: number;
    newTriggerCondition?: OrderTriggerCondition;
    newTriggerPrice?: BN;
    policy?: ModifyOrderPolicy;
    postOnly?: boolean;
    reduceOnly?: boolean;
    userOrderId: number;
}, txParams?: TxParams): Promise<string>
Modifies an open order by closing it and replacing it with a new order.

Returns
Parameters
- orderParams: {
      auctionDuration?: number;
      auctionEndPrice?: BN;
      auctionStartPrice?: BN;
      immediateOrCancel?: boolean;
      maxTs?: BN;
      newBaseAmount?: BN;
      newDirection?: PositionDirection;
      newLimitPrice?: BN;
      newOraclePriceOffset?: number;
      newTriggerCondition?: OrderTriggerCondition;
      newTriggerPrice?: BN;
      policy?: ModifyOrderPolicy;
      postOnly?: boolean;
      reduceOnly?: boolean;
      userOrderId: number;
  }
  - Optional auctionDuration?: number
  - Optional auctionEndPrice?: BN
  - Optional auctionStartPrice?: BN
  - Optional immediateOrCancel?: boolean
  - Optional maxTs?: BN
  - Optional newBaseAmount?: BN
  - Optional newDirection?: PositionDirection
  - Optional newLimitPrice?: BN
  - Optional newOraclePriceOffset?: number
  - Optional newTriggerCondition?: OrderTriggerCondition
  - Optional newTriggerPrice?: BN
  - Optional policy?: ModifyOrderPolicy
  - Optional postOnly?: boolean
  - Optional reduceOnly?: boolean
  - userOrderId: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.modifyOrderByUserOrderId
- Defined in sdk/src/driftClient.ts:4457

modifyPerpOrder

modifyPerpOrder(orderId: number, newBaseAmount?: BN, newLimitPrice?: BN, newOraclePriceOffset?: number): Promise<string>
Modifies an open order by closing it and replacing it with a new order.

Deprecated
use modifyOrder instead

Returns
Parameters
- orderId: number
- Optional newBaseAmount: BN
- Optional newLimitPrice: BN
- Optional newOraclePriceOffset: number
Returns Promise<string>
Inherited from DriftClient.modifyPerpOrder
- Defined in sdk/src/driftClient.ts:4285

modifyPerpOrderByUserOrderId

modifyPerpOrderByUserOrderId(userOrderId: number, newBaseAmount?: BN, newLimitPrice?: BN, newOraclePriceOffset?: number): Promise<string>
Modifies an open order by closing it and replacing it with a new order.

Deprecated
use modifyOrderByUserOrderId instead

Returns
Parameters
- userOrderId: number
- Optional newBaseAmount: BN
- Optional newLimitPrice: BN
- Optional newOraclePriceOffset: number
Returns Promise<string>
Inherited from DriftClient.modifyPerpOrderByUserOrderId
- Defined in sdk/src/driftClient.ts:4308

moveAmmPrice

moveAmmPrice(perpMarketIndex: number, baseAssetReserve: BN, quoteAssetReserve: BN, sqrtK?: BN): Promise<string>
Parameters
- perpMarketIndex: number
- baseAssetReserve: BN
- quoteAssetReserve: BN
- Optional sqrtK: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:308

moveAmmToPrice

moveAmmToPrice(perpMarketIndex: number, targetPrice: BN): Promise<string>
Parameters
- perpMarketIndex: number
- targetPrice: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:379

mustIncludeMarketsInIx

mustIncludeMarketsInIx(__namedParameters: {
perpMarketIndexes: number[];
spotMarketIndexes: number[];
}): void
Each drift instruction must include perp and sport market accounts in the ix remaining accounts. Use this function to force a subset of markets to be included in the remaining accounts for every ix
Parameters
- __namedParameters: {
  perpMarketIndexes: number[];
  spotMarketIndexes: number[];
  }
  - perpMarketIndexes: number[]
  - spotMarketIndexes: number[]
Returns void
Inherited from DriftClient.mustIncludeMarketsInIx
- Defined in sdk/src/driftClient.ts:1247

openPosition

openPosition(direction: PositionDirection, amount: BN, marketIndex: number, limitPrice?: BN): Promise<string>
Deprecated
use placePerpOrder or placeAndTakePerpOrder instead
Parameters
- direction: PositionDirection
- amount: BN
- marketIndex: number
- Optional limitPrice: BN
Returns Promise<string>
Inherited from DriftClient.openPosition
- Defined in sdk/src/driftClient.ts:2377

placeAndMakePerpOrder

placeAndMakePerpOrder(orderParams: OptionalOrderParams, takerInfo: TakerInfo, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- takerInfo: TakerInfo
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeAndMakePerpOrder
- Defined in sdk/src/driftClient.ts:4004

placeAndMakeSpotOrder

placeAndMakeSpotOrder(orderParams: OptionalOrderParams, takerInfo: TakerInfo, fulfillmentConfig?: SerumV3FulfillmentConfigAccount, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- takerInfo: TakerInfo
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeAndMakeSpotOrder
- Defined in sdk/src/driftClient.ts:4172

placeAndTakePerpOrder

placeAndTakePerpOrder(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeAndTakePerpOrder
- Defined in sdk/src/driftClient.ts:3910

placeAndTakeSpotOrder

placeAndTakeSpotOrder(orderParams: OptionalOrderParams, fulfillmentConfig?: SerumV3FulfillmentConfigAccount, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount
- Optional makerInfo: MakerInfo
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeAndTakeSpotOrder
- Defined in sdk/src/driftClient.ts:4074

placeOrders

placeOrders(params: OrderParams[], txParams?: TxParams): Promise<string>
Parameters
- params: OrderParams[]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeOrders
- Defined in sdk/src/driftClient.ts:2878

placePerpOrder

placePerpOrder(orderParams: OptionalOrderParams, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placePerpOrder
- Defined in sdk/src/driftClient.ts:2518

placeSpotOrder

placeSpotOrder(orderParams: OptionalOrderParams, txParams?: TxParams): Promise<string>
Parameters
- orderParams: OptionalOrderParams
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeSpotOrder
- Defined in sdk/src/driftClient.ts:3049

removeInsuranceFundStake

removeInsuranceFundStake(marketIndex: number, collateralAccountPublicKey: PublicKey): Promise<string>
Parameters
- marketIndex: number
- collateralAccountPublicKey: PublicKey
Returns Promise<string>
Inherited from DriftClient.removeInsuranceFundStake
- Defined in sdk/src/driftClient.ts:5435

removePerpLpShares

removePerpLpShares(marketIndex: number, sharesToBurn?: BN, txParams?: TxParams): Promise<string>
Parameters
- marketIndex: number
- Optional sharesToBurn: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.removePerpLpShares
- Defined in sdk/src/driftClient.ts:2199

removePerpLpSharesInExpiringMarket

removePerpLpSharesInExpiringMarket(marketIndex: number, userAccountPublicKey: PublicKey, sharesToBurn?: BN, txParams?: TxParams): Promise<string>
Parameters
- marketIndex: number
- userAccountPublicKey: PublicKey
- Optional sharesToBurn: BN
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.removePerpLpSharesInExpiringMarket
- Defined in sdk/src/driftClient.ts:2215

repegAmmCurve

repegAmmCurve(newPeg: BN, perpMarketIndex: number): Promise<string>
Parameters
- newPeg: BN
- perpMarketIndex: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:423

requestRemoveInsuranceFundStake

requestRemoveInsuranceFundStake(marketIndex: number, amount: BN): Promise<string>
Parameters
- marketIndex: number
- amount: BN
Returns Promise<string>
Inherited from DriftClient.requestRemoveInsuranceFundStake
- Defined in sdk/src/driftClient.ts:5362

resetPerpMarketAmmOracleTwap

resetPerpMarketAmmOracleTwap(perpMarketIndex: number): Promise<string>
Parameters
- perpMarketIndex: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:464

resolvePerpBankruptcy

resolvePerpBankruptcy(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.resolvePerpBankruptcy
- Defined in sdk/src/driftClient.ts:4922

resolvePerpPnlDeficit

resolvePerpPnlDeficit(spotMarketIndex: number, perpMarketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- spotMarketIndex: number
- perpMarketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.resolvePerpPnlDeficit
- Defined in sdk/src/driftClient.ts:5541

resolveSpotBankruptcy

resolveSpotBankruptcy(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.resolveSpotBankruptcy
- Defined in sdk/src/driftClient.ts:4985

sendMarketOrderAndGetSignedFillTx

sendMarketOrderAndGetSignedFillTx(orderParams: OptionalOrderParams, userAccountPublicKey: PublicKey, userAccount: UserAccount, makerInfo?: MakerInfo | MakerInfo[], txParams?: TxParams, bracketOrdersParams?: OptionalOrderParams[], referrerInfo?: ReferrerInfo, useVersionedTx?: boolean): Promise<{
signedFillTx: Transaction;
txSig: string;
}>
Sends a market order and returns a signed tx which can fill the order against the vamm, which the caller can use to fill their own order if required.

Returns
Parameters
- orderParams: OptionalOrderParams
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional txParams: TxParams
- bracketOrdersParams: OptionalOrderParams[] = ...
- Optional referrerInfo: ReferrerInfo
- useVersionedTx: boolean = true
Returns Promise<{
signedFillTx: Transaction;
txSig: string;
}>
Inherited from DriftClient.sendMarketOrderAndGetSignedFillTx
- Defined in sdk/src/driftClient.ts:2413

sendSignedTx

sendSignedTx(tx: Transaction): Promise<string>
Parameters
- tx: Transaction
Returns Promise<string>
Inherited from DriftClient.sendSignedTx
- Defined in sdk/src/driftClient.ts:2392

sendTransaction

sendTransaction(tx: Transaction | VersionedTransaction, additionalSigners?: Signer[], opts?: ConfirmOptions, preSigned?: boolean): Promise<TxSigAndSlot>
Parameters
- tx: Transaction | VersionedTransaction
- Optional additionalSigners: Signer[]
- Optional opts: ConfirmOptions
- Optional preSigned: boolean
Returns Promise<TxSigAndSlot>
Inherited from DriftClient.sendTransaction
- Defined in sdk/src/driftClient.ts:5667

settleExpiredMarket

settleExpiredMarket(marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settleExpiredMarket
- Defined in sdk/src/driftClient.ts:2606

settleExpiredMarketPoolsToRevenuePool

settleExpiredMarketPoolsToRevenuePool(perpMarketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- perpMarketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settleExpiredMarketPoolsToRevenuePool
- Defined in sdk/src/driftClient.ts:2658

settleFundingPayment

settleFundingPayment(userAccountPublicKey: PublicKey, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settleFundingPayment
- Defined in sdk/src/driftClient.ts:5124

settleLP

settleLP(settleeUserAccountPublicKey: PublicKey, marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- settleeUserAccountPublicKey: PublicKey
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settleLP
- Defined in sdk/src/driftClient.ts:2161

settleLPIx

settleLPIx(settleeUserAccountPublicKey: PublicKey, marketIndex: number): Promise<TransactionInstruction>
Parameters
- settleeUserAccountPublicKey: PublicKey
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.settleLPIx
- Defined in sdk/src/driftClient.ts:2177

settlePNL

settlePNL(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- settleeUserAccountPublicKey: PublicKey
- settleeUserAccount: UserAccount
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settlePNL
- Defined in sdk/src/driftClient.ts:4604

settlePNLIx

settlePNLIx(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndex: number): Promise<TransactionInstruction>
Parameters
- settleeUserAccountPublicKey: PublicKey
- settleeUserAccount: UserAccount
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.settlePNLIx
- Defined in sdk/src/driftClient.ts:4625

settlePNLs

settlePNLs(users: {
settleeUserAccount: UserAccount;
settleeUserAccountPublicKey: PublicKey;
}[], marketIndexes: number[]): Promise<string>
Parameters
- users: {
  settleeUserAccount: UserAccount;
  settleeUserAccountPublicKey: PublicKey;
  }[]
- marketIndexes: number[]
Returns Promise<string>
Inherited from DriftClient.settlePNLs
- Defined in sdk/src/driftClient.ts:4561

settleRevenueToInsuranceFund

settleRevenueToInsuranceFund(marketIndex: number): Promise<string>
Parameters
- marketIndex: number
Returns Promise<string>
Inherited from DriftClient.settleRevenueToInsuranceFund
- Defined in sdk/src/driftClient.ts:5511

stakeForMSOL

stakeForMSOL(__namedParameters: {
amount: BN;
}): Promise<TxSigAndSlot>
Parameters
- __namedParameters: {
  amount: BN;
  }
  - amount: BN
Returns Promise<TxSigAndSlot>
Inherited from DriftClient.stakeForMSOL
- Defined in sdk/src/driftClient.ts:3685

subscribe(): Promise<boolean>
Returns Promise<boolean>
Inherited from DriftClient.subscribe
- Defined in sdk/src/driftClient.ts:310

subscribeUsers

subscribeUsers(): Promise<boolean>[]
Returns Promise<boolean>[]
Inherited from DriftClient.subscribeUsers
- Defined in sdk/src/driftClient.ts:325

swap

swap(__namedParameters: {
    amount: BN;
    inAssociatedTokenAccount?: PublicKey;
    inMarketIndex: number;
    jupiterClient: JupiterClient;
    outAssociatedTokenAccount?: PublicKey;
    outMarketIndex: number;
    reduceOnly?: SwapReduceOnly;
    route?: Route;
    slippageBps?: number;
    swapMode?: SwapMode;
    txParams?: TxParams;
}): Promise<string>
Swap tokens in drift account using jupiter
Parameters
- __namedParameters: {
      amount: BN;
      inAssociatedTokenAccount?: PublicKey;
      inMarketIndex: number;
      jupiterClient: JupiterClient;
      outAssociatedTokenAccount?: PublicKey;
      outMarketIndex: number;
      reduceOnly?: SwapReduceOnly;
      route?: Route;
      slippageBps?: number;
      swapMode?: SwapMode;
      txParams?: TxParams;
  }
  - amount: BN
  - Optional inAssociatedTokenAccount?: PublicKey
  - inMarketIndex: number
  - jupiterClient: JupiterClient
  - Optional outAssociatedTokenAccount?: PublicKey
  - outMarketIndex: number
  - Optional reduceOnly?: SwapReduceOnly
  - Optional route?: Route
  - Optional slippageBps?: number
  - Optional swapMode?: SwapMode
  - Optional txParams?: TxParams
Returns Promise<string>
Inherited from DriftClient.swap
- Defined in sdk/src/driftClient.ts:3406

switchActiveUser

switchActiveUser(subAccountId: number, authority?: PublicKey): void
Parameters
- subAccountId: number
- Optional authority: PublicKey
Returns void
Inherited from DriftClient.switchActiveUser
- Defined in sdk/src/driftClient.ts:583

transferDeposit

transferDeposit(amount: BN, marketIndex: number, fromSubAccountId: number, toSubAccountId: number, txParams?: TxParams): Promise<string>
Withdraws from the fromSubAccount and deposits into the toSubAccount
Parameters
- amount: BN
- marketIndex: number
- fromSubAccountId: number
- toSubAccountId: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.transferDeposit
- Defined in sdk/src/driftClient.ts:2044

triggerEvent

triggerEvent(eventName: keyof DriftClientAccountEvents, data?: any): void
Parameters
- eventName: keyof DriftClientAccountEvents
- Optional data: any
Returns void
Inherited from DriftClient.triggerEvent
- Defined in sdk/src/driftClient.ts:5167

triggerOrder

triggerOrder(userAccountPublicKey: PublicKey, user: UserAccount, order: Order, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- order: Order
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.triggerOrder
- Defined in sdk/src/driftClient.ts:3745

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
Inherited from DriftClient.unsubscribe
- Defined in sdk/src/driftClient.ts:342

unsubscribeUsers

unsubscribeUsers(): Promise<void>[]
Returns Promise<void>[]
Inherited from DriftClient.unsubscribeUsers
- Defined in sdk/src/driftClient.ts:355

updateAMMs

updateAMMs(marketIndexes: number[], txParams?: TxParams): Promise<string>
Parameters
- marketIndexes: number[]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateAMMs
- Defined in sdk/src/driftClient.ts:2557

updateAdmin

updateAdmin(admin: PublicKey): Promise<string>
Parameters
- admin: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:513

updateAmmJitIntensity

updateAmmJitIntensity(perpMarketIndex: number, ammJitIntensity: number): Promise<string>
Parameters
- perpMarketIndex: number
- ammJitIntensity: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:633

updateDiscountMint

updateDiscountMint(discountMint: PublicKey): Promise<string>
Parameters
- discountMint: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1133

updateExchangeStatus

updateExchangeStatus(exchangeStatus: ExchangeStatus): Promise<string>
Parameters
- exchangeStatus: ExchangeStatus
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1285

updateFundingRate

updateFundingRate(perpMarketIndex: number, oracle: PublicKey, txParams?: TxParams): Promise<string>
Parameters
- perpMarketIndex: number
- oracle: PublicKey
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateFundingRate
- Defined in sdk/src/driftClient.ts:5043

updateInitialPctToLiquidate

updateInitialPctToLiquidate(initialPctToLiquidate: number): Promise<string>
Parameters
- initialPctToLiquidate: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:743

updateInsuranceFundUnstakingPeriod

updateInsuranceFundUnstakingPeriod(spotMarketIndex: number, insuranceWithdrawEscrowPeriod: BN): Promise<string>
Parameters
- spotMarketIndex: number
- insuranceWithdrawEscrowPeriod: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:894

updateK

updateK(perpMarketIndex: number, sqrtK: BN): Promise<string>
Parameters
- perpMarketIndex: number
- sqrtK: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:340

updateLiquidationDuration

updateLiquidationDuration(liquidationDuration: number): Promise<string>
Parameters
- liquidationDuration: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:757

updateLpCooldownTime

updateLpCooldownTime(cooldownTime: BN): Promise<string>
Parameters
- cooldownTime: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:917

updateMaxSlippageRatio

updateMaxSlippageRatio(perpMarketIndex: number, maxSlippageRatio: number): Promise<string>
Parameters
- perpMarketIndex: number
- maxSlippageRatio: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1349

updateOracleGuardRails

updateOracleGuardRails(oracleGuardRails: OracleGuardRails): Promise<string>
Parameters
- oracleGuardRails: OracleGuardRails
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:771

updatePerpAuctionDuration

updatePerpAuctionDuration(minDuration: any): Promise<string>
Parameters
- minDuration: any
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1302

updatePerpBidAskTwap

updatePerpBidAskTwap(perpMarketIndex: number, makers: [PublicKey, PublicKey][], txParams?: TxParams): Promise<string>
Parameters
- perpMarketIndex: number
- makers: [PublicKey, PublicKey][]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updatePerpBidAskTwap
- Defined in sdk/src/driftClient.ts:5076

updatePerpFeeStructure

updatePerpFeeStructure(feeStructure: FeeStructure): Promise<string>
Parameters
- feeStructure: FeeStructure
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:712

updatePerpMarketAmmOracleTwap

updatePerpMarketAmmOracleTwap(perpMarketIndex: number): Promise<string>
Parameters
- perpMarketIndex: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:445

updatePerpMarketBaseSpread

updatePerpMarketBaseSpread(perpMarketIndex: number, baseSpread: number): Promise<string>
Parameters
- perpMarketIndex: number
- baseSpread: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:611

updatePerpMarketConcentrationScale

updatePerpMarketConcentrationScale(perpMarketIndex: number, concentrationScale: BN): Promise<string>
Parameters
- perpMarketIndex: number
- concentrationScale: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:360

updatePerpMarketContractTier

updatePerpMarketContractTier(perpMarketIndex: number, contractTier: ContractTier): Promise<string>
Parameters
- perpMarketIndex: number
- contractTier: ContractTier
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1263

updatePerpMarketCurveUpdateIntensity

updatePerpMarketCurveUpdateIntensity(perpMarketIndex: number, curveUpdateIntensity: number): Promise<string>
Parameters
- perpMarketIndex: number
- curveUpdateIntensity: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:525

updatePerpMarketExpiry

updatePerpMarketExpiry(perpMarketIndex: number, expiryTs: BN): Promise<string>
Parameters
- perpMarketIndex: number
- expiryTs: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1037

updatePerpMarketImfFactor

updatePerpMarketImfFactor(perpMarketIndex: number, imfFactor: number, unrealizedPnlImfFactor: number): Promise<string>
Parameters
- perpMarketIndex: number
- imfFactor: number
- unrealizedPnlImfFactor: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:590

updatePerpMarketLiquidationFee

updatePerpMarketLiquidationFee(perpMarketIndex: number, liquidatorFee: number, ifLiquidationFee: number): Promise<string>
Parameters
- perpMarketIndex: number
- liquidatorFee: number
- ifLiquidationFee: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1437

updatePerpMarketMarginRatio

updatePerpMarketMarginRatio(perpMarketIndex: number, marginRatioInitial: number, marginRatioMaintenance: number): Promise<string>
Parameters
- perpMarketIndex: number
- marginRatioInitial: number
- marginRatioMaintenance: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:566

updatePerpMarketMaxFillReserveFraction

updatePerpMarketMaxFillReserveFraction(perpMarketIndex: number, maxBaseAssetAmountRatio: number): Promise<string>
Parameters
- perpMarketIndex: number
- maxBaseAssetAmountRatio: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1330

updatePerpMarketMaxImbalances

updatePerpMarketMaxImbalances(perpMarketIndex: number, unrealizedMaxImbalance: BN, maxRevenueWithdrawPerPeriod: BN, quoteMaxInsurance: BN): Promise<string>
Parameters
- perpMarketIndex: number
- unrealizedMaxImbalance: BN
- maxRevenueWithdrawPerPeriod: BN
- quoteMaxInsurance: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1383

updatePerpMarketMaxOpenInterest

updatePerpMarketMaxOpenInterest(perpMarketIndex: number, maxOpenInterest: BN): Promise<string>
Parameters
- perpMarketIndex: number
- maxOpenInterest: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1406

updatePerpMarketMaxSpread

updatePerpMarketMaxSpread(perpMarketIndex: number, maxSpread: number): Promise<string>
Parameters
- perpMarketIndex: number
- maxSpread: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:694

updatePerpMarketMinOrderSize

updatePerpMarketMinOrderSize(perpMarketIndex: number, orderSize: BN): Promise<string>
Parameters
- perpMarketIndex: number
- orderSize: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:984

updatePerpMarketName

updatePerpMarketName(perpMarketIndex: number, name: string): Promise<string>
Parameters
- perpMarketIndex: number
- name: string
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:655

updatePerpMarketOracle

updatePerpMarketOracle(perpMarketIndex: number, oracle: PublicKey, oracleSource: OracleSource): Promise<string>
Parameters
- perpMarketIndex: number
- oracle: PublicKey
- oracleSource: OracleSource
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:934

updatePerpMarketStatus

updatePerpMarketStatus(perpMarketIndex: number, marketStatus: MarketStatus): Promise<string>
Parameters
- perpMarketIndex: number
- marketStatus: MarketStatus
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1241

updatePerpMarketStepSizeAndTickSize

updatePerpMarketStepSizeAndTickSize(perpMarketIndex: number, stepSize: BN, tickSize: BN): Promise<string>
Parameters
- perpMarketIndex: number
- stepSize: BN
- tickSize: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:959

updatePerpMarketTargetBaseAssetAmountPerLp

updatePerpMarketTargetBaseAssetAmountPerLp(perpMarketIndex: number, targetBaseAssetAmountPerLP: number): Promise<string>
Parameters
- perpMarketIndex: number
- targetBaseAssetAmountPerLP: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:547

updatePerpMarketUnrealizedAssetWeight

updatePerpMarketUnrealizedAssetWeight(perpMarketIndex: number, unrealizedInitialAssetWeight: number, unrealizedMaintenanceAssetWeight: number): Promise<string>
Parameters
- perpMarketIndex: number
- unrealizedInitialAssetWeight: number
- unrealizedMaintenanceAssetWeight: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1362

updateSerumFulfillmentConfigStatus

updateSerumFulfillmentConfigStatus(serumFulfillmentConfig: PublicKey, status: SpotFulfillmentConfigStatus): Promise<string>
Parameters
- serumFulfillmentConfig: PublicKey
- status: SpotFulfillmentConfigStatus
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1087

updateSerumVault

updateSerumVault(srmVault: PublicKey): Promise<string>
Parameters
- srmVault: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1425

updateSpotAuctionDuration

updateSpotAuctionDuration(defaultAuctionDuration: number): Promise<string>
Parameters
- defaultAuctionDuration: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1316

updateSpotFeeStructure

updateSpotFeeStructure(feeStructure: FeeStructure): Promise<string>
Parameters
- feeStructure: FeeStructure
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:726

updateSpotMarketAssetTier

updateSpotMarketAssetTier(spotMarketIndex: number, assetTier: AssetTier): Promise<string>
Parameters
- spotMarketIndex: number
- assetTier: AssetTier
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1197

updateSpotMarketBorrowRate

updateSpotMarketBorrowRate(spotMarketIndex: number, optimalUtilization: number, optimalBorrowRate: number, optimalMaxRate: number): Promise<string>
Parameters
- spotMarketIndex: number
- optimalUtilization: number
- optimalBorrowRate: number
- optimalMaxRate: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1174

updateSpotMarketCumulativeInterest

updateSpotMarketCumulativeInterest(marketIndex: number, txParams?: TxParams): Promise<string>
Parameters
- marketIndex: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateSpotMarketCumulativeInterest
- Defined in sdk/src/driftClient.ts:2132

updateSpotMarketCumulativeInterestIx

updateSpotMarketCumulativeInterestIx(marketIndex: number): Promise<TransactionInstruction>
Parameters
- marketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.updateSpotMarketCumulativeInterestIx
- Defined in sdk/src/driftClient.ts:2147

updateSpotMarketExpiry

updateSpotMarketExpiry(spotMarketIndex: number, expiryTs: BN): Promise<string>
Parameters
- spotMarketIndex: number
- expiryTs: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1100

updateSpotMarketIfFactor

updateSpotMarketIfFactor(spotMarketIndex: number, userIfFactor: BN, totalIfFactor: BN): Promise<string>
Parameters
- spotMarketIndex: number
- userIfFactor: BN
- totalIfFactor: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:824

updateSpotMarketLiquidationFee

updateSpotMarketLiquidationFee(spotMarketIndex: number, liquidatorFee: number, ifLiquidationFee: number): Promise<string>
Parameters
- spotMarketIndex: number
- liquidatorFee: number
- ifLiquidationFee: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1458

updateSpotMarketMarginWeights

updateSpotMarketMarginWeights(spotMarketIndex: number, initialAssetWeight: number, maintenanceAssetWeight: number, initialLiabilityWeight: number, maintenanceLiabilityWeight: number, imfFactor?: number): Promise<string>
Parameters
- spotMarketIndex: number
- initialAssetWeight: number
- maintenanceAssetWeight: number
- initialLiabilityWeight: number
- maintenanceLiabilityWeight: number
- imfFactor: number = 0
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1147

updateSpotMarketMaxTokenDeposits

updateSpotMarketMaxTokenDeposits(spotMarketIndex: number, maxTokenDeposits: BN): Promise<string>
Parameters
- spotMarketIndex: number
- maxTokenDeposits: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:872

updateSpotMarketMinOrderSize

updateSpotMarketMinOrderSize(spotMarketIndex: number, orderSize: BN): Promise<string>
Parameters
- spotMarketIndex: number
- orderSize: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1021

updateSpotMarketName

updateSpotMarketName(spotMarketIndex: number, name: string): Promise<string>
Parameters
- spotMarketIndex: number
- name: string
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:676

updateSpotMarketOracle

updateSpotMarketOracle(spotMarketIndex: number, oracle: PublicKey, oracleSource: OracleSource): Promise<string>
Parameters
- spotMarketIndex: number
- oracle: PublicKey
- oracleSource: OracleSource
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1053

updateSpotMarketOrdersEnabled

updateSpotMarketOrdersEnabled(spotMarketIndex: number, ordersEnabled: boolean): Promise<string>
Parameters
- spotMarketIndex: number
- ordersEnabled: boolean
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1071

updateSpotMarketRevenueSettlePeriod

updateSpotMarketRevenueSettlePeriod(spotMarketIndex: number, revenueSettlePeriod: BN): Promise<string>
Parameters
- spotMarketIndex: number
- revenueSettlePeriod: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:849

updateSpotMarketStatus

updateSpotMarketStatus(spotMarketIndex: number, marketStatus: MarketStatus): Promise<string>
Parameters
- spotMarketIndex: number
- marketStatus: MarketStatus
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1219

updateSpotMarketStepSizeAndTickSize

updateSpotMarketStepSizeAndTickSize(spotMarketIndex: number, stepSize: BN, tickSize: BN): Promise<string>
Parameters
- spotMarketIndex: number
- stepSize: BN
- tickSize: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1000

updateStateSettlementDuration

updateStateSettlementDuration(settlementDuration: number): Promise<string>
Parameters
- settlementDuration: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:788

updateUserCustomMarginRatio

updateUserCustomMarginRatio(marginRatio: number, subAccountId?: number): Promise<string>
Parameters
- marginRatio: number
- subAccountId: number = 0
Returns Promise<string>
Inherited from DriftClient.updateUserCustomMarginRatio
- Defined in sdk/src/driftClient.ts:848

updateUserDelegate

updateUserDelegate(delegate: PublicKey, subAccountId?: number): Promise<string>
Parameters
- delegate: PublicKey
- subAccountId: number = 0
Returns Promise<string>
Inherited from DriftClient.updateUserDelegate
- Defined in sdk/src/driftClient.ts:934

updateUserIdle

updateUserIdle(userAccountPublicKey: PublicKey, user: UserAccount, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateUserIdle
- Defined in sdk/src/driftClient.ts:3836

updateUserMarginTradingEnabled

updateUserMarginTradingEnabled(marginTradingEnabled: boolean, subAccountId?: number): Promise<string>
Parameters
- marginTradingEnabled: boolean
- subAccountId: number = 0
Returns Promise<string>
Inherited from DriftClient.updateUserMarginTradingEnabled
- Defined in sdk/src/driftClient.ts:903

updateUserName

updateUserName(name: string, subAccountId?: number): Promise<string>
Parameters
- name: string
- subAccountId: number = 0
Returns Promise<string>
Inherited from DriftClient.updateUserName
- Defined in sdk/src/driftClient.ts:823

updateUserOpenOrdersCount

updateUserOpenOrdersCount(userAccountPublicKey: PublicKey, user: UserAccount, txParams?: TxParams): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- user: UserAccount
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateUserOpenOrdersCount
- Defined in sdk/src/driftClient.ts:3873

updateWallet

updateWallet(newWallet: IWallet, subAccountIds?: number[], activeSubAccountId?: number, includeDelegates?: boolean, authoritySubaccountMap?: Map<string, number[]>): Promise<boolean>
Update the wallet to use for drift transactions and linked user account
Parameters
- newWallet: IWallet
- Optional subAccountIds: number[]
- Optional activeSubAccountId: number
- Optional includeDelegates: boolean
- Optional authoritySubaccountMap: Map<string, number[]>
Returns Promise<boolean>
Inherited from DriftClient.updateWallet
- Defined in sdk/src/driftClient.ts:506

updateWhitelistMint

updateWhitelistMint(whitelistMint?: PublicKey): Promise<string>
Parameters
- Optional whitelistMint: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1116

updateWithdrawGuardThreshold

updateWithdrawGuardThreshold(spotMarketIndex: number, withdrawGuardThreshold: BN): Promise<string>
Parameters
- spotMarketIndex: number
- withdrawGuardThreshold: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:802

withdraw

withdraw(amount: BN, marketIndex: number, associatedTokenAddress: PublicKey, reduceOnly?: boolean): Promise<string>
Withdraws from a user account. If deposit doesn't already exist, creates a borrow
Parameters
- amount: BN
- marketIndex: number
- associatedTokenAddress: PublicKey
  
  the token account to withdraw to. can be the wallet public key if using native sol
- reduceOnly: boolean = false
Returns Promise<string>
Inherited from DriftClient.withdraw
- Defined in sdk/src/driftClient.ts:1917

Class AdminClient

DriftClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: DriftClientConfig

Returns AdminClient

Properties

_isSubscribed

accountSubscriber

activeSubAccountId

authority

Optional authoritySubAccountMap

connection

eventEmitter

Optional includeDelegates

lookupTableAccount

marketLookupTable

mustIncludePerpMarketIndexes

mustIncludeSpotMarketIndexes

Optional opts

perpMarketLastSlotCache

program

provider

Optional signerPublicKey

Optional skipLoadUsers

spotMarketLastSlotCache

Optional statePublicKey

txParams

txSender

txVersion

userAccountSubscriptionConfig

Optional userStats

userStatsAccountPublicKey

userStatsAccountSubscriptionConfig

users

wallet

Accessors

isSubscribed

Returns boolean

Parameters

val: boolean

Returns void

Methods

addAndSubscribeToUsers

Returns Promise<boolean>

addInsuranceFundStake

Parameters

__namedParameters: { amount: BN; collateralAccountPublicKey: PublicKey; fromSubaccount?: boolean; initializeStakeAccount?: boolean; marketIndex: number; }

amount: BN

collateralAccountPublicKey: PublicKey

Optional fromSubaccount?: boolean

Optional initializeStakeAccount?: boolean

marketIndex: number

Returns Promise<string>

addPerpLpShares

Parameters

amount: BN

marketIndex: number

Optional txParams: TxParams

Returns Promise<string>

addPerpMarketToRemainingAccountMaps

Parameters

marketIndex: number

writable: boolean

oracleAccountMap: Map<string, AccountMeta>

spotMarketAccountMap: Map<number, AccountMeta>

perpMarketAccountMap: Map<number, AccountMeta>

Returns void

addPhoenixRemainingAccounts

Parameters

marketIndex: number

remainingAccounts: AccountMeta[]

fulfillmentConfig: PhoenixV1FulfillmentConfigAccount

`Optional` authoritySubAccountMap

`Optional` includeDelegates

`Optional` opts

`Optional` signerPublicKey

`Optional` skipLoadUsers

`Optional` statePublicKey

`Optional` userStats

__namedParameters: {
amount: BN;
collateralAccountPublicKey: PublicKey;
fromSubaccount?: boolean;
initializeStakeAccount?: boolean;
marketIndex: number;
}

`Optional` fromSubaccount?: boolean

`Optional` initializeStakeAccount?: boolean

`Optional` txParams: TxParams

`Optional` fulfillmentConfig: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount

`Optional` authority: PublicKey

`Optional` userAccount: UserAccount

`Optional` txParams: TxParams

`Optional` txVersion: TransactionVersion

`Optional` lookupTables: AddressLookupTableAccount[]

cancelOrderParams: {
direction?: PositionDirection;
marketIndex?: number;
marketType?: MarketType;
}

`Optional` direction?: PositionDirection

`Optional` marketIndex?: number

`Optional` marketType?: MarketType

`Optional` txParams: TxParams

`Optional` orderId: number

`Optional` txParams: TxParams

`Optional` txParams: TxParams

`Optional` marketType: MarketType

`Optional` marketIndex: number

`Optional` direction: PositionDirection

`Optional` txParams: TxParams

`Optional` orderIds: number[]

`Optional` txParams: TxParams