@raydium-io/raydium-sdk

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

AmountSide

AmountSide: "base" | "quote"

BigNumberish

BigNumberish: BN | string | number | bigint

BitStructure

BitStructure<T, P>: Layout<T, P>

Type parameters

T = unknown
P = ""

Blob

Blob: Layout<Buffer, P>

Type parameters

P: string = ""

ExtensionKey

ExtensionKey: "coingeckoId" | "website" | "whitepaper"

Extensions

Extensions: { [ key in ExtensionKey]?: string }

FarmLedger

FarmLedger: FarmLedgerV3_1 | FarmLedgerV3_2 | FarmLedgerV5_1 | FarmLedgerV5_2

FarmLedgerLayout

FarmLedgerLayout: FarmLedgerLayoutV3_1 | FarmLedgerLayoutV3_2 | FarmLedgerLayoutV5_1 | FarmLedgerLayoutV5_2

FarmLedgerLayoutV3_1

FarmLedgerLayoutV3_1: typeof FARM_LEDGER_LAYOUT_V3_1

FarmLedgerLayoutV3_2

FarmLedgerLayoutV3_2: typeof FARM_LEDGER_LAYOUT_V3_2

FarmLedgerLayoutV5_1

FarmLedgerLayoutV5_1: typeof FARM_LEDGER_LAYOUT_V5_1

FarmLedgerLayoutV5_2

FarmLedgerLayoutV5_2: typeof FARM_LEDGER_LAYOUT_V5_2

FarmPoolKeys

FarmPoolKeys: { [ T in keyof FarmPoolJsonInfo]: FarmPoolJsonInfo[T] extends string ? PublicKey : FarmPoolJsonInfo[T] extends string[] ? PublicKey[] : FarmPoolJsonInfo[T] }

FarmState

FarmState: FarmStateV3 | FarmStateV5

FarmStateLayout

FarmStateLayout: FarmStateLayoutV3 | FarmStateLayoutV5

FarmStateLayoutV3

FarmStateLayoutV3: typeof FARM_STATE_LAYOUT_V3

FarmStateLayoutV5

FarmStateLayoutV5: typeof FARM_STATE_LAYOUT_V5

FarmStateV3

FarmStateV3: GetStructureSchema<FarmStateLayoutV3>

FarmStateV5

FarmStateV5: GetStructureSchema<FarmStateLayoutV5>

FarmVersion

FarmVersion: 3 | 4 | 5

FarmWithdrawInstructionParams

FarmWithdrawInstructionParams: FarmDepositInstructionParams

GetLayoutSchemaFromStructure

GetLayoutSchemaFromStructure<T>: T extends Structure<any, any, infer S> ? S : any

Type parameters

T: Structure<any, any, any>

GetStructureFromLayoutSchema

GetStructureFromLayoutSchema<S>: Structure<any, any, S>

Type parameters

GetStructureSchema

GetStructureSchema<T>: T extends Structure<any, any, infer S> ? S : unknown

Type parameters

T: Structure

LiquidityAddInstructionParams

LiquidityAddInstructionParams: LiquidityAddInstructionParamsV4

Add liquidity instruction params

LiquidityAssociatedPoolKeys

LiquidityAssociatedPoolKeys: LiquidityAssociatedPoolKeysV4

Associated liquidity pool keys

remarks: without partial markets keys

LiquidityCreatePoolInstructionParams

LiquidityCreatePoolInstructionParams: LiquidityCreatePoolInstructionParamsV4

Create pool instruction params

LiquidityCreatePoolTransactionParams

LiquidityCreatePoolTransactionParams: LiquidityCreatePoolInstructionParams

Create pool transaction params

LiquidityInitPoolInstructionParams

LiquidityInitPoolInstructionParams: LiquidityInitPoolInstructionParamsV4

Init pool instruction params

LiquidityPoolKeys

LiquidityPoolKeys: LiquidityPoolKeysV4

Full liquidity pool keys that build transaction need

LiquidityPoolKeysV4

LiquidityPoolKeysV4: { [ T in keyof LiquidityPoolJsonInfo]: string extends LiquidityPoolJsonInfo[T] ? PublicKey : LiquidityPoolJsonInfo[T] }

LiquidityRemoveInstructionParams

LiquidityRemoveInstructionParams: LiquidityRemoveInstructionParamsV4

Remove liquidity instruction params

LiquiditySide

LiquiditySide: "a" | "b"

LiquidityState

LiquidityState: LiquidityStateV4 | LiquidityStateV5

LiquidityStateLayout

LiquidityStateLayout: LiquidityStateLayoutV4 | LiquidityStateLayoutV5

LiquidityStateLayoutV4

LiquidityStateLayoutV4: typeof LIQUIDITY_STATE_LAYOUT_V4

LiquidityStateLayoutV5

LiquidityStateLayoutV5: typeof LIQUIDITY_STATE_LAYOUT_V5

