Liquidity | @raydium-io/raydium-sdk

Hierarchy

Base
- Liquidity

Index

Constructors

constructor

Methods

Constructors

constructor

new Liquidity(): Liquidity

Inherited from Base.constructor
Returns Liquidity

Methods

Static _computePriceImpact

_computePriceImpact(currentPrice: Price, amountIn: BN, amountOut: BN): Percent

- Defined in src/liquidity/liquidity.ts:1853
Parameters
- currentPrice: Price
- amountIn: BN
- amountOut: BN
Returns Percent

Static _getAmountSide

_getAmountSide(amount: TokenAmount | CurrencyAmount, poolKeys: LiquidityPoolKeysV4): AmountSide

- Defined in src/liquidity/liquidity.ts:1757
Get currency amount side of liquidity pool

Parameters
- amount: TokenAmount | CurrencyAmount
  
  the currency amount provided
- poolKeys: LiquidityPoolKeysV4
  
  the pool keys
Returns AmountSide
currency amount side is base or quote

Static _getAmountsSide

_getAmountsSide(amountA: TokenAmount | CurrencyAmount, amountB: TokenAmount | CurrencyAmount, poolKeys: LiquidityPoolKeysV4): AmountSide[]

- Defined in src/liquidity/liquidity.ts:1770
Get currencies amount side of liquidity pool

Parameters
- amountA: TokenAmount | CurrencyAmount
  
  the currency amount provided
- amountB: TokenAmount | CurrencyAmount
  
  the currency amount provided
- poolKeys: LiquidityPoolKeysV4
  
  the pool keys
Returns AmountSide[]
currencies amount side array

Static _getTokenSide

_getTokenSide(token: Token, poolKeys: LiquidityPoolKeysV4): AmountSide

- Defined in src/liquidity/liquidity.ts:1716
Get token side of liquidity pool

Parameters
- token: Token
  
  the token provided
- poolKeys: LiquidityPoolKeysV4
  
  the pool keys
Returns AmountSide
token side is base or quote

Static _getTokensSide

_getTokensSide(tokenA: Token, tokenB: Token, poolKeys: LiquidityPoolKeysV4): AmountSide[]

- Defined in src/liquidity/liquidity.ts:1736
Get tokens side of liquidity pool

Parameters
- tokenA: Token
  
  the token provided
- tokenB: Token
  
  the token provided
- poolKeys: LiquidityPoolKeysV4
  
  the pool keys
Returns AmountSide[]
tokens side array

Static _handleTokenAccount

_handleTokenAccount(params: HandleTokenAccountParams): Promise<PublicKey>

Inherited from Base._handleTokenAccount
- Defined in src/base/base.ts:71
Parameters
- params: HandleTokenAccountParams
Returns Promise<PublicKey>

Static _selectTokenAccount

_selectTokenAccount(params: SelectTokenAccountParams): Promise<null | PublicKey>

Inherited from Base._selectTokenAccount
- Defined in src/base/base.ts:38
Parameters
- params: SelectTokenAccountParams
Returns Promise<null | PublicKey>

Static computeAmountIn

computeAmountIn(params: LiquidityComputeAmountInParams): { amountIn: CurrencyAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: CurrencyAmount; priceImpact: Percent } | { amountIn: TokenAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: TokenAmount; priceImpact: Percent }

- Defined in src/liquidity/liquidity.ts:2026
Compute input currency amount of swap

Parameters
- params: LiquidityComputeAmountInParams
  
  {@link ComputeCurrencyAmountInParams}
Returns { amountIn: CurrencyAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: CurrencyAmount; priceImpact: Percent } | { amountIn: TokenAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: TokenAmount; priceImpact: Percent }
amountIn - currency amount without slippage

Static computeAmountOut

computeAmountOut(params: LiquidityComputeAmountOutParams): { amountOut: CurrencyAmount; currentPrice: Price; executionPrice: null | Price; fee: CurrencyAmount; minAmountOut: CurrencyAmount; priceImpact: Percent } | { amountOut: TokenAmount; currentPrice: Price; executionPrice: null | Price; fee: CurrencyAmount; minAmountOut: TokenAmount; priceImpact: Percent }

- Defined in src/liquidity/liquidity.ts:1877
Compute output currency amount of swap

Parameters
- params: LiquidityComputeAmountOutParams
  
  LiquidityComputeAmountOutParams
Returns { amountOut: CurrencyAmount; currentPrice: Price; executionPrice: null | Price; fee: CurrencyAmount; minAmountOut: CurrencyAmount; priceImpact: Percent } | { amountOut: TokenAmount; currentPrice: Price; executionPrice: null | Price; fee: CurrencyAmount; minAmountOut: TokenAmount; priceImpact: Percent }
amountOut - currency amount without slippage

Static computeAnotherAmount

