MangoClient | @blockworks-foundation/mango-client

A class for interacting with the Mango V3 Program

param connection: A solana web.js Connection object
param programId: The PublicKey of the Mango V3 Program
param opts: An object used to configure the MangoClient. Accepts a postSendTxCallback, and prioritizationFee. The prioritizationFee is a number measured in micro lamports that is charged per compute unit.

Hierarchy

MangoClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MangoClient(connection: Connection, programId: PublicKey, opts?: { blockhashCommitment?: Commitment; maxStoredBlockhashes?: number; prioritizationFee?: number; sendConnection?: Connection; timeout?: number; postSendTxCallback?: any }): MangoClient

- Defined in src/client.ts:180
Parameters
- connection: Connection
- programId: PublicKey
- opts: { blockhashCommitment?: Commitment; maxStoredBlockhashes?: number; prioritizationFee?: number; sendConnection?: Connection; timeout?: number; postSendTxCallback?: any } = {}
  - Optional blockhashCommitment?: Commitment
  - Optional maxStoredBlockhashes?: number
  - Optional prioritizationFee?: number
  - Optional sendConnection?: Connection
  - Optional timeout?: number
  - postSendTxCallback?:function
    - postSendTxCallback(__namedParameters: { txid: string }): void
    - Defined in src/client.ts:184
      Parameters
      - __namedParameters: { txid: string }
        txid: string
      Returns void
Returns MangoClient

Properties

blockhashCommitment

blockhashCommitment: Commitment

connection

connection: Connection

lastSlot

lastSlot: number

lastValidBlockHeight

lastValidBlockHeight: number

Optional postSendTxCallback

postSendTxCallback?: (__namedParameters: { txid: string }) => void

Type declaration

- (__namedParameters: { txid: string }): void
- Parameters
  - __namedParameters: { txid: string }
    - txid: string
  Returns void

prioritizationFee

prioritizationFee: number

programId

programId: PublicKey

Optional sendConnection

sendConnection?: Connection

timeout

timeout: null | number

Methods

addMangoAccountInfo

addMangoAccountInfo(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, info: string): Promise<undefined | string>

- Defined in src/client.ts:4034
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- info: string
Returns Promise<undefined | string>

addOracle

addOracle(mangoGroup: MangoGroup, oracle: PublicKey, admin: Keypair): Promise<string>

- Defined in src/client.ts:2160
Add a new oracle to a group

Parameters
- mangoGroup: MangoGroup
- oracle: PublicKey
- admin: Keypair
Returns Promise<string>

addPerpMarket

addPerpMarket(mangoGroup: MangoGroup, oraclePk: PublicKey, mngoMintPk: PublicKey, admin: Keypair, maintLeverage: number, initLeverage: number, liquidationFee: number, makerFee: number, takerFee: number, baseLotSize: number, quoteLotSize: number, maxNumEvents: number, rate: number, maxDepthBps: number, targetPeriodLength: number, mngoPerPeriod: number, exp: number): Promise<string>

- Defined in src/client.ts:3337
Parameters
- mangoGroup: MangoGroup
- oraclePk: PublicKey
- mngoMintPk: PublicKey
- admin: Keypair
- maintLeverage: number
- initLeverage: number
- liquidationFee: number
- makerFee: number
- takerFee: number
- baseLotSize: number
- quoteLotSize: number
- maxNumEvents: number
- rate: number
- maxDepthBps: number
- targetPeriodLength: number
- mngoPerPeriod: number
- exp: number
Returns Promise<string>

addPerpTriggerOrder

addPerpTriggerOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, perpMarket: PerpMarket, owner: Payer, orderType: PerpOrderType, side: "buy" | "sell", price: number, quantity: number, triggerCondition: "above" | "below", triggerPrice: number, reduceOnly: boolean, clientOrderId?: number): Promise<undefined | string>

- Defined in src/client.ts:4548
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- owner: Payer
- orderType: PerpOrderType
- side: "buy" | "sell"
- price: number
- quantity: number
- triggerCondition: "above" | "below"
- triggerPrice: number
- reduceOnly: boolean
- Optional clientOrderId: number
Returns Promise<undefined | string>

addSpotMarket

addSpotMarket(mangoGroup: MangoGroup, oracle: PublicKey, spotMarket: PublicKey, mint: PublicKey, admin: Keypair, maintLeverage: number, initLeverage: number, liquidationFee: number, optimalUtil: number, optimalRate: number, maxRate: number): Promise<string>

- Defined in src/client.ts:2203
Parameters
- mangoGroup: MangoGroup
- oracle: PublicKey
- spotMarket: PublicKey
- mint: PublicKey
- admin: Keypair
- maintLeverage: number
- initLeverage: number
- liquidationFee: number
- optimalUtil: number
- optimalRate: number
- maxRate: number
Returns Promise<string>

addStubOracle

addStubOracle(mangoGroupPk: PublicKey, admin: Keypair): Promise<string>

- Defined in src/client.ts:3293
Parameters
- mangoGroupPk: PublicKey
- admin: Keypair
Returns Promise<string>

awaitTransactionSignatureConfirmation

awaitTransactionSignatureConfirmation(txid: string, timeout: number, confirmLevel: TransactionConfirmationStatus, signedAtBlock?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>): Promise<unknown>

- Defined in src/client.ts:546
Parameters
- txid: string
- timeout: number
- confirmLevel: TransactionConfirmationStatus
- Optional signedAtBlock: Readonly<{ blockhash: string; lastValidBlockHeight: number }>
Returns Promise<unknown>

cachePerpMarkets

cachePerpMarkets(mangoGroup: PublicKey, mangoCache: PublicKey, perpMarkets: PublicKey[], payer: Keypair): Promise<string>

- Defined in src/client.ts:1709
Called by the Keeper to cache perp market funding

Parameters
- mangoGroup: PublicKey
- mangoCache: PublicKey
- perpMarkets: PublicKey[]
- payer: Keypair
Returns Promise<string>

cachePrices

