UNPKG

@kamino-finance/scope-sdk

Version:
213 lines 8.43 kB
import { Address, GetAccountInfoApi, GetMultipleAccountsApi, Rpc } from "@solana/kit"; import BN from "bn.js"; import * as types from "../types"; export interface PoolStateFields { /** Bump to identify PDA */ bump: number; ammConfig: Address; owner: Address; /** Token pair of the pool, where token_mint_0 address < token_mint_1 address */ tokenMint0: Address; tokenMint1: Address; /** Token pair vault */ tokenVault0: Address; tokenVault1: Address; /** observation account key */ observationKey: Address; /** mint0 and mint1 decimals */ mintDecimals0: number; mintDecimals1: number; /** The minimum number of ticks between initialized ticks */ tickSpacing: number; /** The currently in range liquidity available to the pool. */ liquidity: BN; /** The current price of the pool as a sqrt(token_1/token_0) Q64.64 value */ sqrtPriceX64: BN; /** The current tick of the pool, i.e. according to the last tick transition that was run. */ tickCurrent: number; /** the most-recently updated index of the observations array */ observationIndex: number; observationUpdateDuration: number; /** * The fee growth as a Q64.64 number, i.e. fees of token_0 and token_1 collected per * unit of liquidity for the entire life of the pool. */ feeGrowthGlobal0X64: BN; feeGrowthGlobal1X64: BN; /** The amounts of token_0 and token_1 that are owed to the protocol. */ protocolFeesToken0: BN; protocolFeesToken1: BN; /** The amounts in and out of swap token_0 and token_1 */ swapInAmountToken0: BN; swapOutAmountToken1: BN; swapInAmountToken1: BN; swapOutAmountToken0: BN; /** * Bitwise representation of the state of the pool * bit0, 1: disable open position and increase liquidity, 0: normal * bit1, 1: disable decrease liquidity, 0: normal * bit2, 1: disable collect fee, 0: normal * bit3, 1: disable collect reward, 0: normal * bit4, 1: disable swap, 0: normal */ status: number; /** Leave blank for future use */ padding: Array<number>; rewardInfos: Array<types.RewardInfoFields>; /** Packed initialized tick array state */ tickArrayBitmap: Array<BN>; /** except protocol_fee and fund_fee */ totalFeesToken0: BN; /** except protocol_fee and fund_fee */ totalFeesClaimedToken0: BN; totalFeesToken1: BN; totalFeesClaimedToken1: BN; fundFeesToken0: BN; fundFeesToken1: BN; openTime: BN; padding1: Array<BN>; padding2: Array<BN>; } export interface PoolStateJSON { /** Bump to identify PDA */ bump: number; ammConfig: string; owner: string; /** Token pair of the pool, where token_mint_0 address < token_mint_1 address */ tokenMint0: string; tokenMint1: string; /** Token pair vault */ tokenVault0: string; tokenVault1: string; /** observation account key */ observationKey: string; /** mint0 and mint1 decimals */ mintDecimals0: number; mintDecimals1: number; /** The minimum number of ticks between initialized ticks */ tickSpacing: number; /** The currently in range liquidity available to the pool. */ liquidity: string; /** The current price of the pool as a sqrt(token_1/token_0) Q64.64 value */ sqrtPriceX64: string; /** The current tick of the pool, i.e. according to the last tick transition that was run. */ tickCurrent: number; /** the most-recently updated index of the observations array */ observationIndex: number; observationUpdateDuration: number; /** * The fee growth as a Q64.64 number, i.e. fees of token_0 and token_1 collected per * unit of liquidity for the entire life of the pool. */ feeGrowthGlobal0X64: string; feeGrowthGlobal1X64: string; /** The amounts of token_0 and token_1 that are owed to the protocol. */ protocolFeesToken0: string; protocolFeesToken1: string; /** The amounts in and out of swap token_0 and token_1 */ swapInAmountToken0: string; swapOutAmountToken1: string; swapInAmountToken1: string; swapOutAmountToken0: string; /** * Bitwise representation of the state of the pool * bit0, 1: disable open position and increase liquidity, 0: normal * bit1, 1: disable decrease liquidity, 0: normal * bit2, 1: disable collect fee, 0: normal * bit3, 1: disable collect reward, 0: normal * bit4, 1: disable swap, 0: normal */ status: number; /** Leave blank for future use */ padding: Array<number>; rewardInfos: Array<types.RewardInfoJSON>; /** Packed initialized tick array state */ tickArrayBitmap: Array<string>; /** except protocol_fee and fund_fee */ totalFeesToken0: string; /** except protocol_fee and fund_fee */ totalFeesClaimedToken0: string; totalFeesToken1: string; totalFeesClaimedToken1: string; fundFeesToken0: string; fundFeesToken1: string; openTime: string; padding1: Array<string>; padding2: Array<string>; } export declare class PoolState { /** Bump to identify PDA */ readonly bump: number; readonly ammConfig: Address; readonly owner: Address; /** Token pair of the pool, where token_mint_0 address < token_mint_1 address */ readonly tokenMint0: Address; readonly tokenMint1: Address; /** Token pair vault */ readonly tokenVault0: Address; readonly tokenVault1: Address; /** observation account key */ readonly observationKey: Address; /** mint0 and mint1 decimals */ readonly mintDecimals0: number; readonly mintDecimals1: number; /** The minimum number of ticks between initialized ticks */ readonly tickSpacing: number; /** The currently in range liquidity available to the pool. */ readonly liquidity: BN; /** The current price of the pool as a sqrt(token_1/token_0) Q64.64 value */ readonly sqrtPriceX64: BN; /** The current tick of the pool, i.e. according to the last tick transition that was run. */ readonly tickCurrent: number; /** the most-recently updated index of the observations array */ readonly observationIndex: number; readonly observationUpdateDuration: number; /** * The fee growth as a Q64.64 number, i.e. fees of token_0 and token_1 collected per * unit of liquidity for the entire life of the pool. */ readonly feeGrowthGlobal0X64: BN; readonly feeGrowthGlobal1X64: BN; /** The amounts of token_0 and token_1 that are owed to the protocol. */ readonly protocolFeesToken0: BN; readonly protocolFeesToken1: BN; /** The amounts in and out of swap token_0 and token_1 */ readonly swapInAmountToken0: BN; readonly swapOutAmountToken1: BN; readonly swapInAmountToken1: BN; readonly swapOutAmountToken0: BN; /** * Bitwise representation of the state of the pool * bit0, 1: disable open position and increase liquidity, 0: normal * bit1, 1: disable decrease liquidity, 0: normal * bit2, 1: disable collect fee, 0: normal * bit3, 1: disable collect reward, 0: normal * bit4, 1: disable swap, 0: normal */ readonly status: number; /** Leave blank for future use */ readonly padding: Array<number>; readonly rewardInfos: Array<types.RewardInfo>; /** Packed initialized tick array state */ readonly tickArrayBitmap: Array<BN>; /** except protocol_fee and fund_fee */ readonly totalFeesToken0: BN; /** except protocol_fee and fund_fee */ readonly totalFeesClaimedToken0: BN; readonly totalFeesToken1: BN; readonly totalFeesClaimedToken1: BN; readonly fundFeesToken0: BN; readonly fundFeesToken1: BN; readonly openTime: BN; readonly padding1: Array<BN>; readonly padding2: Array<BN>; static readonly discriminator: Buffer<ArrayBuffer>; static readonly layout: import("buffer-layout").Layout<PoolState>; constructor(fields: PoolStateFields); static fetch(rpc: Rpc<GetAccountInfoApi>, address: Address, programId?: Address): Promise<PoolState | null>; static fetchMultiple(rpc: Rpc<GetMultipleAccountsApi>, addresses: Address[], programId?: Address): Promise<Array<PoolState | null>>; static decode(data: Buffer): PoolState; toJSON(): PoolStateJSON; static fromJSON(obj: PoolStateJSON): PoolState; } //# sourceMappingURL=PoolState.d.ts.map