computeAnotherAmount(params: LiquidityComputeAnotherAmountParams): { anotherAmount: CurrencyAmount; maxAnotherAmount: CurrencyAmount } | { anotherAmount: TokenAmount; maxAnotherAmount: TokenAmount }

- Defined in src/liquidity/liquidity.ts:1801
Compute the another currency amount of add liquidity
example
```
Liquidity.computeAnotherAmount({
  // 1%
  slippage: new Percent(1, 100)
})
```
Parameters
- params: LiquidityComputeAnotherAmountParams
  
  LiquidityComputeAnotherAmountParams
Returns { anotherAmount: CurrencyAmount; maxAnotherAmount: CurrencyAmount } | { anotherAmount: TokenAmount; maxAnotherAmount: TokenAmount }
anotherCurrencyAmount - currency amount without slippage

Static fetchAllPoolKeys

fetchAllPoolKeys(connection: Connection, config?: GetMultipleAccountsInfoConfig): Promise<LiquidityPoolKeysV4[]>

- Defined in src/liquidity/liquidity.ts:1385
Fetch all pools keys from on-chain data

Parameters
- connection: Connection
- Optional config: GetMultipleAccountsInfoConfig
Returns Promise<LiquidityPoolKeysV4[]>

Static fetchInfo

fetchInfo(__namedParameters: LiquidityFetchInfoParams): Promise<LiquidityPoolInfo>

- Defined in src/liquidity/liquidity.ts:1574
Fetch liquidity pool's info

Parameters
- __namedParameters: LiquidityFetchInfoParams
Returns Promise<LiquidityPoolInfo>

Static fetchMultipleInfo

fetchMultipleInfo(__namedParameters: LiquidityFetchMultipleInfoParams): Promise<LiquidityPoolInfo[]>

- Defined in src/liquidity/liquidity.ts:1590
Fetch multiple info of liquidity pools

Parameters
- __namedParameters: LiquidityFetchMultipleInfoParams
Returns Promise<LiquidityPoolInfo[]>

Static getAssociatedAuthority

getAssociatedAuthority(__namedParameters: { programId: PublicKey }): Promise<{ nonce: number; publicKey: PublicKey }>

- Defined in src/liquidity/liquidity.ts:404
Parameters
- __namedParameters: { programId: PublicKey }
  - programId: PublicKey
Returns Promise<{ nonce: number; publicKey: PublicKey }>

Static getAssociatedBaseVault

