flash-sdk 1.0.1 → 1.0.3

package/src/PerpetualsClient.ts

@@ -24,42 +24,72 @@ import {
   TOKEN_PROGRAM_ID,
 } from "@solana/spl-token";
 
-import fetch from "node-fetch";
 import { sha256 } from "js-sha256";
 import { encode } from "bs58";
-import { readFileSync } from "fs";
-
 import { PoolAccount } from "./PoolAccount";
 import { PositionAccount } from "./PositionAccount";
 import { BorrowRateParams, Custody, Fees, OracleParams, Permissions, Position, PositionSide, PricingParams, TokenRatios, isVariant } from "./types";
 import { OraclePrice } from "./OraclePrice";
 import { CustodyAccount } from "./CustodyAccount";
-import { Perpetuals } from "./target/types/perpetuals"
-// import { Perpetuals } from "../../target/types/perpetuals"
+import { Perpetuals } from "./target/types/perpetuals";
+import {IDL}  from './target/types/perpetuals';
+
+
+/* USEAGE 
+
+UI ---  
+provider = from phatom 
+
+client = new PerpetualsClient(provider, user.pubkey , programId);
+
+BOT cli -------- 
 
+provider = await getProvider(new DefaultWallet(DEFAULT_PERPS_USER));
 
+AnchorProvider.local(clusterUrl, {
+       commitment: "confirmed",
+      preflightCommitment: "confirmed",
+       skipPreflight: true
+   });
+process.env["ANCHOR_WALLET"] = adminKeyPath;
+
+client = new PerpetualsClient(provider, DEFAULT_PERPS_USER.pubkey , programId);
+
+*/
 export class PerpetualsClient {
   provider: AnchorProvider;
   program: Program<Perpetuals>;
-  admin: Keypair;
+  admin: PublicKey;
+  programId: PublicKey;
 
   // pdas
   multisig: { publicKey: PublicKey; bump: number };
   authority: { publicKey: PublicKey; bump: number };
   perpetuals: { publicKey: PublicKey; bump: number };
 
-  constructor(clusterUrl: string, adminKey: string) {
-    this.provider = AnchorProvider.local(clusterUrl, {
-      commitment: "confirmed",
-      preflightCommitment: "confirmed",
-      skipPreflight: true
-    });
-    setProvider(this.provider);
-    this.program = workspace.Perpetuals as Program<Perpetuals>;
-
-    this.admin = Keypair.fromSecretKey(
-      new Uint8Array(JSON.parse(readFileSync(adminKey).toString()))
-    );
+  constructor(provider: AnchorProvider, programId: PublicKey) {
+    // this.provider = AnchorProvider.local(clusterUrl, {
+    //   commitment: "confirmed",
+    //   preflightCommitment: "confirmed",
+    //   skipPreflight: true
+    // });
+    // setProvider(this.provider);
+    this.provider = provider;
+    setProvider(provider);
+
+    // const idl = JSON.parse(  fs.readFileSync("./target/idl/perpetuals.json", "utf8"));
+    // const idl = JSON.parse(IDL);
+    // const program = new anchor.Program(idl, programId, provider);
+    this.program = new Program(IDL, programId); 
+    //this.program =  workspace.Perpetuals as Program<Perpetuals>;
+    console.log("client constructor programID : ",this.program.programId.toBase58());
+
+    // this.admin = Keypair.fromSecretKey(
+    //   new Uint8Array(JSON.parse(readFileSync(adminKey).toString()))
+    // );
+
+    this.admin =  this.provider.wallet.publicKey;
+    console.log("admin:",this.admin.toBase58())
 
     this.multisig = this.findProgramAddress("multisig");
     this.authority = this.findProgramAddress("transfer_authority");
@@ -343,11 +373,11 @@ export class PerpetualsClient {
           minSignatures,
         })
         .accounts({
-          admin: this.admin.publicKey,
+          admin: this.admin,
           multisig: this.multisig.publicKey,
         })
         .remainingAccounts(adminMetas)
-        .signers([this.admin])
+        // .signers([this.admin])
         .rpc();
     } catch (err) {
       // @ts-ignore
@@ -362,7 +392,7 @@ export class PerpetualsClient {
     await this.program.methods
       .addPool({ name })
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.provider.wallet.publicKey,
         multisig: this.multisig.publicKey,
         transferAuthority: this.authority.publicKey,
         perpetuals: this.perpetuals.publicKey,
@@ -372,7 +402,7 @@ export class PerpetualsClient {
         tokenProgram: TOKEN_PROGRAM_ID,
         rent: SYSVAR_RENT_PUBKEY,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);
@@ -384,14 +414,14 @@ export class PerpetualsClient {
     await this.program.methods
       .removePool({})
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.admin,
         multisig: this.multisig.publicKey,
         transferAuthority: this.authority.publicKey,
         perpetuals: this.perpetuals.publicKey,
         pool: this.getPoolKey(name),
         systemProgram: SystemProgram.programId,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);
@@ -425,7 +455,7 @@ export class PerpetualsClient {
         ratios,
       })
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.admin,
         multisig: this.multisig.publicKey,
         transferAuthority: this.authority.publicKey,
         perpetuals: this.perpetuals.publicKey,
@@ -440,7 +470,7 @@ export class PerpetualsClient {
         tokenProgram: TOKEN_PROGRAM_ID,
         rent: SYSVAR_RENT_PUBKEY,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);
@@ -481,7 +511,7 @@ export class PerpetualsClient {
         ratios,
       })
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.admin,
         multisig: this.multisig.publicKey,
         transferAuthority: this.authority.publicKey,
         perpetuals: this.perpetuals.publicKey,
@@ -496,7 +526,7 @@ export class PerpetualsClient {
         tokenProgram: TOKEN_PROGRAM_ID,
         rent: SYSVAR_RENT_PUBKEY,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);
@@ -509,7 +539,7 @@ export class PerpetualsClient {
     await this.program.methods
       .removeCustody({ ratios })
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.admin,
         multisig: this.multisig.publicKey,
         transferAuthority: this.authority.publicKey,
         perpetuals: this.perpetuals.publicKey,
@@ -522,7 +552,7 @@ export class PerpetualsClient {
         systemProgram: SystemProgram.programId,
         tokenProgram: TOKEN_PROGRAM_ID,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);
@@ -534,13 +564,13 @@ export class PerpetualsClient {
     await this.program.methods
       .upgradeCustody({})
       .accounts({
-        admin: this.admin.publicKey,
+        admin: this.admin,
         multisig: this.multisig.publicKey,
         pool: this.getPoolKey(poolName),
         custody: this.getCustodyKey(poolName, tokenMint),
         systemProgram: SystemProgram.programId,
       })
-      .signers([this.admin])
+      // .signers([this.admin])
       .rpc()
       .catch((err) => {
         console.error(err);

package/src/PoolAccount.ts

@@ -2,7 +2,7 @@
 import { BN_ZERO, BPS_DECIMALS, BPS_POWER, PERCENTAGE_DECIMALS, PRICE_DECIMALS, USD_DECIMALS } from "./constants";
 import { BN } from "@coral-xyz/anchor";
 import { Mint } from "@solana/spl-token";
-import { Custody, FeesMode, Pool, Side, TokenRatios, isVariant } from "./types";
+import { AumCalcMode, Custody, FeesMode, Pool, Side, TokenRatios, isVariant } from "./types";
 import { PublicKey } from "@solana/web3.js";
 import {CustodyAccount} from "./CustodyAccount";
 import { OraclePrice } from "./OraclePrice";
@@ -10,7 +10,8 @@ import { PositionAccount } from "./PositionAccount";
 import { checkedCeilDiv, checkedDecimalCeilMul, checkedDecimalMul, scaleToExponent } from "./utils";
 
 
-export class PoolAccount {
+
+export class PoolAccount implements Pool {
 
     publicKey: PublicKey;
 
@@ -42,9 +43,6 @@ export class PoolAccount {
         return this.custodies.findIndex(i => i.toBase58()==custodyKey.toBase58())
     }
 
-    //   loadlpData(lpTokenInfo : Mint){
-    //     this.lpTokenInfo = lpTokenInfo
-    //   }
 
     getAddLiquidityFee(
         tokenId: number,
@@ -367,5 +365,78 @@ export class PoolAccount {
             }
         }
     } //getPnlUsd
+    
+
+    getAssetsUnderManagementUsd(
+        token_prices: OraclePrice[],
+        token_ema_prices: OraclePrice[],
+        custodies : CustodyAccount[],
+        aum_calc_mode: AumCalcMode,
+    ) :BN  {
+
+        let  pool_amount_usd: BN = BN_ZERO;
+        
+        for (let index=0;index<this.custodies.length;index++) {
+
+            if( token_prices.length != this.custodies.length || token_prices.length != token_ema_prices.length ){
+                throw Error("token prices length incorrect");
+            }
+
+
+            let aum_token_price : OraclePrice;
+            //  switch unable to match enum
+            if(isVariant(aum_calc_mode,"last")){
+                aum_token_price = token_prices[index];
+            } else if( isVariant(aum_calc_mode, "ema") ){
+                aum_token_price = token_ema_prices[index];
+            } else if( isVariant(aum_calc_mode, "min") ) {
+                if (token_prices[index].cmp(token_ema_prices[index])) {
+                    aum_token_price = token_prices[index];
+                } else {
+                    aum_token_price = token_ema_prices[index];
+                }
+            } else if( isVariant(aum_calc_mode, "max") ) {
+                if (token_ema_prices[index].cmp(token_prices[index])) {
+                    aum_token_price = token_prices[index];
+                } else {
+                    aum_token_price = token_ema_prices[index];
+                }
+            }
+
+            let token_amount_usd :BN =
+                aum_token_price.getAssetAmountUsd(custodies[index].assets.owned, custodies[index].decimals);
+
+            pool_amount_usd = pool_amount_usd.add(token_amount_usd);
+
+            // if (custodies[index].pricing.useUnrealizedPnlInAum) {
+            //     // compute aggregate unrealized pnl
+            //     let (long_profit, long_loss, _) = this.getPnlUsd(
+            //         &custodies[index].get_collective_position(Side::Long)?,
+            //         &token_price,
+            //         &token_ema_price,
+            //         &custodies[index],
+            //         curtime,
+            //         false,
+            //     )?;
+            //     let (short_profit, short_loss, _) = self.get_pnl_usd(
+            //         &custodies[index].get_collective_position(Side::Short)?,
+            //         &token_price,
+            //         &token_ema_price,
+            //         &custodies[index],
+            //         curtime,
+            //         false,
+            //     )?;
+
+            //     // adjust pool amount by collective profit/loss
+            //     pool_amount_usd = math::checked_add(pool_amount_usd, long_profit as u128)?;
+            //     pool_amount_usd = math::checked_add(pool_amount_usd, short_profit as u128)?;
+            //     pool_amount_usd = pool_amount_usd.saturating_sub(long_loss as u128);
+            //     pool_amount_usd = pool_amount_usd.saturating_sub(short_loss as u128);
+            // }
+            throw Error("Incomplete")
+        }
+
+        return pool_amount_usd;
+    }
 
 } // Pool

package/src/PoolDisplayData.ts

@@ -4,20 +4,170 @@ import { BN } from "@coral-xyz/anchor";
 import { Mint } from "@solana/spl-token";
 import { Custody, FeesMode, Pool, Side, TokenRatios, isVariant } from "./types";
 import { PublicKey } from "@solana/web3.js";
-import {CustodyAccount} from "./CustodyAccount";
+import { CustodyAccount } from "./CustodyAccount";
 import { OraclePrice } from "./OraclePrice";
 import { PositionAccount } from "./PositionAccount";
-import { checkedCeilDiv, checkedDecimalCeilMul, checkedDecimalMul, scaleToExponent } from "./utils";
+import { checkedCeilDiv, checkedDecimalCeilMul, checkedDecimalMul, scaleToExponent, toUiDecimals } from "./utils";
 import { PoolConfig } from "./PoolConfig";
+import { PoolAccount } from "./PoolAccount";
 
 export class PoolDisplayData {
 
   public poolConfig: PoolConfig;
-  public poolData : Pool;
-  public lpTokenInfo : Mint;
-  public custodies : CustodyAccount[];
-  public totalPoolValueUsd : BN;
+  public pool: PoolAccount;
+  public lpTokenInfo: Mint;
+  public custodies: CustodyAccount[];
+  public totalPoolValueUsd: BN;
 
+  constructor(poolConfig: PoolConfig, pool: PoolAccount, lpTokenInfo: Mint, custodies: CustodyAccount[]) {
+    this.poolConfig = poolConfig;
+    this.pool = pool;
+    this.lpTokenInfo = lpTokenInfo;
+    this.custodies = custodies;
+    this.totalPoolValueUsd = new BN(-1); // -1 meaning unset
+  }
 
+  loadCustodies(custodies: CustodyAccount[]) {
+    this.custodies = custodies;
+  }
 
-} // Pool
+  loadPoolData(pool: PoolAccount) {
+    this.pool = pool
+  }
+
+  loadlpData(lpTokenInfo: Mint) {
+    this.lpTokenInfo = lpTokenInfo
+  }
+
+  // TODO :: replace this with PoolAccount.getAssetsUnderManagementUsd() 
+  // should take pnl's into account 
+  getLpStats(prices: any) {
+
+    let stableCoinAmount = new BN(0);
+    let totalPoolValueUsd = new BN(0);
+
+    for (const custody of this.poolConfig.custodies) {
+      const custodyData = this.custodies.find(t => t.mint.toBase58() === custody.mintKey.toBase58())
+      if (custodyData) {
+        if (custodyData.isStable) {
+          stableCoinAmount = stableCoinAmount.add(custodyData.assets.owned)
+        }
+        const priceBN = new BN(prices.get(custody.symbol) * 10 ** PRICE_DECIMALS); // so always keep prices with 6 decimals 
+        const custodyValue = priceBN.mul(custodyData.assets.owned).div(new BN(10 ** custody.decimals));
+        totalPoolValueUsd = totalPoolValueUsd.add(custodyValue)
+      }
+    }
+
+    // console.log("totalPoolValueUsd.toNumber():",totalPoolValueUsd.toString())
+    // console.log("stableCoinAmount.toNumber():",stableCoinAmount.toString())
+
+    // if(this.lpTokenInfo.supply.toString() =='0' || totalPoolValueUsd.toString()=='0'){
+    //   console.error("supply or amt cannot be zero")
+    //   throw "supply or amt cannot be zero";
+    // }
+    this.totalPoolValueUsd = totalPoolValueUsd;
+    const lpPrice = totalPoolValueUsd.div(new BN(this.lpTokenInfo.supply.toString() === '0' ? 1 : this.lpTokenInfo.supply.toString()))
+
+    return {
+      lpTokenSupply: new BN(this.lpTokenInfo.supply.toString()),
+      decimals: this.poolConfig.lpDecimals,
+      totalPoolValue: totalPoolValueUsd,
+      price: lpPrice,
+      stableCoinPercentage: totalPoolValueUsd.toNumber() != 0 ? stableCoinAmount.mul(new BN(PERCENTAGE_DECIMALS)).div(totalPoolValueUsd) : new BN(1),
+      marketCap: lpPrice.mul(new BN(this.lpTokenInfo.supply.toString())),
+      // totalStaked : BN,
+    }
+  }
+
+  getOiLongUI() {
+    let totalAmount = new BN('0');
+    this.custodies.forEach(i => {
+      totalAmount = totalAmount.add(i.tradeStats.oiLongUsd);
+    })
+    return totalAmount;
+  }
+
+  getOiShortUI() {
+    let totalAmount = new BN('0');
+    this.custodies.forEach(i => {
+      totalAmount = totalAmount.add(i.tradeStats.oiShortUsd);
+    })
+    return totalAmount;
+  }
+
+  // handle decimal and this should accept a list of prices probs map or object
+  getCustodyDetails(prices: any) {
+    const custodyDetails = [];
+
+    for (let i = 0; i < this.poolConfig.custodies.length; i++) {
+      const custody = this.poolConfig.custodies[i];
+      if (!custody) continue;
+
+      // console.log('this.pool :>> ', this.pool);
+      // const token = this.pool.tokens.find(t => t.custody.toBase58() === custody.custodyAccount.toBase58());
+      const tokenRatio = this.pool.ratios[i]
+      const custodyData = this.custodies.find(t => t.mint.toBase58() === custody.mintKey.toBase58())
+      const priceBN = new BN(prices.get(custody.symbol) * 10 ** 6); // so always keep prices with 6 decimals 
+
+      if (this.totalPoolValueUsd.toString() == "-1") {
+        console.error("call getLpStats first")
+        throw "call getLpStats first";
+      }
+
+      // if(this.totalPoolValueUsd.toString()=='0'){
+      //   console.error("call getLpStats first , totalPoolValueUsd ZERO")
+      //   return defaultData.custodyDetails;
+      // } 
+      // console.log("this.totalPoolValueUsd:",this.totalPoolValueUsd.toString())
+
+      if (custodyData && tokenRatio) {
+        custodyDetails.push({
+          symbol: custody.symbol,
+          price: new BN(prices.get(custody.symbol)),
+          targetWeight: tokenRatio.target,
+          currentWeight: this.totalPoolValueUsd.toNumber() ?
+            (custodyData.assets.owned.mul(priceBN)).mul(new BN(10 ** PERCENTAGE_DECIMALS)).div(this.totalPoolValueUsd).div(new BN(10 ** custody.decimals))
+            : new BN(0),
+          utilization: custodyData.assets.owned.toNumber() ?
+            toUiDecimals(custodyData.assets.locked.mul(new BN(10 ** PERCENTAGE_DECIMALS)).div(custodyData.assets.owned), PERCENTAGE_DECIMALS, 2)
+            : '0',
+          // assetsAmountUi : (custodyData.assets.owned.toNumber() / 10**(custody.decimals)).toFixed(4),
+          assetsAmountUi: toUiDecimals(custodyData.assets.owned, custody.decimals, 4, true),
+          // totalUsdAmountUi : ((custodyData.assets.owned.mul(priceBN)).div(new BN(10**(custody.decimals))).toNumber() / 10**6).toFixed(4),
+          totalUsdAmountUi: toUiDecimals((custodyData.assets.owned.mul(priceBN)), custody.decimals + PRICE_DECIMALS, 2, true),
+        })
+      }
+    }
+    return custodyDetails;
+  }
+
+  getPoolStats() {
+    let totalFees = new BN(0)
+    let totalVolume = new BN(0)
+    let currentLongPositionsUsd = new BN(0)
+    let currentShortPositionsUsd = new BN(0)
+
+    for (const custody of this.poolConfig.custodies) {
+      const custodyData = this.custodies.find(t => t.mint.toBase58() === custody.mintKey.toBase58())
+      if (custodyData) {
+        const custodyFeeTotal = Object.values(custodyData.collectedFees).reduce((a: BN, b: BN) => a.add(b), new BN(0))
+        totalFees = totalFees.add(custodyFeeTotal)
+
+        const custodyVolume = Object.values(custodyData.volumeStats).reduce((a: BN, b: BN) => a.add(b), new BN(0))
+        totalVolume = totalVolume.add(custodyVolume)
+
+        currentLongPositionsUsd = currentLongPositionsUsd.add(custodyData.tradeStats.oiLongUsd)
+        currentShortPositionsUsd = currentShortPositionsUsd.add(custodyData.tradeStats.oiShortUsd)
+      }
+    }
+    return {
+      totalFees,
+      totalVolume,
+      currentLongPositionsUsd,
+      currentShortPositionsUsd
+    }
+  }
+
+
+
+} // PoolDisplayData

package/src/PositionAccount.ts

@@ -3,7 +3,7 @@ import { Connection, PublicKey } from "@solana/web3.js";
 import { isVariant, Position, Side } from "./types";
 
 
-export class PositionAccount {
+export class PositionAccount implements Position {
 
     public publicKey: PublicKey;
 
@@ -25,6 +25,7 @@ export class PositionAccount {
     public lockedAmount: BN;
     public collateralAmount: BN;
     // extra 
+    public bump: number
 
     constructor( publicKey : PublicKey, parseData : Position) {
         this.publicKey = publicKey;

package/src/readme.md

@@ -1,4 +1,24 @@
-# strict JS types <=> Rust types 
+# Flash SDK
+Client SDK for interacting with FLASH.TRADE's smart-contracts
 
-1) u65 : unisigned intergar - so no decimals => BN 
-2) u8 : number 
+## Install
+```
+npm i flash-sdk / yarn add flash-sdk 
+```
+
+## Using the SDK
+
+### connect sdk locally 
+`
+  import { AnchorProvider } from "@coral-xyz/anchor";
+
+  const provider : AnchorProvider = AnchorProvider.local(clusterUrl, {
+    commitment: "confirmed",
+    preflightCommitment: "confirmed",
+    skipPreflight: true
+  });
+  client = new PerpetualsClient(provider, programId);
+` 
+
+
+### To fetch all the pool data