Type aliases
AmountSide
AmountSide: "base" | "quote"
BigNumberish
BigNumberish: BN | string | number | bigint
BitStructure
Bit
Structure
<T, P>: Layout<T, P>Type parameters
Blob
Type parameters
ExtensionKey
ExtensionKey: "coingeckoId" | "website" | "whitepaper"
Extensions
FarmCreateInstructionParams
FarmCreatorAddRewardTokenInstructionParams
FarmCreatorWithdrawRewardInstructionParams
FarmLedger
FarmLedgerLayout
FarmLedgerLayoutV3_1
FarmLedgerLayoutV3_2
FarmLedgerLayoutV5_1
FarmLedgerLayoutV5_2
FarmLedgerLayoutV6_1
FarmLedgerV3_1
FarmLedgerV3_2
FarmLedgerV5_1
FarmLedgerV5_2
FarmLedgerV6_1
FarmPoolJsonInfo
FarmPoolKeys
FarmPoolKeys: { authority: PublicKey; id: PublicKey; lpMint: PublicKey; lpVault: PublicKey; programId: PublicKey; rewardInfos: ({ rewardMint: PublicKey; rewardVault: PublicKey } | { rewardEndTime: number; rewardMint: PublicKey; rewardOpenTime: number; rewardPerSecond: number; rewardVault: PublicKey })[]; upcoming: boolean; version: number }
Type declaration
Readonly authority: PublicKey
Readonly id: PublicKey
Readonly lpMint: PublicKey
Readonly lpVault: PublicKey
Readonly programId: PublicKey
Readonly rewardInfos: ({ rewardMint: PublicKey; rewardVault: PublicKey } | { rewardEndTime: number; rewardMint: PublicKey; rewardOpenTime: number; rewardPerSecond: number; rewardVault: PublicKey })[]
Readonly upcoming: boolean
Readonly version: number
FarmRestartInstructionParams
FarmState
FarmStateLayout
FarmStateLayoutV3
FarmStateLayoutV5
FarmStateLayoutV6
FarmStateV3
FarmStateV5
FarmStateV6
FarmVersion
FarmVersion: 3 | 4 | 5 | 6
FarmWithdrawInstructionParams
GetLayoutSchemaFromStructure
Get
Layout
Schema
From
Structure
<T>: T extends Structure<any, any, infer S
> ? S : anyType parameters
GetStructureFromLayoutSchema
Get
Structure
From
Layout
Schema
<S>: Structure<any, any, S>Type parameters
GetStructureSchema
GetStructureSchema<T>: T extends Structure<any, any, infer S> ? S : unknown
Type parameters
LiquidityAddInstructionParams
LiquidityAssociatedPoolKeys
LiquidityCreatePoolInstructionParams
LiquidityCreatePoolTransactionParams
LiquidityInitPoolInstructionParams
LiquidityPoolKeys
LiquidityPoolKeysV4
LiquidityRemoveInstructionParams
LiquiditySide
LiquiditySide: "a" | "b"
LiquidityState
LiquidityStateLayout
LiquidityStateLayoutV4
LiquidityStateLayoutV5
LiquidityStateV4
LiquidityStateV5
LiquidityVersion
LiquidityVersion: 4 | 5
LpTokens
Lp
Tokens
: { [iterator]
: any } & { [ T in string]: LpTokenInfo }LpTokensJsonInfo
Lp
Tokens
Json
Info
: { [iterator]
: any } & { [ T in string]: LpTokenJsonInfo }MarketState
MarketStateLayout
MarketStateLayoutV3
MarketStateV3
PublicKeyish
PublicKeyish: PublicKey | string
ReplaceType
Replace
Type
<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> }Type parameters
RouteType
RouteType: "amm" | "serum" | "route"
RouteVersion
RouteVersion: 1
SerumVersion
SerumVersion: 3
SplAccount
SplAccountLayout
SplMint
SplMintLayout
SplTokens
Spl
Tokens
: { [iterator]
: any } & { [ T in string]: SplTokenInfo }SplTokensJsonInfo
SwapSide
SwapSide: "in" | "out"
TradeSource
TradeSource: "amm" | "serum" | "stable"
UInt
Type parameters
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 | UType parameters
makeCreateFarmInstructionParams
Variables
Const ASSOCIATED_TOKEN_PROGRAM_ID
ASSOCIATED_TOKEN_PROGRAM_ID: PublicKey
BitStructure
BitStructure: BitStructureConstructor
Blob
Blob: BlobConstructor
Const DEVNET_FARM_POOLS
Const DEVNET_LP_TOKENS
Const DEVNET_OFFICIAL_LIQUIDITY_POOLS
DEVNET_OFFICIAL_LIQUIDITY_POOLS: never[] = []
Const DEVNET_SPL_TOKENS
Const FARM_LEDGER_LAYOUT_V3_1
FARM_
LEDGER_
LAYOUT_
V3_
1
: Structure<PublicKey | BN | BN[], "", { deposited
: BN; id
: PublicKey; owner
: PublicKey; rewardDebts
: BN[]; state
: BN }> = ...Const FARM_LEDGER_LAYOUT_V3_2
FARM_
LEDGER_
LAYOUT_
V3_
2
: Structure<PublicKey | BN | BN[], "", { deposited
: BN; id
: PublicKey; owner
: PublicKey; rewardDebts
: BN[]; state
: BN }> = ...Const FARM_LEDGER_LAYOUT_V5_1
FARM_
LEDGER_
LAYOUT_
V5_
1
: Structure<PublicKey | BN | BN[], "", { deposited
: BN; id
: PublicKey; owner
: PublicKey; rewardDebts
: BN[]; state
: BN }> = ...Const FARM_LEDGER_LAYOUT_V5_2
FARM_
LEDGER_
LAYOUT_
V5_
2
: Structure<PublicKey | BN | BN[], "", { deposited
: BN; id
: PublicKey; owner
: PublicKey; rewardDebts
: BN[]; state
: BN }> = ...Const FARM_LEDGER_LAYOUT_V6_1
FARM_
LEDGER_
LAYOUT_
V6_
1
: Structure<PublicKey | BN | BN[], "", { deposited
: BN; id
: PublicKey; owner
: PublicKey; rewardDebts
: BN[]; state
: BN }> = ...Const FARM_PROGRAMID_TO_VERSION
FARM_PROGRAMID_TO_VERSION: {} = ...
Const FARM_PROGRAM_ID_V3
FARM_PROGRAM_ID_V3: PublicKey = ...
Const FARM_PROGRAM_ID_V5
FARM_PROGRAM_ID_V5: PublicKey = ...
Const FARM_PROGRAM_ID_V6
FARM_PROGRAM_ID_V6: PublicKey = ...
Const FARM_STATE_LAYOUT_V3
FARM_
STATE_
LAYOUT_
V3
: GetStructureFromLayoutSchema<{ rewardInfos
: { perShareReward
: BN; perSlotReward
: BN; rewardVault
: PublicKey; totalReward
: BN }[]; version
: 3 } & { lastSlot
: BN; lpVault
: PublicKey; nonce
: BN; perShareReward
: BN; perSlotReward
: BN; rewardVault
: PublicKey; state
: BN; totalReward
: BN }> = ...Const FARM_STATE_LAYOUT_V5
FARM_
STATE_
LAYOUT_
V5
: GetStructureFromLayoutSchema<{ rewardInfos
: { perShareReward
: BN; perSlotReward
: BN; rewardVault
: PublicKey; totalReward
: BN }[]; version
: 5 } & { 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 }> = ...Const FARM_STATE_LAYOUT_V6
FARM_
STATE_
LAYOUT_
V6
: GetStructureFromLayoutSchema<{ rewardInfos
: { accRewardPerShare
: BN; rewardClaimed
: BN; rewardEndTime
: BN; rewardLastUpdateTime
: BN; rewardMint
: PublicKey; rewardOpenTime
: BN; rewardPerSecond
: BN; rewardSender
: PublicKey; rewardState
: BN; rewardVault
: PublicKey; totalReward
: BN; totalRewardEmissioned
: BN }[]; version
: 6 } & { creator
: PublicKey; lpMint
: PublicKey; lpVault
: PublicKey; nonce
: BN; padding
: BN[]; rewardInfos
: { padding: BN[]; rewardVault: PublicKey; totalReward: BN; rewardState: BN; rewardOpenTime: BN; rewardEndTime: BN; rewardLastUpdateTime: BN; totalRewardEmissioned: BN; ... 4 more ...; rewardSender: PublicKey; }
[]; rewardMultiplier
: BN; rewardPeriodExtend
: BN; rewardPeriodMax
: BN; rewardPeriodMin
: BN; state
: BN; validRewardTokenNum
: BN }> = ...Const FARM_VERSION_TO_LEDGER_LAYOUT
Const FARM_VERSION_TO_PROGRAMID
FARM_
VERSION_
TO_
PROGRAMID
: { [ key in FarmVersion]?: PublicKey } & {} = ...Const FARM_VERSION_TO_STATE_LAYOUT
Const FIVE
FIVE: BN = ...
Const LIQUIDITY_FEES_DENOMINATOR
LIQUIDITY_FEES_DENOMINATOR: BN = ...
Const LIQUIDITY_FEES_NUMERATOR
LIQUIDITY_FEES_NUMERATOR: BN = ...
Const LIQUIDITY_PROGRAMID_TO_VERSION
LIQUIDITY_PROGRAMID_TO_VERSION: {} = ...
Const LIQUIDITY_PROGRAM_ID_V4
LIQUIDITY_PROGRAM_ID_V4: PublicKey = ...
Const LIQUIDITY_PROGRAM_ID_V5
LIQUIDITY_PROGRAM_ID_V5: PublicKey = ...
Const LIQUIDITY_STATE_LAYOUT_V4
LIQUIDITY_
STATE_
LAYOUT_
V4
: Structure<PublicKey | BN | BN[], "", { 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 }> = ...Const 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 }> = ...Const LIQUIDITY_VERSION_TO_PROGRAMID
LIQUIDITY_
VERSION_
TO_
PROGRAMID
: { [ key in LiquidityVersion]?: PublicKey } & {} = ...Const LIQUIDITY_VERSION_TO_SERUM_VERSION
Const LIQUIDITY_VERSION_TO_STATE_LAYOUT
LIQUIDITY_VERSION_TO_STATE_LAYOUT: {} = ...
Layout
Const MAINNET_FARM_POOLS
Const MAINNET_LP_TOKENS
Const MAINNET_OFFICIAL_LIQUIDITY_POOLS
MAINNET_OFFICIAL_LIQUIDITY_POOLS: string[] = ...
Const MAINNET_SPL_TOKENS
Const MARKET_STATE_LAYOUT_V3
MARKET_
STATE_
LAYOUT_
V3
: Structure<PublicKey | Buffer | BN, "", { 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 }> = ...Const MARKET_VERSION_TO_STATE_LAYOUT
MARKET_VERSION_TO_STATE_LAYOUT: {} = ...
Const MEMO_PROGRAM_ID
MEMO_PROGRAM_ID: PublicKey = ...
Const ONE
ONE: BN = ...
Const REAL_FARM_STATE_LAYOUT_V3
REAL_
FARM_
STATE_
LAYOUT_
V3
: Structure<PublicKey | BN, "", { lastSlot
: BN; lpVault
: PublicKey; nonce
: BN; perShareReward
: BN; perSlotReward
: BN; rewardVault
: PublicKey; state
: BN; totalReward
: BN }> = ...Const REAL_FARM_STATE_LAYOUT_V5
REAL_
FARM_
STATE_
LAYOUT_
V5
: Structure<number | PublicKey | Buffer | 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 }> = ...Const REAL_FARM_STATE_LAYOUT_V6
REAL_
FARM_
STATE_
LAYOUT_
V6
: Structure<PublicKey | BN | BN[] | { accRewardPerShare
: BN; padding
: BN[]; rewardClaimed
: BN; rewardEndTime
: BN; rewardLastUpdateTime
: BN; rewardMint
: PublicKey; rewardOpenTime
: BN; rewardPerSecond
: BN; rewardSender
: PublicKey; rewardState
: BN; rewardVault
: PublicKey; totalReward
: BN; totalRewardEmissioned
: BN }[], "", { creator
: PublicKey; lpMint
: PublicKey; lpVault
: PublicKey; nonce
: BN; padding
: BN[]; rewardInfos
: { padding: BN[]; rewardVault: PublicKey; totalReward: BN; rewardState: BN; rewardOpenTime: BN; rewardEndTime: BN; rewardLastUpdateTime: BN; totalRewardEmissioned: BN; ... 4 more ...; rewardSender: PublicKey; }
[]; rewardMultiplier
: BN; rewardPeriodExtend
: BN; rewardPeriodMax
: BN; rewardPeriodMin
: BN; state
: BN; validRewardTokenNum
: BN }> = ...Const ROUTE_PROGRAMID_TO_VERSION
ROUTE_PROGRAMID_TO_VERSION: {} = ...
Const ROUTE_PROGRAM_ID_V1
ROUTE_PROGRAM_ID_V1: PublicKey = ...
Const ROUTE_VERSION_TO_LIQUIDITY_VERSION
Const ROUTE_VERSION_TO_PROGRAMID
ROUTE_
VERSION_
TO_
PROGRAMID
: { [ key in RouteVersion]?: PublicKey } & {} = ...Const SERUM_PROGRAMID_TO_VERSION
SERUM_PROGRAMID_TO_VERSION: {} = ...
Const SERUM_PROGRAM_ID_V3
SERUM_PROGRAM_ID_V3: PublicKey = ...
Const SERUM_VERSION_TO_PROGRAMID
SERUM_
VERSION_
TO_
PROGRAMID
: { [ key in SerumVersion]?: PublicKey } & {} = ...Const SOL
Const 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 }> = ...Const SPL_MINT_LAYOUT
SPL_
MINT_
LAYOUT
: Structure<number | PublicKey | BN, "", { decimals
: number; freezeAuthority
: PublicKey; freezeAuthorityOption
: number; isInitialized
: number; mintAuthority
: PublicKey; mintAuthorityOption
: number; supply
: BN }> = ...Const SYSTEM_PROGRAM_ID
SYSTEM_PROGRAM_ID: PublicKey = SystemProgram.programId
Const SYSVAR_CLOCK_PUBKEY
SYSVAR_CLOCK_PUBKEY: PublicKey
Const SYSVAR_RENT_PUBKEY
SYSVAR_RENT_PUBKEY: PublicKey
Const TEN
TEN: BN = ...
Const TESTNET_FARM_POOLS
Const TESTNET_LP_TOKENS
Const TESTNET_OFFICIAL_LIQUIDITY_POOLS
TESTNET_OFFICIAL_LIQUIDITY_POOLS: never[] = []
Const TESTNET_SPL_TOKENS
Const THREE
THREE: BN = ...
Const TOKEN_PROGRAM_ID
TOKEN_PROGRAM_ID: PublicKey
Const TWO
TWO: BN = ...
UInt
UInt: UIntConstructor
Const WSOL
Const ZERO
ZERO: BN = ...
Const _100
_100: BN = ...
Const _1000
_1000: BN = ...
Const _10000
_10000: BN = ...
Const _100_PERCENT
Const _FARM_PROGRAM_ID_V3
_FARM_PROGRAM_ID_V3: "EhhTKczWMGQt46ynNeRX1WfeagwwJd7ufHvCDjRxjo5Q" = "EhhTKczWMGQt46ynNeRX1WfeagwwJd7ufHvCDjRxjo5Q"
Const _FARM_PROGRAM_ID_V5
_FARM_PROGRAM_ID_V5: "9KEPoZmtHUrBbhWN1v1KWLMkkvwY6WLtAVUCPRtRjP4z" = "9KEPoZmtHUrBbhWN1v1KWLMkkvwY6WLtAVUCPRtRjP4z"
Const _FARM_PROGRAM_ID_V6
_FARM_PROGRAM_ID_V6: "FarmqiPv5eAj3j1GMdMCMUGXqPUvmquZtMy86QH6rzhG" = "FarmqiPv5eAj3j1GMdMCMUGXqPUvmquZtMy86QH6rzhG"
Const _LIQUIDITY_PROGRAM_ID_V4
_LIQUIDITY_PROGRAM_ID_V4: "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8" = "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"
Const _LIQUIDITY_PROGRAM_ID_V5
_LIQUIDITY_PROGRAM_ID_V5: "5quBtoiQqxF9Jv6KYKctB59NT3gtJD2Y65kdnB1Uev3h" = "5quBtoiQqxF9Jv6KYKctB59NT3gtJD2Y65kdnB1Uev3h"
Const _ROUTE_PROGRAM_ID_V1
_ROUTE_PROGRAM_ID_V1: "routeUGWgWzqBWFcrCfv8tritsqukccJPu3q5GPP3xS" = "routeUGWgWzqBWFcrCfv8tritsqukccJPu3q5GPP3xS"
Const _SERUM_PROGRAM_ID_V3
_SERUM_PROGRAM_ID_V3: "9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin" = "9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin"
Add liquidity instruction params