@kamino-finance/kliquidity-sdk 8.4.7 → 8.4.8-beta.1

package/src/meteora_client/instructions/togglePairStatus.ts

@@ -0,0 +1,24 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface TogglePairStatusAccounts {
+  lbPair: PublicKey
+  admin: PublicKey
+}
+
+export function togglePairStatus(
+  accounts: TogglePairStatusAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.admin, isSigner: true, isWritable: false },
+  ]
+  const identifier = Buffer.from([61, 115, 52, 23, 46, 13, 31, 144])
+  const data = identifier
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateFeeOwner.ts

@@ -0,0 +1,26 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateFeeOwnerAccounts {
+  lbPair: PublicKey
+  newFeeOwner: PublicKey
+  admin: PublicKey
+}
+
+export function updateFeeOwner(
+  accounts: UpdateFeeOwnerAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.newFeeOwner, isSigner: false, isWritable: false },
+    { pubkey: accounts.admin, isSigner: true, isWritable: false },
+  ]
+  const identifier = Buffer.from([60, 63, 17, 64, 13, 196, 166, 243])
+  const data = identifier
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateFeeParameters.ts

@@ -0,0 +1,42 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateFeeParametersArgs {
+  feeParameter: types.FeeParameterFields
+}
+
+export interface UpdateFeeParametersAccounts {
+  lbPair: PublicKey
+  admin: PublicKey
+  eventAuthority: PublicKey
+  program: PublicKey
+}
+
+export const layout = borsh.struct([types.FeeParameter.layout("feeParameter")])
+
+export function updateFeeParameters(
+  args: UpdateFeeParametersArgs,
+  accounts: UpdateFeeParametersAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.admin, isSigner: true, isWritable: false },
+    { pubkey: accounts.eventAuthority, isSigner: false, isWritable: false },
+    { pubkey: accounts.program, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([128, 128, 208, 91, 246, 53, 31, 176])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      feeParameter: types.FeeParameter.toEncodable(args.feeParameter),
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateFeesAndRewards.ts

@@ -0,0 +1,30 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateFeesAndRewardsAccounts {
+  position: PublicKey
+  lbPair: PublicKey
+  binArrayLower: PublicKey
+  binArrayUpper: PublicKey
+  owner: PublicKey
+}
+
+export function updateFeesAndRewards(
+  accounts: UpdateFeesAndRewardsAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.position, isSigner: false, isWritable: true },
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.binArrayLower, isSigner: false, isWritable: true },
+    { pubkey: accounts.binArrayUpper, isSigner: false, isWritable: true },
+    { pubkey: accounts.owner, isSigner: true, isWritable: false },
+  ]
+  const identifier = Buffer.from([154, 230, 250, 13, 236, 209, 75, 223])
+  const data = identifier
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updatePositionOperator.ts

