@blockworks-foundation/mango-client

Index

Namespaces

Enumerations

Interfaces

Type aliases

Properties

Variables

Type aliases

BlockhashTimes

BlockhashTimes: { blockhash: string; timestamp: number }

Type declaration

blockhash: string
timestamp: number

Cluster

Cluster: "devnet" | "mainnet" | "localnet" | "testnet"

MarketKind

MarketKind: "spot" | "perp"

Payer

Payer: Adapter | Keypair | WalletAdapter

PerpOrderType

PerpOrderType: "limit" | "ioc" | "postOnly" | "market" | "postOnlySlide"

Properties

IDL

IDL: { events: { fields: ({ index: boolean; name: string; type: string } | { index: boolean; name: string; type: { vec: string } })[]; name: string }[]; instructions: never[]; name: string; version: string }

Type declaration

events: { fields: ({ index: boolean; name: string; type: string } | { index: boolean; name: string; type: { vec: string } })[]; name: string }[]
instructions: never[]
name: string
version: string

IDS

IDS: { cluster_urls: { devnet: string; localnet: string; mainnet: string; testnet: string }; groups: { cluster: string; mangoProgramId: string; name: string; oracles: { publicKey: string; symbol: string }[]; perpMarkets: { asksKey: string; baseDecimals: number; baseSymbol: string; bidsKey: string; eventsKey: string; marketIndex: number; name: string; publicKey: string; quoteDecimals: number }[]; publicKey: string; quoteSymbol: string; serumProgramId: string; spotMarkets: { asksKey: string; baseDecimals: number; baseSymbol: string; bidsKey: string; eventsKey: string; marketIndex: number; name: string; publicKey: string; quoteDecimals: number }[]; tokens: { decimals: number; mintKey: string; nodeKeys: string[]; rootKey: string; symbol: string }[] }[] }

Type declaration

cluster_urls: { devnet: string; localnet: string; mainnet: string; testnet: string }
- devnet: string
- localnet: string
- mainnet: string
- testnet: string
groups: { cluster: string; mangoProgramId: string; name: string; oracles: { publicKey: string; symbol: string }[]; perpMarkets: { asksKey: string; baseDecimals: number; baseSymbol: string; bidsKey: string; eventsKey: string; marketIndex: number; name: string; publicKey: string; quoteDecimals: number }[]; publicKey: string; quoteSymbol: string; serumProgramId: string; spotMarkets: { asksKey: string; baseDecimals: number; baseSymbol: string; bidsKey: string; eventsKey: string; marketIndex: number; name: string; publicKey: string; quoteDecimals: number }[]; tokens: { decimals: number; mintKey: string; nodeKeys: string[]; rootKey: string; symbol: string }[] }[]

Variables

AdvancedOrdersLayout

AdvancedOrdersLayout: any = ...

CENTIBPS_PER_UNIT

CENTIBPS_PER_UNIT: 1000000 = 1_000_000

FREE_ORDER_SLOT

FREE_ORDER_SLOT: 255 = 255

INFO_LEN

INFO_LEN: 32 = 32

MAXIMUM_NUMBER_OF_BLOCKS_FOR_TRANSACTION

MAXIMUM_NUMBER_OF_BLOCKS_FOR_TRANSACTION: 152 = 152

If transaction is not confirmed by validators in 152 blocks from signing by the wallet it will never reach blockchain and is considered a timeout

(e.g. transaction is signed at 121398019 block if its not confirmed by the time blockchain reach 121398171 (121398019 + 152) it will never reach blockchain)

MAX_NODE_BANKS

MAX_NODE_BANKS: 8 = 8

MAX_NUM_IN_MARGIN_BASKET

MAX_NUM_IN_MARGIN_BASKET: 9 = 9

MAX_PAIRS

MAX_PAIRS: number = ...

MAX_PERP_OPEN_ORDERS

MAX_PERP_OPEN_ORDERS: 64 = 64

MAX_TOKENS

MAX_TOKENS: 16 = 16