LiquidityStateV4

LiquidityStateV4: GetStructureSchema<LiquidityStateLayoutV4>

LiquidityStateV5

LiquidityStateV5: GetStructureSchema<LiquidityStateLayoutV5>

LiquidityVersion

LiquidityVersion: 4 | 5

LpTokens

LpTokens: { [iterator]: any } & { [ T in string]: LpTokenInfo }

LpTokensJsonInfo

LpTokensJsonInfo: { [iterator]: any } & { [ T in string]: LpTokenJsonInfo }

MarketState

MarketState: MarketStateV3

MarketStateLayout

MarketStateLayout: MarketStateLayoutV3

MarketStateLayoutV3

MarketStateLayoutV3: typeof MARKET_STATE_LAYOUT_V3

MarketStateV3

MarketStateV3: GetStructureSchema<MarketStateLayoutV3>

PublicKeyish

PublicKeyish: PublicKey | string

ReplaceType

ReplaceType<Old, From, To>: { [ T in keyof Old]: Old[T] extends From ? Exclude<Old[T], From> | To : Old[T] extends Primitive ? From extends Old[T] ? Exclude<Old[T], From> | To : Old[T] : ReplaceType<Old[T], From, To> }

example

interface A {
  keyA: string;
  keyB: string;
  map: {
    hello: string;
    i: number;
  };
  list: (string | number)[];
  keyC: number;
}

type WrappedA = ReplaceType<A, string, boolean> // {
  keyA: boolean;
  keyB: boolean;
  map: {
    hello: boolean;
    i: number;
  };
  list: (number | boolean)[];
  keyC: number;
}

Type parameters

Old
From
To

RouteType

RouteType: "amm" | "serum" | "route"

RouteVersion

RouteVersion: 1

SerumVersion

SerumVersion: 3

SplAccount

SplAccount: GetStructureSchema<SplAccountLayout>

SplAccountLayout

SplAccountLayout: typeof SPL_ACCOUNT_LAYOUT

SplMint

SplMint: GetStructureSchema<SplMintLayout>

SplMintLayout

SplMintLayout: typeof SPL_MINT_LAYOUT

SplTokens

SplTokens: { [iterator]: any } & { [ T in string]: SplTokenInfo }

SplTokensJsonInfo

SplTokensJsonInfo: { [iterator]: any } & { [ T in string]: SplTokenJsonInfo }

SwapSide

SwapSide: "in" | "out"

TradeSource

TradeSource: "amm" | "serum" | "stable"

UInt

UInt<T, P>: Layout<T, P>

Type parameters

T = any
P = ""

Without

Without<T, U>: { [ P in Exclude<keyof T, keyof U>]?: never }

Type parameters

XOR