cachePrices(mangoGroup: PublicKey, mangoCache: PublicKey, oracles: PublicKey[], payer: Payer): Promise<string>

- Defined in src/client.ts:1687
Called by the Keeper to cache prices from the Oracles

Parameters
- mangoGroup: PublicKey
- mangoCache: PublicKey
- oracles: PublicKey[]
- payer: Payer
Returns Promise<string>

cacheRootBanks

cacheRootBanks(mangoGroup: PublicKey, mangoCache: PublicKey, rootBanks: PublicKey[], payer: Payer): Promise<string>

- Defined in src/client.ts:1665
Called by the Keeper to cache interest rates from the RootBanks

Parameters
- mangoGroup: PublicKey
- mangoCache: PublicKey
- rootBanks: PublicKey[]
- payer: Payer
Returns Promise<string>

cancelAllPerpOrders

cancelAllPerpOrders(group: MangoGroup, perpMarkets: PerpMarket[], mangoAccount: MangoAccount, owner: Payer, ownerIsSigner?: boolean): Promise<undefined | string[]>

- Defined in src/client.ts:2075
Cancel all perp orders across all markets

Parameters
- group: MangoGroup
- perpMarkets: PerpMarket[]
- mangoAccount: MangoAccount
- owner: Payer
- ownerIsSigner: boolean = true
Returns Promise<undefined | string[]>

cancelAllSpotOrders

cancelAllSpotOrders(mangoGroup: MangoGroup, mangoAccount: MangoAccount, spotMarket: Market, owner: Payer, limit: number, ownerIsSigner?: boolean): Promise<undefined | string>

- Defined in src/client.ts:5434
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- spotMarket: Market
- owner: Payer
- limit: number
- ownerIsSigner: boolean = true
Returns Promise<undefined | string>

cancelPerpOrder

cancelPerpOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, perpMarket: PerpMarket, order: PerpOrder, invalidIdOk?: boolean): Promise<undefined | string>

- Defined in src/client.ts:2042
Cancel an order on a perp market

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- perpMarket: PerpMarket
- order: PerpOrder
- invalidIdOk: boolean = false
  
  Don't throw error if order is invalid
Returns Promise<undefined | string>

cancelPerpOrderSide

cancelPerpOrderSide(mangoGroup: MangoGroup, mangoAccount: MangoAccount, perpMarket: PerpMarket, payer: Payer, side: "buy" | "sell", limit: number): Promise<undefined | string>

- Defined in src/client.ts:5190
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- payer: Payer
- side: "buy" | "sell"
- limit: number
Returns Promise<undefined | string>

cancelSpotOrder

cancelSpotOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, spotMarket: Market, order: Order): Promise<undefined | string>

- Defined in src/client.ts:2670
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- spotMarket: Market
- order: Order
Returns Promise<undefined | string>

changePerpMarketParams

changePerpMarketParams(mangoGroup: MangoGroup, perpMarket: PerpMarket, admin: Payer, maintLeverage: undefined | number, initLeverage: undefined | number, liquidationFee: undefined | number, makerFee: undefined | number, takerFee: undefined | number, rate: undefined | number, maxDepthBps: undefined | number, targetPeriodLength: undefined | number, mngoPerPeriod: undefined | number, exp: undefined | number): Promise<undefined | string>

- Defined in src/client.ts:4109
Parameters
- mangoGroup: MangoGroup
- perpMarket: PerpMarket
- admin: Payer
- maintLeverage: undefined | number
- initLeverage: undefined | number
- liquidationFee: undefined | number
- makerFee: undefined | number
- takerFee: undefined | number
- rate: undefined | number
- maxDepthBps: undefined | number
- targetPeriodLength: undefined | number
- mngoPerPeriod: undefined | number
- exp: undefined | number
Returns Promise<undefined | string>

changePerpMarketParams2

changePerpMarketParams2(mangoGroup: MangoGroup, perpMarket: PerpMarket, admin: Payer, maintLeverage: undefined | number, initLeverage: undefined | number, liquidationFee: undefined | number, makerFee: undefined | number, takerFee: undefined | number, rate: undefined | number, maxDepthBps: undefined | number, targetPeriodLength: undefined | number, mngoPerPeriod: undefined | number, exp: undefined | number, version: undefined | number, lmSizeShift: undefined | number): Promise<undefined | string>

- Defined in src/client.ts:4152
Parameters
- mangoGroup: MangoGroup
- perpMarket: PerpMarket
- admin: Payer
- maintLeverage: undefined | number
- initLeverage: undefined | number
- liquidationFee: undefined | number
- makerFee: undefined | number
- takerFee: undefined | number
- rate: undefined | number
- maxDepthBps: undefined | number
- targetPeriodLength: undefined | number
- mngoPerPeriod: undefined | number
- exp: undefined | number
- version: undefined | number
- lmSizeShift: undefined | number
Returns Promise<undefined | string>

changeReferralFeeParams

changeReferralFeeParams(mangoGroup: MangoGroup, admin: Payer, refSurcharge: number, refShare: number, refMngoRequired: number): Promise<undefined | string>

- Defined in src/client.ts:5289
Change the referral fee params

Parameters
- mangoGroup: MangoGroup
- admin: Payer
- refSurcharge: number
  
  normal units 0.0001 -> 1 basis point
- refShare: number
- refMngoRequired: number
  
  ui units -> 1 -> 1_000_000 MNGO
Returns Promise<undefined | string>

changeSpotMarketParams

changeSpotMarketParams(mangoGroup: MangoGroup, spotMarket: Market, rootBank: RootBank, admin: Payer, maintLeverage: undefined | number, initLeverage: undefined | number, liquidationFee: undefined | number, optimalUtil: undefined | number, optimalRate: undefined | number, maxRate: undefined | number, version: undefined | number): Promise<undefined | string>

- Defined in src/client.ts:5242
Parameters
- mangoGroup: MangoGroup
- spotMarket: Market
- rootBank: RootBank
- admin: Payer
- maintLeverage: undefined | number
- initLeverage: undefined | number
- liquidationFee: undefined | number
- optimalUtil: undefined | number
- optimalRate: undefined | number
- maxRate: undefined | number
- version: undefined | number
Returns Promise<undefined | string>