getAssociatedBaseVault(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:412
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedId

getAssociatedId(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:396
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedLpMint

getAssociatedLpMint(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:428
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedLpVault

getAssociatedLpVault(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:436
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedOpenOrders

getAssociatedOpenOrders(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:460
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedPoolKeys

getAssociatedPoolKeys(__namedParameters: { baseMint: PublicKey; marketId: PublicKey; quoteMint: PublicKey; version: number }): Promise<LiquidityAssociatedPoolKeysV4>

- Defined in src/liquidity/liquidity.ts:468
Parameters
- __namedParameters: { baseMint: PublicKey; marketId: PublicKey; quoteMint: PublicKey; version: number }
  - baseMint: PublicKey
  - marketId: PublicKey
  - quoteMint: PublicKey
  - version: number
Returns Promise<LiquidityAssociatedPoolKeysV4>

Static getAssociatedQuoteVault

getAssociatedQuoteVault(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:420
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedTargetOrders

getAssociatedTargetOrders(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:444
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getAssociatedWithdrawQueue

getAssociatedWithdrawQueue(__namedParameters: { marketId: PublicKey; programId: PublicKey }): Promise<PublicKey>

- Defined in src/liquidity/liquidity.ts:452
Parameters
- __namedParameters: { marketId: PublicKey; programId: PublicKey }
  - marketId: PublicKey
  - programId: PublicKey
Returns Promise<PublicKey>

Static getEnabledFeatures

getEnabledFeatures(poolInfo: LiquidityPoolInfo): { addLiquidity: boolean; removeLiquidity: boolean; swap: boolean }

- Defined in src/liquidity/liquidity.ts:1635
Parameters
- poolInfo: LiquidityPoolInfo
Returns { addLiquidity: boolean; removeLiquidity: boolean; swap: boolean }
- addLiquidity: boolean
- removeLiquidity: boolean
- swap: boolean

Static getLayouts

getLayouts(version: number): { state: LiquidityStateLayout }

- Defined in src/liquidity/liquidity.ts:391
Parameters
- version: number
Returns { state: LiquidityStateLayout }
- state: LiquidityStateLayout

Static getProgramId

getProgramId(version: number): PublicKey

- Defined in src/liquidity/liquidity.ts:360
Parameters
- version: number
Returns PublicKey

Static getRate

getRate(poolInfo: LiquidityPoolInfo): Price

- Defined in src/liquidity/liquidity.ts:1860
Parameters
- poolInfo: LiquidityPoolInfo
Returns Price

Static getSerumVersion

getSerumVersion(version: number): 3

- Defined in src/liquidity/liquidity.ts:376
Parameters
- version: number
Returns 3

Static getStateLayout

getStateLayout(version: number): LiquidityStateLayout

- Defined in src/liquidity/liquidity.ts:384
Parameters
- version: number
Returns LiquidityStateLayout

Static getVersion

getVersion(programId: PublicKey): LiquidityVersion

- Defined in src/liquidity/liquidity.ts:367
Parameters
- programId: PublicKey
Returns LiquidityVersion

Static includesToken

includesToken(token: Token, poolKeys: LiquidityPoolKeysV4): boolean

- Defined in src/liquidity/liquidity.ts:1704
Parameters
- token: Token
- poolKeys: LiquidityPoolKeysV4
Returns boolean

Static isV4

isV4(lsl: any): lsl is { amountWaveRatio: BN; baseDecimal: BN; baseLotSize: BN; baseMint: PublicKey; baseNeedTakePnl: BN; baseTotalDeposited: BN; baseTotalPnl: BN; baseVault: PublicKey; depth: BN; lpMint: PublicKey; lpReserve: BN; lpVault: PublicKey; marketId: PublicKey; marketProgramId: PublicKey; maxOrder: BN; maxPriceMultiplier: BN; minPriceMultiplier: BN; minSeparateDenominator: BN; minSeparateNumerator: BN; minSize: BN; nonce: BN; openOrders: PublicKey; owner: PublicKey; padding: BN[]; pnlDenominator: BN; pnlNumerator: BN; 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 }

- Defined in src/liquidity/liquidity.ts:1377
Parameters
- lsl: any
Returns lsl is { amountWaveRatio: BN; baseDecimal: BN; baseLotSize: BN; baseMint: PublicKey; baseNeedTakePnl: BN; baseTotalDeposited: BN; baseTotalPnl: BN; baseVault: PublicKey; depth: BN; lpMint: PublicKey; lpReserve: BN; lpVault: PublicKey; marketId: PublicKey; marketProgramId: PublicKey; maxOrder: BN; maxPriceMultiplier: BN; minPriceMultiplier: BN; minSeparateDenominator: BN; minSeparateNumerator: BN; minSize: BN; nonce: BN; openOrders: PublicKey; owner: PublicKey; padding: BN[]; pnlDenominator: BN; pnlNumerator: BN; 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 }

Static makeAddLiquidityInstruction

makeAddLiquidityInstruction(params: LiquidityAddInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:526
Parameters
- params: LiquidityAddInstructionParamsV4
Returns TransactionInstruction

Static makeAddLiquidityTransaction

makeAddLiquidityTransaction(params: LiquidityAddTransactionParams): Promise<{ signers: Signer[]; transaction: Transaction }>

- Defined in src/liquidity/liquidity.ts:580
Parameters
- params: LiquidityAddTransactionParams
Returns Promise<{ signers: Signer[]; transaction: Transaction }>

Static makeCreatePoolInstruction

makeCreatePoolInstruction(params: LiquidityCreatePoolInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:1120
Parameters
- params: LiquidityCreatePoolInstructionParamsV4
Returns TransactionInstruction

Static makeCreatePoolInstructionV4

makeCreatePoolInstructionV4(__namedParameters: LiquidityCreatePoolInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:1131
Parameters
- __namedParameters: LiquidityCreatePoolInstructionParamsV4
Returns TransactionInstruction

Static makeCreatePoolTransaction

makeCreatePoolTransaction(params: LiquidityCreatePoolInstructionParamsV4): { signers: Signer[]; transaction: Transaction }

- Defined in src/liquidity/liquidity.ts:1170
Parameters
- params: LiquidityCreatePoolInstructionParamsV4
Returns { signers: Signer[]; transaction: Transaction }
- signers: Signer[]
- transaction: Transaction

Static makeInitPoolInstruction

makeInitPoolInstruction(params: LiquidityInitPoolInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:1179
Parameters
- params: LiquidityInitPoolInstructionParamsV4
Returns TransactionInstruction

Static makeInitPoolInstructionV4

makeInitPoolInstructionV4(__namedParameters: LiquidityInitPoolInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:1190
Parameters
- __namedParameters: LiquidityInitPoolInstructionParamsV4
Returns TransactionInstruction

Static makeInitPoolTransaction

makeInitPoolTransaction(params: LiquidityInitPoolTransactionParams): Promise<{ signers: Signer[]; transaction: Transaction }>

- Defined in src/liquidity/liquidity.ts:1234
Parameters
- params: LiquidityInitPoolTransactionParams
Returns Promise<{ signers: Signer[]; transaction: Transaction }>

Static makeRemoveLiquidityInstruction

makeRemoveLiquidityInstruction(params: LiquidityRemoveInstructionParamsV4): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:723
Parameters
- params: LiquidityRemoveInstructionParamsV4
Returns TransactionInstruction

Static makeRemoveLiquidityTransaction

makeRemoveLiquidityTransaction(params: LiquidityRemoveTransactionParams): Promise<{ signers: Signer[]; transaction: Transaction }>

- Defined in src/liquidity/liquidity.ts:786
Parameters
- params: LiquidityRemoveTransactionParams
Returns Promise<{ signers: Signer[]; transaction: Transaction }>

Static makeSimulatePoolInfoInstruction

makeSimulatePoolInfoInstruction(__namedParameters: { poolKeys: LiquidityPoolKeysV4 }): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:1347
Parameters
- __namedParameters: { poolKeys: LiquidityPoolKeysV4 }
  - poolKeys: LiquidityPoolKeysV4
Returns TransactionInstruction

Static makeSwapFixedInInstruction

makeSwapFixedInInstruction(__namedParameters: LiquiditySwapFixedInInstructionParamsV4, version: number): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:917
Parameters
- __namedParameters: LiquiditySwapFixedInInstructionParamsV4
- version: number
Returns TransactionInstruction

Static makeSwapFixedOutInstruction

makeSwapFixedOutInstruction(__namedParameters: LiquiditySwapFixedOutInstructionParamsV4, version: number): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:974
Parameters
- __namedParameters: LiquiditySwapFixedOutInstructionParamsV4
- version: number
Returns TransactionInstruction

Static makeSwapInstruction

makeSwapInstruction(params: LiquiditySwapInstructionParams): TransactionInstruction

- Defined in src/liquidity/liquidity.ts:884
Parameters
- params: LiquiditySwapInstructionParams
Returns TransactionInstruction

Static makeSwapTransaction

makeSwapTransaction(params: LiquiditySwapTransactionParams): Promise<{ signers: Signer[]; transaction: Transaction }>

- Defined in src/liquidity/liquidity.ts:1028
Parameters
- params: LiquiditySwapTransactionParams
Returns Promise<{ signers: Signer[]; transaction: Transaction }>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Liquidity

Methods

Static _computePriceImpact

Parameters

currentPrice: Price

amountIn: BN

amountOut: BN

Returns Percent

Static _getAmountSide

Parameters

amount: TokenAmount | CurrencyAmount

poolKeys: LiquidityPoolKeysV4

Returns AmountSide

Static _getAmountsSide

Parameters

amountA: TokenAmount | CurrencyAmount

amountB: TokenAmount | CurrencyAmount

poolKeys: LiquidityPoolKeysV4

Returns AmountSide[]

Static _getTokenSide

Parameters

token: Token

poolKeys: LiquidityPoolKeysV4

Returns AmountSide

Static _getTokensSide

Parameters

tokenA: Token

tokenB: Token

poolKeys: LiquidityPoolKeysV4

Returns AmountSide[]

Static _handleTokenAccount

Parameters

params: HandleTokenAccountParams

Returns Promise<PublicKey>

Static _selectTokenAccount

Parameters

params: SelectTokenAccountParams

Returns Promise<null | PublicKey>

Static computeAmountIn

Parameters

params: LiquidityComputeAmountInParams

Returns { amountIn: CurrencyAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: CurrencyAmount; priceImpact: Percent } | { amountIn: TokenAmount; currentPrice: Price; executionPrice: null | Price; maxAmountIn: TokenAmount; priceImpact: Percent }

Static computeAmountOut

Parameters

params: LiquidityComputeAmountOutParams

Static computeAnotherAmount

Parameters

params: LiquidityComputeAnotherAmountParams

Returns { anotherAmount: CurrencyAmount; maxAnotherAmount: CurrencyAmount } | { anotherAmount: TokenAmount; maxAnotherAmount: TokenAmount }

Static fetchAllPoolKeys

Parameters

connection: Connection

Optional config: GetMultipleAccountsInfoConfig

Returns Promise<LiquidityPoolKeysV4[]>

Static fetchInfo

Parameters

__namedParameters: LiquidityFetchInfoParams

Returns Promise<LiquidityPoolInfo>

Static fetchMultipleInfo

Parameters

__namedParameters: LiquidityFetchMultipleInfoParams

Returns Promise<LiquidityPoolInfo[]>

Static getAssociatedAuthority

Parameters

__namedParameters: { programId: PublicKey }

programId: PublicKey

Returns Promise<{ nonce: number; publicKey: PublicKey }>

Static getAssociatedBaseVault

Parameters

__namedParameters: { marketId: PublicKey; programId: PublicKey }

marketId: PublicKey

programId: PublicKey

Returns Promise<PublicKey>

Static getAssociatedId