MangoInstructionLayout

MangoInstructionLayout: MangoInstructionsUnion = ...

QUOTE_INDEX

QUOTE_INDEX: number = ...

delistedOracles

delistedOracles: { marketIndex: number; publicKey: PublicKey; symbol: string }[] = ...

delistedPerpMarkets

delistedPerpMarkets: { baseDecimals: number; baseSymbol: string; marketIndex: number; name: string; publicKey: PublicKey; quoteDecimals: number }[] = ...

delistedSpotMarkets

delistedSpotMarkets: { baseDecimals: number; baseSymbol: string; marketIndex: number; name: string; publicKey: PublicKey }[] = ...

delistedTokens

delistedTokens: { decimals: number; mintKey: PublicKey; symbol: string }[] = ...

mngoMints

mngoMints: { devnet: PublicKey; mainnet: PublicKey; testnet: PublicKey } = ...

Type declaration

devnet: PublicKey
mainnet: PublicKey
testnet: PublicKey

msrmMints

msrmMints: { devnet: PublicKey; localnet: PublicKey; mainnet: PublicKey; testnet: PublicKey } = ...

Type declaration

devnet: PublicKey
localnet: PublicKey
mainnet: PublicKey
testnet: PublicKey

Functions

advancedOrderTypeLayout

advancedOrderTypeLayout(property: any, span: any): EnumLayout

- Defined in src/layout.ts:193
Parameters
- property: any
- span: any
Returns EnumLayout

awaitTransactionSignatureConfirmation

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

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

calculateLotSizes

calculateLotSizes(baseDecimals: number, quoteDecimals: number, minTick: number, minSize: number): { baseLotSize: BN; quoteLotSize: BN }

- Defined in src/utils/utils.ts:490
Calculate the base lot size and quote lot size given a desired min tick and min size in the UI

Parameters
- baseDecimals: number
- quoteDecimals: number
- minTick: number
- minSize: number
Returns { baseLotSize: BN; quoteLotSize: BN }
- baseLotSize: BN
- quoteLotSize: BN

clamp

clamp(x: number, min: number, max: number): number

- Defined in src/utils/utils.ts:411
Parameters
- x: number
- min: number
- max: number
Returns number

createAccountInstruction

createAccountInstruction(connection: Connection, payer: PublicKey, space: number, owner: PublicKey, lamports?: number): Promise<{ account: Keypair; instruction: TransactionInstruction }>

- Defined in src/utils/utils.ts:299
Parameters
- connection: Connection
- payer: PublicKey
- space: number
- owner: PublicKey
- Optional lamports: number
Returns Promise<{ account: Keypair; instruction: TransactionInstruction }>

createSignerKeyAndNonce

createSignerKeyAndNonce(programId: PublicKey, accountKey: PublicKey): Promise<{ signerKey: PublicKey; signerNonce: number }>

- Defined in src/utils/utils.ts:343
Parameters
- programId: PublicKey
- accountKey: PublicKey
Returns Promise<{ signerKey: PublicKey; signerNonce: number }>

createTokenAccountInstructions

createTokenAccountInstructions(connection: Connection, payer: PublicKey, account: PublicKey, mint: PublicKey, owner: PublicKey): Promise<TransactionInstruction[]>

- Defined in src/utils/utils.ts:320
Parameters
- connection: Connection
- payer: PublicKey
- account: PublicKey
- mint: PublicKey
- owner: PublicKey
Returns Promise<TransactionInstruction[]>

expiryTypeLayout

expiryTypeLayout(property: any, span: any): EnumLayout

- Defined in src/layout.ts:197
Parameters
- property: any
- span: any
Returns EnumLayout

findLargestTokenAccountForOwner

findLargestTokenAccountForOwner(connection: Connection, owner: PublicKey, mint: PublicKey): Promise<TokenAccount>

- Defined in src/utils/token.ts:49
Parameters
- connection: Connection
- owner: PublicKey
- mint: PublicKey
Returns Promise<TokenAccount>

