@kamino-finance/kliquidity-sdk 6.2.2 → 6.3.1

package/src/meteora_client/types/VariableParameters.ts

@@ -0,0 +1,131 @@
+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 VariableParametersFields {
+  /**
+   * Volatility accumulator measure the number of bin crossed since reference bin ID. Normally (without filter period taken into consideration), reference bin ID is the active bin of last swap.
+   * It affects the variable fee rate
+   */
+  volatilityAccumulator: number
+  /** Volatility reference is decayed volatility accumulator. It is always <= volatility_accumulator */
+  volatilityReference: number
+  /** Active bin id of last swap. */
+  indexReference: number
+  /** Padding for bytemuck safe alignment */
+  padding: Array<number>
+  /** Last timestamp the variable parameters was updated */
+  lastUpdateTimestamp: BN
+  /** Padding for bytemuck safe alignment */
+  padding1: Array<number>
+}
+
+export interface VariableParametersJSON {
+  /**
+   * Volatility accumulator measure the number of bin crossed since reference bin ID. Normally (without filter period taken into consideration), reference bin ID is the active bin of last swap.
+   * It affects the variable fee rate
+   */
+  volatilityAccumulator: number
+  /** Volatility reference is decayed volatility accumulator. It is always <= volatility_accumulator */
+  volatilityReference: number
+  /** Active bin id of last swap. */
+  indexReference: number
+  /** Padding for bytemuck safe alignment */
+  padding: Array<number>
+  /** Last timestamp the variable parameters was updated */
+  lastUpdateTimestamp: string
+  /** Padding for bytemuck safe alignment */
+  padding1: Array<number>
+}
+
+/** Parameters that changes based on dynamic of the market */
+export class VariableParameters {
+  /**
+   * Volatility accumulator measure the number of bin crossed since reference bin ID. Normally (without filter period taken into consideration), reference bin ID is the active bin of last swap.
+   * It affects the variable fee rate
+   */
+  readonly volatilityAccumulator: number
+  /** Volatility reference is decayed volatility accumulator. It is always <= volatility_accumulator */
+  readonly volatilityReference: number
+  /** Active bin id of last swap. */
+  readonly indexReference: number
+  /** Padding for bytemuck safe alignment */
+  readonly padding: Array<number>
+  /** Last timestamp the variable parameters was updated */
+  readonly lastUpdateTimestamp: BN
+  /** Padding for bytemuck safe alignment */
+  readonly padding1: Array<number>
+
+  constructor(fields: VariableParametersFields) {
+    this.volatilityAccumulator = fields.volatilityAccumulator
+    this.volatilityReference = fields.volatilityReference
+    this.indexReference = fields.indexReference
+    this.padding = fields.padding
+    this.lastUpdateTimestamp = fields.lastUpdateTimestamp
+    this.padding1 = fields.padding1
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borsh.u32("volatilityAccumulator"),
+        borsh.u32("volatilityReference"),
+        borsh.i32("indexReference"),
+        borsh.array(borsh.u8(), 4, "padding"),
+        borsh.i64("lastUpdateTimestamp"),
+        borsh.array(borsh.u8(), 8, "padding1"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new VariableParameters({
+      volatilityAccumulator: obj.volatilityAccumulator,
+      volatilityReference: obj.volatilityReference,
+      indexReference: obj.indexReference,
+      padding: obj.padding,
+      lastUpdateTimestamp: obj.lastUpdateTimestamp,
+      padding1: obj.padding1,
+    })
+  }
+
+  static toEncodable(fields: VariableParametersFields) {
+    return {
+      volatilityAccumulator: fields.volatilityAccumulator,
+      volatilityReference: fields.volatilityReference,
+      indexReference: fields.indexReference,
+      padding: fields.padding,
+      lastUpdateTimestamp: fields.lastUpdateTimestamp,
+      padding1: fields.padding1,
+    }
+  }
+
+  toJSON(): VariableParametersJSON {
+    return {
+      volatilityAccumulator: this.volatilityAccumulator,
+      volatilityReference: this.volatilityReference,
+      indexReference: this.indexReference,
+      padding: this.padding,
+      lastUpdateTimestamp: this.lastUpdateTimestamp.toString(),
+      padding1: this.padding1,
+    }
+  }
+
+  static fromJSON(obj: VariableParametersJSON): VariableParameters {
+    return new VariableParameters({
+      volatilityAccumulator: obj.volatilityAccumulator,
+      volatilityReference: obj.volatilityReference,
+      indexReference: obj.indexReference,
+      padding: obj.padding,
+      lastUpdateTimestamp: new BN(obj.lastUpdateTimestamp),
+      padding1: obj.padding1,
+    })
+  }
+
+  toEncodable() {
+    return VariableParameters.toEncodable(this)
+  }
+}

package/src/meteora_client/types/index.ts

@@ -0,0 +1,140 @@
+import * as StrategyType from "./StrategyType"
+import * as Rounding from "./Rounding"
+import * as LayoutVersion from "./LayoutVersion"
+import * as PairType from "./PairType"
+import * as PairStatus from "./PairStatus"
+
+export { LiquidityParameterByStrategyOneSide } from "./LiquidityParameterByStrategyOneSide"
+export type {
+  LiquidityParameterByStrategyOneSideFields,
+  LiquidityParameterByStrategyOneSideJSON,
+} from "./LiquidityParameterByStrategyOneSide"
+export { LiquidityParameterByStrategy } from "./LiquidityParameterByStrategy"
+export type {
+  LiquidityParameterByStrategyFields,
+  LiquidityParameterByStrategyJSON,
+} from "./LiquidityParameterByStrategy"
+export { StrategyParameters } from "./StrategyParameters"
+export type {
+  StrategyParametersFields,
+  StrategyParametersJSON,
+} from "./StrategyParameters"
+export { LiquidityOneSideParameter } from "./LiquidityOneSideParameter"
+export type {
+  LiquidityOneSideParameterFields,
+  LiquidityOneSideParameterJSON,
+} from "./LiquidityOneSideParameter"
+export { BinLiquidityDistributionByWeight } from "./BinLiquidityDistributionByWeight"
+export type {
+  BinLiquidityDistributionByWeightFields,
+  BinLiquidityDistributionByWeightJSON,
+} from "./BinLiquidityDistributionByWeight"
+export { LiquidityParameterByWeight } from "./LiquidityParameterByWeight"
+export type {
+  LiquidityParameterByWeightFields,
+  LiquidityParameterByWeightJSON,
+} from "./LiquidityParameterByWeight"
+export { AddLiquiditySingleSidePreciseParameter } from "./AddLiquiditySingleSidePreciseParameter"
+export type {
+  AddLiquiditySingleSidePreciseParameterFields,
+  AddLiquiditySingleSidePreciseParameterJSON,
+} from "./AddLiquiditySingleSidePreciseParameter"
+export { CompressedBinDepositAmount } from "./CompressedBinDepositAmount"
+export type {
+  CompressedBinDepositAmountFields,
+  CompressedBinDepositAmountJSON,
+} from "./CompressedBinDepositAmount"
+export { BinLiquidityDistribution } from "./BinLiquidityDistribution"
+export type {
+  BinLiquidityDistributionFields,
+  BinLiquidityDistributionJSON,
+} from "./BinLiquidityDistribution"
+export { LiquidityParameter } from "./LiquidityParameter"
+export type {
+  LiquidityParameterFields,
+  LiquidityParameterJSON,
+} from "./LiquidityParameter"
+export { InitPermissionPairIx } from "./InitPermissionPairIx"
+export type {
+  InitPermissionPairIxFields,
+  InitPermissionPairIxJSON,
+} from "./InitPermissionPairIx"
+export { InitPresetParametersIx } from "./InitPresetParametersIx"
+export type {
+  InitPresetParametersIxFields,
+  InitPresetParametersIxJSON,
+} from "./InitPresetParametersIx"
+export { BinLiquidityReduction } from "./BinLiquidityReduction"
+export type {
+  BinLiquidityReductionFields,
+  BinLiquidityReductionJSON,
+} from "./BinLiquidityReduction"
+export { FeeParameter } from "./FeeParameter"
+export type { FeeParameterFields, FeeParameterJSON } from "./FeeParameter"
+export { Bin } from "./Bin"
+export type { BinFields, BinJSON } from "./Bin"
+export { ProtocolFee } from "./ProtocolFee"
+export type { ProtocolFeeFields, ProtocolFeeJSON } from "./ProtocolFee"
+export { RewardInfo } from "./RewardInfo"
+export type { RewardInfoFields, RewardInfoJSON } from "./RewardInfo"
+export { Observation } from "./Observation"
+export type { ObservationFields, ObservationJSON } from "./Observation"
+export { StaticParameters } from "./StaticParameters"
+export type {
+  StaticParametersFields,
+  StaticParametersJSON,
+} from "./StaticParameters"
+export { VariableParameters } from "./VariableParameters"
+export type {
+  VariableParametersFields,
+  VariableParametersJSON,
+} from "./VariableParameters"
+export { FeeInfo } from "./FeeInfo"
+export type { FeeInfoFields, FeeInfoJSON } from "./FeeInfo"
+export { UserRewardInfo } from "./UserRewardInfo"
+export type { UserRewardInfoFields, UserRewardInfoJSON } from "./UserRewardInfo"
+export { StrategyType }
+
+export type StrategyTypeKind =
+  | StrategyType.SpotOneSide
+  | StrategyType.CurveOneSide
+  | StrategyType.BidAskOneSide
+  | StrategyType.SpotBalanced
+  | StrategyType.CurveBalanced
+  | StrategyType.BidAskBalanced
+  | StrategyType.SpotImBalanced
+  | StrategyType.CurveImBalanced
+  | StrategyType.BidAskImBalanced
+export type StrategyTypeJSON =
+  | StrategyType.SpotOneSideJSON
+  | StrategyType.CurveOneSideJSON
+  | StrategyType.BidAskOneSideJSON
+  | StrategyType.SpotBalancedJSON
+  | StrategyType.CurveBalancedJSON
+  | StrategyType.BidAskBalancedJSON
+  | StrategyType.SpotImBalancedJSON
+  | StrategyType.CurveImBalancedJSON
+  | StrategyType.BidAskImBalancedJSON
+
+export { Rounding }
+
+export type RoundingKind = Rounding.Up | Rounding.Down
+export type RoundingJSON = Rounding.UpJSON | Rounding.DownJSON
+
+export { LayoutVersion }
+
+/** Layout version */
+export type LayoutVersionKind = LayoutVersion.V0 | LayoutVersion.V1
+export type LayoutVersionJSON = LayoutVersion.V0JSON | LayoutVersion.V1JSON
+
+export { PairType }
+
+/** Type of the Pair. 0 = Permissionless, 1 = Permission. Putting 0 as permissionless for backward compatibility. */
+export type PairTypeKind = PairType.Permissionless | PairType.Permission
+export type PairTypeJSON = PairType.PermissionlessJSON | PairType.PermissionJSON
+
+export { PairStatus }
+
+/** Pair status. 0 = Enabled, 1 = Disabled. Putting 0 as enabled for backward compatibility. */
+export type PairStatusKind = PairStatus.Enabled | PairStatus.Disabled
+export type PairStatusJSON = PairStatus.EnabledJSON | PairStatus.DisabledJSON

package/src/models/EnrichedScopePrice.ts

@@ -0,0 +1,32 @@
+import Decimal from 'decimal.js';
+import { OraclePrices } from '@hubbleprotocol/scope-sdk';
+import { CollateralInfo } from '../kamino-client/types';
+
+export interface EnrichedScopePrice {
+  /**
+   * Price in USD
+   */
+  price: Decimal;
+  /**
+   * Token name (as specified in collateral infos)
+   */
+  name: string;
+}
+
+export interface KaminoPrices {
+  /**
+   * Spot prices where record key is token mint and value is enriched scope price
+   */
+  spot: MintToPriceMap;
+  /**
+   * Twap prices where record key is token mint and value is enriched scope price
+   */
+  twap: MintToPriceMap;
+}
+
+export type MintToPriceMap = Record<string, EnrichedScopePrice>;
+
+export interface OraclePricesAndCollateralInfos {
+  oraclePrices: OraclePrices;
+  collateralInfos: CollateralInfo[];
+}

package/src/models/Holdings.ts

@@ -0,0 +1,15 @@
+import Decimal from 'decimal.js';
+import { TokenAmounts } from './TokenAmounts';
+
+export type Holdings = {
+  available: TokenAmounts;
+  availableUsd: Decimal;
+  invested: TokenAmounts;
+  investedUsd: Decimal;
+  totalSum: Decimal;
+};
+
+export type TokenHoldings = {
+  available: TokenAmounts;
+  invested: TokenAmounts;
+};

package/src/models/KaminoPosition.ts

@@ -0,0 +1,12 @@
+import { PublicKey } from '@solana/web3.js';
+import Decimal from 'decimal.js';
+import { Dex } from '../utils';
+
+export interface KaminoPosition {
+  strategy: PublicKey;
+  shareMint: PublicKey;
+  sharesAmount: Decimal;
+  strategyDex: Dex;
+}
+
+export default KaminoPosition;

package/src/models/KaminoStrategyWithShareMint.ts

@@ -0,0 +1,8 @@
+export interface KaminoStrategyWithShareMint {
+  address: string;
+  type: string;
+  shareMint: string;
+  status: string;
+  tokenAMint: string;
+  tokenBMint: string;
+}

package/src/models/KaminoToken.ts

@@ -0,0 +1,6 @@
+export type KaminoToken = {
+  name: string;
+  id: number;
+};
+
+export default KaminoToken;

package/src/models/LbPairWithAddress.ts

@@ -0,0 +1,9 @@
+import { PublicKey } from '@solana/web3.js';
+import { LbPair } from '../meteora_client/accounts';
+
+export interface LbPairWithAddress {
+  pool: LbPair;
+  address: PublicKey;
+}
+
+export default LbPairWithAddress;

package/src/models/MultipleAccountsResponse.ts

@@ -0,0 +1,49 @@
+export interface Context {
+  apiVersion: string;
+  slot: number;
+}
+
+export interface TokenAmount {
+  amount: string;
+  decimals: number;
+  uiAmount: number;
+  uiAmountString: string;
+}
+
+export interface Info {
+  isNative: boolean;
+  mint: string;
+  owner: string;
+  state: string;
+  tokenAmount: TokenAmount;
+}
+
+export interface Parsed {
+  info: Info;
+  type: string;
+}
+
+export interface Data {
+  parsed: Parsed;
+  program: string;
+  space: number;
+}
+
+export interface Value {
+  data: Data;
+  executable: boolean;
+  lamports: number;
+  owner: string;
+  rentEpoch: number;
+}
+
+export interface Result {
+  context: Context;
+  value: Value[];
+}
+
+export interface MultipleAccountsResponse {
+  jsonrpc: string;
+  result: Result;
+  id: number;
+}

package/src/models/PoolSimulationResponseData.ts

@@ -0,0 +1,28 @@
+export interface PoolSimulationResponse {
+  data: PoolSimulationResponseData[];
+  backtest_end_date: string;
+  backtest_start_date: string;
+  backtest_num_days: number;
+  tokena_ratio: number;
+  tokenb_ratio: number;
+}
+
+export interface PoolSimulationResponseData {
+  ts: number;
+  fees_apy: number;
+  il_apy: number;
+  pnl_apy: number;
+  fees_return_pct: number;
+  il_return_pct: number;
+  pnl_return_pct: number;
+  price_lower: number;
+  price_upper: number;
+  price_curr: number;
+  price_curr_twap: number;
+  pnl_vs_usd_apy: number;
+  pnl_vs_usd_return_pct: number;
+  investment_value_usd: number;
+  hodl_value_usd: number;
+  hodl_tokena_value_usd: number;
+  hodl_tokenb_value_usd: number;
+}

package/src/models/PriceData.ts

@@ -0,0 +1,17 @@
+import Decimal from 'decimal.js';
+
+export type PriceData = {
+  aPrice: Decimal;
+  bPrice: Decimal;
+  reward0Price: Decimal | null;
+  reward1Price: Decimal | null;
+  reward2Price: Decimal | null;
+  lowerPrice: Decimal;
+  upperPrice: Decimal;
+  poolPrice: Decimal;
+  twapPrice: Decimal | null;
+  lowerResetPrice: Decimal | null;
+  upperResetPrice: Decimal | null;
+};
+
+export default PriceData;

package/src/models/RaydiumPoolWithAddress.ts

@@ -0,0 +1,9 @@
+import { PublicKey } from '@solana/web3.js';
+import { PoolState } from '../raydium_client/accounts';
+
+export interface RaydiumPoolWithAddress {
+  poolState: PoolState;
+  address: PublicKey;
+}
+
+export default RaydiumPoolWithAddress;

package/src/models/ShareData.ts

@@ -0,0 +1,34 @@
+import { PublicKey } from '@solana/web3.js';
+import Decimal from 'decimal.js';
+import { StrategyBalances } from './StrategyBalances';
+import { WhirlpoolStrategy } from '../kamino-client/accounts';
+import PriceData from './PriceData';
+
+export type ShareData = {
+  balance: StrategyBalances;
+  price: Decimal;
+};
+
+export type ShareDataWithAddress = {
+  shareData: ShareData;
+  address: PublicKey;
+  strategy: WhirlpoolStrategy;
+};
+
+export function getEmptyShareData(prices: PriceData): ShareData {
+  return {
+    price: new Decimal(0),
+    balance: {
+      prices,
+      tokenAAmounts: new Decimal(0),
+      tokenBAmounts: new Decimal(0),
+      computedHoldings: {
+        available: { a: new Decimal(0), b: new Decimal(0) },
+        availableUsd: new Decimal(0),
+        investedUsd: new Decimal(0),
+        invested: { a: new Decimal(0), b: new Decimal(0) },
+        totalSum: new Decimal(0),
+      },
+    },
+  };
+}

package/src/models/StrategyBalances.ts

@@ -0,0 +1,15 @@
+import { Holdings } from './Holdings';
+import { PriceData } from './PriceData';
+import Decimal from 'decimal.js';
+import StrategyWithAddress from './StrategyWithAddress';
+
+export type StrategyBalances = {
+  computedHoldings: Holdings;
+  prices: PriceData;
+  tokenAAmounts: Decimal;
+  tokenBAmounts: Decimal;
+};
+export type StrategyBalanceWithAddress = {
+  balance: StrategyBalances;
+  strategyWithAddress: StrategyWithAddress;
+};

package/src/models/StrategyHolder.ts

@@ -0,0 +1,7 @@
+import { PublicKey } from '@solana/web3.js';
+import Decimal from 'decimal.js';
+
+export type StrategyHolder = {
+  holderPubkey: PublicKey;
+  amount: Decimal;
+};

package/src/models/StrategyPrices.ts

@@ -0,0 +1,11 @@
+import Decimal from 'decimal.js';
+
+export type StrategyPrices = {
+  aPrice: Decimal;
+  bPrice: Decimal;
+  reward0Price: Decimal | null;
+  reward1Price: Decimal | null;
+  reward2Price: Decimal | null;
+  aTwapPrice: Decimal | null;
+  bTwapPrice: Decimal | null;
+};

package/src/models/StrategyProgramAddress.ts

@@ -0,0 +1,14 @@
+import { PublicKey } from '@solana/web3.js';
+
+export type StrategyProgramAddress = {
+  tokenAVault: PublicKey;
+  tokenABump: number;
+  tokenBVault: PublicKey;
+  tokenBBump: number;
+  baseVaultAuthority: PublicKey;
+  baseVaultAuthorityBump: number;
+  sharesMint: PublicKey;
+  sharesMintBump: number;
+  sharesMintAuthority: PublicKey;
+  sharesMintAuthorityBump: number;
+};

package/src/models/StrategyVaultBalances.ts

@@ -0,0 +1,6 @@
+import Decimal from 'decimal.js';
+
+export type StrategyVaultBalances = {
+  a: Decimal;
+  b: Decimal;
+};

package/src/models/StrategyVaultTokens.ts

@@ -0,0 +1,14 @@
+import { PublicKey } from '@solana/web3.js';
+import Decimal from 'decimal.js';
+
+export type StrategyVaultTokens = {
+  address: PublicKey;
+  frontendUrl: string;
+  amount: Decimal;
+};
+
+export type TotalStrategyVaultTokens = {
+  totalTokenAmount: Decimal;
+  vaults: StrategyVaultTokens[];
+  timestamp: Date;
+};

package/src/models/StrategyWithAddress.ts

@@ -0,0 +1,9 @@
+import { WhirlpoolStrategy } from '../kamino-client/accounts';
+import { PublicKey } from '@solana/web3.js';
+
+export interface StrategyWithAddress {
+  strategy: WhirlpoolStrategy;
+  address: PublicKey;
+}
+
+export default StrategyWithAddress;

package/src/models/StrategyWithPendingFees.ts

@@ -0,0 +1,7 @@
+import { TokenAmounts } from './TokenAmounts';
+import StrategyWithAddress from './StrategyWithAddress';
+
+export type StrategyWithPendingFees = {
+  strategy: StrategyWithAddress;
+  pendingFees: TokenAmounts;
+};

package/src/models/TokenAmounts.ts

@@ -0,0 +1,6 @@
+import Decimal from 'decimal.js';
+
+export type TokenAmounts = {
+  a: Decimal;
+  b: Decimal;
+};

package/src/models/TreasuryFeeVault.ts

@@ -0,0 +1,9 @@
+import { PublicKey } from '@solana/web3.js';
+
+export type TreasuryFeeVault = {
+  treasuryFeeTokenAVault: PublicKey;
+  treasuryFeeTokenBVault: PublicKey;
+  treasuryFeeVaultAuthority: PublicKey;
+};
+
+export default TreasuryFeeVault;

package/src/models/WhirlpoolWithAddress.ts

@@ -0,0 +1,9 @@
+import { PublicKey } from '@solana/web3.js';
+import { Whirlpool } from '../whirlpools-client/accounts';
+
+export interface WhirlpoolWithAddress {
+  whirlpool: Whirlpool;
+  address: PublicKey;
+}
+
+export default WhirlpoolWithAddress;

package/src/models/index.ts

@@ -0,0 +1,19 @@
+export * from './Holdings';
+export * from './StrategyBalances';
+export * from './StrategyVaultBalances';
+export * from './TokenAmounts';
+export * from './KaminoToken';
+export * from './PriceData';
+export * from './ShareData';
+export * from './TreasuryFeeVault';
+export * from './MultipleAccountsResponse';
+export * from './StrategyWithAddress';
+export * from './KaminoPosition';
+export * from './StrategyHolder';
+export * from './StrategyPrices';
+export * from './StrategyProgramAddress';
+export * from './StrategyVaultTokens';
+export * from './ShareData';
+export * from './EnrichedScopePrice';
+export * from './KaminoStrategyWithShareMint';
+export * from './StrategyWithPendingFees';