@@ -0,0 +1,42 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdatePositionOperatorArgs {
+  operator: PublicKey
+}
+
+export interface UpdatePositionOperatorAccounts {
+  position: PublicKey
+  owner: PublicKey
+  eventAuthority: PublicKey
+  program: PublicKey
+}
+
+export const layout = borsh.struct([borsh.publicKey("operator")])
+
+export function updatePositionOperator(
+  args: UpdatePositionOperatorArgs,
+  accounts: UpdatePositionOperatorAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.position, isSigner: false, isWritable: true },
+    { pubkey: accounts.owner, isSigner: true, isWritable: false },
+    { pubkey: accounts.eventAuthority, isSigner: false, isWritable: false },
+    { pubkey: accounts.program, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([202, 184, 103, 143, 180, 191, 116, 217])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      operator: args.operator,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateRewardDuration.ts

@@ -0,0 +1,49 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateRewardDurationArgs {
+  rewardIndex: BN
+  newDuration: BN
+}
+
+export interface UpdateRewardDurationAccounts {
+  lbPair: PublicKey
+  admin: PublicKey
+  binArray: PublicKey
+  eventAuthority: PublicKey
+  program: PublicKey
+}
+
+export const layout = borsh.struct([
+  borsh.u64("rewardIndex"),
+  borsh.u64("newDuration"),
+])
+
+export function updateRewardDuration(
+  args: UpdateRewardDurationArgs,
+  accounts: UpdateRewardDurationAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.admin, isSigner: true, isWritable: false },
+    { pubkey: accounts.binArray, isSigner: false, isWritable: true },
+    { pubkey: accounts.eventAuthority, isSigner: false, isWritable: false },
+    { pubkey: accounts.program, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([138, 174, 196, 169, 213, 235, 254, 107])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      rewardIndex: args.rewardIndex,
+      newDuration: args.newDuration,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateRewardFunder.ts

@@ -0,0 +1,47 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateRewardFunderArgs {
+  rewardIndex: BN
+  newFunder: PublicKey
+}
+
+export interface UpdateRewardFunderAccounts {
+  lbPair: PublicKey
+  admin: PublicKey
+  eventAuthority: PublicKey
+  program: PublicKey
+}
+
+export const layout = borsh.struct([
+  borsh.u64("rewardIndex"),
+  borsh.publicKey("newFunder"),
+])
+
+export function updateRewardFunder(
+  args: UpdateRewardFunderArgs,
+  accounts: UpdateRewardFunderAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.admin, isSigner: true, isWritable: false },
+    { pubkey: accounts.eventAuthority, isSigner: false, isWritable: false },
+    { pubkey: accounts.program, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([211, 28, 48, 32, 215, 160, 35, 23])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      rewardIndex: args.rewardIndex,
+      newFunder: args.newFunder,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/updateWhitelistedWallet.ts

@@ -0,0 +1,38 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface UpdateWhitelistedWalletArgs {
+  wallet: PublicKey
+}
+
+export interface UpdateWhitelistedWalletAccounts {
+  lbPair: PublicKey
+  creator: PublicKey
+}
+
+export const layout = borsh.struct([borsh.publicKey("wallet")])
+
+export function updateWhitelistedWallet(
+  args: UpdateWhitelistedWalletArgs,
+  accounts: UpdateWhitelistedWalletAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.creator, isSigner: true, isWritable: false },
+  ]
+  const identifier = Buffer.from([4, 105, 92, 167, 132, 28, 9, 90])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      wallet: args.wallet,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/withdrawIneligibleReward.ts

@@ -0,0 +1,52 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface WithdrawIneligibleRewardArgs {
+  rewardIndex: BN
+}
+
+export interface WithdrawIneligibleRewardAccounts {
+  lbPair: PublicKey
+  rewardVault: PublicKey
+  rewardMint: PublicKey
+  funderTokenAccount: PublicKey
+  funder: PublicKey
+  binArray: PublicKey
+  tokenProgram: PublicKey
+  eventAuthority: PublicKey
+  program: PublicKey
+}
+
+export const layout = borsh.struct([borsh.u64("rewardIndex")])
+
+export function withdrawIneligibleReward(
+  args: WithdrawIneligibleRewardArgs,
+  accounts: WithdrawIneligibleRewardAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.rewardVault, isSigner: false, isWritable: true },
+    { pubkey: accounts.rewardMint, isSigner: false, isWritable: false },
+    { pubkey: accounts.funderTokenAccount, isSigner: false, isWritable: true },
+    { pubkey: accounts.funder, isSigner: true, isWritable: false },
+    { pubkey: accounts.binArray, isSigner: false, isWritable: true },
+    { pubkey: accounts.tokenProgram, isSigner: false, isWritable: false },
+    { pubkey: accounts.eventAuthority, isSigner: false, isWritable: false },
+    { pubkey: accounts.program, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([148, 206, 42, 195, 247, 49, 103, 8])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      rewardIndex: args.rewardIndex,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/instructions/withdrawProtocolFee.ts

@@ -0,0 +1,54 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface WithdrawProtocolFeeArgs {
+  amountX: BN
+  amountY: BN
+}
+
+export interface WithdrawProtocolFeeAccounts {
+  lbPair: PublicKey
+  reserveX: PublicKey
+  reserveY: PublicKey
+  tokenXMint: PublicKey
+  tokenYMint: PublicKey
+  receiverTokenX: PublicKey
+  receiverTokenY: PublicKey
+  tokenXProgram: PublicKey
+  tokenYProgram: PublicKey
+}
+
+export const layout = borsh.struct([borsh.u64("amountX"), borsh.u64("amountY")])
+
+export function withdrawProtocolFee(
+  args: WithdrawProtocolFeeArgs,
+  accounts: WithdrawProtocolFeeAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.lbPair, isSigner: false, isWritable: true },
+    { pubkey: accounts.reserveX, isSigner: false, isWritable: true },
+    { pubkey: accounts.reserveY, isSigner: false, isWritable: true },
+    { pubkey: accounts.tokenXMint, isSigner: false, isWritable: false },
+    { pubkey: accounts.tokenYMint, isSigner: false, isWritable: false },
+    { pubkey: accounts.receiverTokenX, isSigner: false, isWritable: true },
+    { pubkey: accounts.receiverTokenY, isSigner: false, isWritable: true },
+    { pubkey: accounts.tokenXProgram, isSigner: false, isWritable: false },
+    { pubkey: accounts.tokenYProgram, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([158, 201, 158, 189, 33, 93, 162, 103])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      amountX: args.amountX,
+      amountY: args.amountY,
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/meteora_client/programId.ts

@@ -0,0 +1,14 @@
+import { PublicKey } from "@solana/web3.js"
+
+// Program ID passed with the cli --program-id flag when running the code generator. Do not edit, it will get overwritten.
+export const PROGRAM_ID_CLI = new PublicKey(
+  "LBUZKhRxPF3XUpBCjp4YzTKgLccjZhTSDM9YuVaPwxo"
+)
+
+// This constant will not get overwritten on subsequent code generations and it's safe to modify it's value.
+export let METEORA_PROGRAM_ID: PublicKey = PROGRAM_ID_CLI;
+export let PROGRAM_ID: PublicKey = PROGRAM_ID_CLI;
+export const setMeteoraProgramId = (programId: PublicKey) => {
+  METEORA_PROGRAM_ID = programId;
+  PROGRAM_ID = programId;
+};

package/src/meteora_client/types/AddLiquiditySingleSidePreciseParameter.ts

@@ -0,0 +1,79 @@
+import { PublicKey } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh"
+
+export interface AddLiquiditySingleSidePreciseParameterFields {
+  bins: Array<types.CompressedBinDepositAmountFields>
+  decompressMultiplier: BN
+}
+
+export interface AddLiquiditySingleSidePreciseParameterJSON {
+  bins: Array<types.CompressedBinDepositAmountJSON>
+  decompressMultiplier: string
+}
+
+export class AddLiquiditySingleSidePreciseParameter {
+  readonly bins: Array<types.CompressedBinDepositAmount>
+  readonly decompressMultiplier: BN
+
+  constructor(fields: AddLiquiditySingleSidePreciseParameterFields) {
+    this.bins = fields.bins.map(
+      (item) => new types.CompressedBinDepositAmount({ ...item })
+    )
+    this.decompressMultiplier = fields.decompressMultiplier
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borsh.vec(types.CompressedBinDepositAmount.layout(), "bins"),
+        borsh.u64("decompressMultiplier"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new AddLiquiditySingleSidePreciseParameter({
+      bins: obj.bins.map(
+        (
+          item: any /* eslint-disable-line @typescript-eslint/no-explicit-any */
+        ) => types.CompressedBinDepositAmount.fromDecoded(item)
+      ),
+      decompressMultiplier: obj.decompressMultiplier,
+    })
+  }
+
+  static toEncodable(fields: AddLiquiditySingleSidePreciseParameterFields) {
+    return {
+      bins: fields.bins.map((item) =>
+        types.CompressedBinDepositAmount.toEncodable(item)
+      ),
+      decompressMultiplier: fields.decompressMultiplier,
+    }
+  }
+
+  toJSON(): AddLiquiditySingleSidePreciseParameterJSON {
+    return {
+      bins: this.bins.map((item) => item.toJSON()),
+      decompressMultiplier: this.decompressMultiplier.toString(),
+    }
+  }
+
+  static fromJSON(
+    obj: AddLiquiditySingleSidePreciseParameterJSON
+  ): AddLiquiditySingleSidePreciseParameter {
+    return new AddLiquiditySingleSidePreciseParameter({
+      bins: obj.bins.map((item) =>
+        types.CompressedBinDepositAmount.fromJSON(item)
+      ),
+      decompressMultiplier: new BN(obj.decompressMultiplier),
+    })
+  }
+
+  toEncodable() {
+    return AddLiquiditySingleSidePreciseParameter.toEncodable(this)
+  }
+}

package/src/meteora_client/types/Bin.ts

@@ -0,0 +1,161 @@
+import { PublicKey } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh"
+
+export interface BinFields {
+  /** Amount of token X in the bin. This already excluded protocol fees. */
+  amountX: BN
+  /** Amount of token Y in the bin. This already excluded protocol fees. */
+  amountY: BN
+  /** Bin price */
+  price: BN
+  /** Liquidities of the bin. This is the same as LP mint supply. q-number */
+  liquiditySupply: BN
+  /** reward_a_per_token_stored */
+  rewardPerTokenStored: Array<BN>
+  /** Swap fee amount of token X per liquidity deposited. */
+  feeAmountXPerTokenStored: BN
+  /** Swap fee amount of token Y per liquidity deposited. */
+  feeAmountYPerTokenStored: BN
+  /** Total token X swap into the bin. Only used for tracking purpose. */
+  amountXIn: BN
+  /** Total token Y swap into he bin. Only used for tracking purpose. */
+  amountYIn: BN
+}
+
+export interface BinJSON {
+  /** Amount of token X in the bin. This already excluded protocol fees. */
+  amountX: string
+  /** Amount of token Y in the bin. This already excluded protocol fees. */
+  amountY: string
+  /** Bin price */
+  price: string
+  /** Liquidities of the bin. This is the same as LP mint supply. q-number */
+  liquiditySupply: string
+  /** reward_a_per_token_stored */
+  rewardPerTokenStored: Array<string>
+  /** Swap fee amount of token X per liquidity deposited. */
+  feeAmountXPerTokenStored: string
+  /** Swap fee amount of token Y per liquidity deposited. */
+  feeAmountYPerTokenStored: string
+  /** Total token X swap into the bin. Only used for tracking purpose. */
+  amountXIn: string
+  /** Total token Y swap into he bin. Only used for tracking purpose. */
+  amountYIn: string
+}
+
+export class Bin {
+  /** Amount of token X in the bin. This already excluded protocol fees. */
+  readonly amountX: BN
+  /** Amount of token Y in the bin. This already excluded protocol fees. */
+  readonly amountY: BN
+  /** Bin price */
+  readonly price: BN
+  /** Liquidities of the bin. This is the same as LP mint supply. q-number */
+  readonly liquiditySupply: BN
+  /** reward_a_per_token_stored */
+  readonly rewardPerTokenStored: Array<BN>
+  /** Swap fee amount of token X per liquidity deposited. */
+  readonly feeAmountXPerTokenStored: BN
+  /** Swap fee amount of token Y per liquidity deposited. */
+  readonly feeAmountYPerTokenStored: BN
+  /** Total token X swap into the bin. Only used for tracking purpose. */
+  readonly amountXIn: BN
+  /** Total token Y swap into he bin. Only used for tracking purpose. */
+  readonly amountYIn: BN
+
+  constructor(fields: BinFields) {
+    this.amountX = fields.amountX
+    this.amountY = fields.amountY
+    this.price = fields.price
+    this.liquiditySupply = fields.liquiditySupply
+    this.rewardPerTokenStored = fields.rewardPerTokenStored
+    this.feeAmountXPerTokenStored = fields.feeAmountXPerTokenStored
+    this.feeAmountYPerTokenStored = fields.feeAmountYPerTokenStored
+    this.amountXIn = fields.amountXIn
+    this.amountYIn = fields.amountYIn
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borsh.u64("amountX"),
+        borsh.u64("amountY"),
+        borsh.u128("price"),
+        borsh.u128("liquiditySupply"),
+        borsh.array(borsh.u128(), 2, "rewardPerTokenStored"),
+        borsh.u128("feeAmountXPerTokenStored"),
+        borsh.u128("feeAmountYPerTokenStored"),
+        borsh.u128("amountXIn"),
+        borsh.u128("amountYIn"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new Bin({
+      amountX: obj.amountX,
+      amountY: obj.amountY,
+      price: obj.price,
+      liquiditySupply: obj.liquiditySupply,
+      rewardPerTokenStored: obj.rewardPerTokenStored,
+      feeAmountXPerTokenStored: obj.feeAmountXPerTokenStored,
+      feeAmountYPerTokenStored: obj.feeAmountYPerTokenStored,
+      amountXIn: obj.amountXIn,
+      amountYIn: obj.amountYIn,
+    })
+  }
+
+  static toEncodable(fields: BinFields) {
+    return {
+      amountX: fields.amountX,
+      amountY: fields.amountY,
+      price: fields.price,
+      liquiditySupply: fields.liquiditySupply,
+      rewardPerTokenStored: fields.rewardPerTokenStored,
+      feeAmountXPerTokenStored: fields.feeAmountXPerTokenStored,
+      feeAmountYPerTokenStored: fields.feeAmountYPerTokenStored,
+      amountXIn: fields.amountXIn,
+      amountYIn: fields.amountYIn,
+    }
+  }
+
+  toJSON(): BinJSON {
+    return {
+      amountX: this.amountX.toString(),
+      amountY: this.amountY.toString(),
+      price: this.price.toString(),
+      liquiditySupply: this.liquiditySupply.toString(),
+      rewardPerTokenStored: this.rewardPerTokenStored.map((item) =>
+        item.toString()
+      ),
+      feeAmountXPerTokenStored: this.feeAmountXPerTokenStored.toString(),
+      feeAmountYPerTokenStored: this.feeAmountYPerTokenStored.toString(),
+      amountXIn: this.amountXIn.toString(),
+      amountYIn: this.amountYIn.toString(),
+    }
+  }
+
+  static fromJSON(obj: BinJSON): Bin {
+    return new Bin({
+      amountX: new BN(obj.amountX),
+      amountY: new BN(obj.amountY),
+      price: new BN(obj.price),
+      liquiditySupply: new BN(obj.liquiditySupply),
+      rewardPerTokenStored: obj.rewardPerTokenStored.map(
+        (item) => new BN(item)
+      ),
+      feeAmountXPerTokenStored: new BN(obj.feeAmountXPerTokenStored),
+      feeAmountYPerTokenStored: new BN(obj.feeAmountYPerTokenStored),
+      amountXIn: new BN(obj.amountXIn),
+      amountYIn: new BN(obj.amountYIn),
+    })
+  }
+
+  toEncodable() {
+    return Bin.toEncodable(this)
+  }
+}