findPerpMarketParams

findPerpMarketParams(nativeBaseDecimals: number, quoteDecimals: number, oraclePrice: number, leverage: number, mngoPerHour: number): { baseDecimals: number; baseLotSize: number; decimals: number; exp: number; initLeverage: number; liquidationFee: number; lmSizeShift: number; maintLeverage: number; makerFee: number; maxDepthBps: number; maxNumEvents: number; minSize: number; minTick: number; mngoPerPeriod: number; quoteLotSize: number; rate: number; takerFee: number; targetPeriodLength: number; version: number }

- Defined in src/utils/utils.ts:511
Return some standard params for a new perp market oraclePrice is the current oracle price for the perp market being added Assumes a rate 1000 MNGO per hour for 500k liquidity rewarded nativeBaseDecimals are the decimals for the asset on the native chain

Parameters
- nativeBaseDecimals: number
- quoteDecimals: number
- oraclePrice: number
- leverage: number
- mngoPerHour: number
Returns { baseDecimals: number; baseLotSize: number; decimals: number; exp: number; initLeverage: number; liquidationFee: number; lmSizeShift: number; maintLeverage: number; makerFee: number; maxDepthBps: number; maxNumEvents: number; minSize: number; minTick: number; mngoPerPeriod: number; quoteLotSize: number; rate: number; takerFee: number; targetPeriodLength: number; version: number }
- baseDecimals: number
- baseLotSize: number
- decimals: number
- exp: number
- initLeverage: number
- liquidationFee: number
- lmSizeShift: number
- maintLeverage: number
- makerFee: number
- maxDepthBps: number
- maxNumEvents: number
- minSize: number
- minTick: number
- mngoPerPeriod: number
- quoteLotSize: number
- rate: number
- takerFee: number
- targetPeriodLength: number
- version: number

getAllMarkets

getAllMarkets(group: GroupConfig): MarketConfig[]

- Defined in src/config.ts:247
Parameters
- group: GroupConfig
Returns MarketConfig[]

getFilteredProgramAccounts

getFilteredProgramAccounts(connection: Connection, programId: PublicKey, filters: any): Promise<{ accountInfo: AccountInfo<Buffer>; publicKey: PublicKey }[]>

- Defined in src/utils/utils.ts:371
Parameters
- connection: Connection
- programId: PublicKey
- filters: any
Returns Promise<{ accountInfo: AccountInfo<Buffer>; publicKey: PublicKey }[]>

getMarketByBaseSymbolAndKind

getMarketByBaseSymbolAndKind(group: GroupConfig, symbol: string, kind: MarketKind): MarketConfig

- Defined in src/config.ts:259
Parameters
- group: GroupConfig
- symbol: string
- kind: MarketKind
Returns MarketConfig

getMarketByPublicKey

getMarketByPublicKey(group: GroupConfig, key: string | Buffer | PublicKey): undefined | MarketConfig

- Defined in src/config.ts:271
Parameters
- group: GroupConfig
- key: string | Buffer | PublicKey
Returns undefined | MarketConfig

getMarketIndexBySymbol

getMarketIndexBySymbol(group: GroupConfig, symbol: string): number

- Defined in src/config.ts:202
Parameters
- group: GroupConfig
- symbol: string
Returns number

getMultipleAccounts

getMultipleAccounts(connection: Connection, publicKeys: PublicKey[], commitment?: Commitment): Promise<{ accountInfo: AccountInfo<Buffer>; context: { slot: number }; publicKey: PublicKey }[]>

- Defined in src/utils/utils.ts:421
Parameters
- connection: Connection
- publicKeys: PublicKey[]
- Optional commitment: Commitment
Returns Promise<{ accountInfo: AccountInfo<Buffer>; context: { slot: number }; publicKey: PublicKey }[]>

getOracleBySymbol

getOracleBySymbol(group: GroupConfig, symbol: string): undefined | OracleConfig