closeAdvancedOrders

closeAdvancedOrders(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer): Promise<undefined | string>

- Defined in src/client.ts:4697
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
Returns Promise<undefined | string>

closeMangoAccount

closeMangoAccount(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer): Promise<undefined | string>

- Defined in src/client.ts:4745
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
Returns Promise<undefined | string>

closeSpotOpenOrders

closeSpotOpenOrders(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer, marketIndex: number, ownerIsSigner?: boolean): Promise<undefined | string>

- Defined in src/client.ts:4718
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
- marketIndex: number
- ownerIsSigner: boolean = true
Returns Promise<undefined | string>

consumeEvents

consumeEvents(mangoGroup: MangoGroup, perpMarket: PerpMarket, mangoAccounts: PublicKey[], payer: Keypair, limit: BN): Promise<string>

- Defined in src/client.ts:1754
Called by the Keeper to process events on the Perp order book

Parameters
- mangoGroup: MangoGroup
- perpMarket: PerpMarket
- mangoAccounts: PublicKey[]
- payer: Keypair
- limit: BN
Returns Promise<string>

createDustAccount

createDustAccount(mangoGroup: MangoGroup, payer: Payer): Promise<undefined | string>

- Defined in src/client.ts:4765
Parameters
- mangoGroup: MangoGroup
- payer: Payer
Returns Promise<undefined | string>

createMangoAccount

createMangoAccount(mangoGroup: MangoGroup, owner: Payer, accountNum: number, payerPk?: PublicKey): Promise<undefined | PublicKey>

- Defined in src/client.ts:853
Create a new Mango Account (PDA) on a given group

Parameters
- mangoGroup: MangoGroup
- owner: Payer
- accountNum: number
- Optional payerPk: PublicKey
Returns Promise<undefined | PublicKey>

createMangoAccountAndDeposit

createMangoAccountAndDeposit(mangoGroup: MangoGroup, owner: Payer, rootBank: PublicKey, nodeBank: PublicKey, vault: PublicKey, tokenAcc: PublicKey, quantity: number, accountNum: number, info?: string, referrerPk?: PublicKey, payerPk?: PublicKey): Promise<undefined | [string, string]>

- Defined in src/client.ts:1076
Create a new Mango Account (PDA) and deposit some tokens in a single transaction

Parameters
- mangoGroup: MangoGroup
- owner: Payer
- rootBank: PublicKey
  
  The RootBank for the deposit currency
- nodeBank: PublicKey
  
  The NodeBank asociated with the RootBank
- vault: PublicKey
  
  The token account asociated with the NodeBank
- tokenAcc: PublicKey
  
  The token account to transfer from
- quantity: number
- accountNum: number
- Optional info: string
  
  An optional UI name for the account
- Optional referrerPk: PublicKey
- Optional payerPk: PublicKey
Returns Promise<undefined | [string, string]>

createPerpMarket

createPerpMarket(mangoGroup: MangoGroup, oraclePk: PublicKey, mngoMintPk: PublicKey, admin: Payer, maintLeverage: number, initLeverage: number, liquidationFee: number, makerFee: number, takerFee: number, baseLotSize: number, quoteLotSize: number, maxNumEvents: number, rate: number, maxDepthBps: number, targetPeriodLength: number, mngoPerPeriod: number, exp: number, version: number, lmSizeShift: number, baseDecimals: number): Promise<undefined | string>

- Defined in src/client.ts:3440
Parameters
- mangoGroup: MangoGroup
- oraclePk: PublicKey
- mngoMintPk: PublicKey
- admin: Payer
- maintLeverage: number
- initLeverage: number
- liquidationFee: number
- makerFee: number
- takerFee: number
- baseLotSize: number
- quoteLotSize: number
- maxNumEvents: number
- rate: number
- maxDepthBps: number
- targetPeriodLength: number
- mngoPerPeriod: number
- exp: number
- version: number
- lmSizeShift: number
- baseDecimals: number
Returns Promise<undefined | string>

deposit

deposit(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, rootBank: PublicKey, nodeBank: PublicKey, vault: PublicKey, tokenAcc: PublicKey, quantity: number): Promise<undefined | string>

- Defined in src/client.ts:1224
Deposit tokens in a Mango Account

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- rootBank: PublicKey
  
  The RootBank for the deposit currency
- nodeBank: PublicKey
  
  The NodeBank asociated with the RootBank
- vault: PublicKey
  
  The token account asociated with the NodeBank
- tokenAcc: PublicKey
  
  The token account to transfer from
- quantity: number
Returns Promise<undefined | string>

depositMsrm

depositMsrm(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, msrmAccount: PublicKey, quantity: number): Promise<undefined | string>

- Defined in src/client.ts:4057
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- msrmAccount: PublicKey
- quantity: number
Returns Promise<undefined | string>

emptyAndCloseMangoAccount

emptyAndCloseMangoAccount(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: MangoCache, mngoIndex: number, payer: Payer): Promise<undefined | string[]>

- Defined in src/client.ts:4914
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: MangoCache
- mngoIndex: number
- payer: Payer
Returns Promise<undefined | string[]>

ensureOpenOrdersAccount

ensureOpenOrdersAccount(mangoAccount: MangoAccount, mangoGroup: MangoGroup, payer: Keypair, spotMarket: Market, spotMarketConfig: any): Promise<void>

- Defined in src/client.ts:5494
Parameters
- mangoAccount: MangoAccount
- mangoGroup: MangoGroup
- payer: Keypair
- spotMarket: Market
- spotMarketConfig: any
Returns Promise<void>

executePerpTriggerOrder

executePerpTriggerOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: MangoCache, perpMarket: PerpMarket, payer: Payer, orderIndex: number): Promise<undefined | string>

- Defined in src/client.ts:4662
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: MangoCache
- perpMarket: PerpMarket
- payer: Payer
- orderIndex: number
Returns Promise<undefined | string>