XOR<T, U>: (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U

Type parameters

Variables

ASSOCIATED_TOKEN_PROGRAM_ID

ASSOCIATED_TOKEN_PROGRAM_ID: PublicKey

BitStructure

BitStructure: BitStructureConstructor

Blob

Blob: BlobConstructor

DEVNET_FARM_POOLS

DEVNET_FARM_POOLS: FarmPoolBaseInfo[] = []

DEVNET_LP_TOKENS

DEVNET_LP_TOKENS: LpTokens = ...

DEVNET_OFFICIAL_LIQUIDITY_POOLS

DEVNET_OFFICIAL_LIQUIDITY_POOLS: never[] = []

DEVNET_SPL_TOKENS

DEVNET_SPL_TOKENS: SplTokens = ...

FARM_LEDGER_LAYOUT_V3_1

FARM_LEDGER_LAYOUT_V3_1: Structure<PublicKey | BN | BN[], "", { deposited: BN; id: PublicKey; owner: PublicKey; rewardDebts: BN[]; state: BN }> = ...

FARM_LEDGER_LAYOUT_V3_2

FARM_LEDGER_LAYOUT_V3_2: Structure<PublicKey | BN | BN[], "", { deposited: BN; id: PublicKey; owner: PublicKey; rewardDebts: BN[]; state: BN }> = ...

FARM_LEDGER_LAYOUT_V5_1

FARM_LEDGER_LAYOUT_V5_1: Structure<PublicKey | BN | BN[], "", { deposited: BN; id: PublicKey; owner: PublicKey; rewardDebts: BN[]; state: BN }> = ...

FARM_LEDGER_LAYOUT_V5_2

FARM_LEDGER_LAYOUT_V5_2: Structure<PublicKey | BN | BN[], "", { deposited: BN; id: PublicKey; owner: PublicKey; rewardDebts: BN[]; state: BN }> = ...

FARM_PROGRAMID_TO_VERSION

FARM_PROGRAMID_TO_VERSION: {} = ...

Type declaration

[key: string]: FarmVersion

FARM_PROGRAM_ID_V3

FARM_PROGRAM_ID_V3: PublicKey = ...

FARM_PROGRAM_ID_V5

FARM_PROGRAM_ID_V5: PublicKey = ...

FARM_STATE_LAYOUT_V3

FARM_STATE_LAYOUT_V3: Structure<PublicKey | BN | PublicKey[] | BN[], "", { lastSlot: BN; lpVault: PublicKey; nonce: BN; perShareRewards: BN[]; perSlotRewards: BN[]; rewardVaults: PublicKey[]; state: BN; totalRewards: BN[] }> = ...

FARM_STATE_LAYOUT_V5

FARM_STATE_LAYOUT_V5: GetStructureFromLayoutSchema<{ perShareRewards: BN[]; perSlotRewards: BN[]; rewardVaults: PublicKey[]; totalRewards: BN[] } & { lastSlot: BN; lpVault: PublicKey; nonce: BN; option: number; perShareRewardA: BN; perShareRewardB: BN; perSlotRewardA: BN; perSlotRewardB: BN; rewardVaultA: PublicKey; rewardVaultB: PublicKey; state: BN; totalRewardA: BN; totalRewardB: BN }> = ...

FARM_VERSION_TO_LEDGER_LAYOUT

FARM_VERSION_TO_LEDGER_LAYOUT: { [ version in FarmVersion]?: FarmLedgerLayout } & {} = ...

FARM_VERSION_TO_PROGRAMID

FARM_VERSION_TO_PROGRAMID: { [ key in FarmVersion]?: PublicKey } & {} = ...

FARM_VERSION_TO_STATE_LAYOUT

FARM_VERSION_TO_STATE_LAYOUT: { [ version in FarmVersion]?: FarmStateLayout } & {} = ...

FIVE

FIVE: BN = ...

LIQUIDITY_FEES_DENOMINATOR

LIQUIDITY_FEES_DENOMINATOR: BN = ...

LIQUIDITY_FEES_NUMERATOR

LIQUIDITY_FEES_NUMERATOR: BN = ...

LIQUIDITY_PROGRAMID_TO_VERSION

LIQUIDITY_PROGRAMID_TO_VERSION: {} = ...

Type declaration

[key: string]: LiquidityVersion

LIQUIDITY_PROGRAM_ID_V4

LIQUIDITY_PROGRAM_ID_V4: PublicKey = ...

LIQUIDITY_PROGRAM_ID_V5

LIQUIDITY_PROGRAM_ID_V5: PublicKey = ...

LIQUIDITY_STATE_LAYOUT_V4

LIQUIDITY_STATE_LAYOUT_V4: Structure<PublicKey | BN, "", { amountWaveRatio: BN; baseDecimal: BN; baseLotSize: BN; baseMint: PublicKey; baseNeedTakePnl: BN; baseTotalDeposited: BN; baseTotalPnl: BN; baseVault: PublicKey; depth: BN; lpMint: PublicKey; lpVault: PublicKey; marketId: PublicKey; marketProgramId: PublicKey; maxOrder: BN; maxPriceMultiplier: BN; minPriceMultiplier: BN; minSeparateDenominator: BN; minSeparateNumerator: BN; minSize: BN; nonce: BN; openOrders: PublicKey; owner: PublicKey; pnlDenominator: BN; pnlNumerator: BN; pnlOwner: PublicKey; quoteDecimal: BN; quoteLotSize: BN; quoteMint: PublicKey; quoteNeedTakePnl: BN; quoteTotalDeposited: BN; quoteTotalPnl: BN; quoteVault: PublicKey; resetFlag: BN; state: BN; status: BN; swapBase2QuoteFee: BN; swapBaseInAmount: BN; swapBaseOutAmount: BN; swapFeeDenominator: BN; swapFeeNumerator: BN; swapQuote2BaseFee: BN; swapQuoteInAmount: BN; swapQuoteOutAmount: BN; systemDecimalValue: BN; targetOrders: PublicKey; tradeFeeDenominator: BN; tradeFeeNumerator: BN; volMaxCutRatio: BN; withdrawQueue: PublicKey }> = ...

LIQUIDITY_STATE_LAYOUT_V5

LIQUIDITY_STATE_LAYOUT_V5: Structure<PublicKey | BN | BN[], "", { abortTradeFactor: BN; accountType: BN; amountWaveRatio: BN; baseDecimal: BN; baseLotSize: BN; baseMint: PublicKey; baseNeedTakePnl: BN; baseTotalPnl: BN; baseVault: PublicKey; depth: BN; lpMint: PublicKey; marketId: PublicKey; marketProgramId: PublicKey; maxOrder: BN; maxPriceMultiplier: BN; minPriceMultiplier: BN; minSeparateDenominator: BN; minSeparateNumerator: BN; minSize: BN; modelDataAccount: PublicKey; nonce: BN; openOrders: PublicKey; orderbookToInitTime: BN; owner: PublicKey; padding: BN[]; pnlDenominator: BN; pnlNumerator: BN; poolOpenTime: BN; priceTick: BN; priceTickMultiplier: BN; punishCoinAmount: BN; punishPcAmount: BN; quoteDecimal: BN; quoteLotSize: BN; quoteMint: PublicKey; quoteNeedTakePnl: BN; quoteTotalPnl: BN; quoteVault: PublicKey; resetFlag: BN; state: BN; status: BN; swapBase2QuoteFee: BN; swapBaseInAmount: BN; swapBaseOutAmount: BN; swapFeeDenominator: BN; swapFeeNumerator: BN; swapQuote2BaseFee: BN; swapQuoteInAmount: BN; swapQuoteOutAmount: BN; systemDecimalsValue: BN; targetOrders: PublicKey; tradeFeeDenominator: BN; tradeFeeNumerator: BN; volMaxCutRatio: BN }> = ...

LIQUIDITY_VERSION_TO_PROGRAMID

LIQUIDITY_VERSION_TO_PROGRAMID: { [ key in LiquidityVersion]?: PublicKey } & {} = ...

LIQUIDITY_VERSION_TO_SERUM_VERSION

LIQUIDITY_VERSION_TO_SERUM_VERSION: { [ key in LiquidityVersion]?: SerumVersion } & {} = ...

LIQUIDITY_VERSION_TO_STATE_LAYOUT

LIQUIDITY_VERSION_TO_STATE_LAYOUT: {} = ...

Type declaration

[version: number]: LiquidityStateLayout

Layout

Layout: LayoutConstructor

MAINNET_FARM_POOLS

MAINNET_FARM_POOLS: FarmPoolBaseInfo[] = ...

MAINNET_LP_TOKENS

MAINNET_LP_TOKENS: LpTokens = ...

MAINNET_OFFICIAL_LIQUIDITY_POOLS

MAINNET_OFFICIAL_LIQUIDITY_POOLS: string[] = ...

MAINNET_SPL_TOKENS

MAINNET_SPL_TOKENS: SplTokens = ...

MARKET_STATE_LAYOUT_V3

MARKET_STATE_LAYOUT_V3: Structure<PublicKey | BN | Buffer, "", { asks: PublicKey; baseDepositsTotal: BN; baseFeesAccrued: BN; baseLotSize: BN; baseMint: PublicKey; baseVault: PublicKey; bids: PublicKey; eventQueue: PublicKey; feeRateBps: BN; ownAddress: PublicKey; quoteDepositsTotal: BN; quoteDustThreshold: BN; quoteFeesAccrued: BN; quoteLotSize: BN; quoteMint: PublicKey; quoteVault: PublicKey; referrerRebatesAccrued: BN; requestQueue: PublicKey; vaultSignerNonce: BN }> = ...

MARKET_VERSION_TO_STATE_LAYOUT

MARKET_VERSION_TO_STATE_LAYOUT: {} = ...

Type declaration

[version: number]: MarketStateLayout

MEMO_PROGRAM_ID

MEMO_PROGRAM_ID: PublicKey = ...

ONE

ONE: BN = ...

REAL_FARM_STATE_LAYOUT_V5

REAL_FARM_STATE_LAYOUT_V5: Structure<number | PublicKey | BN | Buffer, "", { lastSlot: BN; lpVault: PublicKey; nonce: BN; option: number; perShareRewardA: BN; perShareRewardB: BN; perSlotRewardA: BN; perSlotRewardB: BN; rewardVaultA: PublicKey; rewardVaultB: PublicKey; state: BN; totalRewardA: BN; totalRewardB: BN }> = ...

ROUTE_PROGRAMID_TO_VERSION

ROUTE_PROGRAMID_TO_VERSION: {} = ...

Type declaration

[key: string]: RouteVersion

ROUTE_PROGRAM_ID_V1

ROUTE_PROGRAM_ID_V1: PublicKey = ...

ROUTE_VERSION_TO_LIQUIDITY_VERSION

ROUTE_VERSION_TO_LIQUIDITY_VERSION: { [ key in RouteVersion]?: LiquidityVersion } & {} = ...

ROUTE_VERSION_TO_PROGRAMID

ROUTE_VERSION_TO_PROGRAMID: { [ key in RouteVersion]?: PublicKey } & {} = ...

SERUM_PROGRAMID_TO_VERSION

SERUM_PROGRAMID_TO_VERSION: {} = ...

Type declaration

[key: string]: SerumVersion

SERUM_PROGRAM_ID_V3

SERUM_PROGRAM_ID_V3: PublicKey = ...

SERUM_VERSION_TO_PROGRAMID

SERUM_VERSION_TO_PROGRAMID: { [ key in SerumVersion]?: PublicKey } & {} = ...

SOL

SOL: NativeTokenInfo = ...

SPL_ACCOUNT_LAYOUT

SPL_ACCOUNT_LAYOUT: Structure<number | PublicKey | BN, "", { amount: BN; closeAuthority: PublicKey; closeAuthorityOption: number; delegate: PublicKey; delegateOption: number; delegatedAmount: BN; isNative: BN; isNativeOption: number; mint: PublicKey; owner: PublicKey; state: number }> = ...

SPL_MINT_LAYOUT

SPL_MINT_LAYOUT: Structure<number | PublicKey | BN, "", { decimals: number; freezeAuthority: PublicKey; freezeAuthorityOption: number; isInitialized: number; mintAuthority: PublicKey; mintAuthorityOption: number; supply: BN }> = ...

SYSTEM_PROGRAM_ID

SYSTEM_PROGRAM_ID: PublicKey = SystemProgram.programId

SYSVAR_CLOCK_PUBKEY

SYSVAR_CLOCK_PUBKEY: PublicKey

SYSVAR_RENT_PUBKEY

SYSVAR_RENT_PUBKEY: PublicKey

TEN

TEN: BN = ...

TESTNET_FARM_POOLS

TESTNET_FARM_POOLS: FarmPoolBaseInfo[] = []

TESTNET_LP_TOKENS

TESTNET_LP_TOKENS: LpTokens = ...

TESTNET_OFFICIAL_LIQUIDITY_POOLS

TESTNET_OFFICIAL_LIQUIDITY_POOLS: never[] = []

TESTNET_SPL_TOKENS

TESTNET_SPL_TOKENS: SplTokens = ...

THREE

THREE: BN = ...

TOKEN_PROGRAM_ID

TOKEN_PROGRAM_ID: PublicKey

TWO

TWO: BN = ...

UInt

UInt: UIntConstructor

WSOL

WSOL: SplTokenInfo = ...

ZERO

ZERO: BN = ...

_100

_100: BN = ...

_1000

_1000: BN = ...

_10000

_10000: BN = ...

_100_PERCENT

_100_PERCENT: Fraction = ...

_FARM_PROGRAM_ID_V3

_FARM_PROGRAM_ID_V3: "EhhTKczWMGQt46ynNeRX1WfeagwwJd7ufHvCDjRxjo5Q" = "EhhTKczWMGQt46ynNeRX1WfeagwwJd7ufHvCDjRxjo5Q"

_FARM_PROGRAM_ID_V5

_FARM_PROGRAM_ID_V5: "9KEPoZmtHUrBbhWN1v1KWLMkkvwY6WLtAVUCPRtRjP4z" = "9KEPoZmtHUrBbhWN1v1KWLMkkvwY6WLtAVUCPRtRjP4z"

_LIQUIDITY_PROGRAM_ID_V4

_LIQUIDITY_PROGRAM_ID_V4: "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8" = "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"

_LIQUIDITY_PROGRAM_ID_V5

_LIQUIDITY_PROGRAM_ID_V5: "5quBtoiQqxF9Jv6KYKctB59NT3gtJD2Y65kdnB1Uev3h" = "5quBtoiQqxF9Jv6KYKctB59NT3gtJD2Y65kdnB1Uev3h"

_ROUTE_PROGRAM_ID_V1

_ROUTE_PROGRAM_ID_V1: "routeUGWgWzqBWFcrCfv8tritsqukccJPu3q5GPP3xS" = "routeUGWgWzqBWFcrCfv8tritsqukccJPu3q5GPP3xS"

_SERUM_PROGRAM_ID_V3

_SERUM_PROGRAM_ID_V3: "9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin" = "9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin"

Functions

AccountMeta

AccountMeta(publicKey: PublicKey, isSigner: boolean): { isSigner: boolean; isWritable: boolean; pubkey: PublicKey }

- Defined in src/common/pubkey.ts:39
Parameters
- publicKey: PublicKey
- isSigner: boolean
Returns { isSigner: boolean; isWritable: boolean; pubkey: PublicKey }
- isSigner: boolean
- isWritable: boolean
- pubkey: PublicKey

AccountMetaReadonly

AccountMetaReadonly(publicKey: PublicKey, isSigner: boolean): { isSigner: boolean; isWritable: boolean; pubkey: PublicKey }

- Defined in src/common/pubkey.ts:47
Parameters
- publicKey: PublicKey
- isSigner: boolean
Returns { isSigner: boolean; isWritable: boolean; pubkey: PublicKey }
- isSigner: boolean
- isWritable: boolean
- pubkey: PublicKey

array

array<T, P>(elementLayout: Layout<T, "">, length: number, property?: P): Layout<T[], P>

- Defined in src/marshmallow/index.ts:249
Type parameters
- T
- P: string = ""
Parameters
- elementLayout: Layout<T, "">
- length: number
- Optional property: P
Returns Layout<T[], P>

Const bits

bits<T, P>(word: Layout<T, "">, msb?: boolean, property?: P): BitStructure<T, P>

- Defined in src/marshmallow/buffer-layout.ts:157
Type parameters
- T
- P: string = ""
Parameters
- word: Layout<T, "">
- Optional msb: boolean
- Optional property: P
Returns BitStructure<T, P>

Const blob

blob(length: number | Layout<number, P>, property?: P): Blob

- Defined in src/marshmallow/buffer-layout.ts:154
Type parameters
- P: string = ""
Parameters
- length: number | Layout<number, P>
- Optional property: P
Returns Blob

bool

bool(property?: P): Layout<boolean, P>

- Defined in src/marshmallow/index.ts:175
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<boolean, P>

chunkArray

chunkArray<T>(arr: T[], chunkSize?: number, cache?: T[][]): T[][]

- Defined in src/common/lodash.ts:5
https://youmightnotneed.com/lodash/

Type parameters
- T
Parameters
- arr: T[]
- chunkSize: number = 1
- cache: T[][] = []
Returns T[][]

Const cstr

cstr(property?: P): Layout<string, P>

- Defined in src/marshmallow/buffer-layout.ts:155
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<string, P>

currencyEquals

currencyEquals(currencyA: Currency, currencyB: Currency): boolean

- Defined in src/entity/currency.ts:118
Compares two currencies for equality

Parameters
- currencyA: Currency
- currencyB: Currency
Returns boolean

decodeBool

decodeBool(value: number): boolean

- Defined in src/marshmallow/index.ts:179
Parameters
- value: number
Returns boolean

divCeil

divCeil(a: BN, b: BN): BN

- Defined in src/entity/bignumber.ts:54
Parameters
- a: BN
- b: BN
Returns BN

encodeBool

encodeBool(value: boolean): number

- Defined in src/marshmallow/index.ts:188
Parameters
- value: boolean
Returns number

Const f32

f32(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:120
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const f32be

f32be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:121
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const f64

f64(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:122
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const f64be

f64be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:123
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

findProgramAddress

findProgramAddress(seeds: (Buffer | Uint8Array)[], programId: PublicKey): Promise<{ nonce: number; publicKey: PublicKey }>

- Defined in src/common/pubkey.ts:34
Parameters
- seeds: (Buffer | Uint8Array)[]
- programId: PublicKey
Returns Promise<{ nonce: number; publicKey: PublicKey }>

forecastTransactionSize

forecastTransactionSize(instructions: TransactionInstruction[], signers: PublicKey[]): number

- Defined in src/common/web3.ts:184
Forecast transaction size

Parameters
- instructions: TransactionInstruction[]
- signers: PublicKey[]
Returns number

getMultipleAccountsInfo

getMultipleAccountsInfo(connection: Connection, publicKeys: PublicKey[], config?: GetMultipleAccountsInfoConfig): Promise<(AccountInfo<Buffer> | null)[]>

- Defined in src/common/web3.ts:36
Parameters
- connection: Connection
- publicKeys: PublicKey[]
- Optional config: GetMultipleAccountsInfoConfig
Returns Promise<(AccountInfo<Buffer> | null)[]>

getMultipleAccountsInfoWithCustomFlags

getMultipleAccountsInfoWithCustomFlags<T>(connection: Connection, publicKeysWithCustomFlag: T[], config?: GetMultipleAccountsInfoConfig): Promise<({ accountInfo: AccountInfo<Buffer> | null } & T)[]>

- Defined in src/common/web3.ts:108
Type parameters
- T: { pubkey: PublicKey }
Parameters
- connection: Connection
- publicKeysWithCustomFlag: T[]
- Optional config: GetMultipleAccountsInfoConfig
Returns Promise<({ accountInfo: AccountInfo<Buffer> | null } & T)[]>

Const greedy

greedy(elementSpan?: number, property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:93
Type parameters
- P: string = ""
Parameters
- Optional elementSpan: number
- Optional property: P
Returns Layout<number, P>

i128

i128(property?: P): BNLayout

- Defined in src/marshmallow/index.ts:92
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns BNLayout

i64

i64(property?: P): BNLayout

- Defined in src/marshmallow/index.ts:88
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns BNLayout

inspectAll

inspectAll(): void

- Defined in src/common/inspect.ts:49
Returns void

inspectBN

inspectBN(): void

- Defined in src/common/inspect.ts:26
Returns void

inspectCurrency

inspectCurrency(): void

- Defined in src/entity/currency.ts:37
Returns void

inspectPublicKey

inspectPublicKey(): void

- Defined in src/common/inspect.ts:6
Returns void

inspectToken

inspectToken(): void

- Defined in src/entity/currency.ts:88
Returns void

intersection

intersection<T>(arr: T[], ...args: T[][]): T[]

- Defined in src/common/lodash.ts:12
Type parameters
- T
Parameters
- arr: T[]
- Rest ...args: T[][]
Returns T[]

jsonInfo2PoolKeys

jsonInfo2PoolKeys<T>(jsonInfo: T): ReplaceType<T, string, PublicKey>

- Defined in src/common/convert-json.ts:44
Type parameters
- T
Parameters
- jsonInfo: T
Returns ReplaceType<T, string, PublicKey>

Const ns64

ns64(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:113
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const ns64be

ns64be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:119
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const nu64

nu64(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:100
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const nu64be

nu64be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:106
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const offset

offset<T, P>(layout: Layout<T, P>, offset?: number, property?: P): Layout<T, P>

- Defined in src/marshmallow/buffer-layout.ts:162
Type parameters
- T
- P: string = ""
Parameters
- layout: Layout<T, P>
- Optional offset: number
- Optional property: P
Returns Layout<T, P>

option

option<T, P>(layout: Layout<T, "">, property?: P): Layout<T | null, P>

- Defined in src/marshmallow/index.ts:171
Type parameters
- T
- P: string = ""
Parameters
- layout: Layout<T, "">
- Optional property: P
Returns Layout<T | null, P>

parseBigNumberish

parseBigNumberish(value: BigNumberish): BN

- Defined in src/entity/bignumber.ts:13
Parameters
- value: BigNumberish
Returns BN

parseSimulateLogToJson

parseSimulateLogToJson(log: string, keyword: string): string

- Defined in src/common/web3.ts:263
Parameters
- log: string
- keyword: string
Returns string

parseSimulateValue

parseSimulateValue(log: string, key: string): string

- Defined in src/common/web3.ts:272
Parameters
- log: string
- key: string
Returns string

poolKeys2JsonInfo

poolKeys2JsonInfo<T>(jsonInfo: T): ReplaceType<T, PublicKey, string>

- Defined in src/common/convert-json.ts:59
Type parameters
- T
Parameters
- jsonInfo: T
Returns ReplaceType<T, PublicKey, string>

publicKey

publicKey(property?: P): Layout<PublicKey, P>

- Defined in src/marshmallow/index.ts:122
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<PublicKey, P>

rustEnum

rustEnum<T, P>(variants: Layout<any, "">[], property?: P): EnumLayout<T, P>

- Defined in src/marshmallow/index.ts:243
Type parameters
- T
- P: string = ""
Parameters
- variants: Layout<any, "">[]
- Optional property: P
Returns EnumLayout<T, P>

Const s16

s16(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:108
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s16be

s16be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:114
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s24

s24(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:109
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s24be

s24be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:115
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s32

s32(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:110
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s32be

s32be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:116
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s40

s40(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:111
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s40be

s40be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:117
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s48

s48(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:112
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s48be

s48be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:118
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const s8

s8(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:107
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

seq

seq<T, P, AnotherP>(elementLayout: Layout<T, P>, count: number | BN | Layout<number | BN, P>, property?: AnotherP): Layout<T[], AnotherP>

- Defined in src/marshmallow/index.ts:327
Type parameters
- T
- P: string = ""
- AnotherP: string = ""
Parameters
- elementLayout: Layout<T, P>
- count: number | BN | Layout<number | BN, P>
- Optional property: AnotherP
Returns Layout<T[], AnotherP>

simulateMultipleInstruction

simulateMultipleInstruction(connection: Connection, instructions: TransactionInstruction[], keyword: string): Promise<string[]>

- Defined in src/common/web3.ts:209
Simulates multiple instruction

Parameters
- connection: Connection
- instructions: TransactionInstruction[]
- keyword: string
Returns Promise<string[]>

splitNumber

splitNumber(num: string, decimals: number): string[]

- Defined in src/entity/amount.ts:17
Parameters
- num: string
- decimals: number
Returns string[]

str

str(property?: P): Layout<string, P>

- Defined in src/marshmallow/index.ts:230
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<string, P>

struct

struct<T, P>(fields: T, property?: P, decodePrefixes?: boolean): T extends Layout<infer Value, infer Property>[] ? Structure<Value, P, { [ K in Exclude<Extract<Property, string>, "">]: Extract<T[number], Layout<any, K>> extends Layout<infer V, any> ? V : any }> : any

- Defined in src/marshmallow/index.ts:270
Type parameters
- T
- P: string = ""
Parameters
- fields: T
- Optional property: P
- Optional decodePrefixes: boolean
Returns T extends Layout<infer Value, infer Property>[] ? Structure<Value, P, { [ K in Exclude<Extract<Property, string>, "">]: Extract<T[number], Layout<any, K>> extends Layout<infer V, any> ? V : any }> : any

tagged

tagged<T, P>(tag: BN, layout: Layout<T, "">, property?: P): Layout<T, P>

- Defined in src/marshmallow/index.ts:206
Type parameters
- T
- P: string = ""
Parameters
- tag: BN
- layout: Layout<T, "">
- Optional property: P
Returns Layout<T, P>

tenExponentiate

tenExponentiate(shift: BigNumberish): BN

- Defined in src/entity/bignumber.ts:49
Parameters
- shift: BigNumberish
Returns BN

u128

u128(property?: P): BNLayout

- Defined in src/marshmallow/index.ts:84
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns BNLayout

Const u16

u16(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:95
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u16be

u16be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:101
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u24

u24(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:96
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u24be

u24be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:102
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

u32

u32(property?: P): UInt<number, P>

- Defined in src/marshmallow/index.ts:76
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns UInt<number, P>

Const u32be

u32be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:103
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u40

u40(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:98
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u40be

u40be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:104
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u48

u48(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:99
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

Const u48be

u48be(property?: P): Layout<number, P>

- Defined in src/marshmallow/buffer-layout.ts:105
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<number, P>

u64

u64(property?: P): BNLayout

- Defined in src/marshmallow/index.ts:80
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns BNLayout

u8

u8(property?: P): UInt<number, P>

- Defined in src/marshmallow/index.ts:72
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns UInt<number, P>

union

union<UnionSchema>(discr: any, defaultLayout?: any, property?: string): Union<UnionSchema>

- Defined in src/marshmallow/index.ts:305
Type parameters
- UnionSchema: {} = any
Parameters
- discr: any
- Optional defaultLayout: any
- Optional property: string
Returns Union<UnionSchema>

Const unionLayoutDiscriminator

unionLayoutDiscriminator(layout: Layout<any, P>, property?: P): any

- Defined in src/marshmallow/buffer-layout.ts:150
Type parameters
- P: string = ""
Parameters
- layout: Layout<any, P>
- Optional property: P
Returns any

uniq

uniq<T>(arr: T[]): T[]

- Defined in src/common/lodash.ts:20
Type parameters
- T
Parameters
- arr: T[]
Returns T[]

Const utf8

utf8(maxSpan: number, property?: P): Layout<string, P>

- Defined in src/marshmallow/buffer-layout.ts:156
Type parameters
- P: string = ""
Parameters
- maxSpan: number
- Optional property: P
Returns Layout<string, P>

validateAndParsePublicKey

validateAndParsePublicKey(publicKey: PublicKeyish): PublicKey

- Defined in src/common/pubkey.ts:17
Parameters
- publicKey: PublicKeyish
Returns PublicKey

vec

vec<T, P>(elementLayout: Layout<T, "">, property?: P): Layout<T[], P>

- Defined in src/marshmallow/index.ts:192
Type parameters
- T
- P: string = ""
Parameters
- elementLayout: Layout<T, "">
- Optional property: P
Returns Layout<T[], P>

vecU8

vecU8(property?: P): Layout<Buffer, P>

- Defined in src/marshmallow/index.ts:219
Type parameters
- P: string = ""
Parameters
- Optional property: P
Returns Layout<Buffer, P>

xor

xor<T>(arr: T[], ...args: T[][]): T[]

- Defined in src/common/lodash.ts:16
Type parameters
- T
Parameters
- arr: T[]
- Rest ...args: T[][]
Returns T[]

zeros

zeros(length: number): Zeros

- Defined in src/marshmallow/index.ts:323
Parameters
- length: number
Returns Zeros

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AmountSide

BigNumberish

BitStructure

Type parameters

T = unknown

P = ""

Blob

Type parameters

P: string = ""

ExtensionKey

Extensions

FarmLedger

FarmLedgerLayout

FarmLedgerLayoutV3_1

FarmLedgerLayoutV3_2

FarmLedgerLayoutV5_1

FarmLedgerLayoutV5_2

FarmLedgerV3_1

FarmLedgerV3_2

FarmLedgerV5_1

FarmLedgerV5_2

FarmPoolKeys

FarmState

FarmStateLayout

FarmStateLayoutV3

FarmStateLayoutV5

FarmStateV3

FarmStateV5

FarmVersion

FarmWithdrawInstructionParams

GetLayoutSchemaFromStructure

Type parameters

T: Structure<any, any, any>

GetStructureFromLayoutSchema

Type parameters

S

GetStructureSchema

Type parameters

T: Structure

LiquidityAddInstructionParams

LiquidityAssociatedPoolKeys

LiquidityCreatePoolInstructionParams

LiquidityCreatePoolTransactionParams

LiquidityInitPoolInstructionParams

LiquidityPoolKeys

LiquidityPoolKeysV4

LiquidityRemoveInstructionParams

LiquiditySide

LiquidityState

LiquidityStateLayout

LiquidityStateLayoutV4

LiquidityStateLayoutV5

LiquidityStateV4

LiquidityStateV5

LiquidityVersion

LpTokens

LpTokensJsonInfo

MarketState

MarketStateLayout

MarketStateLayoutV3

MarketStateV3

PublicKeyish

ReplaceType

Type parameters

Old

From

To

RouteType

RouteVersion

SerumVersion

SplAccount

SplAccountLayout