- Defined in src/config.ts:213
Parameters
- group: GroupConfig
- symbol: string
Returns undefined | OracleConfig

getOracleConfig

getOracleConfig(group: GroupConfig, predicate: any): undefined | OracleConfig

- Defined in src/config.ts:192
Parameters
- group: GroupConfig
- predicate: any
Returns undefined | OracleConfig

getPerpMarketByBaseSymbol

getPerpMarketByBaseSymbol(group: GroupConfig, symbol: string): undefined | PerpMarketConfig

- Defined in src/config.ts:217
Parameters
- group: GroupConfig
- symbol: string
Returns undefined | PerpMarketConfig

getPerpMarketByIndex

getPerpMarketByIndex(group: GroupConfig, marketIndex: number): PerpMarketConfig | undefined

- Defined in src/config.ts:221
Parameters
- group: GroupConfig
- marketIndex: number
Returns PerpMarketConfig | undefined

getPerpMarketConfig

getPerpMarketConfig(group: GroupConfig, predicate: any): undefined | PerpMarketConfig

- Defined in src/config.ts:172
Parameters
- group: GroupConfig
- predicate: any
Returns undefined | PerpMarketConfig

getPriceFromKey

getPriceFromKey(key: BN): BN

- Defined in src/book.ts:203
Parameters
- key: BN
Returns BN

getSpotMarketByBaseSymbol

getSpotMarketByBaseSymbol(group: GroupConfig, symbol: string): undefined | SpotMarketConfig

- Defined in src/config.ts:228
Parameters
- group: GroupConfig
- symbol: string
Returns undefined | SpotMarketConfig

getSpotMarketConfig

getSpotMarketConfig(group: GroupConfig, predicate: any): undefined | SpotMarketConfig

- Defined in src/config.ts:162
Parameters
- group: GroupConfig
- predicate: any
Returns undefined | SpotMarketConfig

getTokenAccountsByOwnerWithWrappedSol

getTokenAccountsByOwnerWithWrappedSol(connection: Connection, owner: PublicKey): Promise<TokenAccount[]>

- Defined in src/utils/token.ts:24
Parameters
- connection: Connection
- owner: PublicKey
Returns Promise<TokenAccount[]>

getTokenByMint

getTokenByMint(group: GroupConfig, mint: string | Buffer | PublicKey): undefined | TokenConfig

- Defined in src/config.ts:292
Parameters
- group: GroupConfig
- mint: string | Buffer | PublicKey
Returns undefined | TokenConfig

getTokenBySymbol

getTokenBySymbol(group: GroupConfig, symbol: string): TokenConfig

- Defined in src/config.ts:302
Parameters
- group: GroupConfig
- symbol: string
Returns TokenConfig

getTokenConfig

getTokenConfig(group: GroupConfig, predicate: any): undefined | TokenConfig

- Defined in src/config.ts:182
Parameters
- group: GroupConfig
- predicate: any
Returns undefined | TokenConfig

Const getUnixTs

getUnixTs(): number

- Defined in src/client.ts:152
Get the current epoch timestamp in seconds with microsecond precision

Returns number

getWeights

getWeights(mangoGroup: MangoGroup, marketIndex: number, healthType?: HealthType): { perpAssetWeight: I80F48; perpLiabWeight: I80F48; spotAssetWeight: I80F48; spotLiabWeight: I80F48 }

- Defined in src/utils/utils.ts:101
Return weights corresponding to health type; Weights are all 1 if no healthType provided

Parameters
- mangoGroup: MangoGroup
- marketIndex: number
- Optional healthType: HealthType
Returns { perpAssetWeight: I80F48; perpLiabWeight: I80F48; spotAssetWeight: I80F48; spotLiabWeight: I80F48 }
- perpAssetWeight: I80F48
- perpLiabWeight: I80F48
- spotAssetWeight: I80F48
- spotLiabWeight: I80F48

nativeI80F48ToUi

nativeI80F48ToUi(amount: I80F48, decimals: number): I80F48

