pinpet-sdk 0.1.2 → 2.0.0

package/README.md

@@ -2,6 +2,18 @@
 
 A JavaScript SDK for interacting with PinPet protocol-related Solana Anchor smart contracts. The SDK supports both Node.js and browser environments, providing modular functionality for trading, token management, order management, and more.
 
+
+## PinPet Project Repositories
+
+- **[PinPet swap](https://devnet.pinpet.fun/#/)** - devnet swap web
+- **[Technical Documentation](https://doc.pinpet.fun/#/)** - Multi-language technical specification docs
+- **[pinpet-sdk](https://github.com/pinpetfun/pinpet-sdk)** - SDK for trading operations
+- **[pinpet-anchor](https://github.com/pinpetfun/pinpet-anchor)** - Solana smart contract code
+- **[pinpet-web](https://github.com/pinpetfun/pinpet-web)** - Website frontend code
+- **[pinpet-server](https://github.com/pinpetfun/pinpet-server)** - Transaction acceleration server code
+
+
+
 ## Installation 
 
 ```bash

package/dist/index.d copy.ts

@@ -0,0 +1,342 @@
+import { Connection, PublicKey, Transaction, Keypair } from '@solana/web3.js';
+import { BN, Wallet, Program } from '@coral-xyz/anchor';
+
+// ========================= 基础类型定义 =========================
+
+export type DataSourceType = 'fast' | 'chain';
+
+export interface NetworkConfig {
+  name: string;
+  defaultDataSource: DataSourceType;
+  solanaEndpoint: string;
+  spin_fast_api_url: string;
+  fee_recipient: string;
+  base_fee_recipient: string;
+  params_account: string;
+}
+
+export interface PinPetSdkOptions {
+  defaultDataSource?: DataSourceType;
+  solanaEndpoint?: string;
+  spin_fast_api_url?: string;
+  fee_recipient?: string;
+  base_fee_recipient?: string;
+  params_account?: string;
+  debug_log_path?: string;
+  debugLogPath?: string;
+}
+
+// ========================= 订单和交易相关类型 =========================
+
+export interface OrderData {
+  order_pda: string;
+  user: string;
+  mint: string;
+  order_type: string;
+  lock_lp_sol_amount: string;
+  lock_lp_token_amount: string;
+  lock_lp_start_price: string;
+  lock_lp_end_price: string;
+  margin_sol_amount: string;
+  borrow_amount: string;
+  position_asset_amount: string;
+  created_at?: string;
+  updated_at?: string;
+}
+
+export interface LpPair {
+  solAmount: BN;
+  tokenAmount: BN;
+}
+
+export interface TransactionResult {
+  transaction: Transaction;
+  signers: Keypair[];
+  accounts: Record<string, PublicKey>;
+  orderData?: {
+    ordersUsed: number;
+    lpPairsCount: number;
+    lpPairs: LpPair[];
+    orderAccounts: (string | null)[];
+    [key: string]: any;
+  };
+}
+
+export interface OrdersResponse {
+  data: {
+    orders: OrderData[];
+    total?: number;
+    page?: number;
+    limit?: number;
+  };
+}
+
+export interface PriceResponse {
+  price: string;
+  price_u128: string;
+  [key: string]: any;
+}
+
+export interface MintInfo {
+  mint: string;
+  name?: string;
+  symbol?: string;
+  decimals: number;
+  total_supply?: string;
+  [key: string]: any;
+}
+
+// ========================= 交易参数类型 =========================
+
+export interface BuyParams {
+  mintAccount: string | PublicKey;
+  buyTokenAmount: BN;
+  maxSolAmount: BN;
+  payer: PublicKey;
+}
+
+export interface SellParams {
+  mintAccount: string | PublicKey;
+  sellTokenAmount: BN;
+  minSolOutput: BN;
+  payer: PublicKey;
+}
+
+export interface LongParams {
+  mintAccount: string | PublicKey;
+  buyTokenAmount: BN;
+  maxSolAmount: BN;
+  marginSol: BN;
+  closePrice: BN;
+  prevOrder?: PublicKey | null;
+  nextOrder?: PublicKey | null;
+  payer: PublicKey;
+}
+
+export interface ShortParams {
+  mintAccount: string | PublicKey;
+  borrowSellTokenAmount: BN;
+  minSolOutput: BN;
+  marginSol: BN;
+  closePrice: BN;
+  prevOrder?: PublicKey | null;
+  nextOrder?: PublicKey | null;
+  payer: PublicKey;
+}
+
+export interface CloseLongParams {
+  mintAccount: string | PublicKey;
+  closeOrder: string | PublicKey;
+  sellTokenAmount: BN;
+  minSolOutput: BN;
+  payer: PublicKey;
+}
+
+export interface CloseShortParams {
+  mintAccount: string | PublicKey;
+  closeOrder: string | PublicKey;
+  buyTokenAmount: BN;
+  maxSolAmount: BN;
+  payer: PublicKey;
+}
+
+export interface TransactionOptions {
+  computeUnits?: number;
+}
+
+// ========================= 查询参数类型 =========================
+
+export interface OrdersQueryOptions {
+  type?: 'up_orders' | 'down_orders';
+  limit?: number;
+  page?: number;
+  dataSource?: DataSourceType;
+}
+
+export interface PriceQueryOptions {
+  dataSource?: DataSourceType;
+}
+
+export interface UserOrdersQueryOptions {
+  type?: 'up_orders' | 'down_orders';
+  limit?: number;
+  page?: number;
+  dataSource?: DataSourceType;
+}
+
+// ========================= 模拟器相关类型 =========================
+
+export interface SimulationResult {
+  liqResult: {
+    free_lp_sol_amount_sum: bigint;
+    free_lp_token_amount_sum: bigint;
+    lock_lp_sol_amount_sum: bigint;
+    lock_lp_token_amount_sum: bigint;
+    has_infinite_lp: boolean;
+    pass_order_id: number;
+    force_close_num: number;
+    ideal_lp_sol_amount: bigint;
+    real_lp_sol_amount: bigint;
+  };
+  completion: string;
+  slippage: string;
+  suggestedTokenAmount: string;
+  suggestedSolAmount: string;
+}
+
+// ========================= 工具类相关类型 =========================
+
+export interface FindPrevNextResult {
+  prevOrder: OrderData | null;
+  nextOrder: OrderData | null;
+}
+
+export interface ValidationResult {
+  valid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+
+// ========================= 模块接口定义 =========================
+
+export interface TradingModule {
+  buy(params: BuyParams, options?: TransactionOptions): Promise<TransactionResult>;
+  sell(params: SellParams, options?: TransactionOptions): Promise<TransactionResult>;
+  long(params: LongParams, options?: TransactionOptions): Promise<TransactionResult>;
+  short(params: ShortParams, options?: TransactionOptions): Promise<TransactionResult>;
+  closeLong(params: CloseLongParams, options?: TransactionOptions): Promise<TransactionResult>;
+  closeShort(params: CloseShortParams, options?: TransactionOptions): Promise<TransactionResult>;
+}
+
+export interface FastModule {
+  mints(options?: any): Promise<any>;
+  mint_info(mint: string): Promise<MintInfo>;
+  orders(mint: string, options?: OrdersQueryOptions): Promise<OrdersResponse>;
+  price(mint: string, options?: PriceQueryOptions): Promise<PriceResponse>;
+  user_orders(user: string, mint: string, options?: UserOrdersQueryOptions): Promise<OrdersResponse>;
+}
+
+export interface ChainModule {
+  getCurveAccount(mint: string): Promise<any>;
+  orders(mint: string, options?: OrdersQueryOptions): Promise<OrdersResponse>;
+  price(mint: string, options?: PriceQueryOptions): Promise<PriceResponse>;
+}
+
+export interface TokenModule {
+  create(params: any): Promise<TransactionResult>;
+}
+
+export interface ParamModule {
+  createParams(params: any): Promise<TransactionResult>;
+  getParams(partner: string): Promise<any>;
+  getAdmin(): Promise<any>;
+}
+
+export interface SimulatorModule {
+  simulateTokenBuy(mint: string, buyTokenAmount: bigint | string | number, passOrder?: string | null): Promise<SimulationResult>;
+  simulateTokenSell(mint: string, sellTokenAmount: bigint | string | number, passOrder?: string | null): Promise<SimulationResult>;
+  simulateLongStopLoss(mint: string, buyTokenAmount: bigint | string | number, stopLossPrice: bigint | string | number, lastPrice?: any, ordersData?: any): Promise<any>;
+  simulateSellStopLoss(mint: string, sellTokenAmount: bigint | string | number, stopLossPrice: bigint | string | number, lastPrice?: any, ordersData?: any): Promise<any>;
+}
+
+// ========================= 数据接口类型 =========================
+
+export interface DataInterface {
+  orders(mint: string, options?: OrdersQueryOptions): Promise<OrdersResponse>;
+  price(mint: string, options?: PriceQueryOptions): Promise<PriceResponse>;
+}
+
+// ========================= 主 SDK 类型定义 =========================
+
+export declare class PinPetSdk {
+  connection: Connection;
+  programId: PublicKey;
+  program: Program;
+  options: PinPetSdkOptions;
+  defaultDataSource: DataSourceType;
+  feeRecipient: PublicKey;
+  baseFeeRecipient: PublicKey;
+  paramsAccount: PublicKey;
+  spinFastApiUrl: string;
+  debugLogPath: string | null;
+  
+  // 常量
+  readonly MAX_ORDERS_COUNT: number;
+  readonly FIND_MAX_ORDERS_COUNT: number;
+  readonly SUGGEST_LIQ_RATIO: number;
+  
+  // 模块
+  trading: TradingModule;
+  fast: FastModule;
+  chain: ChainModule;
+  token: TokenModule;
+  param: ParamModule;
+  simulator: SimulatorModule;
+  data: DataInterface;
+
+  constructor(
+    connection: Connection,
+    programId: string | PublicKey,
+    options?: PinPetSdkOptions
+  );
+
+  // OrderUtils 快捷方法
+  buildLpPairs(orders: OrderData[], direction: string, price: any, maxCount?: number): LpPair[];
+  buildOrderAccounts(orders: OrderData[], maxCount?: number): (string | null)[];
+  findPrevNext(orders: OrderData[], findOrderPda: string): FindPrevNextResult;
+  findOrderIndex(orders: OrderData[], targetOrderPda: string | PublicKey | null): number;
+}
+
+// ========================= 工具类导出 =========================
+
+export declare class OrderUtils {
+  static buildLpPairs(orders: OrderData[], direction: string, price: any, maxCount?: number): LpPair[];
+  static buildOrderAccounts(orders: OrderData[], maxCount?: number): (string | null)[];
+  static findPrevNext(orders: OrderData[], findOrderPda: string): FindPrevNextResult;
+  static findOrderIndex(orders: OrderData[], targetOrderPda: string | PublicKey | null): number;
+  static validateOrdersFormat(orders: OrderData[], throwOnError?: boolean): boolean | ValidationResult;
+}
+
+export declare class CurveAMM {
+  static readonly INITIAL_SOL_RESERVE_DECIMAL: any;
+  static readonly INITIAL_TOKEN_RESERVE_DECIMAL: any;
+  static readonly INITIAL_K_DECIMAL: any;
+  static readonly INITIAL_MIN_PRICE_DECIMAL: any;
+  static readonly PRICE_PRECISION_FACTOR_DECIMAL: any;
+  static readonly TOKEN_PRECISION_FACTOR_DECIMAL: any;
+  static readonly SOL_PRECISION_FACTOR_DECIMAL: any;
+  static readonly MAX_U128_PRICE: bigint;
+  static readonly MIN_U128_PRICE: bigint;
+
+  static u128ToDecimal(price: bigint | string | number): any;
+  static decimalToU128(price: any): bigint | null;
+  static decimalToU128Ceil(price: any): bigint | null;
+  static buyFromPriceToPrice(startLowPrice: bigint | string | number, endHighPrice: bigint | string | number): [bigint, bigint] | null;
+  static sellFromPriceToPrice(startHighPrice: bigint | string | number, endLowPrice: bigint | string | number): [bigint, bigint] | null;
+  static buyFromPriceWithSolInput(startLowPrice: bigint | string | number, solInputAmount: bigint | string | number): [bigint, bigint] | null;
+  static sellFromPriceWithTokenInput(startHighPrice: bigint | string | number, tokenInputAmount: bigint | string | number): [bigint, bigint] | null;
+  static buyFromPriceWithTokenOutput(startLowPrice: bigint | string | number, tokenOutputAmount: bigint | string | number): [bigint, bigint] | null;
+  static sellFromPriceWithSolOutput(startHighPrice: bigint | string | number, solOutputAmount: bigint | string | number): [bigint, bigint] | null;
+  static calculateAmountAfterFee(amount: bigint | string | number, fee: number): bigint | null;
+  static formatPriceForDisplay(price: bigint | string | number, decimalPlaces?: number): string;
+  static createPriceDisplayString(price: bigint | string | number, decimalPlaces?: number): string;
+  static calculatePoolPrice(lpTokenReserve: bigint | string | number | BN, lpSolReserve: bigint | string | number | BN): string | null;
+}
+
+// ========================= 常量和函数导出 =========================
+
+export declare const SPINPET_PROGRAM_ID: string;
+
+export declare function getDefaultOptions(networkName?: 'MAINNET' | 'DEVNET' | 'LOCALNET'): NetworkConfig;
+
+// ========================= 模块类导出 =========================
+
+export declare class TradingModule implements TradingModule {}
+export declare class FastModule implements FastModule {}
+export declare class ChainModule implements ChainModule {}
+export declare class TokenModule implements TokenModule {}
+export declare class ParamModule implements ParamModule {}
+export declare class SimulatorModule implements SimulatorModule {}
+
+// 默认导出
+export default PinPetSdk;

package/dist/index.d.ts

@@ -9,20 +9,19 @@ export interface NetworkConfig {
   name: string;
   defaultDataSource: DataSourceType;
   solanaEndpoint: string;
-  spin_fast_api_url: string;
-  fee_recipient: string;
-  base_fee_recipient: string;
-  params_account: string;
+  pinPetFastApiUrl: string;
+  feeRecipient: string;
+  baseFeeRecipient: string;
+  paramsAccount: string;
 }
 
 export interface PinPetSdkOptions {
   defaultDataSource?: DataSourceType;
   solanaEndpoint?: string;
-  spin_fast_api_url?: string;
-  fee_recipient?: string;
-  base_fee_recipient?: string;
-  params_account?: string;
-  debug_log_path?: string;
+  pinPetFastApiUrl?: string;
+  feeRecipient?: string;
+  baseFeeRecipient?: string;
+  paramsAccount?: string;
   debugLogPath?: string;
 }
 
@@ -257,7 +256,7 @@ export declare class PinPetSdk {
   feeRecipient: PublicKey;
   baseFeeRecipient: PublicKey;
   paramsAccount: PublicKey;
-  spinFastApiUrl: string;
+  pinPetFastApiUrl: string;
   debugLogPath: string | null;
   
   // 常量