fetchTopPnlAccountsFromDB

fetchTopPnlAccountsFromDB(mangoGroup: MangoGroup, perpMarket: PerpMarket, sign: number): Promise<AccountWithPnl[]>

- Defined in src/client.ts:2939
Parameters
- mangoGroup: MangoGroup
- perpMarket: PerpMarket
- sign: number
Returns Promise<AccountWithPnl[]>

fetchTopPnlAccountsFromRPC

fetchTopPnlAccountsFromRPC(mangoGroup: MangoGroup, mangoCache: MangoCache, perpMarket: PerpMarket, price: I80F48, sign: number, mangoAccounts?: MangoAccount[]): Promise<AccountWithPnl[]>

- Defined in src/client.ts:2912
Parameters
- mangoGroup: MangoGroup
- mangoCache: MangoCache
- perpMarket: PerpMarket
- price: I80F48
- sign: number
- Optional mangoAccounts: MangoAccount[]
Returns Promise<AccountWithPnl[]>

forceCancelAllPerpOrdersInMarket

forceCancelAllPerpOrdersInMarket(mangoGroup: MangoGroup, liqee: MangoAccount, perpMarket: PerpMarket, payer: Payer, limitPerInstruction: number): Promise<string>

- Defined in src/client.ts:3643
Send multiple instructions to cancel all perp orders in this market

Parameters
- mangoGroup: MangoGroup
- liqee: MangoAccount
- perpMarket: PerpMarket
- payer: Payer
- limitPerInstruction: number
Returns Promise<string>

forceCancelPerpOrders

forceCancelPerpOrders(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, perpMarket: PerpMarket, payer: Keypair, limit: BN): Promise<string>

- Defined in src/client.ts:3697
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- perpMarket: PerpMarket
- payer: Keypair
- limit: BN
Returns Promise<string>

forceCancelSpotOrders

forceCancelSpotOrders(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, spotMarket: Market, baseRootBank: RootBank, quoteRootBank: RootBank, payer: Keypair, limit: BN): Promise<string>

- Defined in src/client.ts:3547
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- spotMarket: Market
- baseRootBank: RootBank
- quoteRootBank: RootBank
- payer: Keypair
- limit: BN
Returns Promise<string>

getAllMangoAccounts

getAllMangoAccounts(mangoGroup: MangoGroup, filters?: any[], includeOpenOrders?: boolean): Promise<MangoAccount[]>

- Defined in src/client.ts:3219
Parameters
- mangoGroup: MangoGroup
- Optional filters: any[]
- includeOpenOrders: boolean = true
Returns Promise<MangoAccount[]>

getCurrentBlockhash

getCurrentBlockhash(): Promise<Readonly<{ blockhash: string; lastValidBlockHeight: number }>>

- Defined in src/client.ts:225
Returns Promise<Readonly<{ blockhash: string; lastValidBlockHeight: number }>>

getMangoAccount

getMangoAccount(mangoAccountPk: PublicKey, dexProgramId: PublicKey): Promise<MangoAccount>

- Defined in src/client.ts:931
Retrieve information about a Mango Account

Parameters
- mangoAccountPk: PublicKey
- dexProgramId: PublicKey
Returns Promise<MangoAccount>

getMangoAccountsForDelegate

getMangoAccountsForDelegate(mangoGroup: MangoGroup, delegate: PublicKey, includeOpenOrders?: boolean): Promise<MangoAccount[]>

- Defined in src/client.ts:3203
Get all MangoAccounts where delegate pubkey has authority

Parameters
- mangoGroup: MangoGroup
- delegate: PublicKey
- includeOpenOrders: boolean = false
Returns Promise<MangoAccount[]>

getMangoAccountsForOwner

getMangoAccountsForOwner(mangoGroup: MangoGroup, owner: PublicKey, includeOpenOrders?: boolean): Promise<MangoAccount[]>

- Defined in src/client.ts:3183
Parameters
- mangoGroup: MangoGroup
- owner: PublicKey
- includeOpenOrders: boolean = false
Returns Promise<MangoAccount[]>

getMangoGroup

getMangoGroup(mangoGroup: PublicKey): Promise<MangoGroup>

- Defined in src/client.ts:806
Retrieve information about a Mango Group

Parameters
- mangoGroup: PublicKey
Returns Promise<MangoGroup>

getPerpMarket

getPerpMarket(perpMarketPk: PublicKey, baseDecimal: number, quoteDecimal: number): Promise<PerpMarket>

- Defined in src/client.ts:1806
Retrieve information about a perp market

Parameters
- perpMarketPk: PublicKey
- baseDecimal: number
- quoteDecimal: number
Returns Promise<PerpMarket>

getReferrerIdsForMangoAccount

getReferrerIdsForMangoAccount(mangoAccount: MangoAccount): Promise<ReferrerIdRecord[]>

- Defined in src/client.ts:5402
Parameters
- mangoAccount: MangoAccount
Returns Promise<ReferrerIdRecord[]>

getReferrerPda

getReferrerPda(mangoGroup: MangoGroup, referrerId: string): Promise<{ encodedReferrerId: Buffer; referrerPda: PublicKey }>

- Defined in src/client.ts:5344
Parameters
- mangoGroup: MangoGroup
- referrerId: string
Returns Promise<{ encodedReferrerId: Buffer; referrerPda: PublicKey }>

initMangoAccount

initMangoAccount(mangoGroup: MangoGroup, owner: Payer): Promise<undefined | PublicKey>

- Defined in src/client.ts:818
DEPRECATED - Create a new Mango Account on a given group

Parameters
- mangoGroup: MangoGroup
- owner: Payer
Returns Promise<undefined | PublicKey>

initMangoAccountAndDeposit

initMangoAccountAndDeposit(mangoGroup: MangoGroup, owner: Payer, rootBank: PublicKey, nodeBank: PublicKey, vault: PublicKey, tokenAcc: PublicKey, quantity: number, info?: string): Promise<undefined | string>