- Defined in src/utils/utils.ts:71
Parameters
- amount: I80F48
- decimals: number
Returns I80F48

nativeToUi

nativeToUi(amount: number, decimals: number): number

- Defined in src/utils/utils.ts:67
Parameters
- amount: number
- decimals: number
Returns number

optionalBNFromString

optionalBNFromString(x?: string): BN | undefined

- Defined in src/utils/utils.ts:59
Parameters
- Optional x: string
Returns BN | undefined

Const prependFeePrioritizationIx

prependFeePrioritizationIx(transaction: any, prioritizationFee: any): any

- Defined in src/utils/utils.ts:565
Parameters
- transaction: any
- prioritizationFee: any
Returns any

simulateTransaction

simulateTransaction(connection: Connection, transaction: Transaction, commitment: Commitment): Promise<RpcResponseAndContext<SimulatedTransactionResponse>>

- Defined in src/utils/utils.ts:273
Parameters
- connection: Connection
- transaction: Transaction
- commitment: Commitment
Returns Promise<RpcResponseAndContext<SimulatedTransactionResponse>>

sleep

sleep(ms: any): Promise<unknown>

- Defined in src/utils/utils.ts:269
Parameters
- ms: any
Returns Promise<unknown>

splitOpenOrders

splitOpenOrders(openOrders: OpenOrders): { baseFree: I80F48; baseLocked: I80F48; quoteFree: I80F48; quoteLocked: I80F48 }

- Defined in src/utils/utils.ts:135
Parameters
- openOrders: OpenOrders
Returns { baseFree: I80F48; baseLocked: I80F48; quoteFree: I80F48; quoteLocked: I80F48 }
- baseFree: I80F48
- baseLocked: I80F48
- quoteFree: I80F48
- quoteLocked: I80F48

triggerConditionLayout

triggerConditionLayout(property: any, span: any): EnumLayout

- Defined in src/layout.ts:189
Parameters
- property: any
- span: any
Returns EnumLayout

uiToNative

uiToNative(amount: number, decimals: number): BN

- Defined in src/utils/utils.ts:63
Parameters
- amount: number
- decimals: number
Returns BN

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Properties

Variables

Functions

Type aliases

BlockhashTimes

Type declaration

blockhash: string

timestamp: number

Cluster

MarketKind

Payer

PerpOrderType

Properties

IDL

Type declaration

events: { fields: ({ index: boolean; name: string; type: string } | { index: boolean; name: string; type: { vec: string } })[]; name: string }[]

instructions: never[]

name: string

version: string

IDS

Type declaration

cluster_urls: { devnet: string; localnet: string; mainnet: string; testnet: string }

devnet: string

localnet: string

mainnet: string

testnet: string

Variables

AdvancedOrdersLayout

CENTIBPS_PER_UNIT

FREE_ORDER_SLOT

INFO_LEN

MAXIMUM_NUMBER_OF_BLOCKS_FOR_TRANSACTION

MAX_NODE_BANKS

MAX_NUM_IN_MARGIN_BASKET

MAX_PAIRS

MAX_PERP_OPEN_ORDERS

MAX_TOKENS

MangoInstructionLayout

QUOTE_INDEX

delistedOracles

delistedPerpMarkets

delistedSpotMarkets

delistedTokens

mngoMints

Type declaration

devnet: PublicKey

mainnet: PublicKey

testnet: PublicKey

msrmMints

Type declaration

devnet: PublicKey

localnet: PublicKey

mainnet: PublicKey

testnet: PublicKey

Functions

advancedOrderTypeLayout

Parameters

property: any

span: any

Returns EnumLayout

awaitTransactionSignatureConfirmation

Parameters

txid: string

timeout: number

connection: Connection

confirmLevel: TransactionConfirmationStatus

Optional signedAtBlock: Readonly<{ blockhash: string; lastValidBlockHeight: number }>

Returns Promise<unknown>

calculateLotSizes

Parameters

baseDecimals: number

quoteDecimals: number

minTick: number

minSize: number