@drift-labs/common 1.0.0

package/lib/drift/Drift/clients/AuthorityDrift/index.d.ts

@@ -0,0 +1,242 @@
+import { DriftClient, DriftClientConfig, DriftEnv, IWallet, PerpMarketConfig, QuoteResponse, SpotMarketConfig, SwapMode, User } from '@drift-labs/sdk';
+import { PublicKey, TransactionSignature } from '@solana/web3.js';
+import { MarketId } from '../../../../types';
+import { PollingDlob } from '../../data/PollingDlob';
+import { MarkPriceLookup } from '../../stores/MarkPriceCache';
+import { OraclePriceLookup } from '../../stores/OraclePriceCache';
+import { DriftL2OrderbookManager } from './DriftL2OrderbookManager';
+import { Subscription } from 'rxjs';
+import { EnhancedAccountData, UserAccountLookup } from '../../stores/UserAccountCache';
+import { PriorityFeeSubscriberConfig } from '@drift-labs/sdk';
+import { CreateUserAndDepositParams, DepositParams, WithdrawParams, PerpOrderParams, SwapParams, SettleAccountPnlParams, CancelOrdersParams } from './DriftOperations/types';
+import { L2WithOracleAndMarketData } from '../../../../utils/orderbook';
+import { SwiftOrderResult } from '../../../base/actions/trade/openPerpOrder/openSwiftOrder';
+import { OrderbookGrouping } from '../../../../utils/dlob-server/DlobServerWebsocketUtils';
+export interface AuthorityDriftConfig {
+    solanaRpcEndpoint: string;
+    driftEnv: DriftEnv;
+    wallet?: IWallet;
+    driftDlobServerHttpUrl?: string;
+    tradableMarkets?: MarketId[];
+    selectedTradeMarket?: MarketId;
+    additionalDriftClientConfig?: Partial<Omit<DriftClientConfig, 'env'>>;
+    priorityFeeSubscriberConfig?: Partial<PriorityFeeSubscriberConfig>;
+    orderbookConfig?: {
+        dlobWebSocketUrl?: string;
+        orderbookGrouping?: OrderbookGrouping;
+    };
+}
+/**
+ * A Drift client that is used to subscribe to all accounts for a given authority.
+ *
+ * This is useful for applications that want to subscribe to all user accounts for a given authority,
+ * such as a UI to trade on Drift or a wallet application that allows trading on Drift.
+ */
+export declare class AuthorityDrift {
+    /**
+     * Handles all Drift program interactions e.g. trading, read account details, etc.
+     */
+    private _driftClient;
+    /**
+     * Handles bulk account loading from the RPC.
+     */
+    private accountLoader;
+    /**
+     * Handles polling the DLOB server for mark price and oracle price data for markets.
+     * It is also the fallback source for orderbook data, if the websocket DLOB subscriber is unavailable.
+     */
+    private _pollingDlob;
+    /**
+     * Subscription to the polling DLOB data.
+     */
+    private pollingDlobSubscription;
+    /**
+     * Subscription to the orderbook data.
+     */
+    private orderbookSubscription;
+    /**
+     * Handles all trading operations including deposits, withdrawals, and position management.
+     */
+    private driftOperations;
+    /**
+     * Manages all subscription operations including user accounts, market subscriptions, and polling optimization.
+     */
+    private subscriptionManager;
+    /**
+     * Stores the fetched mark prices for all tradable markets.
+     * Mark price sources includes:
+     * - Websocket DLOB subscriber (active market, derived when fetching orderbook data)
+     * - Polling DLOB server (all non-active markets)
+     */
+    private _markPriceCache;
+    /**
+     * Stores the fetched oracle prices for all tradable markets.
+     * Oracle price sources includes:
+     * - DriftClient oracle account subscriptions
+     * - Polling DLOB server (all non-active markets)
+     */
+    private _oraclePriceCache;
+    /**
+     * Stores the fetched user account data for all user accounts.
+     */
+    private _userAccountCache;
+    /**
+     * Manages real-time orderbook subscriptions via websocket.
+     */
+    private _orderbookManager;
+    /**
+     * Handles priority fee tracking and calculation for optimized transaction costs.
+     */
+    private priorityFeeSubscriber;
+    /**
+     * Stores whether the user is geographically blocked from using the service.
+     * This is checked during subscription and cached for decorator use.
+     */
+    protected _isGeoBlocked: boolean;
+    /**
+     * The selected trade market to use for the drift client. This is used to subscribe to the market account,
+     * oracle data and mark price more frequently compared to the other markets.
+     *
+     * Example usage:
+     * - When the UI wants to display the orderbook of this market.
+     * - When the user is interacting with the trade form to trade on this market.
+     */
+    private selectedTradeMarket;
+    /**
+     * The markets that are tradable through this client. This affects oracle price, mark price and market account subscriptions.
+     */
+    private _tradableMarkets;
+    private _spotMarketConfigs;
+    private _perpMarketConfigs;
+    /**
+     * The public endpoints that can be used to retrieve Drift data / interact with the Drift program.
+     */
+    private _driftEndpoints;
+    /**
+     * @param solanaRpcEndpoint - The Solana RPC endpoint to use for reading RPC data.
+     * @param driftEnv - The drift environment to use for the drift client.
+     * @param authority - The authority (wallet) whose user accounts to subscribe to.
+     * @param tradableMarkets - The markets that are tradable through this client.
+     * @param selectedTradeMarket - The active trade market to use for the drift client. This is used to subscribe to the market account, oracle data and mark price more frequently compared to the other markets.
+     * @param additionalDriftClientConfig - Additional DriftClient config to use for the DriftClient.
+     */
+    constructor(config: AuthorityDriftConfig);
+    get driftClient(): DriftClient;
+    get authority(): PublicKey;
+    get pollingDlob(): PollingDlob;
+    get oraclePriceCache(): OraclePriceLookup;
+    get markPriceCache(): MarkPriceLookup;
+    get userAccountCache(): UserAccountLookup;
+    get orderbookCache(): L2WithOracleAndMarketData | null;
+    get orderbookManager(): DriftL2OrderbookManager;
+    get tradableMarkets(): MarketId[];
+    /**
+     * Gets the current geoblock status of the user.
+     *
+     * @returns True if the user is geographically blocked, false otherwise
+     */
+    get isGeoBlocked(): boolean;
+    /**
+     * The public endpoints that can be used to retrieve Drift data / interact with the Drift program.
+     */
+    get driftEndpoints(): {
+        dlobServerHttpUrl: string;
+        swiftServerUrl: string;
+    };
+    private set tradableMarkets(value);
+    get spotMarketConfigs(): SpotMarketConfig[];
+    get perpMarketConfigs(): PerpMarketConfig[];
+    private initializeStores;
+    private initializeOrderbookManager;
+    private initializePollingDlob;
+    private initializePriorityFeeSubscriber;
+    private setupDriftClient;
+    private setupOrderbookManager;
+    private setupPollingDlob;
+    private initializeManagers;
+    private unsubscribeFromPollingDlob;
+    private unsubscribeFromOrderbook;
+    subscribe(): Promise<void>;
+    unsubscribe(): Promise<void>;
+    onOraclePricesUpdate(callback: (oraclePrice: OraclePriceLookup) => void): Subscription;
+    onMarkPricesUpdate(callback: (markPrice: MarkPriceLookup) => void): Subscription;
+    onUserAccountUpdate(callback: (userAccount: EnhancedAccountData) => void): Subscription;
+    onOrderbookUpdate(callback: (orderbook: L2WithOracleAndMarketData) => void): Subscription;
+    /**
+     * Updates the authority (wallet) for the drift client and reestablishes subscriptions.
+     *
+     * @param wallet - The new wallet to use as authority
+     * @param activeSubAccountId - Optional subaccount ID to switch to after wallet update
+     */
+    updateAuthority(wallet: IWallet, activeSubAccountId?: number): Promise<void>;
+    /**
+     * Updates the selected trade market and optimizes subscription polling.
+     *
+     * @param newSelectedTradeMarket - The new market to prioritize for trading
+     */
+    updateSelectedTradeMarket(newSelectedTradeMarket: MarketId | null): void;
+    /**
+     * Creates a new user account and deposits initial collateral.
+     *
+     * @param params - Parameters for creating user and depositing collateral
+     * @returns Promise resolving to transaction signature and user account public key
+     */
+    createUserAndDeposit(params: CreateUserAndDepositParams): Promise<{
+        txSig: TransactionSignature;
+        user: User;
+    }>;
+    /**
+     * Deposits collateral into a user's spot market position.
+     *
+     * @param params - Parameters for the deposit operation
+     * @returns Promise resolving to the transaction signature
+     */
+    deposit(params: DepositParams): Promise<TransactionSignature>;
+    /**
+     * Withdraws collateral from a user's spot market position.
+     *
+     * @param params - Parameters for the withdrawal operation
+     * @returns Promise resolving to the transaction signature
+     */
+    withdraw(params: WithdrawParams): Promise<TransactionSignature>;
+    /**
+     * Opens a perpetual market order.
+     *
+     * @param params - Parameters for the perp order
+     * @returns Promise resolving to the transaction signature
+     */
+    openPerpOrder(params: PerpOrderParams): Promise<TransactionSignature | SwiftOrderResult>;
+    /**
+     * Executes a swap between two spot markets.
+     *
+     * @param params - Parameters for the swap operation
+     * @returns Promise resolving to the transaction signature
+     */
+    swap(params: SwapParams): Promise<TransactionSignature>;
+    getSwapQuote(params: Omit<SwapParams, 'jupiterQuote'> & {
+        slippageBps?: number;
+        swapMode?: SwapMode;
+        onlyDirectRoutes?: boolean;
+    }): Promise<QuoteResponse>;
+    /**
+     * Settles profit and loss for a perpetual position.
+     *
+     * @param params - Parameters for the settle PnL operation
+     * @returns Promise resolving to the transaction signature
+     */
+    settleAccountPnl(params: SettleAccountPnlParams): Promise<TransactionSignature>;
+    /**
+     * Deletes a user account from the Drift protocol.
+     *
+     * @param subAccountId - The ID of the sub-account to delete
+     * @returns Promise resolving to the transaction signature of the deletion
+     */
+    deleteUser(subAccountId: number): Promise<TransactionSignature>;
+    /**
+     * Cancels a list of open orders.
+     *
+     * @param params - See `CancelOrdersParams`
+     * @returns Promise resolving to the transaction signature of the cancellation
+     */
+    cancelOrders(params: CancelOrdersParams): Promise<TransactionSignature>;
+}