flash-sdk 1.0.21 → 1.0.23

package/src/index.ts

@@ -1,19 +0,0 @@
-export * from './PoolAccount';
-export * from './CustodyAccount';
-export * from './PositionAccount';
-export * from './OraclePrice';
-export * from './constants';
-export * from './types';
-export * from './utils';
-export * from './PerpetualsClient';
-export * from './PoolConfig';
-export * from './PoolDataClient';
-export {IDL}  from './idl/perpetuals';
-export * from './utils/rpc';
-// export { default as PoolConfigJson } from "./PoolConfig.json";
-
-
-
-
-
-

package/src/type-rules.md

@@ -1,4 +0,0 @@
-# strict JS types <=> Rust types 
-
-1) u65 : unisigned intergar - so no decimals => BN 
-2) u8 : number 

package/src/types/index.ts

@@ -1,290 +0,0 @@
-import { PublicKey } from "@solana/web3.js";
-import { OraclePrice } from "../OraclePrice";
-import { BN_ZERO } from "../constants";
-import { BN } from "@coral-xyz/anchor";
-
-export type PositionSide = "long" | "short";
-
-//  taken from drift 
-export function isVariant(object: any, type: string) {
-    return object.hasOwnProperty(type);
-}
-
-// isOneOfVariant(side, ['long', 'short']
-export function isOneOfVariant(object: any, types: string[]) {
-    return types.reduce((result, type) => {
-        return result || object.hasOwnProperty(type);
-    }, false);
-}
-
-//  simple type cannot be used as anchor somehow makes it a object while parseing 
-// export enum Side {
-//     None,
-//     Long,
-//     Short,
-// }
-export class Side {
-    static None = { none: {} };
-    static Long = { long: {} };
-    static Short = { short: {} };
-}
-
-export class AumCalcMode {
-    static Min = { min: {} };
-    static Max = { max: {} };
-    static Last = { last : {} };
-    static EMA = { ema : {} };
-}
-
-// =======================================================
-// ==================    POSITION     ====================
-// =======================================================
-
-export interface Position {
-    owner: PublicKey,
-    pool: PublicKey,
-    custody: PublicKey,
-    // lockCustody: PublicKey,
-
-    openTime: BN,
-    updateTime: BN,
-
-    side: Side,
-    price: BN,
-    sizeUsd: BN,
-    collateralUsd: BN,
-    unrealizedProfitUsd: BN,
-    unrealizedLossUsd: BN,
-    cumulativeInterestSnapshot: BN,
-    lockedAmount: BN,
-    collateralAmount: BN,
-
-    bump: number
-}
-
-export const DEFAULT_POSITION : Position = {
-    owner: PublicKey.default,
-    pool: PublicKey.default,
-    custody: PublicKey.default,
-    // lockCustody: PublicKey.default,
-
-    openTime: BN_ZERO,
-    updateTime: BN_ZERO,
-
-    side: Side.Long,
-    price: BN_ZERO,
-    sizeUsd: BN_ZERO,
-    collateralUsd: BN_ZERO,
-    unrealizedProfitUsd: BN_ZERO,
-    unrealizedLossUsd: BN_ZERO,
-    cumulativeInterestSnapshot: BN_ZERO,
-    lockedAmount: BN_ZERO,
-    collateralAmount: BN_ZERO,
-
-    bump: 0
-}
-
-// =======================================================
-// ==================    POOL     ========================
-// =======================================================
-export interface Pool {
-    name: string;
-    custodies: PublicKey[];
-    ratios: TokenRatios[];
-    aumUsd: BN;
-    bump: number;
-    lpTokenBump: number;
-    inceptionTime: BN;
-}
-
-export interface TokenRatios {
-    target: BN;
-    min: BN;
-    max: BN;
-}
-
-// =======================================================
-// ==================    CUSTODY     =====================
-// =======================================================
-
-export interface Custody {
-    // static parameters
-    pool: PublicKey;
-    mint: PublicKey;
-    tokenAccount: PublicKey;
-    decimals: number;
-    isStable: boolean;
-    oracle: OracleParams;
-    pricing: PricingParams;
-    permissions: Permissions;
-    fees: Fees;
-    borrowRate: BorrowRateParams;
-
-    // dynamic variables
-    assets: Assets;
-    collectedFees: FeesStats;
-    volumeStats: VolumeStats;
-    tradeStats: TradeStats;
-
-    longPositions: PositionStats,
-    shortPositions: PositionStats,
-    borrowRateState: BorrowRateState,
-
-    // bumps for address validation
-    bump: number;
-    tokenAccountBump: number;
-}
-
-export interface BorrowRateParams {
-    // borrow rate params have implied RATE_DECIMALS decimals
-    baseRate: BN,
-    slope1: BN,
-    slope2: BN,
-    optimalUtilization: BN,
-}
-
-export interface BorrowRateState {
-    // borrow rates have implied RATE_DECIMALS decimals
-    currentRate: BN,
-    cumulativeInterest: BN,
-    lastUpdate: BN,
-}
-
-export interface PositionStats {
-    openPositions: BN,
-    collateralUsd: BN,
-    sizeUsd: BN,
-    lockedAmount: BN,
-    weightedPrice: BN, 
-    totalQuantity: BN, 
-    cumulativeInterestUsd: BN,
-    cumulativeInterestSnapshot: BN,
-}
-
-
-
-export interface Assets {
-    collateral: BN;
-    protocolFees: BN;
-    owned: BN;
-    locked: BN;
-}
-
-export interface FeesStats {
-    swapUsd: BN;
-    addLiquidityUsd: BN;
-    removeLiquidityUsd: BN;
-    openPositionUsd: BN;
-    closePositionUsd: BN;
-    liquidationUsd: BN;
-}
-
-export interface VolumeStats {
-    swapUsd: BN;
-    addLiquidityUsd: BN;
-    removeLiquidityUsd: BN;
-    openPositionUsd: BN;
-    closePositionUsd: BN;
-    liquidationUsd: BN;
-}
-
-export interface Fees {
-    mode: FeesMode;
-    ratioMult :BN;
-    utilizationMult : BN;
-     swapIn: BN,
-     swapOut: BN,
-     stableSwapIn: BN,
-     stableSwapOut: BN,
-     addLiquidity: BN,
-     removeLiquidity: BN,
-     openPosition: BN,
-     closePosition: BN,
-     liquidation: BN,
-     protocolShare: BN,
-}
-
-// export enum FeesMode {
-//     Fixed,
-//     Linear
-// }
-export class FeesMode {
-    static Fixed = { fixed: {} };
-    static Linear = { linear: {} };
-}
-
-export interface OracleParams {
-    oracleAccount: PublicKey;
-    oracleType: OracleType;
-    maxPriceError: BN;
-    maxPriceAgeSec: number;
-}
-
-// export enum OracleType {
-//     None,
-//     Test,
-//     Pyth,
-// }
-
-export class OracleType {
-    static None = { none: {} };
-    static Test = { test: {} };
-    static Pyth = { pyth: {} };
-}
-
-export interface Permissions {
-    allowSwap: boolean;
-    allowAddLiquidity: boolean;
-    allowRemoveLiquidity: boolean;
-    allowOpenPosition: boolean;
-    allowClosePosition: boolean;
-    allowPnlWithdrawal: boolean;
-    allowCollateralWithdrawal: boolean;
-    allowSizeChange: boolean;
-}
-
-export interface PricingParams {
-    useEma: boolean;
-    useUnrealizedPnlInAum: boolean;
-
-    tradeSpreadLong: BN;
-    tradeSpreadShort: BN;
-    swapSpread: BN;
-
-    minInitialLeverage: BN;
-    maxInitialLeverage: BN;
-    maxLeverage: BN;
-
-    maxPayoffMult: BN;
-    maxUtilization: BN;
-    // USD denominated values always have implied USD_DECIMALS decimals
-    maxPositionLockedUsd: BN;
-    maxTotalLockedUsd: BN;
-}
-
-export interface TradeStats {
-    profitUsd: BN;
-    lossUsd: BN;
-    oiLongUsd: BN;
-    oiShortUsd: BN;
-}
-
-// export interface Price {
-//     price: BN, //i64,
-//     conf?: BN,
-//     /// Exponent.
-//     expo: BN, // i32,
-//     /// Publish time.
-//     publish_time?: BN,//UnixTimestamp,
-// }
-
-export interface PriceFeed {
-    /// Unique identifier for this price.
-    //  id: any,// PriceIdentifier,
-    /// Price.
-    price: OraclePrice,
-    /// Exponentially-weighted moving average (EMA) price.
-    ema_price: OraclePrice,
-}
-
-