- Defined in src/client.ts:956
Create a new Mango Account and deposit some tokens in a single transaction

Parameters
- mangoGroup: MangoGroup
- owner: Payer
- rootBank: PublicKey
  
  The RootBank for the deposit currency
- nodeBank: PublicKey
  
  The NodeBank asociated with the RootBank
- vault: PublicKey
  
  The token account asociated with the NodeBank
- tokenAcc: PublicKey
  
  The token account to transfer from
- quantity: number
- Optional info: string
  
  An optional UI name for the account
Returns Promise<undefined | string>

initMangoGroup

initMangoGroup(quoteMint: PublicKey, msrmMint: PublicKey, dexProgram: PublicKey, feesVault: PublicKey, validInterval: number, quoteOptimalUtil: number, quoteOptimalRate: number, quoteMaxRate: number, payer: Payer): Promise<undefined | PublicKey>

- Defined in src/client.ts:673
Create a new Mango group

Parameters
- quoteMint: PublicKey
- msrmMint: PublicKey
- dexProgram: PublicKey
- feesVault: PublicKey
- validInterval: number
- quoteOptimalUtil: number
- quoteOptimalRate: number
- quoteMaxRate: number
- payer: Payer
Returns Promise<undefined | PublicKey>

isMainnet

isMainnet(): any

- Defined in src/client.ts:5552
Returns any

liquidatePerpMarket

liquidatePerpMarket(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, liqorMangoAccount: MangoAccount, perpMarket: PerpMarket, payer: Keypair, baseTransferRequest: BN): Promise<string>

- Defined in src/client.ts:3789
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- liqorMangoAccount: MangoAccount
- perpMarket: PerpMarket
- payer: Keypair
- baseTransferRequest: BN
Returns Promise<string>

liquidateTokenAndPerp

liquidateTokenAndPerp(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, liqorMangoAccount: MangoAccount, rootBank: RootBank, payer: Keypair, assetType: AssetType, assetIndex: number, liabType: AssetType, liabIndex: number, maxLiabTransfer: I80F48): Promise<string>

- Defined in src/client.ts:3753
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- liqorMangoAccount: MangoAccount
- rootBank: RootBank
- payer: Keypair
- assetType: AssetType
- assetIndex: number
- liabType: AssetType
- liabIndex: number
- maxLiabTransfer: I80F48
Returns Promise<string>

liquidateTokenAndToken

liquidateTokenAndToken(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, liqorMangoAccount: MangoAccount, assetRootBank: RootBank, liabRootBank: RootBank, payer: Keypair, maxLiabTransfer: I80F48): Promise<string>

- Defined in src/client.ts:3722
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- liqorMangoAccount: MangoAccount
- assetRootBank: RootBank
- liabRootBank: RootBank
- payer: Keypair
- maxLiabTransfer: I80F48
Returns Promise<string>

modifyPerpOrder

modifyPerpOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: PublicKey, perpMarket: PerpMarket, owner: Payer, order: PerpOrder, side: "buy" | "sell", price: number, quantity: number, orderType?: PerpOrderType, clientOrderId?: number, bookSideInfo?: AccountInfo<Buffer>, invalidIdOk?: boolean, referrerMangoAccountPk?: PublicKey): Promise<undefined | string>

- Defined in src/client.ts:4448
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: PublicKey
- perpMarket: PerpMarket
- owner: Payer
- order: PerpOrder
- side: "buy" | "sell"
- price: number
- quantity: number
- Optional orderType: PerpOrderType
- Optional clientOrderId: number
- Optional bookSideInfo: AccountInfo<Buffer>
- invalidIdOk: boolean = false
- Optional referrerMangoAccountPk: PublicKey
Returns Promise<undefined | string>

modifySpotOrder

modifySpotOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: PublicKey, spotMarket: Market, owner: Payer, order: Order, side: "buy" | "sell", price: number, size: number, orderType?: "limit" | "ioc" | "postOnly"): Promise<undefined | string>

- Defined in src/client.ts:4222
Add allowance for orders to be cancelled and replaced in a single transaction

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: PublicKey
- spotMarket: Market
- owner: Payer
- order: Order
- side: "buy" | "sell"
- price: number
- size: number
- Optional orderType: "limit" | "ioc" | "postOnly"
Returns Promise<undefined | string>

placePerpOrder

placePerpOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: PublicKey, perpMarket: PerpMarket, owner: Payer, side: "buy" | "sell", price: number, quantity: number, orderType?: PerpOrderType, clientOrderId?: number, bookSideInfo?: AccountInfo<Buffer>, reduceOnly?: boolean, referrerMangoAccountPk?: PublicKey): Promise<undefined | string>

- Defined in src/client.ts:1827
Place an order on a perp market

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: PublicKey
- perpMarket: PerpMarket
- owner: Payer
- side: "buy" | "sell"
- price: number
- quantity: number
- Optional orderType: PerpOrderType
- clientOrderId: number = 0
  
  An optional id that can be used to correlate events related to your order
- Optional bookSideInfo: AccountInfo<Buffer>
  
  Account info for asks if side === bid, bids if side === ask. If this is given, crank instruction is added
- Optional reduceOnly: boolean
- Optional referrerMangoAccountPk: PublicKey
Returns Promise<undefined | string>

placePerpOrder2

placePerpOrder2(mangoGroup: MangoGroup, mangoAccount: MangoAccount, perpMarket: PerpMarket, owner: Payer, side: "buy" | "sell", price: number, quantity: number, options?: { bookSideInfo?: AccountInfo<Buffer>; clientOrderId?: number; expiryTimestamp?: number; expiryType?: "absolute" | "relative"; limit?: number; maxQuoteQuantity?: number; orderType?: PerpOrderType; reduceOnly?: boolean; referrerMangoAccountPk?: PublicKey }): Promise<undefined | string>

