@drift-labs/sdk 2.96.0-beta.9 → 2.97.0-beta.0

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.95.0",
+  "version": "2.96.0",
   "name": "drift",
   "instructions": [
     {
@@ -554,7 +554,7 @@
           }
         },
         {
-          "name": "makerOrderId",
+          "name": "successCondition",
           "type": {
             "option": "u32"
           }
@@ -608,6 +608,60 @@
         }
       ]
     },
+    {
+      "name": "placeSwiftTakerOrder",
+      "accounts": [
+        {
+          "name": "state",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "user",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "userStats",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "authority",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "ixSysvar",
+          "isMut": false,
+          "isSigner": false,
+          "docs": [
+            "the supplied Sysvar could be anything else.",
+            "The Instruction Sysvar has not been implemented",
+            "in the Anchor framework yet, so this is the safe approach."
+          ]
+        }
+      ],
+      "args": [
+        {
+          "name": "swiftMessageBytes",
+          "type": "bytes"
+        },
+        {
+          "name": "swiftOrderParamsMessageBytes",
+          "type": "bytes"
+        },
+        {
+          "name": "swiftMessageSignature",
+          "type": {
+            "array": [
+              "u8",
+              64
+            ]
+          }
+        }
+      ]
+    },
     {
       "name": "placeSpotOrder",
       "accounts": [
@@ -8050,6 +8104,81 @@
         ]
       }
     },
+    {
+      "name": "SwiftServerMessage",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "swiftOrderSignature",
+            "type": {
+              "array": [
+                "u8",
+                64
+              ]
+            }
+          },
+          {
+            "name": "slot",
+            "type": "u64"
+          }
+        ]
+      }
+    },
+    {
+      "name": "SwiftOrderParamsMessage",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "swiftOrderParams",
+            "type": {
+              "defined": "OrderParams"
+            }
+          },
+          {
+            "name": "expectedOrderId",
+            "type": "i32"
+          },
+          {
+            "name": "subAccountId",
+            "type": "u16"
+          },
+          {
+            "name": "takeProfitOrderParams",
+            "type": {
+              "option": {
+                "defined": "SwiftTriggerOrderParams"
+              }
+            }
+          },
+          {
+            "name": "stopLossOrderParams",
+            "type": {
+              "option": {
+                "defined": "SwiftTriggerOrderParams"
+              }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "name": "SwiftTriggerOrderParams",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "triggerPrice",
+            "type": "u64"
+          },
+          {
+            "name": "baseAssetAmount",
+            "type": "u64"
+          }
+        ]
+      }
+    },
     {
       "name": "ModifyOrderParams",
       "type": {
@@ -10122,6 +10251,20 @@
         ]
       }
     },