package/src/utils/index.ts

@@ -1,234 +0,0 @@
-import BN from "bn.js";
-import { BN_ONE, BN_ZERO } from "../constants";
-import { Connection, PublicKey } from "@solana/web3.js";
-
-export const getUnixTs = () => {
-    return new Date().getTime() / 1000;
-  };
-
-// 99999.123456
-// 99999.123
-export function toUiDecimals(
-  nativeAmount: BN  | number | string,
-  decimals: number,
-  precision = 3,
-  commaSeperated = false
-): string {
-  // TODO: remove BN and upgrade to bigint https://github.com/solana-labs/solana/issues/27440
-
-  if(precision> decimals){
-    throw "not allowed precision> decimals"
-  }
-  let r = '';
-
-  if (nativeAmount instanceof BN) {
-    const nativeAmountString = nativeAmount.toString();
-    // get decimals 
-    const d = nativeAmountString.slice((decimals) * -1);
-    const p = d.slice(0 ,precision);
-    const nativeAmountWithoutDecimalsStr = nativeAmount.div(new BN( 10 ** decimals)).toString();
-
-     r =  nativeAmountWithoutDecimalsStr + "." + p;
-  }
- else if (typeof nativeAmount === "string") {
-    if( isNaN(Number(nativeAmount))){
-        throw "String No valid "
-    }
-    const d = nativeAmount.slice((decimals) * -1);
-    const p = d.slice(0 ,precision);
-    const nativeAmountWithoutDecimalsStr = (new BN(nativeAmount)).div(new BN( 10 ** decimals)).toString();
-
-     r = nativeAmountWithoutDecimalsStr + "." + p;
-  }
-  else if (typeof nativeAmount === "number") {
-    const d = nativeAmount.toString().slice((decimals) * -1);
-    const p = d.slice(0 ,precision);
-    const nativeAmountWithoutDecimalsStr = (new BN(nativeAmount)).div(new BN( 10 ** decimals)).toString();
-     r = nativeAmountWithoutDecimalsStr + "." + p;
-  } 
-  else {
-      return 'type unknown'
-  }
-
-  if(commaSeperated){
-    return Number(r).toLocaleString();
-  } else {
-    return r;
-  }
-
-}
-
-export async function checkIfAccountExists(
-  account: PublicKey,
-  connection: Connection
-): Promise<boolean> {
-  // console.log("connection print", connection);
-  let bal = await connection.getBalance(account);
-  if (bal > 0) {
-    return true;
-  } else {
-    return false;
-  }
-}
-
-  // recheck ?? logic 
-export const scaleToExponent = (arg: BN, exponent: BN, target_exponent: BN) : BN => {
-    if (target_exponent.eq(exponent)) {
-        return arg;
-    }
-    let delta = target_exponent.sub(exponent);
-    if (delta.gt(BN_ZERO)) {
-      // checked_div(arg, checked_pow(10, delta as usize)?)
-      return arg.div( new BN(10).pow(delta) );
-    } else {
-        // checked_mul(arg, checked_pow(10, (-delta) as usize)?)
-        return arg.mul( new BN(10).pow(delta.muln(-1)))
-    }
-}
-
-// ceil(a/b) = ((a + b - 1) / b) , if a>=0
-export const checkedCeilDiv = (arg1: BN, arg2: BN) => {
-    if (arg1.gt(BN_ZERO)){
-        if (arg1.eq(arg2) && !arg2.isZero()) {
-            return BN_ONE;
-        }
-        let res = (arg1.sub(BN_ONE)).div(arg2);
-        if(!res){
-          throw Error("error :: MathOverflow")
-        }
-        return res.add(BN_ONE);
-    } else {
-      let res = (arg1).div(arg2);
-      if(!res){
-        throw Error("error :: MathOverflow")
-      }
-      return res;
-    }
-}
-
-export const checkedDecimalCeilMul = (
-    coefficient1: BN,
-    exponent1: BN,
-    coefficient2: BN,
-    exponent2: BN,
-    target_exponent: BN,
-) : BN => {
-    if (coefficient1.isZero() || coefficient2.isZero()) {
-        return BN_ZERO;
-    }
-    let target_power = (exponent1.add(exponent2)).sub(target_exponent); 
-    if (target_power.gt(BN_ZERO) ){
-        // checked_as_u64(checked_mul(
-        //     checked_mul(coefficient1 as u128, coefficient2 as u128)?,
-        //     checked_pow(10u128, target_power as usize)?,
-        // )?)
-        
-         return (coefficient1.mul(coefficient2)).mul(new BN(10).pow(target_power));
-        
-    } else {
-        // checked_as_u64(checked_ceil_div(
-        //     checked_mul(coefficient1 as u128, coefficient2 as u128)?,
-        //     checked_pow(10u128, (-target_power) as usize)?,
-        // )?)
-
-        // ceil(a/b) = ((a + b - 1) / b) , if a>=0
-        //  
-        const a = (coefficient1.mul(coefficient2));
-        const b = (new BN(10).pow(target_power.muln(-1)))
-        // return (a.add(b).subn(1)).div(b);
-        return checkedCeilDiv(a,b);
-    }
-}
-
-export const checkedDecimalMul = (
-  coefficient1: BN,
-  exponent1: BN,
-  coefficient2: BN,
-  exponent2: BN,
-  target_exponent: BN,
-) : BN => {
-  if (coefficient1.isZero() || coefficient2.isZero()) {
-      return BN_ZERO;
-  }
-  let target_power = (exponent1.add(exponent2)).sub(target_exponent); 
-  if (target_power.gt(BN_ZERO) ){
-      // checked_as_u64(checked_mul(
-      //     checked_mul(coefficient1 as u128, coefficient2 as u128)?,
-      //     checked_pow(10u128, target_power as usize)?,
-      // )?)
-      
-       return (coefficient1.mul(coefficient2)).mul(new BN(10).pow(target_power));
-      
-  } else {
-    // checked_as_u64(checked_div(
-    //   checked_mul(coefficient1 as u128, coefficient2 as u128)?,
-    //   checked_pow(10u128, (-target_power) as usize)?,
-    // )?)
-
-      return (coefficient1.mul(coefficient2))
-              .div 
-              (new BN(10).pow(target_power.muln(-1)));
-  }
-}
-
-export const checkedDecimalDiv = (
-  coefficient1: BN,
-  exponent1: BN,
-  coefficient2: BN,
-  exponent2: BN,
-  target_exponent: BN,
-) : BN => {
-  if (coefficient2.isZero()) {
-      // msg!("Error: Overflow in {} / {}", coefficient1, coefficient2);
-      // return err!(PerpetualsError::MathOverflow);
-      throw Error(`"Error: Overflow in ${coefficient1} / ${coefficient2}`)
-  }
-  if (coefficient1.isZero()) {
-      return BN_ZERO;
-  }
-  // compute scale factor for the dividend
-  let  scale_factor = BN_ZERO;
-  let  target_power = (exponent1.sub(exponent2)).sub(target_exponent);
-  if (exponent1.gt(BN_ZERO))  {
-      scale_factor = scale_factor.add(exponent1);
-  }
-  if (exponent2.lt(BN_ZERO)) {
-      scale_factor = scale_factor.sub(exponent2);
-      target_power = target_power.add(exponent2);
-  }
-  if (target_exponent.lt(BN_ZERO)) {
-      scale_factor = scale_factor.sub(target_exponent);
-      target_power = target_power.add(target_exponent);
-  }
-  let scaled_coeff1 = BN_ZERO;
-  if (scale_factor.gt(BN_ZERO)) {
-      // checked_mul(
-      //     coefficient1 ,
-      //     checked_pow(10u128, scale_factor as usize)?,
-      // )?
-      scaled_coeff1 = coefficient1.mul(
-        new BN(10).pow(scale_factor)
-      );
-  } else {
-      scaled_coeff1 = coefficient1;
-  };
-
-  if (target_power.gte(BN_ZERO)) {
-    //  return (
-    //   checked_mul(
-    //       checked_div(scaled_coeff1, coefficient2),
-    //       checked_pow(10u128, target_power),
-    //   ))
-   return (scaled_coeff1.div(coefficient2))
-     .mul( new BN(10).pow(target_power) );
-
-  } else {
-    // return checked_as_u64(checked_div(
-    //       checked_div(scaled_coeff1, coefficient2 as u128)?,
-    //       checked_pow(10u128, (-target_power) as usize)?,
-    //   ))
-    return (scaled_coeff1.div(coefficient2))
-     .div( new BN(10).pow(target_power.muln(-1)) );
-
-  }
-}