- Defined in src/client.ts:1920
Place an order on a perp market

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- owner: Payer
- side: "buy" | "sell"
- price: number
- quantity: number
- Optional options: { bookSideInfo?: AccountInfo<Buffer>; clientOrderId?: number; expiryTimestamp?: number; expiryType?: "absolute" | "relative"; limit?: number; maxQuoteQuantity?: number; orderType?: PerpOrderType; reduceOnly?: boolean; referrerMangoAccountPk?: PublicKey }
  - Optional bookSideInfo?: AccountInfo<Buffer>
  - Optional clientOrderId?: number
  - Optional expiryTimestamp?: number
  - Optional expiryType?: "absolute" | "relative"
  - Optional limit?: number
  - Optional maxQuoteQuantity?: number
  - Optional orderType?: PerpOrderType
  - Optional reduceOnly?: boolean
  - Optional referrerMangoAccountPk?: PublicKey
Returns Promise<undefined | string>

placeSpotOrder

placeSpotOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: PublicKey, spotMarket: Market, owner: Payer, side: "buy" | "sell", price: number, size: number, orderType?: "limit" | "ioc" | "postOnly", clientId?: BN): Promise<undefined | string>

- Defined in src/client.ts:2275
Make sure mangoAccount has recent and valid inMarginBasket and spotOpenOrders

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: PublicKey
- spotMarket: Market
- owner: Payer
- side: "buy" | "sell"
- price: number
- size: number
- Optional orderType: "limit" | "ioc" | "postOnly"
- Optional clientId: BN
Returns Promise<undefined | string>

placeSpotOrder2

placeSpotOrder2(mangoGroup: MangoGroup, mangoAccount: MangoAccount, spotMarket: Market, owner: Payer, side: "buy" | "sell", price: number, size: number, orderType?: "limit" | "ioc" | "postOnly", clientOrderId?: BN, useMsrmVault?: boolean): Promise<undefined | string[]>

- Defined in src/client.ts:2464
Make sure mangoAccount has recent and valid inMarginBasket and spotOpenOrders

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- spotMarket: Market
- owner: Payer
- side: "buy" | "sell"
- price: number
- size: number
- Optional orderType: "limit" | "ioc" | "postOnly"
- Optional clientOrderId: BN
- Optional useMsrmVault: boolean
Returns Promise<undefined | string[]>

redeemAllMngo

redeemAllMngo(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer, mngoRootBank: PublicKey, mngoNodeBank: PublicKey, mngoVault: PublicKey): Promise<undefined | string[]>

- Defined in src/client.ts:3946
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
- mngoRootBank: PublicKey
- mngoNodeBank: PublicKey
- mngoVault: PublicKey
Returns Promise<undefined | string[]>

redeemMngo

redeemMngo(mangoGroup: MangoGroup, mangoAccount: MangoAccount, perpMarket: PerpMarket, payer: Payer, mngoRootBank: PublicKey, mngoNodeBank: PublicKey, mngoVault: PublicKey): Promise<undefined | string>

- Defined in src/client.ts:3915
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- payer: Payer
- mngoRootBank: PublicKey
- mngoNodeBank: PublicKey
- mngoVault: PublicKey
Returns Promise<undefined | string>

registerReferrerId

registerReferrerId(mangoGroup: MangoGroup, referrerMangoAccount: MangoAccount, payer: Payer, referrerId: string): Promise<undefined | string>

- Defined in src/client.ts:5373
Parameters
- mangoGroup: MangoGroup
- referrerMangoAccount: MangoAccount
- payer: Payer
- referrerId: string
Returns Promise<undefined | string>

removeAdvancedOrder

removeAdvancedOrder(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, orderIndex: number): Promise<undefined | string>

- Defined in src/client.ts:4639
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- orderIndex: number
Returns Promise<undefined | string>

resolveAllDust

resolveAllDust(mangoGroup: MangoGroup, mangoAccount: MangoAccount, mangoCache: MangoCache, payer: Payer): Promise<void>

- Defined in src/client.ts:4835
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- mangoCache: MangoCache
- payer: Payer
Returns Promise<void>

resolveDust

resolveDust(mangoGroup: MangoGroup, mangoAccount: MangoAccount, rootBank: RootBank, mangoCache: MangoCache, payer: Payer): Promise<undefined | string>

- Defined in src/client.ts:4788
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- rootBank: RootBank
- mangoCache: MangoCache
- payer: Payer
Returns Promise<undefined | string>

resolvePerpBankruptcy

resolvePerpBankruptcy(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, liqorMangoAccount: MangoAccount, perpMarket: PerpMarket, rootBank: RootBank, payer: Keypair, liabIndex: number, maxLiabTransfer: I80F48): Promise<string>

- Defined in src/client.ts:3845
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- liqorMangoAccount: MangoAccount
- perpMarket: PerpMarket
- rootBank: RootBank
- payer: Keypair
- liabIndex: number
- maxLiabTransfer: I80F48
Returns Promise<string>

resolveTokenBankruptcy

resolveTokenBankruptcy(mangoGroup: MangoGroup, liqeeMangoAccount: MangoAccount, liqorMangoAccount: MangoAccount, quoteRootBank: RootBank, liabRootBank: RootBank, payer: Keypair, maxLiabTransfer: I80F48): Promise<string>

- Defined in src/client.ts:3880
Parameters
- mangoGroup: MangoGroup
- liqeeMangoAccount: MangoAccount
- liqorMangoAccount: MangoAccount
- quoteRootBank: RootBank
- liabRootBank: RootBank
- payer: Keypair
- maxLiabTransfer: I80F48
Returns Promise<string>

sendSignedTransaction

sendSignedTransaction(__namedParameters: { confirmLevel?: TransactionConfirmationStatus; signedAtBlock?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; signedTransaction: Transaction; timeout?: null | number }): Promise<string>

- Defined in src/client.ts:444
Parameters
- __namedParameters: { confirmLevel?: TransactionConfirmationStatus; signedAtBlock?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; signedTransaction: Transaction; timeout?: null | number }
  - Optional confirmLevel?: TransactionConfirmationStatus
  - Optional signedAtBlock?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>
  - signedTransaction: Transaction
  - Optional timeout?: null | number
