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

Accessors

isSubscribed

Methods

Constructors

constructor

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

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: DriftClientAccountSubscriber

activeSubAccountId

activeSubAccountId: number

authority

authority: PublicKey

`Optional` authoritySubAccountMap

authoritySubAccountMap?: Map<string, number[]>

connection

connection: Connection

`Optional` enableMetricsEvents

enableMetricsEvents?: boolean

eventEmitter

`Optional` includeDelegates

includeDelegates?: boolean

lookupTableAccount

lookupTableAccount: AddressLookupTableAccount

marketLookupTable

marketLookupTable: PublicKey

metricsEventEmitter

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` receiverProgram

receiverProgram?: Program<PythSolanaReceiver>

`Optional` sbOnDemandProgram

sbOnDemandProgram?: Program<Idl>

sbOnDemandProgramdId

sbOnDemandProgramdId: PublicKey

`Optional` sbProgramFeedConfigs

sbProgramFeedConfigs?: Map<string, any>

`Optional` signerPublicKey

signerPublicKey?: PublicKey

`Optional` skipLoadUsers

skipLoadUsers?: boolean

spotMarketLastSlotCache

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

`Optional` statePublicKey

statePublicKey?: PublicKey

swiftID

swiftID: PublicKey

txHandler

txHandler: TxHandler

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

`Optional` wormholeProgram

wormholeProgram?: Program<WormholeCoreBridgeSolana>

Accessors

isSubscribed

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

Methods

addAndSubscribeToUsers

addAndSubscribeToUsers(authority?: PublicKey): Promise<boolean>
Adds and subscribes to users based on params set by the constructor or by updateWallet.
Parameters
- Optional authority: PublicKey
Returns Promise<boolean>
Inherited from DriftClient.addAndSubscribeToUsers
- Defined in sdk/src/driftClient.ts:843

addInsuranceFundStake

addInsuranceFundStake(__namedParameters: {
    amount: BN;
    collateralAccountPublicKey: PublicKey;
    fromSubaccount?: boolean;
    initializeStakeAccount?: boolean;
    marketIndex: number;
    txParams?: TxParams;
}): 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;
      txParams?: TxParams;
  }
  - 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
  - Optional txParams?: TxParams
Returns Promise<string>
Inherited from DriftClient.addInsuranceFundStake
- Defined in sdk/src/driftClient.ts:7139

addOpenbookRemainingAccounts

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

addPerpLpShares

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

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:1766

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:4073

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:3982

addSpotFulfillmentAccounts

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

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:1794

addTokenMintToRemainingAccounts

addTokenMintToRemainingAccounts(spotMarketAccount: SpotMarketAccount, remainingAccounts: AccountMeta[]): void
Parameters
- spotMarketAccount: SpotMarketAccount
- remainingAccounts: AccountMeta[]
Returns void
Inherited from DriftClient.addTokenMintToRemainingAccounts
- Defined in sdk/src/driftClient.ts:2167

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:812

buildAndSignTransactionsMap

buildAndSignTransactionsMap(instructionsMap: Record<string, TransactionInstruction | TransactionInstruction[]>, txParams?: TxParams, txVersion?: TransactionVersion, lookupTables?: AddressLookupTableAccount[], forceVersionedTransaction?: boolean): Promise<{
    signedTxData: SignedTxData[];
    signedTxMap: Record<string, Transaction>;
} | {
    signedTxData: SignedTxData[];
    signedTxMap: MappedRecord<Record<string, TransactionInstruction | TransactionInstruction[]>, Transaction | VersionedTransaction>;
}>
Parameters
- instructionsMap: Record<string, TransactionInstruction | TransactionInstruction[]>
- Optional txParams: TxParams
- Optional txVersion: TransactionVersion
- Optional lookupTables: AddressLookupTableAccount[]
- Optional forceVersionedTransaction: boolean
Returns Promise<{
    signedTxData: SignedTxData[];
    signedTxMap: Record<string, Transaction>;
} | {
    signedTxData: SignedTxData[];
    signedTxMap: MappedRecord<Record<string, TransactionInstruction | TransactionInstruction[]>, Transaction | VersionedTransaction>;
}>
Inherited from DriftClient.buildAndSignTransactionsMap
- Defined in sdk/src/driftClient.ts:8160

buildBulkTransactions

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

buildTransaction

buildTransaction(instructions: TransactionInstruction | TransactionInstruction[], txParams?: TxParams, txVersion?: TransactionVersion, lookupTables?: AddressLookupTableAccount[], forceVersionedTransaction?: boolean, recentBlockhash?: Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>): Promise<Transaction | VersionedTransaction>
Parameters
- instructions: TransactionInstruction | TransactionInstruction[]
- Optional txParams: TxParams
- Optional txVersion: TransactionVersion
- Optional lookupTables: AddressLookupTableAccount[]
- Optional forceVersionedTransaction: boolean
- Optional recentBlockhash: Readonly<{
  blockhash: string;
  lastValidBlockHeight: number;
  }>
Returns Promise<Transaction | VersionedTransaction>
Inherited from DriftClient.buildTransaction
- Defined in sdk/src/driftClient.ts:8095

buildTransactionsMap

buildTransactionsMap(instructionsMap: Record<string, TransactionInstruction | TransactionInstruction[]>, txParams?: TxParams, txVersion?: TransactionVersion, lookupTables?: AddressLookupTableAccount[], forceVersionedTransaction?: boolean): Promise<MappedRecord<Record<string, TransactionInstruction | TransactionInstruction[]>, Transaction | VersionedTransaction>>
Parameters
- instructionsMap: Record<string, TransactionInstruction | TransactionInstruction[]>
- Optional txParams: TxParams
- Optional txVersion: TransactionVersion
- Optional lookupTables: AddressLookupTableAccount[]
- Optional forceVersionedTransaction: boolean
Returns Promise<MappedRecord<Record<string, TransactionInstruction | TransactionInstruction[]>, Transaction | VersionedTransaction>>
Inherited from DriftClient.buildTransactionsMap
- Defined in sdk/src/driftClient.ts:8137

cancelAndPlaceOrders

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

cancelOrder

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

cancelOrderByUserId

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

cancelOrders

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

cancelOrdersByIds

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

cancelRequestRemoveInsuranceFundStake

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

closePosition

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

convertToPerpPrecision

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

convertToPricePrecision

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

convertToSpotPrecision

convertToSpotPrecision(marketIndex: number, amount: number | BN): 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: number | BN
Returns BN
Inherited from DriftClient.convertToSpotPrecision
- Defined in sdk/src/driftClient.ts:1592

createAssociatedTokenAccountIdempotentInstruction

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

createDepositTxn

createDepositTxn(amount: BN, marketIndex: number, associatedTokenAccount: PublicKey, subAccountId?: number, reduceOnly?: boolean, txParams?: TxParams): Promise<Transaction | VersionedTransaction>
Parameters
- amount: BN
- marketIndex: number
- associatedTokenAccount: PublicKey
- Optional subAccountId: number
- reduceOnly: boolean = false
- Optional txParams: TxParams
Returns Promise<Transaction | VersionedTransaction>
Inherited from DriftClient.createDepositTxn
- Defined in sdk/src/driftClient.ts:1986

createInitializeUserAccountAndDepositCollateral

createInitializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, donateAmount?: BN, txParams?: TxParams, customMaxMarginRatio?: number): Promise<[Transaction | VersionedTransaction, PublicKey]>
Parameters
- amount: BN
- userTokenAccount: PublicKey
- marketIndex: number = 0
- subAccountId: number = 0
- Optional name: string
- Optional fromSubAccountId: number
- Optional referrerInfo: ReferrerInfo
- Optional donateAmount: BN
- Optional txParams: TxParams
- Optional customMaxMarginRatio: number
Returns Promise<[Transaction | VersionedTransaction, PublicKey]>
Inherited from DriftClient.createInitializeUserAccountAndDepositCollateral
- Defined in sdk/src/driftClient.ts:2314

createInitializeUserAccountAndDepositCollateralIxs

createInitializeUserAccountAndDepositCollateralIxs(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, donateAmount?: BN, customMaxMarginRatio?: number): Promise<{
ixs: TransactionInstruction[];
userAccountPublicKey: PublicKey;
}>
Parameters
- amount: BN
- userTokenAccount: PublicKey
- marketIndex: number = 0
- subAccountId: number = 0
- Optional name: string
- Optional fromSubAccountId: number
- Optional referrerInfo: ReferrerInfo
- Optional donateAmount: BN
- Optional customMaxMarginRatio: number
Returns Promise<{
ixs: TransactionInstruction[];
userAccountPublicKey: PublicKey;
}>
Inherited from DriftClient.createInitializeUserAccountAndDepositCollateralIxs
- Defined in sdk/src/driftClient.ts:2194

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:399

decodeSwiftOrderParamsMessage

decodeSwiftOrderParamsMessage(encodedMessage: Buffer): SwiftOrderParamsMessage
Parameters
- encodedMessage: Buffer
Returns SwiftOrderParamsMessage
Inherited from DriftClient.decodeSwiftOrderParamsMessage
- Defined in sdk/src/driftClient.ts:5423

decodeSwiftServerMessage

decodeSwiftServerMessage(encodedMessage: Buffer): SwiftServerMessage
Parameters
- encodedMessage: Buffer
Returns SwiftServerMessage
Inherited from DriftClient.decodeSwiftServerMessage
- Defined in sdk/src/driftClient.ts:5385

deleteInitializedPerpMarket

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

deleteInitializedSpotMarket

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

deletePrelaunchOracle

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

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:1388

deposit

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

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:987

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:7583

depositIntoSpotMarketVault

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

emulateAccount

emulateAccount(emulateAuthority: PublicKey): Promise<boolean>
Update the subscribed accounts to a given authority, while leaving the connected wallet intact. This allows a user to emulate another user's account on the UI and sign permissionless transactions with their own wallet.
Parameters
- emulateAuthority: PublicKey
Returns Promise<boolean>
Inherited from DriftClient.emulateAccount
- Defined in sdk/src/driftClient.ts:747

encodeSwiftOrderParamsMessage

encodeSwiftOrderParamsMessage(orderParamsMessage: SwiftOrderParamsMessage): Buffer
Parameters
- orderParamsMessage: SwiftOrderParamsMessage
Returns Buffer
Inherited from DriftClient.encodeSwiftOrderParamsMessage
- Defined in sdk/src/driftClient.ts:5414

encodeSwiftServerMessage

encodeSwiftServerMessage(message: SwiftServerMessage): Buffer
Parameters
- message: SwiftServerMessage
Returns Buffer
Inherited from DriftClient.encodeSwiftServerMessage
- Defined in sdk/src/driftClient.ts:5374

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:439

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:1286

fetchMarketLookupTableAccount

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

fetchReferrerNameAccount

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

fillPerpOrder

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

fillSpotOrder

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

forceCancelOrders

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

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:508

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:540

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:493

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:1540

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:7098

getAddPerpLpSharesIx

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

getAssociatedTokenAccount

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

getAssociatedTokenAccountCreationIx

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

getCancelOrderByUserIdIx

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

getCancelOrderIx

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

getCancelOrdersByIdsIx

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

getCancelOrdersIx

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

getDeleteInitializedPerpMarketIx

getDeleteInitializedPerpMarketIx(marketIndex: number): Promise<TransactionInstruction>
Parameters
- marketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:636

getDeleteInitializedSpotMarketIx

getDeleteInitializedSpotMarketIx(marketIndex: number): Promise<TransactionInstruction>
Parameters
- marketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:259

getDeletePrelaunchOracleIx

getDeletePrelaunchOracleIx(perpMarketIndex: number, price?: BN, maxPrice?: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional price: BN
- Optional maxPrice: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3629

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:2040

getDepositIntoPerpMarketFeePoolIx

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

getDepositIntoSpotMarketRevenuePoolIx

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

getDepositIntoSpotMarketVaultIx

getDepositIntoSpotMarketVaultIx(spotMarketIndex: number, amount: BN, sourceVault: PublicKey): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- amount: BN
- sourceVault: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1051

getDepositTxnIx

getDepositTxnIx(amount: BN, marketIndex: number, associatedTokenAccount: PublicKey, subAccountId?: number, reduceOnly?: boolean): Promise<TransactionInstruction[]>
Parameters
- amount: BN
- marketIndex: number
- associatedTokenAccount: PublicKey
- Optional subAccountId: number
- reduceOnly: boolean = false
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getDepositTxnIx
- Defined in sdk/src/driftClient.ts:1931

getFillPerpOrderIx

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

getFillSpotOrderIx

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

getForceCancelOrdersIx

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

getInitUserFuelIx

getInitUserFuelIx(user: PublicKey, authority: PublicKey, fuelBonusDeposits?: number, fuelBonusBorrows?: number, fuelBonusTaker?: number, fuelBonusMaker?: number, fuelBonusInsurance?: number): Promise<TransactionInstruction>
Parameters
- user: PublicKey
- authority: PublicKey
- Optional fuelBonusDeposits: number
- Optional fuelBonusBorrows: number
- Optional fuelBonusTaker: number
- Optional fuelBonusMaker: number
- Optional fuelBonusInsurance: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3785

getInitializeInsuranceFundStakeIx

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

getInitializeOpenbookV2FulfillmentConfigIx

getInitializeOpenbookV2FulfillmentConfigIx(marketIndex: number, openbookMarket: PublicKey): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- openbookMarket: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:412

getInitializePerpMarketIx

getInitializePerpMarketIx(marketIndex: number, priceOracle: PublicKey, baseAssetReserve: BN, quoteAssetReserve: BN, periodicity: BN, pegMultiplier?: BN, oracleSource?: OracleSource, contractTier?: ContractTier, marginRatioInitial?: number, marginRatioMaintenance?: number, liquidatorFee?: number, ifLiquidatorFee?: number, imfFactor?: number, activeStatus?: boolean, baseSpread?: number, maxSpread?: number, maxOpenInterest?: BN, maxRevenueWithdrawPerPeriod?: BN, quoteMaxInsurance?: BN, orderStepSize?: BN, orderTickSize?: BN, minOrderSize?: BN, concentrationCoefScale?: BN, curveUpdateIntensity?: number, ammJitIntensity?: number, name?: string): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- priceOracle: PublicKey
- baseAssetReserve: BN
- quoteAssetReserve: BN
- periodicity: BN
- pegMultiplier: BN = PEG_PRECISION
- oracleSource: OracleSource = OracleSource.PYTH
- contractTier: ContractTier = ContractTier.SPECULATIVE
- marginRatioInitial: number = 2000
- marginRatioMaintenance: number = 500
- liquidatorFee: number = 0
- ifLiquidatorFee: number = 10000
- imfFactor: number = 0
- activeStatus: boolean = true
- baseSpread: number = 0
- maxSpread: number = 142500
- maxOpenInterest: BN = ZERO
- maxRevenueWithdrawPerPeriod: BN = ZERO
- quoteMaxInsurance: BN = ZERO
- orderStepSize: BN = ...
- orderTickSize: BN = ...
- minOrderSize: BN = ...
- concentrationCoefScale: BN = ONE
- curveUpdateIntensity: number = 0
- ammJitIntensity: number = 0
- name: string = DEFAULT_MARKET_NAME
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:518

getInitializePhoenixFulfillmentConfigIx

getInitializePhoenixFulfillmentConfigIx(marketIndex: number, phoenixMarket: PublicKey): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- phoenixMarket: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:366

getInitializePredictionMarketIx

getInitializePredictionMarketIx(perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:606

getInitializePrelaunchOracleIx

getInitializePrelaunchOracleIx(perpMarketIndex: number, price?: BN, maxPrice?: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional price: BN
- Optional maxPrice: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3538

getInitializeProtocolIfSharesTransferConfigIx

getInitializeProtocolIfSharesTransferConfigIx(): Promise<TransactionInstruction>
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3463

getInitializePythPullOracleIx

getInitializePythPullOracleIx(feedId: string): Promise<TransactionInstruction>
Parameters
- feedId: string
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3828

getInitializeSerumFulfillmentConfigIx

getInitializeSerumFulfillmentConfigIx(marketIndex: number, serumMarket: PublicKey, serumProgram: PublicKey): Promise<TransactionInstruction>
Parameters
- marketIndex: number
- serumMarket: PublicKey
- serumProgram: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:313

getInitializeSpotMarketIx

getInitializeSpotMarketIx(mint: PublicKey, optimalUtilization: number, optimalRate: number, maxRate: number, oracle: PublicKey, oracleSource: OracleSource, initialAssetWeight: number, maintenanceAssetWeight: number, initialLiabilityWeight: number, maintenanceLiabilityWeight: number, imfFactor?: number, liquidatorFee?: number, ifLiquidationFee?: number, activeStatus?: boolean, assetTier?: {
collateral: {};
}, scaleInitialAssetWeightStart?: BN, withdrawGuardThreshold?: BN, orderTickSize?: BN, orderStepSize?: BN, ifTotalFactor?: number, name?: string, marketIndex?: number): Promise<TransactionInstruction>
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
- ifLiquidationFee: number = 0
- activeStatus: boolean = true
- assetTier: {
  collateral: {};
  } = AssetTier.COLLATERAL
  - collateral: {}
- scaleInitialAssetWeightStart: BN = ZERO
- withdrawGuardThreshold: BN = ZERO
- orderTickSize: BN = ONE
- orderStepSize: BN = ONE
- ifTotalFactor: number = 0
- name: string = DEFAULT_MARKET_NAME
- Optional marketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:160

getInitializeUserInstructions

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

getInitializeUserStatsIx

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

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:4322

getJupiterSwapIxV6

getJupiterSwapIxV6(__namedParameters: {
    amount: BN;
    inAssociatedTokenAccount?: PublicKey;
    inMarketIndex: number;
    jupiterClient: JupiterClient;
    onlyDirectRoutes?: boolean;
    outAssociatedTokenAccount?: PublicKey;
    outMarketIndex: number;
    quote?: QuoteResponse;
    reduceOnly?: SwapReduceOnly;
    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;
      quote?: QuoteResponse;
      reduceOnly?: SwapReduceOnly;
      slippageBps?: number;
      swapMode?: SwapMode;
      userAccountPublicKey?: PublicKey;
  }
  - amount: BN
  - Optional inAssociatedTokenAccount?: PublicKey
  - inMarketIndex: number
  - jupiterClient: JupiterClient
  - Optional onlyDirectRoutes?: boolean
  - Optional outAssociatedTokenAccount?: PublicKey
  - outMarketIndex: number
  - Optional quote?: QuoteResponse
  - Optional reduceOnly?: SwapReduceOnly
  - Optional slippageBps?: number
  - Optional swapMode?: SwapMode
  - Optional userAccountPublicKey?: PublicKey
Returns Promise<{
ixs: TransactionInstruction[];
lookupTables: AddressLookupTableAccount[];
}>
Inherited from DriftClient.getJupiterSwapIxV6
- Defined in sdk/src/driftClient.ts:4458

getLiquidateBorrowForPerpPnlIx

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

getLiquidatePerpIx

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

getLiquidatePerpPnlForDepositIx

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

getLiquidatePerpWithFillIx

getLiquidatePerpWithFillIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, makerInfos: MakerInfo[], liquidatorSubAccountId?: number): Promise<TransactionInstruction>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- makerInfos: MakerInfo[]
- Optional liquidatorSubAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getLiquidatePerpWithFillIx
- Defined in sdk/src/driftClient.ts:6477

getLiquidateSpotIx

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

getMarketFees

getMarketFees(marketType: MarketType, marketIndex?: number, user?: User): {
makerFee: number;
takerFee: number;
}
Calculates taker / maker fee (as a percentage, e.g. .001 = 10 basis points) for particular marketType

Returns
: {takerFee: number, makerFee: number} Precision None
Parameters
- marketType: MarketType
- Optional marketIndex: number
- Optional user: User
Returns {
makerFee: number;
takerFee: number;
}
- makerFee: number
- takerFee: number
Inherited from DriftClient.getMarketFees
- Defined in sdk/src/driftClient.ts:7630

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:7672

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;
}, subAccountId?: 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
- Optional subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getModifyOrderByUserIdIx
- Defined in sdk/src/driftClient.ts:6102

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;
}, subAccountId?: 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;
      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 subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getModifyOrderIx
- Defined in sdk/src/driftClient.ts:5980

getMoveAmmPriceIx

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

getMoveAmmToPriceIx

getMoveAmmToPriceIx(perpMarketIndex: number, targetPrice: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- targetPrice: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:838

getNextSubAccountId

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

getOpenbookV2FulfillmentConfig

getOpenbookV2FulfillmentConfig(openbookMarket: PublicKey): Promise<OpenbookV2FulfillmentConfigAccount>
Parameters
- openbookMarket: PublicKey
Returns Promise<OpenbookV2FulfillmentConfigAccount>
Inherited from DriftClient.getOpenbookV2FulfillmentConfig
- Defined in sdk/src/driftClient.ts:611

getOpenbookV2FulfillmentConfigs

getOpenbookV2FulfillmentConfigs(): Promise<OpenbookV2FulfillmentConfigAccount[]>
Returns Promise<OpenbookV2FulfillmentConfigAccount[]>
Inherited from DriftClient.getOpenbookV2FulfillmentConfigs
- Defined in sdk/src/driftClient.ts:623

getOracleDataForPerpMarket

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

getOracleDataForSpotMarket

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

getOraclePriceDataAndSlot

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

getOrder

getOrder(orderId: number, subAccountId?: number): Order
Parameters
- orderId: number
- Optional subAccountId: number
Returns Order
Inherited from DriftClient.getOrder
- Defined in sdk/src/driftClient.ts:1867

getOrderByUserId

getOrderByUserId(userOrderId: number, subAccountId?: number): Order
Parameters
- userOrderId: number
- Optional subAccountId: number
Returns Order
Inherited from DriftClient.getOrderByUserId
- Defined in sdk/src/driftClient.ts:1873

getPerpMarketAccount

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

getPerpMarketAccounts

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

getPerpMarketExtendedInfo

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

getPhoenixV1FulfillmentConfig

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

getPhoenixV1FulfillmentConfigs

getPhoenixV1FulfillmentConfigs(): Promise<PhoenixV1FulfillmentConfigAccount[]>
Returns Promise<PhoenixV1FulfillmentConfigAccount[]>
Inherited from DriftClient.getPhoenixV1FulfillmentConfigs
- Defined in sdk/src/driftClient.ts:601

getPlaceAndMakePerpOrderIx

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

getPlaceAndMakeSpotOrderIx

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

getPlaceAndMakeSwiftPerpOrderIxs

getPlaceAndMakeSwiftPerpOrderIxs(encodedSwiftMessage: Buffer, swiftSignature: Buffer, encodedSwiftOrderParamsMessage: Buffer, swiftOrderParamsSignature: Buffer, takerExpectedOrderId: number, takerInfo: {
    taker: PublicKey;
    takerStats: PublicKey;
    takerUserAccount: UserAccount;
}, orderParams: OptionalOrderParams, referrerInfo?: ReferrerInfo, subAccountId?: number): Promise<TransactionInstruction[]>
Parameters
- encodedSwiftMessage: Buffer
- swiftSignature: Buffer
- encodedSwiftOrderParamsMessage: Buffer
- swiftOrderParamsSignature: Buffer
- takerExpectedOrderId: number
- takerInfo: {
      taker: PublicKey;
      takerStats: PublicKey;
      takerUserAccount: UserAccount;
  }
  - taker: PublicKey
  - takerStats: PublicKey
  - takerUserAccount: UserAccount
- orderParams: OptionalOrderParams
- Optional referrerInfo: ReferrerInfo
- Optional subAccountId: number
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getPlaceAndMakeSwiftPerpOrderIxs
- Defined in sdk/src/driftClient.ts:5561

getPlaceAndTakePerpOrderIx

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

getPlaceAndTakeSpotOrderIx

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

getPlaceOrdersIx

getPlaceOrdersIx(params: OptionalOrderParams[], subAccountId?: number): Promise<TransactionInstruction>
Parameters
- params: OptionalOrderParams[]
- Optional subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceOrdersIx
- Defined in sdk/src/driftClient.ts:3603

getPlacePerpOrderIx

getPlacePerpOrderIx(orderParams: OptionalOrderParams, subAccountId?: number, depositToTradeArgs?: {
depositMarketIndex: number;
isMakingNewAccount: boolean;
}): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- Optional subAccountId: number
- Optional depositToTradeArgs: {
  depositMarketIndex: number;
  isMakingNewAccount: boolean;
  }
  - depositMarketIndex: number
  - isMakingNewAccount: boolean
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlacePerpOrderIx
- Defined in sdk/src/driftClient.ts:3204

getPlaceSpotOrderIx

getPlaceSpotOrderIx(orderParams: OptionalOrderParams, subAccountId?: number): Promise<TransactionInstruction>
Parameters
- orderParams: OptionalOrderParams
- Optional subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPlaceSpotOrderIx
- Defined in sdk/src/driftClient.ts:3799

getPlaceSwiftTakerPerpOrderIxs

getPlaceSwiftTakerPerpOrderIxs(encodedSwiftServerMessage: Buffer, swiftSignature: Buffer, encodedSwiftOrderParamsMessage: Buffer, swiftOrderParamsSignature: Buffer, marketIndex: number, takerInfo: {
    taker: PublicKey;
    takerStats: PublicKey;
    takerUserAccount: UserAccount;
}): Promise<TransactionInstruction[]>
Parameters
- encodedSwiftServerMessage: Buffer
- swiftSignature: Buffer
- encodedSwiftOrderParamsMessage: Buffer
- swiftOrderParamsSignature: Buffer
- marketIndex: number
- takerInfo: {
      taker: PublicKey;
      takerStats: PublicKey;
      takerUserAccount: UserAccount;
  }
  - taker: PublicKey
  - takerStats: PublicKey
  - takerUserAccount: UserAccount
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getPlaceSwiftTakerPerpOrderIxs
- Defined in sdk/src/driftClient.ts:5468

getPostPythPullOracleUpdateAtomicIxs

getPostPythPullOracleUpdateAtomicIxs(vaaString: string, feedIds: string | string[], numSignatures?: number): Promise<TransactionInstruction[]>
Parameters
- vaaString: string
- feedIds: string | string[]
- numSignatures: number = 2
Returns Promise<TransactionInstruction[]>
Inherited from DriftClient.getPostPythPullOracleUpdateAtomicIxs
- Defined in sdk/src/driftClient.ts:7747

getPostSwitchboardOnDemandUpdateAtomicIx

getPostSwitchboardOnDemandUpdateAtomicIx(feed: PublicKey, numSignatures?: number): Promise<TransactionInstruction>
Parameters
- feed: PublicKey
- numSignatures: number = 3
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getPostSwitchboardOnDemandUpdateAtomicIx
- Defined in sdk/src/driftClient.ts:7932

getQuoteAssetTokenAmount

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

getQuoteSpotMarketAccount

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

getQuoteValuePerLpShare

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

getReceiverProgram

getReceiverProgram(): Program<PythSolanaReceiver>
Returns Program<PythSolanaReceiver>
Inherited from DriftClient.getReceiverProgram
- Defined in sdk/src/driftClient.ts:7697

getRecenterPerpMarketAmmIx

getRecenterPerpMarketAmmIx(perpMarketIndex: number, pegMultiplier: BN, sqrtK: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- pegMultiplier: BN
- sqrtK: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:759

getReclaimRentIx

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

getReferredUserStatsAccountsByReferrer

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

getReferrerNameAccountsForAuthority

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

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:1815

getRemainingAccounts

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

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:2857

getRemovePerpLpSharesIx

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

getRepegAmmCurveIx

getRepegAmmCurveIx(newPeg: BN, perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- newPeg: BN
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:897

getResetPerpMarketAmmOracleTwapIx

getResetPerpMarketAmmOracleTwapIx(perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:966

getResolvePerpBankruptcyIx

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

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:7526

getResolveSpotBankruptcyIx

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

getRevertFillIx

getRevertFillIx(fillerPublicKey?: PublicKey): Promise<TransactionInstruction>
Parameters
- Optional fillerPublicKey: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getRevertFillIx
- Defined in sdk/src/driftClient.ts:3751

getSerumV3FulfillmentConfig

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

getSerumV3FulfillmentConfigs

getSerumV3FulfillmentConfigs(): Promise<SerumV3FulfillmentConfigAccount[]>
Returns Promise<SerumV3FulfillmentConfigAccount[]>
Inherited from DriftClient.getSerumV3FulfillmentConfigs
- Defined in sdk/src/driftClient.ts:580

getSetUserStatusToBeingLiquidatedIx

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

getSettleExpiredMarketIx

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

getSettleFundingPaymentIx

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

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:6231

getSettleRevenueToInsuranceFundIx

getSettleRevenueToInsuranceFundIx(spotMarketIndex: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getSettleRevenueToInsuranceFundIx
- Defined in sdk/src/driftClient.ts:7487

getSignerPublicKey

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

getSpotMarketAccount

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

getSpotMarketAccounts

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

getSpotPosition

getSpotPosition(marketIndex: number, subAccountId?: number): SpotPosition
Parameters
- marketIndex: number
- Optional subAccountId: number
Returns SpotPosition
Inherited from DriftClient.getSpotPosition
- Defined in sdk/src/driftClient.ts:1553

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:4731

getStateAccount

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

getStatePublicKey

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

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:4610

getSwitchboardOnDemandProgram

getSwitchboardOnDemandProgram(): Promise<Program<Idl>>
Returns Promise<Program<Idl>>
Inherited from DriftClient.getSwitchboardOnDemandProgram
- Defined in sdk/src/driftClient.ts:7708

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:1571

getTokenProgramForSpotMarket

getTokenProgramForSpotMarket(spotMarketAccount: SpotMarketAccount): PublicKey
Parameters
- spotMarketAccount: SpotMarketAccount
Returns PublicKey
Inherited from DriftClient.getTokenProgramForSpotMarket
- Defined in sdk/src/driftClient.ts:2158

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:2689

getTriggerOrderIx

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

getUpdateAMMsIx

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

getUpdateAdminIx

getUpdateAdminIx(admin: PublicKey): Promise<TransactionInstruction>
Parameters
- admin: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1084

getUpdateAdvancedDlpIx

getUpdateAdvancedDlpIx(advancedLp: boolean, subAccountId: number): Promise<TransactionInstruction>
Parameters
- advancedLp: boolean
- subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateAdvancedDlpIx
- Defined in sdk/src/driftClient.ts:1227

getUpdateAmmJitIntensityIx

getUpdateAmmJitIntensityIx(perpMarketIndex: number, ammJitIntensity: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- ammJitIntensity: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1364

getUpdateDiscountMintIx

getUpdateDiscountMintIx(discountMint: PublicKey): Promise<TransactionInstruction>
Parameters
- discountMint: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2604

getUpdateExchangeStatusIx

getUpdateExchangeStatusIx(exchangeStatus: ExchangeStatus): Promise<TransactionInstruction>
Parameters
- exchangeStatus: ExchangeStatus
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2949

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:6900

getUpdateInitialPctToLiquidateIx

getUpdateInitialPctToLiquidateIx(initialPctToLiquidate: number): Promise<TransactionInstruction>
Parameters
- initialPctToLiquidate: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1590

getUpdateInsuranceFundUnstakingPeriodIx

getUpdateInsuranceFundUnstakingPeriodIx(spotMarketIndex: number, insuranceWithdrawEscrowPeriod: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- insuranceWithdrawEscrowPeriod: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2040

getUpdateKIx

getUpdateKIx(perpMarketIndex: number, sqrtK: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- sqrtK: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:722

getUpdateLiquidationDurationIx

getUpdateLiquidationDurationIx(liquidationDuration: number): Promise<TransactionInstruction>
Parameters
- liquidationDuration: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1619

getUpdateLiquidationMarginBufferRatioIx

getUpdateLiquidationMarginBufferRatioIx(updateLiquidationMarginBufferRatio: number): Promise<TransactionInstruction>
Parameters
- updateLiquidationMarginBufferRatio: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1652

getUpdateLpCooldownTimeIx

getUpdateLpCooldownTimeIx(cooldownTime: BN): Promise<TransactionInstruction>
Parameters
- cooldownTime: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2075

getUpdateMaxSlippageRatioIx

getUpdateMaxSlippageRatioIx(perpMarketIndex: number, maxSlippageRatio: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- maxSlippageRatio: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3076

getUpdateOracleGuardRailsIx

getUpdateOracleGuardRailsIx(oracleGuardRails: OracleGuardRails): Promise<TransactionInstruction>
Parameters
- oracleGuardRails: OracleGuardRails
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1682

getUpdatePerpAuctionDurationIx

getUpdatePerpAuctionDurationIx(minDuration: number | BN): Promise<TransactionInstruction>
Parameters
- minDuration: number | BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2975

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:6966

getUpdatePerpFeeStructureIx

getUpdatePerpFeeStructureIx(feeStructure: FeeStructure): Promise<TransactionInstruction>
Parameters
- feeStructure: FeeStructure
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1537

getUpdatePerpMarketAmmOracleTwapIx

getUpdatePerpMarketAmmOracleTwapIx(perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:932

getUpdatePerpMarketAmmSummaryStatsIx

getUpdatePerpMarketAmmSummaryStatsIx(perpMarketIndex: number, updateAmmSummaryStats?: boolean, quoteAssetAmountWithUnsettledLp?: BN, netUnsettledFundingPnl?: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional updateAmmSummaryStats: boolean
- Optional quoteAssetAmountWithUnsettledLp: BN
- Optional netUnsettledFundingPnl: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1177

getUpdatePerpMarketBaseSpreadIx

getUpdatePerpMarketBaseSpreadIx(perpMarketIndex: number, baseSpread: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- baseSpread: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1327

getUpdatePerpMarketConcentrationScaleIx

getUpdatePerpMarketConcentrationScaleIx(perpMarketIndex: number, concentrationScale: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- concentrationScale: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:801

getUpdatePerpMarketContractTierIx

getUpdatePerpMarketContractTierIx(perpMarketIndex: number, contractTier: ContractTier): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- contractTier: ContractTier
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2914

getUpdatePerpMarketCurveUpdateIntensityIx

getUpdatePerpMarketCurveUpdateIntensityIx(perpMarketIndex: number, curveUpdateIntensity: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- curveUpdateIntensity: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1116

getUpdatePerpMarketExpiryIx

getUpdatePerpMarketExpiryIx(perpMarketIndex: number, expiryTs: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- expiryTs: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2314

getUpdatePerpMarketFeeAdjustmentIx

getUpdatePerpMarketFeeAdjustmentIx(perpMarketIndex: number, feeAdjustment: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- feeAdjustment: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3281

getUpdatePerpMarketFuelIx

getUpdatePerpMarketFuelIx(perpMarketIndex: number, fuelBoostTaker?: number, fuelBoostMaker?: number, fuelBoostPosition?: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional fuelBoostTaker: number
- Optional fuelBoostMaker: number
- Optional fuelBoostPosition: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3733

getUpdatePerpMarketImfFactorIx

getUpdatePerpMarketImfFactorIx(perpMarketIndex: number, imfFactor: number, unrealizedPnlImfFactor: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- imfFactor: number
- unrealizedPnlImfFactor: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1290

getUpdatePerpMarketLiquidationFeeIx

getUpdatePerpMarketLiquidationFeeIx(perpMarketIndex: number, liquidatorFee: number, ifLiquidationFee: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- liquidatorFee: number
- ifLiquidationFee: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3385

getUpdatePerpMarketMarginRatioIx

getUpdatePerpMarketMarginRatioIx(perpMarketIndex: number, marginRatioInitial: number, marginRatioMaintenance: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- marginRatioInitial: number
- marginRatioMaintenance: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1248

getUpdatePerpMarketMaxFillReserveFractionIx

getUpdatePerpMarketMaxFillReserveFractionIx(perpMarketIndex: number, maxBaseAssetAmountRatio: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- maxBaseAssetAmountRatio: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3039

getUpdatePerpMarketMaxImbalancesIx

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

getUpdatePerpMarketMaxOpenInterestIx

getUpdatePerpMarketMaxOpenInterestIx(perpMarketIndex: number, maxOpenInterest: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- maxOpenInterest: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3201

getUpdatePerpMarketMaxSpreadIx

getUpdatePerpMarketMaxSpreadIx(perpMarketIndex: number, maxSpread: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- maxSpread: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1503

getUpdatePerpMarketMinOrderSizeIx

getUpdatePerpMarketMinOrderSizeIx(perpMarketIndex: number, orderSize: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- orderSize: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2188

getUpdatePerpMarketNameIx

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

getUpdatePerpMarketNumberOfUsersIx

getUpdatePerpMarketNumberOfUsersIx(perpMarketIndex: number, numberOfUsers?: number, numberOfUsersWithBase?: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional numberOfUsers: number
- Optional numberOfUsersWithBase: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3241

getUpdatePerpMarketOracleIx

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

getUpdatePerpMarketPausedOperationsIx

getUpdatePerpMarketPausedOperationsIx(perpMarketIndex: number, pausedOperations: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- pausedOperations: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2876

getUpdatePerpMarketPerLpBaseIx

getUpdatePerpMarketPerLpBaseIx(perpMarketIndex: number, perLpBase: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- perLpBase: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1469

getUpdatePerpMarketStatusIx

getUpdatePerpMarketStatusIx(perpMarketIndex: number, marketStatus: MarketStatus): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- marketStatus: MarketStatus
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2841

getUpdatePerpMarketStepSizeAndTickSizeIx

getUpdatePerpMarketStepSizeAndTickSizeIx(perpMarketIndex: number, stepSize: BN, tickSize: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- stepSize: BN
- tickSize: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2151

getUpdatePerpMarketTargetBaseAssetAmountPerLpIx

getUpdatePerpMarketTargetBaseAssetAmountPerLpIx(perpMarketIndex: number, targetBaseAssetAmountPerLP: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- targetBaseAssetAmountPerLP: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1208

getUpdatePerpMarketUnrealizedAssetWeightIx

getUpdatePerpMarketUnrealizedAssetWeightIx(perpMarketIndex: number, unrealizedInitialAssetWeight: number, unrealizedMaintenanceAssetWeight: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- unrealizedInitialAssetWeight: number
- unrealizedMaintenanceAssetWeight: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3115

getUpdatePhoenixFulfillmentConfigStatusIx

getUpdatePhoenixFulfillmentConfigStatusIx(phoenixFulfillmentConfig: PublicKey, status: SpotFulfillmentConfigStatus): Promise<TransactionInstruction>
Parameters
- phoenixFulfillmentConfig: PublicKey
- status: SpotFulfillmentConfigStatus
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2511

getUpdatePrelaunchOracleIx

getUpdatePrelaunchOracleIx(perpMarketIndex: number): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdatePrelaunchOracleIx
- Defined in sdk/src/driftClient.ts:6932

getUpdatePrelaunchOracleParamsIx

getUpdatePrelaunchOracleParamsIx(perpMarketIndex: number, price?: BN, maxPrice?: BN): Promise<TransactionInstruction>
Parameters
- perpMarketIndex: number
- Optional price: BN
- Optional maxPrice: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3584

getUpdateProtocolIfSharesTransferConfigIx

getUpdateProtocolIfSharesTransferConfigIx(whitelistedSigners?: PublicKey[], maxTransferPerEpoch?: BN): Promise<TransactionInstruction>
Parameters
- Optional whitelistedSigners: PublicKey[]
- Optional maxTransferPerEpoch: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3499

getUpdatePythPullOracleIxs

getUpdatePythPullOracleIxs(params: {
    merklePriceUpdate: {
        message: Buffer;
        proof: number[][];
    };
}, feedId: string, encodedVaaAddress: PublicKey): Promise<TransactionInstruction>
Parameters
- params: {
      merklePriceUpdate: {
          message: Buffer;
          proof: number[][];
      };
  }
  - merklePriceUpdate: {
    message: Buffer;
    proof: number[][];
    }
    - message: Buffer
    - proof: number[][]
- feedId: string
- encodedVaaAddress: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdatePythPullOracleIxs
- Defined in sdk/src/driftClient.ts:7897

getUpdateSerumFulfillmentConfigStatusIx

getUpdateSerumFulfillmentConfigStatusIx(serumFulfillmentConfig: PublicKey, status: SpotFulfillmentConfigStatus): Promise<TransactionInstruction>
Parameters
- serumFulfillmentConfig: PublicKey
- status: SpotFulfillmentConfigStatus
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2469

getUpdateSerumVaultIx

getUpdateSerumVaultIx(srmVault: PublicKey): Promise<TransactionInstruction>
Parameters
- srmVault: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3352

getUpdateSpotAuctionDurationIx

getUpdateSpotAuctionDurationIx(defaultAuctionDuration: number): Promise<TransactionInstruction>
Parameters
- defaultAuctionDuration: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3004

getUpdateSpotFeeStructureIx

getUpdateSpotFeeStructureIx(feeStructure: FeeStructure): Promise<TransactionInstruction>
Parameters
- feeStructure: FeeStructure
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1564

getUpdateSpotMarketAssetTierIx

getUpdateSpotMarketAssetTierIx(spotMarketIndex: number, assetTier: AssetTier): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- assetTier: AssetTier
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2735

getUpdateSpotMarketBorrowRateIx

getUpdateSpotMarketBorrowRateIx(spotMarketIndex: number, optimalUtilization: number, optimalBorrowRate: number, optimalMaxRate: number, minBorrowRate?: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- optimalUtilization: number
- optimalBorrowRate: number
- optimalMaxRate: number
- Optional minBorrowRate: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2694

getUpdateSpotMarketExpiryIx

getUpdateSpotMarketExpiryIx(spotMarketIndex: number, expiryTs: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- expiryTs: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2545

getUpdateSpotMarketFeeAdjustmentIx

getUpdateSpotMarketFeeAdjustmentIx(spotMarketIndex: number, feeAdjustment: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- feeAdjustment: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3319

getUpdateSpotMarketFuelIx

getUpdateSpotMarketFuelIx(spotMarketIndex: number, fuelBoostDeposits?: number, fuelBoostBorrows?: number, fuelBoostTaker?: number, fuelBoostMaker?: number, fuelBoostInsurance?: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- Optional fuelBoostDeposits: number
- Optional fuelBoostBorrows: number
- Optional fuelBoostTaker: number
- Optional fuelBoostMaker: number
- Optional fuelBoostInsurance: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3683

getUpdateSpotMarketIfFactorIx

getUpdateSpotMarketIfFactorIx(spotMarketIndex: number, userIfFactor: BN, totalIfFactor: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- userIfFactor: BN
- totalIfFactor: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1841

getUpdateSpotMarketIfPausedOperationsIx

getUpdateSpotMarketIfPausedOperationsIx(spotMarketIndex: number, pausedOperations: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- pausedOperations: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2429

getUpdateSpotMarketLiquidationFeeIx

getUpdateSpotMarketLiquidationFeeIx(spotMarketIndex: number, liquidatorFee: number, ifLiquidationFee: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- liquidatorFee: number
- ifLiquidationFee: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:3427

getUpdateSpotMarketMarginWeightsIx

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

getUpdateSpotMarketMaxTokenBorrowsIx

getUpdateSpotMarketMaxTokenBorrowsIx(spotMarketIndex: number, maxTokenBorrowsFraction: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- maxTokenBorrowsFraction: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1960

getUpdateSpotMarketMaxTokenDepositsIx

getUpdateSpotMarketMaxTokenDepositsIx(spotMarketIndex: number, maxTokenDeposits: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- maxTokenDeposits: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1922

getUpdateSpotMarketMinOrderSizeIx

getUpdateSpotMarketMinOrderSizeIx(spotMarketIndex: number, orderSize: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- orderSize: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2278

getUpdateSpotMarketNameIx

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

getUpdateSpotMarketOracleIx

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

getUpdateSpotMarketOrdersEnabledIx

getUpdateSpotMarketOrdersEnabledIx(spotMarketIndex: number, ordersEnabled: boolean): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- ordersEnabled: boolean
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2391

getUpdateSpotMarketPausedOperationsIx

getUpdateSpotMarketPausedOperationsIx(spotMarketIndex: number, pausedOperations: number): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- pausedOperations: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2804

getUpdateSpotMarketRevenueSettlePeriodIx

getUpdateSpotMarketRevenueSettlePeriodIx(spotMarketIndex: number, revenueSettlePeriod: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- revenueSettlePeriod: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1884

getUpdateSpotMarketScaleInitialAssetWeightStartIx

getUpdateSpotMarketScaleInitialAssetWeightStartIx(spotMarketIndex: number, scaleInitialAssetWeightStart: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- scaleInitialAssetWeightStart: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2000

getUpdateSpotMarketStatusIx

getUpdateSpotMarketStatusIx(spotMarketIndex: number, marketStatus: MarketStatus): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- marketStatus: MarketStatus
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2769

getUpdateSpotMarketStepSizeAndTickSizeIx

getUpdateSpotMarketStepSizeAndTickSizeIx(spotMarketIndex: number, stepSize: BN, tickSize: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- stepSize: BN
- tickSize: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2230

getUpdateStateMaxInitializeUserFeeIx

getUpdateStateMaxInitializeUserFeeIx(maxInitializeUserFee: number): Promise<TransactionInstruction>
Parameters
- maxInitializeUserFee: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1769

getUpdateStateMaxNumberOfSubAccountsIx

getUpdateStateMaxNumberOfSubAccountsIx(maxNumberOfSubAccounts: number): Promise<TransactionInstruction>
Parameters
- maxNumberOfSubAccounts: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1740

getUpdateStateSettlementDurationIx

getUpdateStateSettlementDurationIx(settlementDuration: number): Promise<TransactionInstruction>
Parameters
- settlementDuration: number
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1711

getUpdateUserCustomMarginRatioIx

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

getUpdateUserGovTokenInsuranceStakeIx

getUpdateUserGovTokenInsuranceStakeIx(authority: PublicKey): Promise<TransactionInstruction>
Parameters
- authority: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserGovTokenInsuranceStakeIx
- Defined in sdk/src/driftClient.ts:7446

getUpdateUserIdleIx

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

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:1138

getUpdateUserOpenOrdersCountIx

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

getUpdateUserQuoteAssetInsuranceStakeIx

getUpdateUserQuoteAssetInsuranceStakeIx(authority: PublicKey): Promise<TransactionInstruction>
Parameters
- authority: PublicKey
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserQuoteAssetInsuranceStakeIx
- Defined in sdk/src/driftClient.ts:7405

getUpdateUserReduceOnlyIx

getUpdateUserReduceOnlyIx(reduceOnly: boolean, subAccountId: number): Promise<TransactionInstruction>
Parameters
- reduceOnly: boolean
- subAccountId: number
Returns Promise<TransactionInstruction>
Inherited from DriftClient.getUpdateUserReduceOnlyIx
- Defined in sdk/src/driftClient.ts:1264

getUpdateWhitelistMintIx

getUpdateWhitelistMintIx(whitelistMint?: PublicKey): Promise<TransactionInstruction>
Parameters
- Optional whitelistMint: PublicKey
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:2577

getUpdateWithdrawGuardThresholdIx

getUpdateWithdrawGuardThresholdIx(spotMarketIndex: number, withdrawGuardThreshold: BN): Promise<TransactionInstruction>
Parameters
- spotMarketIndex: number
- withdrawGuardThreshold: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/adminClient.ts:1802

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:1459

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:1529

getUserAccountAndSlot

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

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:1522

getUserAccountsAndAddressesForAuthority

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

getUserAccountsForAuthority

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

getUserAccountsForDelegate

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

getUserDeletionIx

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

getUserMapKey

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

getUserStats

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

getUserStatsAccountPublicKey

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

getUsers

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

getWithdrawIx

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

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:2102

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:1470

initUserFuel

initUserFuel(user: PublicKey, authority: PublicKey, fuelBonusDeposits?: number, fuelBonusBorrows?: number, fuelBonusTaker?: number, fuelBonusMaker?: number, fuelBonusInsurance?: number): Promise<string>
Parameters
- user: PublicKey
- authority: PublicKey
- Optional fuelBonusDeposits: number
- Optional fuelBonusBorrows: number
- Optional fuelBonusTaker: number
- Optional fuelBonusMaker: number
- Optional fuelBonusInsurance: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3760

initialize

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

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:7057

initializeOpenbookV2FulfillmentConfig

initializeOpenbookV2FulfillmentConfig(marketIndex: number, openbookMarket: PublicKey): Promise<string>
Parameters
- marketIndex: number
- openbookMarket: PublicKey
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:396

initializePerpMarket

initializePerpMarket(marketIndex: number, priceOracle: PublicKey, baseAssetReserve: BN, quoteAssetReserve: BN, periodicity: BN, pegMultiplier?: BN, oracleSource?: OracleSource, contractTier?: ContractTier, marginRatioInitial?: number, marginRatioMaintenance?: number, liquidatorFee?: number, ifLiquidatorFee?: number, imfFactor?: number, activeStatus?: boolean, baseSpread?: number, maxSpread?: number, maxOpenInterest?: BN, maxRevenueWithdrawPerPeriod?: BN, quoteMaxInsurance?: BN, orderStepSize?: BN, orderTickSize?: BN, minOrderSize?: BN, concentrationCoefScale?: BN, curveUpdateIntensity?: number, ammJitIntensity?: number, name?: string): Promise<string>
Parameters
- marketIndex: number
- priceOracle: PublicKey
- baseAssetReserve: BN
- quoteAssetReserve: BN
- periodicity: BN
- pegMultiplier: BN = PEG_PRECISION
- oracleSource: OracleSource = OracleSource.PYTH
- contractTier: ContractTier = ContractTier.SPECULATIVE
- marginRatioInitial: number = 2000
- marginRatioMaintenance: number = 500
- liquidatorFee: number = 0
- ifLiquidatorFee: number = 10000
- imfFactor: number = 0
- activeStatus: boolean = true
- baseSpread: number = 0
- maxSpread: number = 142500
- maxOpenInterest: BN = ZERO
- maxRevenueWithdrawPerPeriod: BN = ZERO
- quoteMaxInsurance: BN = ZERO
- orderStepSize: BN = ...
- orderTickSize: BN = ...
- minOrderSize: BN = ...
- concentrationCoefScale: BN = ONE
- curveUpdateIntensity: number = 0
- ammJitIntensity: number = 0
- name: string = DEFAULT_MARKET_NAME
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:442

initializePhoenixFulfillmentConfig

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

initializePredictionMarket

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

initializePrelaunchOracle

initializePrelaunchOracle(perpMarketIndex: number, price?: BN, maxPrice?: BN): Promise<string>
Parameters
- perpMarketIndex: number
- Optional price: BN
- Optional maxPrice: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3519

initializeProtocolIfSharesTransferConfig

initializeProtocolIfSharesTransferConfig(): Promise<string>
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3450

initializePythPullOracle

initializePythPullOracle(feedId: string): Promise<string>
Parameters
- feedId: string
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3816

initializeReferrerName

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

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:295

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, ifLiquidationFee?: number, activeStatus?: boolean, assetTier?: {
collateral: {};
}, scaleInitialAssetWeightStart?: BN, withdrawGuardThreshold?: BN, orderTickSize?: BN, orderStepSize?: BN, ifTotalFactor?: number, name?: string, marketIndex?: number): 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
- ifLiquidationFee: number = 0
- activeStatus: boolean = true
- assetTier: {
  collateral: {};
  } = AssetTier.COLLATERAL
  - collateral: {}
- scaleInitialAssetWeightStart: BN = ZERO
- withdrawGuardThreshold: BN = ZERO
- orderTickSize: BN = ONE
- orderStepSize: BN = ONE
- ifTotalFactor: number = 0
- name: string = DEFAULT_MARKET_NAME
- Optional marketIndex: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:94

initializeUserAccount

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

initializeUserAccountAndDepositCollateral

initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, marketIndex?: number, subAccountId?: number, name?: string, fromSubAccountId?: number, referrerInfo?: ReferrerInfo, donateAmount?: BN, txParams?: TxParams, customMaxMarginRatio?: number): 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
- Optional name: string
- Optional fromSubAccountId: number
- Optional referrerInfo: ReferrerInfo
- Optional donateAmount: BN
- Optional txParams: TxParams
- Optional customMaxMarginRatio: number
Returns Promise<[string, PublicKey]>
Inherited from DriftClient.initializeUserAccountAndDepositCollateral
- Defined in sdk/src/driftClient.ts:2357

initializeUserAccountForDevnet

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

liquidateBorrowForPerpPnl

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

liquidatePerp

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

liquidatePerpPnlForDeposit

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

liquidatePerpWithFill

liquidatePerpWithFill(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: number, makerInfos: MakerInfo[], txParams?: TxParams, liquidatorSubAccountId?: number): Promise<string>
Parameters
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- marketIndex: number
- makerInfos: MakerInfo[]
- Optional txParams: TxParams
- Optional liquidatorSubAccountId: number
Returns Promise<string>
Inherited from DriftClient.liquidatePerpWithFill
- Defined in sdk/src/driftClient.ts:6451

liquidateSpot

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

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, subAccountId?: number): 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
- Optional subAccountId: number
Returns Promise<string>
Inherited from DriftClient.modifyOrder
- Defined in sdk/src/driftClient.ts:5948

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, subAccountId?: number): 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
- Optional subAccountId: number
Returns Promise<string>
Inherited from DriftClient.modifyOrderByUserOrderId
- Defined in sdk/src/driftClient.ts:6070

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:5893

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:5916

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:658

moveAmmToPrice

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

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:1628

openPosition

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

placeAndMakePerpOrder

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

placeAndMakeSpotOrder

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

placeAndMakeSwiftPerpOrder

placeAndMakeSwiftPerpOrder(encodedSwiftMessage: Buffer, swiftSignature: Buffer, encodedSwiftOrderParamsMessage: Buffer, swiftOrderParamsSignature: Buffer, takerExpectedOrderId: number, takerInfo: {
    taker: PublicKey;
    takerStats: PublicKey;
    takerUserAccount: UserAccount;
}, orderParams: OptionalOrderParams, referrerInfo?: ReferrerInfo, txParams?: TxParams, subAccountId?: number): Promise<string>
Parameters
- encodedSwiftMessage: Buffer
- swiftSignature: Buffer
- encodedSwiftOrderParamsMessage: Buffer
- swiftOrderParamsSignature: Buffer
- takerExpectedOrderId: number
- takerInfo: {
      taker: PublicKey;
      takerStats: PublicKey;
      takerUserAccount: UserAccount;
  }
  - taker: PublicKey
  - takerStats: PublicKey
  - takerUserAccount: UserAccount
- orderParams: OptionalOrderParams
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
- Optional subAccountId: number
Returns Promise<string>
Inherited from DriftClient.placeAndMakeSwiftPerpOrder
- Defined in sdk/src/driftClient.ts:5524

placeAndTakePerpOrder

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

placeAndTakePerpWithAdditionalOrders

placeAndTakePerpWithAdditionalOrders(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, bracketOrdersParams?: OptionalOrderParams[], txParams?: TxParams, subAccountId?: number, cancelExistingOrders?: boolean, settlePnl?: boolean, exitEarlyIfSimFails?: boolean): Promise<{
    signedCancelExistingOrdersTx?: Transaction;
    signedSettlePnlTx?: Transaction;
    txSig: string;
}>
Parameters
- orderParams: OptionalOrderParams
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
- bracketOrdersParams: OptionalOrderParams[] = ...
- Optional txParams: TxParams
- Optional subAccountId: number
- Optional cancelExistingOrders: boolean
- Optional settlePnl: boolean
- Optional exitEarlyIfSimFails: boolean
Returns Promise<{
    signedCancelExistingOrdersTx?: Transaction;
    signedSettlePnlTx?: Transaction;
    txSig: string;
}>
Inherited from DriftClient.placeAndTakePerpWithAdditionalOrders
- Defined in sdk/src/driftClient.ts:5167

placeAndTakeSpotOrder

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

placeOrders

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

placePerpOrder

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

placeSpotOrder

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

placeSwiftTakerOrder

placeSwiftTakerOrder(swiftServerMessage: Buffer, swiftSignature: Buffer, swiftOrderParamsMessage: Buffer, swiftOrderParamsSignature: Buffer, marketIndex: number, takerInfo: {
    taker: PublicKey;
    takerStats: PublicKey;
    takerUserAccount: UserAccount;
}, txParams?: TxParams): Promise<string>
Parameters
- swiftServerMessage: Buffer
- swiftSignature: Buffer
- swiftOrderParamsMessage: Buffer
- swiftOrderParamsSignature: Buffer
- marketIndex: number
- takerInfo: {
      taker: PublicKey;
      takerStats: PublicKey;
      takerUserAccount: UserAccount;
  }
  - taker: PublicKey
  - takerStats: PublicKey
  - takerUserAccount: UserAccount
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.placeSwiftTakerOrder
- Defined in sdk/src/driftClient.ts:5439

postMultiPythPullOracleUpdatesAtomic

postMultiPythPullOracleUpdatesAtomic(vaaString: string, feedIds: string[]): Promise<string>
Parameters
- vaaString: string
- feedIds: string[]
Returns Promise<string>
Inherited from DriftClient.postMultiPythPullOracleUpdatesAtomic
- Defined in sdk/src/driftClient.ts:7733

postPythPullOracleUpdateAtomic

postPythPullOracleUpdateAtomic(vaaString: string, feedId: string): Promise<string>
Parameters
- vaaString: string
- feedId: string
Returns Promise<string>
Inherited from DriftClient.postPythPullOracleUpdateAtomic
- Defined in sdk/src/driftClient.ts:7719

postSwitchboardOnDemandUpdate

postSwitchboardOnDemandUpdate(feed: PublicKey, numSignatures?: number): Promise<string>
Parameters
- feed: PublicKey
- numSignatures: number = 3
Returns Promise<string>
Inherited from DriftClient.postSwitchboardOnDemandUpdate
- Defined in sdk/src/driftClient.ts:7955

prepareMarketOrderTxs

prepareMarketOrderTxs(orderParams: OptionalOrderParams, userAccountPublicKey: PublicKey, userAccount: UserAccount, makerInfo?: MakerInfo | MakerInfo[], txParams?: TxParams, bracketOrdersParams?: OptionalOrderParams[], referrerInfo?: ReferrerInfo, cancelExistingOrders?: boolean, settlePnl?: boolean): Promise<{
    cancelExistingOrdersTx?: Transaction | VersionedTransaction;
    fillTx?: Transaction | VersionedTransaction;
    marketOrderTx: Transaction | VersionedTransaction;
    settlePnlTx?: Transaction | VersionedTransaction;
}>
Parameters
- orderParams: OptionalOrderParams
- userAccountPublicKey: PublicKey
- userAccount: UserAccount
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional txParams: TxParams
- bracketOrdersParams: OptionalOrderParams[] = ...
- Optional referrerInfo: ReferrerInfo
- Optional cancelExistingOrders: boolean
- Optional settlePnl: boolean
Returns Promise<{
    cancelExistingOrdersTx?: Transaction | VersionedTransaction;
    fillTx?: Transaction | VersionedTransaction;
    marketOrderTx: Transaction | VersionedTransaction;
    settlePnlTx?: Transaction | VersionedTransaction;
}>
Inherited from DriftClient.prepareMarketOrderTxs
- Defined in sdk/src/driftClient.ts:3038

preparePlaceAndTakePerpOrderWithAdditionalOrders

preparePlaceAndTakePerpOrderWithAdditionalOrders(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, bracketOrdersParams?: OptionalOrderParams[], txParams?: TxParams, subAccountId?: number, cancelExistingOrders?: boolean, settlePnl?: boolean, exitEarlyIfSimFails?: boolean): Promise<{
    cancelExistingOrdersTx: Transaction | VersionedTransaction;
    placeAndTakeTx: Transaction | VersionedTransaction;
    settlePnlTx: Transaction | VersionedTransaction;
}>
Parameters
- orderParams: OptionalOrderParams
- Optional makerInfo: MakerInfo | MakerInfo[]
- Optional referrerInfo: ReferrerInfo
- bracketOrdersParams: OptionalOrderParams[] = ...
- Optional txParams: TxParams
- Optional subAccountId: number
- Optional cancelExistingOrders: boolean
- Optional settlePnl: boolean
- Optional exitEarlyIfSimFails: boolean
Returns Promise<{
    cancelExistingOrdersTx: Transaction | VersionedTransaction;
    placeAndTakeTx: Transaction | VersionedTransaction;
    settlePnlTx: Transaction | VersionedTransaction;
}>
Inherited from DriftClient.preparePlaceAndTakePerpOrderWithAdditionalOrders
- Defined in sdk/src/driftClient.ts:5001

preparePlaceAndTakeSpotOrder

preparePlaceAndTakeSpotOrder(orderParams: OptionalOrderParams, fulfillmentConfig?: SerumV3FulfillmentConfigAccount, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo, txParams?: TxParams, subAccountId?: number): Promise<{
placeAndTakeSpotOrderTx: Transaction | VersionedTransaction;
}>
Parameters
- orderParams: OptionalOrderParams
- Optional fulfillmentConfig: SerumV3FulfillmentConfigAccount
- Optional makerInfo: MakerInfo
- Optional referrerInfo: ReferrerInfo
- Optional txParams: TxParams
- Optional subAccountId: number
Returns Promise<{
placeAndTakeSpotOrderTx: Transaction | VersionedTransaction;
}>
Inherited from DriftClient.preparePlaceAndTakeSpotOrder
- Defined in sdk/src/driftClient.ts:5639

preparePlaceOrdersTx

preparePlaceOrdersTx(params: OrderParams[], txParams?: TxParams, subAccountId?: number): Promise<{
placeOrdersTx: Transaction | VersionedTransaction;
}>
Parameters
- params: OrderParams[]
- Optional txParams: TxParams
- Optional subAccountId: number
Returns Promise<{
placeOrdersTx: Transaction | VersionedTransaction;
}>
Inherited from DriftClient.preparePlaceOrdersTx
- Defined in sdk/src/driftClient.ts:3588

preparePlaceSpotOrderTx

preparePlaceSpotOrderTx(orderParams: OptionalOrderParams, txParams?: TxParams, subAccountId?: number): Promise<{
placeSpotOrderTx: Transaction | VersionedTransaction;
}>
Parameters
- orderParams: OptionalOrderParams
- Optional txParams: TxParams
- Optional subAccountId: number
Returns Promise<{
placeSpotOrderTx: Transaction | VersionedTransaction;
}>
Inherited from DriftClient.preparePlaceSpotOrderTx
- Defined in sdk/src/driftClient.ts:3784

recenterPerpMarketAmm

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

reclaimRent

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

removeInsuranceFundStake

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

removePerpLpShares

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

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:2836

repegAmmCurve

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

requestRemoveInsuranceFundStake

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

resetPerpMarketAmmOracleTwap

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

resolvePerpBankruptcy

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

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:7510

resolveSpotBankruptcy

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

sendMarketOrderAndGetSignedFillTx

sendMarketOrderAndGetSignedFillTx(orderParams: OptionalOrderParams, userAccountPublicKey: PublicKey, userAccount: UserAccount, makerInfo?: MakerInfo | MakerInfo[], txParams?: TxParams, bracketOrdersParams?: OptionalOrderParams[], referrerInfo?: ReferrerInfo, cancelExistingOrders?: boolean, settlePnl?: boolean): Promise<{
    signedCancelExistingOrdersTx?: Transaction;
    signedFillTx?: Transaction;
    signedSettlePnlTx?: 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
- Optional cancelExistingOrders: boolean
  
  Builds and returns an extra transaciton to cancel the existing orders in the same perp market. Intended use is to auto-cancel TP/SL orders when closing a position. Ignored if orderParams.marketType is not MarketType.PERP
- Optional settlePnl: boolean
Returns Promise<{
    signedCancelExistingOrdersTx?: Transaction;
    signedFillTx?: Transaction;
    signedSettlePnlTx?: Transaction;
    txSig: string;
}>
Inherited from DriftClient.sendMarketOrderAndGetSignedFillTx
- Defined in sdk/src/driftClient.ts:3137

sendSignedTx

sendSignedTx(tx: Transaction | VersionedTransaction, opts?: ConfirmOptions): Promise<string>
Parameters
- tx: Transaction | VersionedTransaction
- Optional opts: ConfirmOptions
Returns Promise<string>
Inherited from DriftClient.sendSignedTx
- Defined in sdk/src/driftClient.ts:3024

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:8070

setUserStatusToBeingLiquidated

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

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:3295

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:3335

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:6998

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:2777

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:2793

settleMultiplePNLs

settleMultiplePNLs(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndexes: number[], mode: SettlePnlMode, txParams?: TxParams): Promise<string>
Parameters
- settleeUserAccountPublicKey: PublicKey
- settleeUserAccount: UserAccount
- marketIndexes: number[]
- mode: SettlePnlMode
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settleMultiplePNLs
- Defined in sdk/src/driftClient.ts:6297

settleMultiplePNLsIx

settleMultiplePNLsIx(settleeUserAccountPublicKey: PublicKey, settleeUserAccount: UserAccount, marketIndexes: number[], mode: SettlePnlMode): Promise<TransactionInstruction>
Parameters
- settleeUserAccountPublicKey: PublicKey
- settleeUserAccount: UserAccount
- marketIndexes: number[]
- mode: SettlePnlMode
Returns Promise<TransactionInstruction>
Inherited from DriftClient.settleMultiplePNLsIx
- Defined in sdk/src/driftClient.ts:6320

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:6254

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:6275

settlePNLs

settlePNLs(users: {
    settleeUserAccount: UserAccount;
    settleeUserAccountPublicKey: PublicKey;
}[], marketIndexes: number[], opts?: {
    filterInvalidMarkets?: boolean;
}, txParams?: TxParams): Promise<string>
Parameters
- users: {
  settleeUserAccount: UserAccount;
  settleeUserAccountPublicKey: PublicKey;
  }[]
- marketIndexes: number[]
- Optional opts: {
  filterInvalidMarkets?: boolean;
  }
  - Optional filterInvalidMarkets?: boolean
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.settlePNLs
- Defined in sdk/src/driftClient.ts:6178

settleRevenueToInsuranceFund

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

signMessage

signMessage(message: Uint8Array, keypair?: Keypair): Promise<Buffer>
Parameters
- message: Uint8Array
- keypair: Keypair = ...
Returns Promise<Buffer>
Inherited from DriftClient.signMessage
- Defined in sdk/src/driftClient.ts:5432

signSwiftOrderParamsMessage

signSwiftOrderParamsMessage(orderParamsMessage: SwiftOrderParamsMessage): Promise<Buffer>
Parameters
- orderParamsMessage: SwiftOrderParamsMessage
Returns Promise<Buffer>
Inherited from DriftClient.signSwiftOrderParamsMessage
- Defined in sdk/src/driftClient.ts:5405

signSwiftServerMessage

signSwiftServerMessage(message: SwiftServerMessage): Promise<Buffer>
Parameters
- message: SwiftServerMessage
Returns Promise<Buffer>
Inherited from DriftClient.signSwiftServerMessage
- Defined in sdk/src/driftClient.ts:5396

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:4725

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

subscribeUsers

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

swap

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

switchActiveUser

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

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:2660

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:7041

triggerOrder

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

unsubscribe

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

unsubscribeUsers

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

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:3246

updateAdmin

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

updateAmmJitIntensity

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

updateDiscountMint

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

updateExchangeStatus

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

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:6884

updateInitialPctToLiquidate

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

updateInsuranceFundUnstakingPeriod

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

updateK

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

updateLiquidationDuration

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

updateLiquidationMarginBufferRatio

updateLiquidationMarginBufferRatio(updateLiquidationMarginBufferRatio: number): Promise<string>
Parameters
- updateLiquidationMarginBufferRatio: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1635

updateLpCooldownTime

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

updateMaxSlippageRatio

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

updateOracleGuardRails

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

updatePerpAuctionDuration

updatePerpAuctionDuration(minDuration: number | BN): Promise<string>
Parameters
- minDuration: number | BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:2962

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:6950

updatePerpFeeStructure

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

updatePerpMarketAmmOracleTwap

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

updatePerpMarketAmmSummaryStats

updatePerpMarketAmmSummaryStats(perpMarketIndex: number, updateAmmSummaryStats?: boolean, quoteAssetAmountWithUnsettledLp?: BN, netUnsettledFundingPnl?: BN): Promise<string>
Parameters
- perpMarketIndex: number
- Optional updateAmmSummaryStats: boolean
- Optional quoteAssetAmountWithUnsettledLp: BN
- Optional netUnsettledFundingPnl: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1156

updatePerpMarketBaseSpread

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

updatePerpMarketConcentrationScale

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

updatePerpMarketContractTier

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

updatePerpMarketCurveUpdateIntensity

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

updatePerpMarketExpiry

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

updatePerpMarketFeeAdjustment

updatePerpMarketFeeAdjustment(perpMarketIndex: number, feeAdjustment: number): Promise<string>
Parameters
- perpMarketIndex: number
- feeAdjustment: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3264

updatePerpMarketFuel

updatePerpMarketFuel(perpMarketIndex: number, fuelBoostTaker?: number, fuelBoostMaker?: number, fuelBoostPosition?: number): Promise<string>
Parameters
- perpMarketIndex: number
- Optional fuelBoostTaker: number
- Optional fuelBoostMaker: number
- Optional fuelBoostPosition: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3714

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:1271

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:3366

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:1229

updatePerpMarketMaxFillReserveFraction

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

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:3138

updatePerpMarketMaxOpenInterest

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

updatePerpMarketMaxSpread

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

updatePerpMarketMinOrderSize

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

updatePerpMarketName

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

updatePerpMarketNumberOfUser

updatePerpMarketNumberOfUser(perpMarketIndex: number, numberOfUsers?: number, numberOfUsersWithBase?: number): Promise<string>
Parameters
- perpMarketIndex: number
- Optional numberOfUsers: number
- Optional numberOfUsersWithBase: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3222

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:2088

updatePerpMarketPausedOperations

updatePerpMarketPausedOperations(perpMarketIndex: number, pausedOperations: number): Promise<string>
Parameters
- perpMarketIndex: number
- pausedOperations: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:2859

updatePerpMarketPerLpBase

updatePerpMarketPerLpBase(perpMarketIndex: number, perLpBase: number): Promise<string>
Parameters
- perpMarketIndex: number
- perLpBase: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1455

updatePerpMarketStatus

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

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:2130

updatePerpMarketTargetBaseAssetAmountPerLp

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

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:3094

updatePhoenixFulfillmentConfigStatus

updatePhoenixFulfillmentConfigStatus(phoenixFulfillmentConfig: PublicKey, status: SpotFulfillmentConfigStatus): Promise<string>
Parameters
- phoenixFulfillmentConfig: PublicKey
- status: SpotFulfillmentConfigStatus
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:2487

updatePrelaunchOracle

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

updatePrelaunchOracleParams

updatePrelaunchOracleParams(perpMarketIndex: number, price?: BN, maxPrice?: BN): Promise<string>
Parameters
- perpMarketIndex: number
- Optional price: BN
- Optional maxPrice: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3565

updateProtocolIfSharesTransferConfig

updateProtocolIfSharesTransferConfig(whitelistedSigners?: PublicKey[], maxTransferPerEpoch?: BN): Promise<string>
Parameters
- Optional whitelistedSigners: PublicKey[]
- Optional maxTransferPerEpoch: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3480

updatePythPullOracle

updatePythPullOracle(vaaString: string, feedId: string): Promise<string>
Parameters
- vaaString: string
- feedId: string
Returns Promise<string>
Inherited from DriftClient.updatePythPullOracle
- Defined in sdk/src/driftClient.ts:7856

updateSerumFulfillmentConfigStatus

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

updateSerumVault

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

updateSpotAuctionDuration

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

updateSpotFeeStructure

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

updateSpotMarketAssetTier

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

updateSpotMarketBorrowRate

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

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:2748

updateSpotMarketCumulativeInterestIx

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

updateSpotMarketExpiry

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

updateSpotMarketFeeAdjustment

updateSpotMarketFeeAdjustment(perpMarketIndex: number, feeAdjustment: number): Promise<string>
Parameters
- perpMarketIndex: number
- feeAdjustment: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3302

updateSpotMarketFuel

updateSpotMarketFuel(spotMarketIndex: number, fuelBoostDeposits?: number, fuelBoostBorrows?: number, fuelBoostTaker?: number, fuelBoostMaker?: number, fuelBoostInsurance?: number): Promise<string>
Parameters
- spotMarketIndex: number
- Optional fuelBoostDeposits: number
- Optional fuelBoostBorrows: number
- Optional fuelBoostTaker: number
- Optional fuelBoostMaker: number
- Optional fuelBoostInsurance: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:3660

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:1823

updateSpotMarketIfPausedOperations

updateSpotMarketIfPausedOperations(spotMarketIndex: number, pausedOperations: number): Promise<string>
Parameters
- spotMarketIndex: number
- pausedOperations: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:2412

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:3408

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:2617

updateSpotMarketMaxTokenBorrows

updateSpotMarketMaxTokenBorrows(spotMarketIndex: number, maxTokenBorrowsFraction: number): Promise<string>
Parameters
- spotMarketIndex: number
- maxTokenBorrowsFraction: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1943

updateSpotMarketMaxTokenDeposits

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

updateSpotMarketMinOrderSize

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

updateSpotMarketName

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

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:2332

updateSpotMarketOrdersEnabled

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

updateSpotMarketPausedOperations

updateSpotMarketPausedOperations(spotMarketIndex: number, pausedOperations: number): Promise<string>
Parameters
- spotMarketIndex: number
- pausedOperations: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:2787

updateSpotMarketRevenueSettlePeriod

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

updateSpotMarketScaleInitialAssetWeightStart

updateSpotMarketScaleInitialAssetWeightStart(spotMarketIndex: number, scaleInitialAssetWeightStart: BN): Promise<string>
Parameters
- spotMarketIndex: number
- scaleInitialAssetWeightStart: BN
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1981

updateSpotMarketStatus

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

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:2209

updateStateMaxInitializeUserFee

updateStateMaxInitializeUserFee(maxInitializeUserFee: number): Promise<string>
Parameters
- maxInitializeUserFee: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1756

updateStateMaxNumberOfSubAccounts

updateStateMaxNumberOfSubAccounts(maxNumberOfSubAccounts: number): Promise<string>
Parameters
- maxNumberOfSubAccounts: number
Returns Promise<string>
- Defined in sdk/src/adminClient.ts:1727

updateStateSettlementDuration

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

updateUserAdvancedLp

updateUserAdvancedLp(updates: {
advancedLp: boolean;
subAccountId: number;
}[]): Promise<string>
Parameters
- updates: {
  advancedLp: boolean;
  subAccountId: number;
  }[]
Returns Promise<string>
Inherited from DriftClient.updateUserAdvancedLp
- Defined in sdk/src/driftClient.ts:1212

updateUserCustomMarginRatio

updateUserCustomMarginRatio(updates: {
marginRatio: number;
subAccountId: number;
}[], txParams?: TxParams): Promise<string>
Parameters
- updates: {
  marginRatio: number;
  subAccountId: number;
  }[]
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.updateUserCustomMarginRatio
- Defined in sdk/src/driftClient.ts:1092

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:1193

updateUserGovTokenInsuranceStake

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

updateUserIdle

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

updateUserMarginTradingEnabled

updateUserMarginTradingEnabled(updates: {
marginTradingEnabled: boolean;
subAccountId: number;
}[]): Promise<string>
Parameters
- updates: {
  marginTradingEnabled: boolean;
  subAccountId: number;
  }[]
Returns Promise<string>
Inherited from DriftClient.updateUserMarginTradingEnabled
- Defined in sdk/src/driftClient.ts:1175

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:1067

updateUserOpenOrdersCount

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

updateUserQuoteAssetInsuranceStake

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

updateUserReduceOnly

updateUserReduceOnly(updates: {
reduceOnly: boolean;
subAccountId: number;
}[]): Promise<string>
Parameters
- updates: {
  reduceOnly: boolean;
  subAccountId: number;
  }[]
Returns Promise<string>
Inherited from DriftClient.updateUserReduceOnly
- Defined in sdk/src/driftClient.ts:1249

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:656

updateWhitelistMint

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

updateWithdrawGuardThreshold

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

withdraw

withdraw(amount: BN, marketIndex: number, associatedTokenAddress: PublicKey, reduceOnly?: boolean, subAccountId?: number, txParams?: TxParams): 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
- Optional subAccountId: number
- Optional txParams: TxParams
Returns Promise<string>
Inherited from DriftClient.withdraw
- Defined in sdk/src/driftClient.ts:2525

withdrawAllDustPositions

withdrawAllDustPositions(subAccountId?: number, txParams?: TxParams, opts?: {
dustPositionCountCallback?: ((count: number) => void);
}): Promise<string>
Parameters
- Optional subAccountId: number
- Optional txParams: TxParams
- Optional opts: {
  dustPositionCountCallback?: ((count: number) => void);
  }
  - Optional dustPositionCountCallback?: ((count: number) => void)
    - (count: number): void
      
      Parameters
      
      count: number
      
      Returns void
Returns Promise<string>
Inherited from DriftClient.withdrawAllDustPositions
- Defined in sdk/src/driftClient.ts:2557

Class AdminClient

DriftClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: DriftClientConfig

Returns AdminClient

Properties

_isSubscribed

accountSubscriber

activeSubAccountId

authority

Optional authoritySubAccountMap

connection

Optional enableMetricsEvents

eventEmitter

Optional includeDelegates

lookupTableAccount

marketLookupTable

metricsEventEmitter

mustIncludePerpMarketIndexes

mustIncludeSpotMarketIndexes

Optional opts

perpMarketLastSlotCache

program

provider

Optional receiverProgram

Optional sbOnDemandProgram

sbOnDemandProgramdId

Optional sbProgramFeedConfigs

Optional signerPublicKey

Optional skipLoadUsers

spotMarketLastSlotCache

Optional statePublicKey

swiftID

txHandler

txParams

txSender

txVersion

userAccountSubscriptionConfig

Optional userStats

userStatsAccountPublicKey

userStatsAccountSubscriptionConfig

users

wallet

Optional wormholeProgram

Accessors

isSubscribed

Returns boolean

Parameters

val: boolean

Returns void

Methods

addAndSubscribeToUsers

Parameters

Optional authority: PublicKey

Returns Promise<boolean>

addInsuranceFundStake

Parameters

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

amount: BN

collateralAccountPublicKey: PublicKey

Optional fromSubaccount?: boolean

Optional initializeStakeAccount?: boolean

marketIndex: number

Optional txParams?: TxParams

Returns Promise<string>

addOpenbookRemainingAccounts

Parameters

marketIndex: number

remainingAccounts: AccountMeta[]

fulfillmentConfig: OpenbookV2FulfillmentConfigAccount

Returns void

addPerpLpShares

`Optional` authoritySubAccountMap

`Optional` enableMetricsEvents

`Optional` includeDelegates

`Optional` opts

`Optional` receiverProgram

`Optional` sbOnDemandProgram

`Optional` sbProgramFeedConfigs

`Optional` signerPublicKey

`Optional` skipLoadUsers

`Optional` statePublicKey

`Optional` userStats

`Optional` wormholeProgram

`Optional` authority: PublicKey

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

`Optional` fromSubaccount?: boolean

`Optional` initializeStakeAccount?: boolean

`Optional` txParams?: TxParams

`Optional` txParams: TxParams

`Optional` subAccountId: number

`Optional` fulfillmentConfig: SerumV3FulfillmentConfigAccount | PhoenixV1FulfillmentConfigAccount | OpenbookV2FulfillmentConfigAccount

`Optional` authority: PublicKey

`Optional` userAccount: UserAccount

`Optional` txParams: TxParams

`Optional` txVersion: TransactionVersion

`Optional` lookupTables: AddressLookupTableAccount[]

`Optional` forceVersionedTransaction: boolean

Returns Promise<{
signedTxData: SignedTxData[];
signedTxMap: Record<string, Transaction>;
} | {
signedTxData: SignedTxData[];
signedTxMap: MappedRecord<Record<string, TransactionInstruction | TransactionInstruction[]>, Transaction | VersionedTransaction>;
}>

`Optional` txParams: TxParams

`Optional` txVersion: TransactionVersion

`Optional` lookupTables: AddressLookupTableAccount[]

`Optional` forceVersionedTransaction: boolean

`Optional` txParams: TxParams