package/src/utils/rpc.ts

@@ -1,162 +0,0 @@
-import { AnchorProvider } from '@coral-xyz/anchor';
-import NodeWallet from '@coral-xyz/anchor/dist/cjs/nodewallet';
-import {
-  AddressLookupTableAccount,
-  Commitment,
-  ComputeBudgetProgram,
-  MessageV0,
-  Signer,
-  TransactionInstruction,
-  VersionedTransaction,
-} from '@solana/web3.js';
-
-export async function sendTransaction(
-  provider: AnchorProvider,
-  ixs: TransactionInstruction[],
-  alts: AddressLookupTableAccount[],
-  opts: any = {},
-): Promise<string> {
-  const connection = provider.connection;
-  const latestBlockhash =
-    opts.latestBlockhash ??
-    (await connection.getLatestBlockhash(
-      opts.preflightCommitment ??
-      provider.opts.preflightCommitment ??
-      'finalized',
-    ));
-
-  const payer = (provider as AnchorProvider).wallet;
-
-  if (opts.prioritizationFee) {
-    ixs = [createComputeBudgetIx(opts.prioritizationFee), ...ixs];
-  }
-
-  const message = MessageV0.compile({
-    payerKey: (provider as AnchorProvider).wallet.publicKey,
-    instructions: ixs,
-    recentBlockhash: latestBlockhash.blockhash,
-    addressLookupTableAccounts: alts,
-  });
-
-  let vtx = new VersionedTransaction(message);
-  if (opts?.additionalSigners?.length) {
-    vtx.sign([...opts?.additionalSigners]);
-  }
-
-  if (
-    typeof payer.signTransaction === 'function' &&
-    !(payer instanceof NodeWallet || payer.constructor.name == 'NodeWallet')
-  ) {
-    vtx = (await payer.signTransaction(
-      vtx as any,
-    )) as unknown as VersionedTransaction;
-  } else {
-    // Maybe this path is only correct for NodeWallet?
-    vtx.sign([(payer as any).payer as Signer]);
-  }
-
-  const signature = await connection.sendRawTransaction(vtx.serialize(), {
-    skipPreflight: true, // mergedOpts.skipPreflight,
-  });
-
-  return signature;
-}
-
-
-export async function confirmTransaction(
-  provider: AnchorProvider,
-  signature: string,
-  opts: any = {},
-): Promise<string> {
-  const connection = provider.connection;
-  const latestBlockhash =
-    opts.latestBlockhash ??
-    (await connection.getLatestBlockhash(
-      opts.preflightCommitment ??
-      provider.opts.preflightCommitment ??
-      'finalized',
-    ));
-
-  const txConfirmationCommitment = opts.txConfirmationCommitment ?? 'processed';
-  let status: any;
-  if (
-    latestBlockhash.blockhash != null &&
-    latestBlockhash.lastValidBlockHeight != null
-  ) {
-    status = (
-      await connection.confirmTransaction(
-        {
-          signature: signature,
-          blockhash: latestBlockhash.blockhash,
-          lastValidBlockHeight: latestBlockhash.lastValidBlockHeight,
-        },
-        txConfirmationCommitment,
-      )
-    ).value;
-  } else {
-    status = (
-      await connection.confirmTransaction(signature, txConfirmationCommitment)
-    ).value;
-  }
-
-  if (status.err) {
-    console.warn('Tx status: ', status);
-    throw new TransactionFailError({
-      txid: signature,
-      message: `${JSON.stringify(status)}`,
-    });
-  }
-  return signature;
-}
-
-export const createComputeBudgetIx = (
-  microLamports: number,
-): TransactionInstruction => {
-  const computeBudgetIx = ComputeBudgetProgram.setComputeUnitPrice({
-    microLamports,
-  });
-  return computeBudgetIx;
-};
-
-export class TransactionFailError extends Error {
-  message: string;
-  txid: string;
-
-  constructor({ txid, message }) {
-    super();
-    this.message = message;
-    this.txid = txid;
-  }
-}
-
-// const sendAndConfirmTransaction = async (
-//     ixs: TransactionInstruction[],
-//     opts: any = {},
-//     provider: AnchorProvider,
-//     postSendTxCallback?: Function,
-//     prioritizationFee?: number,
-//     txConfirmationCommitment?: Commitment
-//   ): Promise<string> => {
-//     return await sendTransaction(
-//       provider,
-//       ixs,
-//       opts.alts ?? [],
-//       {
-//         postSendTxCallback,
-//         prioritizationFee,
-//         txConfirmationCommitment,
-//         ...opts,
-//       },
-//     );
-//   }
-
-//   private async sendAndConfirmTransactionForGroup(
-//     group: Group,
-//     ixs: TransactionInstruction[],
-//     opts: any = {},
-//   ): Promise<string> {
-//     return await this.sendAndConfirmTransaction(ixs, {
-//       alts: group.addressLookupTablesList,
-//       ...opts,
-//     });
-//   }