Returns Promise<string>

sendTransaction

sendTransaction(transaction: Transaction, payer: Payer, additionalSigners: Keypair[], timeout?: null | number, confirmLevel?: TransactionConfirmationStatus): Promise<string>

- Defined in src/client.ts:316
Send a transaction using the Solana Web3.js connection on the mango client

Parameters
- transaction: Transaction
- payer: Payer
- additionalSigners: Keypair[]
- timeout: null | number = ...
  
  Retries sending the transaction and trying to confirm it until the given timeout. Passing null will disable the transaction confirmation check and always return success.
- confirmLevel: TransactionConfirmationStatus = 'processed'
Returns Promise<string>

sendTransactions

sendTransactions(transactions: Transaction[], payer: Payer, additionalSigners: Keypair[], timeout?: null | number, confirmLevel?: TransactionConfirmationStatus): Promise<string[]>

- Defined in src/client.ts:205
Parameters
- transactions: Transaction[]
- payer: Payer
- additionalSigners: Keypair[]
- timeout: null | number = ...
- confirmLevel: TransactionConfirmationStatus = 'processed'
Returns Promise<string[]>

setDelegate

setDelegate(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer, delegate: PublicKey): Promise<undefined | string>

- Defined in src/client.ts:5219
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
- delegate: PublicKey
Returns Promise<undefined | string>

setGroupAdmin

setGroupAdmin(mangoGroup: MangoGroup, newAdmin: PublicKey, admin: Payer): Promise<undefined | string>

- Defined in src/client.ts:4199
Parameters
- mangoGroup: MangoGroup
- newAdmin: PublicKey
- admin: Payer
Returns Promise<undefined | string>

setOracle

setOracle(mangoGroup: MangoGroup, oracle: PublicKey, admin: Keypair, price: I80F48): Promise<string>

- Defined in src/client.ts:2182
Set the price of a 'stub' type oracle

Parameters
- mangoGroup: MangoGroup
- oracle: PublicKey
- admin: Keypair
- price: I80F48
Returns Promise<string>

setReferrerMemory

setReferrerMemory(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer, referrerMangoAccountPk: PublicKey): Promise<undefined | string>

- Defined in src/client.ts:5313
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
- referrerMangoAccountPk: PublicKey
Returns Promise<undefined | string>

setStubOracle

setStubOracle(mangoGroupPk: PublicKey, oraclePk: PublicKey, admin: Keypair, price: number): Promise<string>

- Defined in src/client.ts:3316
Parameters
- mangoGroupPk: PublicKey
- oraclePk: PublicKey
- admin: Keypair
- price: number
Returns Promise<string>

settleAll

settleAll(mangoGroup: MangoGroup, mangoAccount: MangoAccount, spotMarkets: Market[], owner: Payer): Promise<undefined | string[]>

- Defined in src/client.ts:2805
Assumes spotMarkets contains all Markets in MangoGroup in order

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- spotMarkets: Market[]
- owner: Payer
Returns Promise<undefined | string[]>

settleAllPerpPnl

settleAllPerpPnl(mangoGroup: MangoGroup, mangoCache: MangoCache, mangoAccount: MangoAccount, perpMarkets: PerpMarket[], quoteRootBank: RootBank, owner: Payer, mangoAccounts?: MangoAccount[]): Promise<(null | string)[]>

- Defined in src/client.ts:3143
Settle all perp accounts with any pnl

Parameters
- mangoGroup: MangoGroup
- mangoCache: MangoCache
- mangoAccount: MangoAccount
- perpMarkets: PerpMarket[]
- quoteRootBank: RootBank
- owner: Payer
- Optional mangoAccounts: MangoAccount[]
Returns Promise<(null | string)[]>

settleFees

settleFees(mangoGroup: MangoGroup, mangoAccount: MangoAccount, perpMarket: PerpMarket, rootBank: RootBank, payer: Keypair): Promise<string>

- Defined in src/client.ts:3817
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- rootBank: RootBank
- payer: Keypair
Returns Promise<string>

settleFunds

settleFunds(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, spotMarket: Market): Promise<undefined | string>

- Defined in src/client.ts:2744
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- spotMarket: Market
Returns Promise<undefined | string>

settlePnl

settlePnl(mangoGroup: MangoGroup, mangoCache: MangoCache, mangoAccount: MangoAccount, perpMarket: PerpMarket, quoteRootBank: RootBank, price: I80F48, owner: Payer, mangoAccounts?: MangoAccount[]): Promise<null | string>

- Defined in src/client.ts:2962
Automatically fetch MangoAccounts for this PerpMarket Pick enough MangoAccounts that have opposite sign and send them in to get settled

Parameters
- mangoGroup: MangoGroup
- mangoCache: MangoCache
- mangoAccount: MangoAccount
- perpMarket: PerpMarket
- quoteRootBank: RootBank
- price: I80F48
- owner: Payer
- Optional mangoAccounts: MangoAccount[]
Returns Promise<null | string>

settlePosPnl

settlePosPnl(mangoGroup: MangoGroup, mangoCache: MangoCache, mangoAccount: MangoAccount, perpMarkets: PerpMarket[], quoteRootBank: RootBank, owner: Payer, mangoAccounts?: MangoAccount[]): Promise<undefined | string[]>

- Defined in src/client.ts:3089
Settle all perp accounts with positive pnl

Parameters
- mangoGroup: MangoGroup
- mangoCache: MangoCache
- mangoAccount: MangoAccount
- perpMarkets: PerpMarket[]
- quoteRootBank: RootBank
- owner: Payer
- Optional mangoAccounts: MangoAccount[]
Returns Promise<undefined | string[]>

signTransaction

signTransaction(__namedParameters: { currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; payer: any; signers: Keypair[]; transaction: Transaction }): Promise<any>

- Defined in src/client.ts:233
Parameters
- __namedParameters: { currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; payer: any; signers: Keypair[]; transaction: Transaction }
  - Optional currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>
  - payer: any
  - signers: Keypair[]
  - transaction: Transaction
