@drift-labs/sdk/src/priorityFee/types.ts

SDK for Drift Protocol

import { Connection, PublicKey } from '@solana/web3.js';
import { SolanaPriorityFeeResponse } from './solanaPriorityFeeMethod';
import { HeliusPriorityFeeResponse } from './heliusPriorityFeeMethod';
import {
	DriftMarketInfo,
	DriftPriorityFeeResponse,
} from './driftPriorityFeeMethod';

export const DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS = 10_000;

export interface PriorityFeeStrategy {
	// calculate the priority fee for a given set of samples.
	// expect samples to be sorted in descending order (by slot)
	calculate(
		samples:
			| SolanaPriorityFeeResponse[]
			| HeliusPriorityFeeResponse
			| DriftPriorityFeeResponse
	): number;
}

export enum PriorityFeeMethod {
	SOLANA = 'solana',
	HELIUS = 'helius',
	DRIFT = 'drift',
}

export type PriorityFeeSubscriberConfig = {
	/// rpc connection, optional if using priorityFeeMethod.HELIUS
	connection?: Connection;
	/// frequency to make RPC calls to update priority fee samples, in milliseconds
	frequencyMs?: number;
	/// addresses you plan to write lock, used to determine priority fees
	addresses?: PublicKey[];
	/// drift market type and index, optionally provide at initialization time if using priorityFeeMethod.DRIFT
	driftMarkets?: DriftMarketInfo[];
	/// custom strategy to calculate priority fees, defaults to AVERAGE
	customStrategy?: PriorityFeeStrategy;
	/// method for fetching priority fee samples
	priorityFeeMethod?: PriorityFeeMethod;
	/// lookback window to determine priority fees, in slots.
	slotsToCheck?: number;
	/// url for helius rpc, required if using priorityFeeMethod.HELIUS
	heliusRpcUrl?: string;
	/// url for drift cached priority fee endpoint, required if using priorityFeeMethod.DRIFT
	driftPriorityFeeEndpoint?: string;
	/// clamp any returned priority fee value to this value.
	maxFeeMicroLamports?: number;
	/// multiplier applied to priority fee before maxFeeMicroLamports, defaults to 1.0
	priorityFeeMultiplier?: number;
};

export type PriorityFeeSubscriberMapConfig = {
	/// frequency to make RPC calls to update priority fee samples, in milliseconds
	frequencyMs?: number;
	/// drift market type and associated market index to query
	driftMarkets?: DriftMarketInfo[];
	/// url for drift cached priority fee endpoint
	driftPriorityFeeEndpoint: string;
};