+    {
+      "name": "PlaceAndTakeOrderSuccessCondition",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "PartialFill"
+          },
+          {
+            "name": "FullFill"
+          }
+        ]
+      }
+    },
     {
       "name": "PerpOperation",
       "type": {
@@ -12958,6 +13101,31 @@
       "code": 6284,
       "name": "InvalidPredictionMarketOrder",
       "msg": "Invalid prediction market order"
+    },
+    {
+      "code": 6285,
+      "name": "InvalidVerificationIxIndex",
+      "msg": "Ed25519 Ix must be before place and make swift order ix"
+    },
+    {
+      "code": 6286,
+      "name": "SigVerificationFailed",
+      "msg": "Swift message verificaiton failed"
+    },
+    {
+      "code": 6287,
+      "name": "MismatchedSwiftOrderParamsMarketIndex",
+      "msg": "Market index mismatched b/w taker and maker swift order params"
+    },
+    {
+      "code": 6288,
+      "name": "InvalidSwiftOrderParam",
+      "msg": "Swift only available for market/oracle perp orders"
+    },
+    {
+      "code": 6289,
+      "name": "PlaceAndTakeOrderSuccessConditionFailed",
+      "msg": "Place and take order success condition failed"
     }
   ],
   "metadata": {

package/src/index.ts

@@ -108,6 +108,7 @@ export * from './memcmp';
 export * from './decode/user';
 export * from './blockhashSubscriber';
 export * from './util/chainClock';
+export * from './util/TransactionConfirmationManager';
 export * from './clock/clockSubscriber';
 
 export { BN, PublicKey, pyth };

package/src/orderParams.ts

@@ -10,9 +10,11 @@ import { BN } from '@coral-xyz/anchor';
 export function getLimitOrderParams(
 	params: Omit<OptionalOrderParams, 'orderType'> & { price: BN }
 ): OptionalOrderParams {
-	return Object.assign({}, params, {
-		orderType: OrderType.LIMIT,
-	});
+	return getOrderParams(
+		Object.assign({}, params, {
+			orderType: OrderType.LIMIT,
+		})
+	);
 }
 
 export function getTriggerMarketOrderParams(
@@ -21,9 +23,11 @@ export function getTriggerMarketOrderParams(
 		triggerPrice: BN;
 	}
 ): OptionalOrderParams {
-	return Object.assign({}, params, {
-		orderType: OrderType.TRIGGER_MARKET,
-	});
+	return getOrderParams(
+		Object.assign({}, params, {
+			orderType: OrderType.TRIGGER_MARKET,
+		})
+	);
 }
 
 export function getTriggerLimitOrderParams(
@@ -33,17 +37,21 @@ export function getTriggerLimitOrderParams(
 		price: BN;
 	}
 ): OptionalOrderParams {
-	return Object.assign({}, params, {
-		orderType: OrderType.TRIGGER_LIMIT,
-	});
+	return getOrderParams(
+		Object.assign({}, params, {
+			orderType: OrderType.TRIGGER_LIMIT,
+		})
+	);
 }
 
 export function getMarketOrderParams(
 	params: Omit<OptionalOrderParams, 'orderType'>
 ): OptionalOrderParams {
-	return Object.assign({}, params, {
-		orderType: OrderType.MARKET,
-	});
+	return getOrderParams(
+		Object.assign({}, params, {
+			orderType: OrderType.MARKET,
+		})
+	);
 }
 
 /**

package/src/orderSubscriber/OrderSubscriber.ts

@@ -209,11 +209,8 @@ export class OrderSubscriber {
 					dataType
 				);
 			}
-			if (userAccount.hasOpenOrder) {
-				this.usersAccounts.set(key, { slot, userAccount });
-			} else {
-				this.usersAccounts.delete(key);
-			}
+
+			this.usersAccounts.set(key, { slot, userAccount });
 		}
 	}
 

package/src/tokenFaucet.ts

@@ -16,7 +16,7 @@ import {
 	TransactionInstruction,
 	TransactionSignature,
 } from '@solana/web3.js';
-import { BN } from '.';
+import { BN, DEFAULT_CONFIRMATION_OPTS } from '.';
 import tokenFaucet from './idl/token_faucet.json';
 import { IWallet } from './types';
 import { BankrunContextWrapper } from './bankrun/bankrunConnection';
@@ -41,7 +41,7 @@ export class TokenFaucet {
 		this.connection = connection;
 		this.context = context;
 		this.wallet = wallet;
-		this.opts = opts || AnchorProvider.defaultOptions();
+		this.opts = opts || DEFAULT_CONFIRMATION_OPTS;
 		// @ts-ignore
 		const provider = new AnchorProvider(
 			context ? context.connection.toConnection() : this.connection,

package/src/tx/baseTxSender.ts

@@ -15,22 +15,22 @@ import {
 	TransactionSignature,
 	Connection,
 	VersionedTransaction,
-	SendTransactionError,
 	TransactionInstruction,
 	AddressLookupTableAccount,
 	BlockhashWithExpiryBlockHeight,
 } from '@solana/web3.js';
-import { AnchorProvider } from '@coral-xyz/anchor';
 import assert from 'assert';
 import bs58 from 'bs58';
 import { TxHandler } from './txHandler';
 import { IWallet } from '../types';
 import NodeCache from 'node-cache';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
+import { NOT_CONFIRMED_ERROR_CODE } from '../constants/txConstants';
+import { throwTransactionError } from './reportTransactionError';
 
 const BASELINE_TX_LAND_RATE = 0.9;
 const DEFAULT_TIMEOUT = 35000;
 const DEFAULT_TX_LAND_RATE_LOOKBACK_WINDOW_MINUTES = 10;
-const NOT_CONFIRMED_ERROR_CODE = -1001;
 
 export abstract class BaseTxSender implements TxSender {
 	connection: Connection;
@@ -54,7 +54,7 @@ export abstract class BaseTxSender implements TxSender {
 	public constructor({
 		connection,
 		wallet,
-		opts = AnchorProvider.defaultOptions(),
+		opts = DEFAULT_CONFIRMATION_OPTS,
 		timeout = DEFAULT_TIMEOUT,
 		additionalConnections = new Array<Connection>(),
 		confirmationStrategy = ConfirmationStrategy.Combo,
@@ -406,40 +406,18 @@ export abstract class BaseTxSender implements TxSender {
 	public async checkConfirmationResultForError(
 		txSig: string,
 		result: SignatureResult
-	) {
+	): Promise<void> {
 		if (result.err) {
-			await this.reportTransactionError(txSig);
+			await throwTransactionError(
+				txSig,
+				this.connection,
+				this.opts?.commitment
+			);
 		}
 
 		return;
 	}
 
-	public async reportTransactionError(txSig: string) {
-		const transactionResult = await this.connection.getTransaction(txSig, {
-			maxSupportedTransactionVersion: 0,
-		});
-
-		if (!transactionResult?.meta?.err) {
-			return undefined;
-		}
-
-		const logs = transactionResult.meta.logMessages;
-
-		const lastLog = logs[logs.length - 1];
-
-		const friendlyMessage = lastLog?.match(/(failed:) (.+)/)?.[2];
-
-		// @ts-ignore
-		throw new SendTransactionError({
-			action: 'send',
-			signature: txSig,
-			transactionMessage: `Transaction Failed${
-				friendlyMessage ? `: ${friendlyMessage}` : ''
-			}`,
-			logs,
-		});
-	}
-
 	public getTxLandRate(): number {
 		if (!this.trackTxLandRate) {
 			console.warn(

package/src/tx/fastSingleTxSender.ts

@@ -6,10 +6,10 @@ import {
 	Commitment,
 	BlockhashWithExpiryBlockHeight,
 } from '@solana/web3.js';
-import { AnchorProvider } from '@coral-xyz/anchor';
 import { BaseTxSender } from './baseTxSender';
 import { TxHandler } from './txHandler';
 import { IWallet } from '../types';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
 
 const DEFAULT_TIMEOUT = 35000;
 const DEFAULT_BLOCKHASH_REFRESH = 10000;
@@ -31,7 +31,7 @@ export class FastSingleTxSender extends BaseTxSender {
 	public constructor({
 		connection,
 		wallet,
-		opts = { ...AnchorProvider.defaultOptions(), maxRetries: 0 },
+		opts = { ...DEFAULT_CONFIRMATION_OPTS, maxRetries: 0 },
 		timeout = DEFAULT_TIMEOUT,
 		blockhashRefreshInterval = DEFAULT_BLOCKHASH_REFRESH,
 		additionalConnections = new Array<Connection>(),

package/src/tx/forwardOnlyTxSender.ts

@@ -1,4 +1,3 @@
-import { AnchorProvider } from '@coral-xyz/anchor';
 import {
 	ConfirmOptions,
 	Connection,
@@ -9,6 +8,7 @@ import { BaseTxSender } from './baseTxSender';
 import { ConfirmationStrategy, TxSigAndSlot } from './types';
 import { TxHandler } from './txHandler';
 import { IWallet } from '../types';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
 
 const DEFAULT_TIMEOUT = 35000;
 const DEFAULT_RETRY = 5000;
@@ -29,7 +29,7 @@ export class ForwardOnlyTxSender extends BaseTxSender {
 	public constructor({
 		connection,
 		wallet,
-		opts = { ...AnchorProvider.defaultOptions(), maxRetries: 0 },
+		opts = { ...DEFAULT_CONFIRMATION_OPTS, maxRetries: 0 },
 		timeout = DEFAULT_TIMEOUT,
 		retrySleep = DEFAULT_RETRY,
 		confirmationStrategy = ConfirmationStrategy.Combo,

package/src/tx/reportTransactionError.ts

@@ -0,0 +1,159 @@
+import {
+	Commitment,
+	Connection,
+	Finality,
+	SendTransactionError,
+	VersionedTransactionResponse,
+} from '@solana/web3.js';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
+
+/**
+ * The new getTransaction method expects a Finality type instead of a Commitment type. The only options for Finality are 'confirmed' and 'finalized'.
+ * @param commitment
+ * @returns
+ */
+const commitmentToFinality = (commitment: Commitment): Finality => {
+	switch (commitment) {
+		case 'confirmed':
+			return 'confirmed';
+		case 'finalized':
+			return 'finalized';
+		default:
+			throw new Error(
+				`Invalid commitment when reporting transaction error. The commitment must be 'confirmed' or 'finalized' but was given '${commitment}'. If you're using this commitment for a specific reason, you may need to roll your own logic here.`
+			);
+	}
+};
+
+const getTransactionResult = async (
+	txSig: string,
+	connection: Connection,
+	commitment?: Commitment
+): Promise<VersionedTransactionResponse> => {
+	const finality = commitmentToFinality(
+		commitment || connection.commitment || DEFAULT_CONFIRMATION_OPTS.commitment
+	);
+	return await connection.getTransaction(txSig, {
+		maxSupportedTransactionVersion: 0,
+		commitment: finality,
+	});
+};
+
+const getTransactionResultWithRetry = async (
+	txSig: string,
+	connection: Connection,
+	commitment?: Commitment
+): Promise<VersionedTransactionResponse> => {
+	const start = Date.now();
+
+	const retryTimeout = 3_000; // Timeout after 3 seconds
+	const retryInterval = 800; // Retry with 800ms interval
+	const retryCount = 3; // Retry 3 times
+
+	let currentCount = 0;
+	let transactionResult = await getTransactionResult(
+		txSig,
+		connection,
+		commitment
+	);
+
+	// Retry 3 times or until timeout as long as we don't have a result yet
+	while (
+		!transactionResult &&
+		Date.now() - start < retryTimeout &&
+		currentCount < retryCount
+	) {
+		// Sleep for 1 second :: Do this first so that we don't run the first loop immediately after the initial fetch above
+		await new Promise((resolve) => setTimeout(resolve, retryInterval));
+
+		transactionResult = await getTransactionResult(
+			txSig,
+			connection,
+			commitment
+		);
+		currentCount++;
+	}
+
+	return transactionResult;
+};
+
+/**
+ * THROWS if there is an error
+ *
+ * Should only be used for a txSig that is confirmed has an error. There is a race-condition where sometimes the transaction is not instantly available to fetch after the confirmation has already failed with an error, so this method has retry logic which we don't want to do wastefully. This method will throw a generic error if it can't get the transaction result after a retry period.
+ * @param txSig
+ * @param connection
+ * @returns
+ */
+export const throwTransactionError = async (
+	txSig: string,
+	connection: Connection,
+	commitment?: Commitment
+): Promise<void> => {
+	const err = await getTransactionErrorFromTxSig(txSig, connection, commitment);
+
+	if (err) {
+		throw err;
+	}
+
+	return;
+};
+
+/**
+ * RETURNS an error if there is one
+ *
+ * Should only be used for a txSig that is confirmed has an error. There is a race-condition where sometimes the transaction is not instantly available to fetch after the confirmation has already failed with an error, so this method has retry logic which we don't want to do wastefully. This method will throw a generic error if it can't get the transaction result after a retry period.
+ * @param txSig
+ * @param connection
+ * @returns
+ */
+export const getTransactionErrorFromTxSig = async (
+	txSig: string,
+	connection: Connection,
+	commitment?: Commitment
+): Promise<SendTransactionError> => {
+	const transactionResult = await getTransactionResultWithRetry(
+		txSig,
+		connection,
+		commitment
+	);
+
+	if (!transactionResult) {
+		// Throw a generic error because we couldn't get the transaction result for the given txSig
+		return new SendTransactionError({
+			action: 'send',
+			signature: txSig,
+			transactionMessage: `Transaction Failed`,
+		});
+	}
+
+	if (!transactionResult?.meta?.err) {
+		// Assume that the transaction was successful and we are here erroneously because we have a result with no error
+		return;
+	}
+
+	return getTransactionError(transactionResult);
+};
+
+export const getTransactionError = (
+	transactionResult: VersionedTransactionResponse
+): SendTransactionError => {
+	if (!transactionResult?.meta?.err) {
+		return;
+	}
+
+	const logs = transactionResult?.meta?.logMessages ?? ['No logs'];
+
+	const lastLog = logs[logs.length - 1];
+
+	const friendlyMessage = lastLog?.match(/(failed:) (.+)/)?.[2];
+
+	return new SendTransactionError({
+		action: 'send',
+		signature: transactionResult?.transaction?.signatures?.[0],
+		transactionMessage: `Transaction Failed${
+			friendlyMessage ? `: ${friendlyMessage}` : ''
+		}`,
+		logs,
+	});
+};

package/src/tx/retryTxSender.ts

@@ -1,9 +1,9 @@
 import { ConfirmationStrategy, TxSigAndSlot } from './types';
 import { ConfirmOptions, Connection } from '@solana/web3.js';
-import { AnchorProvider } from '@coral-xyz/anchor';
 import { BaseTxSender } from './baseTxSender';
 import { TxHandler } from './txHandler';
 import { IWallet } from '../types';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
 
 const DEFAULT_TIMEOUT = 35000;
 const DEFAULT_RETRY = 2000;
@@ -24,7 +24,7 @@ export class RetryTxSender extends BaseTxSender {
 	public constructor({
 		connection,
 		wallet,
-		opts = { ...AnchorProvider.defaultOptions(), maxRetries: 0 },
+		opts = { ...DEFAULT_CONFIRMATION_OPTS, maxRetries: 0 },
 		timeout = DEFAULT_TIMEOUT,
 		retrySleep = DEFAULT_RETRY,
 		additionalConnections = new Array<Connection>(),

package/src/tx/txHandler.ts

@@ -29,6 +29,7 @@ import { CachedBlockhashFetcher } from './blockhashFetcher/cachedBlockhashFetche
 import { BaseBlockhashFetcher } from './blockhashFetcher/baseBlockhashFetcher';
 import { BlockhashFetcher } from './blockhashFetcher/types';
 import { isVersionedTransaction } from './utils';
+import { DEFAULT_CONFIRMATION_OPTS } from '../config';
 
 /**
  * Explanation for SIGNATURE_BLOCK_AND_EXPIRY:
@@ -81,7 +82,8 @@ export class TxHandler {
 	private preSignedCb?: () => void;
 	private onSignedCb?: (txSigs: DriftClientMetricsEvents['txSigned']) => void;
 
-	private blockhashCommitment: Commitment = 'finalized';
+	private blockhashCommitment: Commitment =
+		DEFAULT_CONFIRMATION_OPTS.commitment;
 	private blockHashFetcher: BlockhashFetcher;
 
 	constructor(props: {
@@ -98,6 +100,11 @@ export class TxHandler {
 		this.connection = props.connection;
 		this.wallet = props.wallet;
 		this.confirmationOptions = props.confirmationOptions;
+		this.blockhashCommitment =
+			props.confirmationOptions?.preflightCommitment ??
+			props?.connection?.commitment ??
+			this.blockhashCommitment ??
+			'confirmed';
 
 		this.blockHashFetcher = props?.config?.blockhashCachingEnabled
 			? new CachedBlockhashFetcher(
@@ -536,7 +543,6 @@ export class TxHandler {
 			}
 		} else {
 			const marketLookupTable = await fetchMarketLookupTableAccount();
-
 			lookupTables = lookupTables
 				? [...lookupTables, marketLookupTable]
 				: [marketLookupTable];