Returns Promise<any>

signTransactions

signTransactions(__namedParameters: { currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; payer: Payer; transactionsAndSigners: { signers?: Keypair[]; transaction: Transaction }[] }): Promise<undefined | Transaction[]>

- Defined in src/client.ts:261
Parameters
- __namedParameters: { currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>; payer: Payer; transactionsAndSigners: { signers?: Keypair[]; transaction: Transaction }[] }
  - Optional currentBlockhash?: Readonly<{ blockhash: string; lastValidBlockHeight: number }>
  - payer: Payer
  - transactionsAndSigners: { signers?: Keypair[]; transaction: Transaction }[]
Returns Promise<undefined | Transaction[]>

updateFunding

updateFunding(mangoGroup: PublicKey, mangoCache: PublicKey, perpMarket: PublicKey, bids: PublicKey, asks: PublicKey, payer: Keypair): Promise<string>

- Defined in src/client.ts:1780
Called by the Keeper to update funding on the perp markets

Parameters
- mangoGroup: PublicKey
- mangoCache: PublicKey
- perpMarket: PublicKey
- bids: PublicKey
- asks: PublicKey
- payer: Keypair
Returns Promise<string>

updateMarginBasket

updateMarginBasket(mangoGroup: MangoGroup, mangoAccount: MangoAccount, payer: Payer): Promise<string>

- Defined in src/client.ts:4818
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- payer: Payer
Returns Promise<string>

updateRootBank

updateRootBank(mangoGroup: MangoGroup, rootBank: PublicKey, nodeBanks: PublicKey[], payer: Payer): Promise<string>

- Defined in src/client.ts:1731
Called by the Keeper to update interest rates on the RootBanks

Parameters
- mangoGroup: MangoGroup
- rootBank: PublicKey
- nodeBanks: PublicKey[]
- payer: Payer
Returns Promise<string>

upgradeMangoAccountV0V1

upgradeMangoAccountV0V1(mangoGroup: MangoGroup, owner: Payer, accountNum: number): Promise<undefined | PublicKey>

- Defined in src/client.ts:894
Upgrade a Mango Account from V0 (not deletable) to V1 (deletable)

Parameters
- mangoGroup: MangoGroup
- owner: Payer
- accountNum: number
Returns Promise<undefined | PublicKey>

withdraw

withdraw(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, rootBank: PublicKey, nodeBank: PublicKey, vault: PublicKey, quantity: number, allowBorrow: boolean): Promise<undefined | string>

- Defined in src/client.ts:1312
Withdraw tokens from a Mango Account

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- rootBank: PublicKey
  
  The RootBank for the withdrawn currency
- nodeBank: PublicKey
  
  The NodeBank asociated with the RootBank
- vault: PublicKey
  
  The token account asociated with the NodeBank
- quantity: number
- allowBorrow: boolean
  
  Whether to borrow tokens if there are not enough deposits for the withdrawal
Returns Promise<undefined | string>

withdraw2

withdraw2(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, rootBank: PublicKey, nodeBank: PublicKey, vault: PublicKey, quantity: number, allowBorrow: boolean): Promise<undefined | string>

- Defined in src/client.ts:1424
Withdraw tokens from a Mango Account, only passing open orders accounts in the margin basket

Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- rootBank: PublicKey
  
  The RootBank for the withdrawn currency
- nodeBank: PublicKey
  
  The NodeBank asociated with the RootBank
- vault: PublicKey
  
  The token account asociated with the NodeBank
- quantity: number
- allowBorrow: boolean
  
  Whether to borrow tokens if there are not enough deposits for the withdrawal
Returns Promise<undefined | string>

withdrawAll

withdrawAll(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer): Promise<void>

- Defined in src/client.ts:1530
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
Returns Promise<void>

withdrawMsrm

withdrawMsrm(mangoGroup: MangoGroup, mangoAccount: MangoAccount, owner: Payer, msrmAccount: PublicKey, quantity: number): Promise<undefined | string>

- Defined in src/client.ts:4082
Parameters
- mangoGroup: MangoGroup
- mangoAccount: MangoAccount
- owner: Payer
- msrmAccount: PublicKey
- quantity: number
Returns Promise<undefined | string>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

connection: Connection

programId: PublicKey

opts: { blockhashCommitment?: Commitment; maxStoredBlockhashes?: number; prioritizationFee?: number; sendConnection?: Connection; timeout?: number; postSendTxCallback?: any } = {}

Optional blockhashCommitment?: Commitment

Optional maxStoredBlockhashes?: number

Optional prioritizationFee?: number

Optional sendConnection?: Connection

Optional timeout?: number

postSendTxCallback?:function

Parameters

__namedParameters: { txid: string }

txid: string

Returns void

Returns MangoClient

Properties

blockhashCommitment

connection

lastSlot

lastValidBlockHeight

Optional postSendTxCallback

Type declaration

Parameters

__namedParameters: { txid: string }

txid: string

Returns void

prioritizationFee

programId

Optional sendConnection

timeout

Methods

addMangoAccountInfo

Parameters

mangoGroup: MangoGroup

mangoAccount: MangoAccount

owner: Payer

info: string

Returns Promise<undefined | string>

addOracle

Parameters

mangoGroup: MangoGroup

oracle: PublicKey

admin: Keypair

Returns Promise<string>

addPerpMarket

Parameters

mangoGroup: MangoGroup

oraclePk: PublicKey

mngoMintPk: PublicKey

admin: Keypair

maintLeverage: number

initLeverage: number

liquidationFee: number

makerFee: number

takerFee: number

baseLotSize: number

quoteLotSize: number

maxNumEvents: number

rate: number

maxDepthBps: number

targetPeriodLength: number

mngoPerPeriod: number

exp: number

Returns Promise<string>

addPerpTriggerOrder

Parameters

mangoGroup: MangoGroup

mangoAccount: MangoAccount

perpMarket: PerpMarket

owner: Payer

orderType: PerpOrderType

side: "buy" | "sell"

price: number