@drift-labs/sdk 0.2.0-master.24 → 0.2.0-master.26

package/lib/types.d.ts

@@ -1,6 +1,25 @@
 /// <reference types="bn.js" />
 import { PublicKey, Transaction } from '@solana/web3.js';
 import { BN } from '.';
+export declare class MarketStatus {
+    static readonly INITIALIZED: {
+        initialized: {};
+    };
+    static readonly REDUCEONLY: {
+        reduceonly: {};
+    };
+    static readonly SETTLEMENT: {
+        settlement: {};
+    };
+}
+export declare class ContractType {
+    static readonly PERPETUAL: {
+        perpetual: {};
+    };
+    static readonly FUTURE: {
+        future: {};
+    };
+}
 export declare class SwapDirection {
     static readonly ADD: {
         add: {};
@@ -9,7 +28,7 @@ export declare class SwapDirection {
         remove: {};
     };
 }
-export declare class BankBalanceType {
+export declare class SpotBalanceType {
     static readonly DEPOSIT: {
         deposit: {};
     };
@@ -58,6 +77,14 @@ export declare class OrderType {
         market: {};
     };
 }
+export declare class MarketType {
+    static readonly SPOT: {
+        spot: {};
+    };
+    static readonly PERP: {
+        perp: {};
+    };
+}
 export declare class OrderStatus {
     static readonly INIT: {
         init: {};
@@ -125,6 +152,19 @@ export declare class OrderTriggerCondition {
         below: {};
     };
 }
+export declare class SpotFulfillmentType {
+    static readonly SERUM_v3: {
+        serumV3: {};
+    };
+}
+export declare class SpotFulfillmentStatus {
+    static readonly ENABLED: {
+        enabled: {};
+    };
+    static readonly DISABLED: {
+        disabled: {};
+    };
+}
 export declare function isVariant(object: unknown, type: string): boolean;
 export declare function isOneOfVariant(object: unknown, types: string[]): boolean;
 export declare enum TradeSide {
@@ -149,7 +189,7 @@ export declare type DepositRecord = {
         deposit?: any;
         withdraw?: any;
     };
-    bankIndex: BN;
+    marketIndex: BN;
     amount: BN;
     oraclePrice: BN;
     referrer: PublicKey;
@@ -175,6 +215,39 @@ export declare type CurveRecord = {
     oraclePrice: BN;
     tradeId: BN;
 };
+export declare type InsuranceFundRecord = {
+    ts: BN;
+    bankIndex: BN;
+    marketIndex: BN;
+    userIfFactor: BN;
+    totalIfFactor: BN;
+    vaultAmountBefore: BN;
+    insuranceVaultAmountBefore: BN;
+    amount: BN;
+    totalIfSharesBefore: BN;
+    totalIfSharesAfter: BN;
+};
+export declare type LPRecord = {
+    ts: BN;
+    user: PublicKey;
+    action: LPAction;
+    nShares: BN;
+    marketIndex: BN;
+    deltaBaseAssetAmount: BN;
+    deltaQuoteAssetAmount: BN;
+    pnl: BN;
+};
+export declare class LPAction {
+    static readonly ADD_LIQUIDITY: {
+        addLiquidity: {};
+    };
+    static readonly REMOVE_LIQUIDITY: {
+        removeLiquidity: {};
+    };
+    static readonly SETTLE_LIQUIDITY: {
+        settleLiquidity: {};
+    };
+}
 export declare type FundingRateRecord = {
     ts: BN;
     recordId: BN;
@@ -243,6 +316,7 @@ export declare type LiquidatePerpRecord = {
     oraclePrice: BN;
     baseAssetAmount: BN;
     quoteAssetAmount: BN;
+    lpShares: BN;
     userPnl: BN;
     liquidatorPnl: BN;
     canceledOrdersFee: BN;
@@ -251,26 +325,26 @@ export declare type LiquidatePerpRecord = {
     fillRecordId: BN;
 };
 export declare type LiquidateBorrowRecord = {
-    assetBankIndex: BN;
+    assetMarketIndex: BN;
     assetPrice: BN;
     assetTransfer: BN;
-    liabilityBankIndex: BN;
+    liabilityMarketIndex: BN;
     liabilityPrice: BN;
     liabilityTransfer: BN;
 };
 export declare type LiquidateBorrowForPerpPnlRecord = {
-    marketIndex: BN;
+    perpMarketIndex: BN;
     marketOraclePrice: BN;
     pnlTransfer: BN;
-    liabilityBankIndex: BN;
+    liabilityMarketIndex: BN;
     liabilityPrice: BN;
     liabilityTransfer: BN;
 };
 export declare type LiquidatePerpPnlForDepositRecord = {
-    marketIndex: BN;
+    perpMarketIndex: BN;
     marketOraclePrice: BN;
     pnlTransfer: BN;
-    assetBankIndex: BN;
+    assetMarketIndex: BN;
     assetPrice: BN;
     assetTransfer: BN;
 };
@@ -280,7 +354,7 @@ export declare type PerpBankruptcyRecord = {
     cumulativeFundingRateDelta: BN;
 };
 export declare type BorrowBankruptcyRecord = {
-    bankIndex: BN;
+    marketIndex: BN;
     borrowAmount: BN;
     cumulativeDepositInterestDelta: BN;
 };
@@ -291,7 +365,7 @@ export declare type SettlePnlRecord = {
     pnl: BN;
     baseAssetAmount: BN;
     quoteAssetAmountAfter: BN;
-    quoteEntryamount: BN;
+    quoteEntryAmount: BN;
     settlePrice: BN;
 };
 export declare type OrderRecord = {
@@ -319,12 +393,14 @@ export declare type OrderActionRecord = {
     quoteAssetAmountSurplus: BN | null;
     taker: PublicKey | null;
     takerOrderId: BN | null;
+    takerOrderDirection: PositionDirection | null;
     takerOrderBaseAssetAmount: BN | null;
     takerOrderBaseAssetAmountFilled: BN | null;
     takerOrderQuoteAssetAmountFilled: BN | null;
     takerOrderFee: BN | null;
     maker: PublicKey | null;
     makerOrderId: BN | null;
+    makerOrderDirection: PositionDirection | null;
     makerOrderBaseAssetAmount: BN | null;
     makerOrderBaseAssetAmountFilled: BN | null;
     makerOrderQuoteAssetAmountFilled: BN | null;
@@ -337,8 +413,6 @@ export declare type StateAccount = {
     exchangePaused: boolean;
     adminControlsPrices: boolean;
     insuranceVault: PublicKey;
-    insuranceVaultAuthority: PublicKey;
-    insuranceVaultNonce: number;
     marginRatioInitial: BN;
     marginRatioMaintenance: BN;
     marginRatioPartial: BN;
@@ -350,7 +424,8 @@ export declare type StateAccount = {
     fullLiquidationPenaltyPercentageDenominator: BN;
     partialLiquidationLiquidatorShareDenominator: BN;
     fullLiquidationLiquidatorShareDenominator: BN;
-    feeStructure: FeeStructure;
+    perpFeeStructure: FeeStructure;
+    spotFeeStructure: FeeStructure;
     totalFee: BN;
     totalFeeWithdrawn: BN;
     whitelistMint: PublicKey;
@@ -358,13 +433,19 @@ export declare type StateAccount = {
     oracleGuardRails: OracleGuardRails;
     maxDeposit: BN;
     numberOfMarkets: BN;
-    numberOfBanks: BN;
+    numberOfSpotMarkets: BN;
     minOrderQuoteAssetAmount: BN;
+    signer: PublicKey;
+    signerNonce: number;
     maxAuctionDuration: number;
     minAuctionDuration: number;
+    liquidationMarginBufferRatio: number;
 };
-export declare type MarketAccount = {
-    initialized: boolean;
+export declare type PerpMarketAccount = {
+    status: MarketStatus;
+    contractType: ContractType;
+    expiryTs: BN;
+    settlementPrice: BN;
     marketIndex: BN;
     pubkey: PublicKey;
     amm: AMM;
@@ -379,19 +460,21 @@ export declare type MarketAccount = {
     liquidationFee: BN;
     imfFactor: BN;
     unrealizedImfFactor: BN;
+    unrealizedMaxImbalance: BN;
     unrealizedInitialAssetWeight: number;
     unrealizedMaintenanceAssetWeight: number;
+    revenueWithdrawSinceLastSettle: BN;
+    maxRevenueWithdrawPerPeriod: BN;
+    lastRevenueWithdrawTs: BN;
+    quoteSettledInsurance: BN;
+    quoteMaxInsurance: BN;
 };
-export declare type BankAccount = {
-    bankIndex: BN;
+export declare type SpotMarketAccount = {
+    marketIndex: BN;
     pubkey: PublicKey;
     mint: PublicKey;
     vault: PublicKey;
-    vaultAuthority: PublicKey;
-    vaultAuthorityNonce: number;
     insuranceFundVault: PublicKey;
-    insuranceFundVaultAuthority: PublicKey;
-    insuranceFundVaultAuthorityNonce: number;
     insuranceWithdrawEscrowPeriod: BN;
     revenuePool: PoolBalance;
     totalIfShares: BN;
@@ -420,6 +503,12 @@ export declare type BankAccount = {
     depositTokenTwap: BN;
     borrowTokenTwap: BN;
     utilizationTwap: BN;
+    orderStepSize: BN;
+    nextFillRecordId: BN;
+    spotFeePool: {
+        balance: BN;
+    };
+    totalSpotFee: BN;
 };
 export declare type PoolBalance = {
     balance: BN;
@@ -455,6 +544,7 @@ export declare type AMM = {
     cumulativeFeePerLp: BN;
     cumulativeNetBaseAssetAmountPerLp: BN;
     userLpShares: BN;
+    netUnsettledLpBaseAssetAmount: BN;
     minimumQuoteAssetTradeSize: BN;
     baseAssetAmountStepSize: BN;
     maxBaseAssetAmountRatio: number;
@@ -471,19 +561,22 @@ export declare type AMM = {
     totalMmFee: BN;
     netRevenueSinceLastFunding: BN;
     lastUpdateSlot: BN;
+    lastOracleValid: boolean;
     lastBidPriceTwap: BN;
     lastAskPriceTwap: BN;
     longSpread: BN;
     shortSpread: BN;
     maxSpread: number;
-    marketPosition: UserPosition;
-    marketPositionPerLp: UserPosition;
+    marketPosition: PerpPosition;
+    marketPositionPerLp: PerpPosition;
     ammJitIntensity: number;
     maxBaseAssetReserve: BN;
     minBaseAssetReserve: BN;
+    cumulativeSocialLoss: BN;
 };
-export declare type UserPosition = {
+export declare type PerpPosition = {
     baseAssetAmount: BN;
+    remainderBaseAssetAmount: BN;
     lastCumulativeFundingRate: BN;
     marketIndex: BN;
     quoteAssetAmount: BN;
@@ -521,22 +614,26 @@ export declare type UserAccount = {
     authority: PublicKey;
     name: number[];
     userId: number;
-    bankBalances: UserBankBalance[];
-    positions: UserPosition[];
+    spotPositions: SpotPosition[];
+    perpPositions: PerpPosition[];
     orders: Order[];
     beingLiquidated: boolean;
     bankrupt: boolean;
     nextLiquidationId: number;
     nextOrderId: BN;
 };
-export declare type UserBankBalance = {
-    bankIndex: BN;
-    balanceType: BankBalanceType;
+export declare type SpotPosition = {
+    marketIndex: BN;
+    balanceType: SpotBalanceType;
     balance: BN;
+    openOrders: number;
+    openBids: BN;
+    openAsks: BN;
 };
 export declare type Order = {
     status: OrderStatus;
     orderType: OrderType;
+    marketType: MarketType;
     ts: BN;
     slot: BN;
     orderId: BN;
@@ -563,6 +660,7 @@ export declare type Order = {
 };
 export declare type OrderParams = {
     orderType: OrderType;
+    marketType: MarketType;
     userOrderId: number;
     direction: PositionDirection;
     baseAssetAmount: BN;
@@ -577,10 +675,6 @@ export declare type OrderParams = {
     oraclePriceOffset: BN;
     padding0: boolean;
     padding1: BN;
-    optionalAccounts: {
-        discountToken: boolean;
-        referrer: boolean;
-    };
 };
 export declare type NecessaryOrderParams = {
     orderType: OrderType;
@@ -595,6 +689,9 @@ export declare const DefaultOrderParams: {
     orderType: {
         market: {};
     };
+    marketType: {
+        perp: {};
+    };
     userOrderId: number;
     direction: {
         long: {};
@@ -613,10 +710,6 @@ export declare const DefaultOrderParams: {
     oraclePriceOffset: BN;
     padding0: BN;
     padding1: BN;
-    optionalAccounts: {
-        discountToken: boolean;
-        referrer: boolean;
-    };
 };
 export declare type MakerInfo = {
     maker: PublicKey;
@@ -693,7 +786,7 @@ export declare type OrderFillerRewardStructure = {
 };
 export declare type MarginCategory = 'Initial' | 'Maintenance';
 export declare type InsuranceFundStake = {
-    bankIndex: BN;
+    marketIndex: BN;
     authority: PublicKey;
     ifShares: BN;
     ifBase: BN;
@@ -701,3 +794,19 @@ export declare type InsuranceFundStake = {
     lastWithdrawRequestValue: BN;
     lastWithdrawRequestTs: BN;
 };
+export declare type SerumV3FulfillmentConfigAccount = {
+    fulfillmentType: SpotFulfillmentType;
+    status: SpotFulfillmentStatus;
+    pubkey: PublicKey;
+    marketIndex: BN;
+    serumProgramId: PublicKey;
+    serumMarket: PublicKey;
+    serumRequestQueue: PublicKey;
+    serumEventQueue: PublicKey;
+    serumBids: PublicKey;
+    serumAsks: PublicKey;
+    serumBaseVault: PublicKey;
+    serumQuoteVault: PublicKey;
+    serumOpenOrders: PublicKey;
+    serumSignerNonce: BN;
+};

package/lib/types.js

@@ -1,18 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultOrderParams = exports.LiquidationType = exports.TradeSide = exports.isOneOfVariant = exports.isVariant = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderDiscountTier = exports.OrderStatus = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.BankBalanceType = exports.SwapDirection = void 0;
+exports.DefaultOrderParams = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.isOneOfVariant = exports.isVariant = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderDiscountTier = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.ContractType = exports.MarketStatus = void 0;
 const _1 = require(".");
 // # Utility Types / Enums / Constants
+class MarketStatus {
+}
+exports.MarketStatus = MarketStatus;
+MarketStatus.INITIALIZED = { initialized: {} };
+MarketStatus.REDUCEONLY = { reduceonly: {} };
+MarketStatus.SETTLEMENT = { settlement: {} };
+class ContractType {
+}
+exports.ContractType = ContractType;
+ContractType.PERPETUAL = { perpetual: {} };
+ContractType.FUTURE = { future: {} };
 class SwapDirection {
 }
 exports.SwapDirection = SwapDirection;
 SwapDirection.ADD = { add: {} };
 SwapDirection.REMOVE = { remove: {} };
-class BankBalanceType {
+class SpotBalanceType {
 }
-exports.BankBalanceType = BankBalanceType;
-BankBalanceType.DEPOSIT = { deposit: {} };
-BankBalanceType.BORROW = { borrow: {} };
+exports.SpotBalanceType = SpotBalanceType;
+SpotBalanceType.DEPOSIT = { deposit: {} };
+SpotBalanceType.BORROW = { borrow: {} };
 class PositionDirection {
 }
 exports.PositionDirection = PositionDirection;
@@ -36,6 +47,11 @@ OrderType.LIMIT = { limit: {} };
 OrderType.TRIGGER_MARKET = { triggerMarket: {} };
 OrderType.TRIGGER_LIMIT = { triggerLimit: {} };
 OrderType.MARKET = { market: {} };
+class MarketType {
+}
+exports.MarketType = MarketType;
+MarketType.SPOT = { spot: {} };
+MarketType.PERP = { perp: {} };
 class OrderStatus {
 }
 exports.OrderStatus = OrderStatus;
@@ -78,6 +94,15 @@ class OrderTriggerCondition {
 exports.OrderTriggerCondition = OrderTriggerCondition;
 OrderTriggerCondition.ABOVE = { above: {} };
 OrderTriggerCondition.BELOW = { below: {} };
+class SpotFulfillmentType {
+}
+exports.SpotFulfillmentType = SpotFulfillmentType;
+SpotFulfillmentType.SERUM_v3 = { serumV3: {} };
+class SpotFulfillmentStatus {
+}
+exports.SpotFulfillmentStatus = SpotFulfillmentStatus;
+SpotFulfillmentStatus.ENABLED = { enabled: {} };
+SpotFulfillmentStatus.DISABLED = { disabled: {} };
 function isVariant(object, type) {
     return object.hasOwnProperty(type);
 }
@@ -94,6 +119,12 @@ var TradeSide;
     TradeSide[TradeSide["Buy"] = 1] = "Buy";
     TradeSide[TradeSide["Sell"] = 2] = "Sell";
 })(TradeSide = exports.TradeSide || (exports.TradeSide = {}));
+class LPAction {
+}
+exports.LPAction = LPAction;
+LPAction.ADD_LIQUIDITY = { addLiquidity: {} };
+LPAction.REMOVE_LIQUIDITY = { removeLiquidity: {} };
+LPAction.SETTLE_LIQUIDITY = { settleLiquidity: {} };
 class LiquidationType {
 }
 exports.LiquidationType = LiquidationType;
@@ -113,6 +144,7 @@ LiquidationType.BORROW_BANKRUPTCY = {
 };
 exports.DefaultOrderParams = {
     orderType: OrderType.MARKET,
+    marketType: MarketType.PERP,
     userOrderId: 0,
     direction: PositionDirection.LONG,
     baseAssetAmount: _1.ZERO,
@@ -127,8 +159,4 @@ exports.DefaultOrderParams = {
     oraclePriceOffset: _1.ZERO,
     padding0: _1.ZERO,
     padding1: _1.ZERO,
-    optionalAccounts: {
-        discountToken: false,
-        referrer: false,
-    },
 };

package/my-script/.env

@@ -0,0 +1,7 @@
+#ANCHOR_WALLET=/Users/ww/.config/solana/id.json
+
+#ANCHOR_WALLET=/Users/ww/.config/solana/bot2RzYy9oY5s3z71Yubo4MmRxyDBQP3qNNCqyqLcPp.json
+
+ANCHOR_WALLET=./ww18NdhuLSQPCrHSx7V68eZJpe2y311heWeXJfSmP3Q.json
+#ANCHOR_WALLET=./ww2z7N9TG1PLLUQGQF2VKzCFaPtQ5FBhRfeEAuy6c5C.json
+#ANCHOR_WALLET=./ww3StJtTubhwssqAhvSSAc5ifCgKjzmF8hz7Gt2DmSa.json

package/my-script/getUserStats.ts

@@ -0,0 +1,106 @@
+import * as anchor from '@project-serum/anchor';
+import { PublicKey, clusterApiUrl } from '@solana/web3.js';
+
+import {
+    initialize,
+    BulkAccountLoader,
+    EventSubscriber,
+    DevnetMarkets,
+    ClearingHouse,
+} from '..';
+import { printUserStats } from './utils';
+
+require('dotenv').config();
+
+
+async function main(provider: anchor.AnchorProvider) {
+    const connection = provider.connection;
+    const config = initialize({ env: 'devnet' });
+    const clearingHousePublicKey = new PublicKey(
+        config.CLEARING_HOUSE_PROGRAM_ID
+    );
+
+    const bulkAccountLoader = new BulkAccountLoader(connection, 'confirmed', 1000);
+    const clearingHouse = new ClearingHouse({
+        connection,
+        wallet: provider.wallet,
+        programID: clearingHousePublicKey,
+        env: 'devnet',
+        // accountSubscription: {
+		// 	type: 'websocket',
+        // }
+        accountSubscription: {
+            type: 'polling',
+            accountLoader: bulkAccountLoader,
+        }
+    });
+
+    console.log(`clearingHouseProgramID: ${clearingHousePublicKey}`);
+    console.log(`provider.wallet:        ${provider.wallet.publicKey.toBase58()}`);
+
+    const eventSubscriber = new EventSubscriber(connection, clearingHouse.program, {
+        maxTx: 8192,
+        maxEventsPerType: 4096,
+        orderBy: 'blockchain',
+        orderDir: 'desc',
+        commitment: 'confirmed',
+        logProviderConfig: {
+            type: 'websocket',
+        },
+    });
+
+	if (!(await clearingHouse.getUser().exists())) {
+		console.error(`ClearingHouseUser for ${provider.wallet.publicKey} does not exist`);
+        console.info(`Creating ClearingHouseUser for ${provider.wallet.publicKey}`);
+        const [txSig] = await clearingHouse.initializeUserAccount();
+        console.log(`Initialized user account in transaction: ${txSig}`);
+	}
+
+    if (!await clearingHouse.subscribe()) {
+        throw new Error("fail clearingHouse.subscribe");
+    }
+    if (!await clearingHouse.accountSubscriber.subscribe()) {
+        throw new Error("fail clearingHouse.accountSubscriber.subscribe");
+    }
+	if (!eventSubscriber.subscribe()) {
+        throw new Error("fail eventSubscriber.subscribe");
+    }
+
+    const chUser = clearingHouse.getUser();
+    const chUserAccount = clearingHouse.getUserAccount();
+    console.log(`chUserAcc.authority:    ${chUserAccount!.authority.toBase58()}`);
+    console.log(`  chUserAccount pubkey: ${chUser.userAccountPublicKey.toBase58()}`);
+
+    const keyToSymbol = new Map<string, string>();
+    const marketIndexToSymbol = new Map<number, string>();
+    for (const market of DevnetMarkets) {
+        keyToSymbol.set(market.oracle.toBase58(), market.baseAssetSymbol);
+        marketIndexToSymbol.set(market.marketIndex.toNumber(), market.symbol);
+    }
+
+    const run = async () => {
+        await clearingHouse.fetchAccounts();
+        await chUser.fetchAccounts();
+        printUserStats(chUserAccount!, marketIndexToSymbol);
+    };
+    await run();
+    setInterval(run, 1000);
+}
+
+
+try {
+    if (!process.env.ANCHOR_WALLET) {
+        throw new Error('ANCHOR_WALLET must be set.');
+    }
+    main(
+        anchor.AnchorProvider.local(clusterApiUrl("devnet"), {
+            // anchor.AnchorProvider.local('https://devnet.genesysgo.net', {
+            preflightCommitment: 'confirmed',
+            skipPreflight: false,
+            commitment: 'confirmed',
+        })
+    );
+    // anchor.AnchorProvider.local('https://psytrbhymqlkfrhudd.dev.genesysgo.net:8899/');
+} catch (e) {
+   console.error(e);
+}