@drift-labs/sdk 2.30.0-beta.0 → 2.30.0

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.30.0-beta.0",
+  "version": "2.30.0",
   "name": "drift",
   "instructions": [
     {
@@ -710,6 +710,170 @@
         }
       ]
     },
+    {
+      "name": "beginSwap",
+      "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": "outSpotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "inSpotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "outTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "inTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "tokenProgram",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "driftSigner",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "instructions",
+          "isMut": false,
+          "isSigner": false,
+          "docs": [
+            "Instructions Sysvar for instruction introspection"
+          ]
+        }
+      ],
+      "args": [
+        {
+          "name": "inMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "outMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "amountIn",
+          "type": "u64"
+        }
+      ]
+    },
+    {
+      "name": "endSwap",
+      "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": "outSpotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "inSpotMarketVault",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "outTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "inTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "tokenProgram",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "driftSigner",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "instructions",
+          "isMut": false,
+          "isSigner": false,
+          "docs": [
+            "Instructions Sysvar for instruction introspection"
+          ]
+        }
+      ],
+      "args": [
+        {
+          "name": "inMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "outMarketIndex",
+          "type": "u16"
+        },
+        {
+          "name": "limitPrice",
+          "type": {
+            "option": "u64"
+          }
+        },
+        {
+          "name": "reduceOnly",
+          "type": {
+            "option": {
+              "defined": "SwapReduceOnly"
+            }
+          }
+        }
+      ]
+    },
     {
       "name": "addPerpLpShares",
       "accounts": [
@@ -4895,12 +5059,46 @@
               "defined": "AssetTier"
             }
           },
+          {
+            "name": "padding1",
+            "type": {
+              "array": [
+                "u8",
+                6
+              ]
+            }
+          },
+          {
+            "name": "flashLoanAmount",
+            "docs": [
+              "For swaps, the amount of token loaned out in the begin_swap ix",
+              "precision: token mint precision"
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "flashLoanInitialTokenAmount",
+            "docs": [
+              "For swaps, the amount in the users token account in the begin_swap ix",
+              "Used to calculate how much of the token left the system in end_swap ix",
+              "precision: token mint precision"
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "totalSwapFee",
+            "docs": [
+              "The total fees received from swaps",
+              "precision: token mint precision"
+            ],
+            "type": "u64"
+          },
           {
             "name": "padding",
             "type": {
               "array": [
                 "u8",
-                86
+                56
               ]
             }
           }
@@ -7259,6 +7457,20 @@
         ]
       }
     },
+    {
+      "name": "SwapReduceOnly",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "In"
+          },
+          {
+            "name": "Out"
+          }
+        ]
+      }
+    },
     {
       "name": "TwapPeriod",
       "type": {
@@ -8845,6 +9057,56 @@
           "index": false
         }
       ]
+    },
+    {
+      "name": "SwapRecord",
+      "fields": [
+        {
+          "name": "ts",
+          "type": "i64",
+          "index": false
+        },
+        {
+          "name": "user",
+          "type": "publicKey",
+          "index": false
+        },
+        {
+          "name": "amountOut",
+          "type": "u64",
+          "index": false
+        },
+        {
+          "name": "amountIn",
+          "type": "u64",
+          "index": false
+        },
+        {
+          "name": "outMarketIndex",
+          "type": "u16",
+          "index": false
+        },
+        {
+          "name": "inMarketIndex",
+          "type": "u16",
+          "index": false
+        },
+        {
+          "name": "outOraclePrice",
+          "type": "i64",
+          "index": false
+        },
+        {
+          "name": "inOraclePrice",
+          "type": "i64",
+          "index": false
+        },
+        {
+          "name": "fee",
+          "type": "u64",
+          "index": false
+        }
+      ]
     }
   ],
   "errors": [
@@ -10087,6 +10349,21 @@
       "code": 6247,
       "name": "InvalidPhoenixMarket",
       "msg": "InvalidPhoenixMarket"
+    },
+    {
+      "code": 6248,
+      "name": "InvalidSwap",
+      "msg": "InvalidSwap"
+    },
+    {
+      "code": 6249,
+      "name": "SwapLimitPriceBreached",
+      "msg": "SwapLimitPriceBreached"
+    },
+    {
+      "code": 6250,
+      "name": "SpotMarketReduceOnly",
+      "msg": "SpotMarketReduceOnly"
     }
   ]
 }

package/src/index.ts

@@ -32,6 +32,7 @@ export * from './factory/bigNum';
 export * from './events/types';
 export * from './events/eventSubscriber';
 export * from './events/fetchLogs';
+export * from './jupiter/jupiterClient';
 export * from './math/auction';
 export * from './math/spotMarket';
 export * from './math/conversion';

package/src/jupiter/jupiterClient.ts

@@ -0,0 +1,214 @@
+import {
+	AddressLookupTableAccount,
+	Connection,
+	PublicKey,
+	TransactionInstruction,
+	TransactionMessage,
+	VersionedTransaction,
+} from '@solana/web3.js';
+import fetch from 'node-fetch';
+import { BN } from '@coral-xyz/anchor';
+
+export type SwapMode = 'ExactIn' | 'ExactOut';
+
+export interface MarketInfo {
+	id: string;
+	inAmount: number;
+	inputMint: string;
+	label: string;
+	lpFee: Fee;
+	notEnoughLiquidity: boolean;
+	outAmount: number;
+	outputMint: string;
+	platformFee: Fee;
+	priceImpactPct: number;
+}
+
+export interface Fee {
+	amount: number;
+	mint: string;
+	pct: number;
+}
+
+export interface Route {
+	amount: number;
+	inAmount: number;
+	marketInfos: MarketInfo[];
+	otherAmountThreshold: number;
+	outAmount: number;
+	priceImpactPct: number;
+	slippageBps: number;
+	swapMode: SwapMode;
+}
+
+export class JupiterClient {
+	url = 'https://quote-api.jup.ag/v4';
+	connection: Connection;
+	lookupTableCahce = new Map<string, AddressLookupTableAccount>();
+
+	constructor({ connection }: { connection: Connection }) {
+		this.connection = connection;
+	}
+
+	/**
+	 * Get routes for a swap
+	 * @param inputMint the mint of the input token
+	 * @param outputMint the mint of the output token
+	 * @param amount the amount of the input token
+	 * @param slippageBps the slippage tolerance in basis points
+	 * @param swapMode the swap mode (ExactIn or ExactOut)
+	 */
+	public async getRoutes({
+		inputMint,
+		outputMint,
+		amount,
+		slippageBps = 50,
+		swapMode = 'ExactIn',
+	}: {
+		inputMint: PublicKey;
+		outputMint: PublicKey;
+		amount: BN;
+		slippageBps?: number;
+		swapMode?: SwapMode;
+	}): Promise<Route[]> {
+		const params = new URLSearchParams({
+			inputMint: inputMint.toString(),
+			outputMint: outputMint.toString(),
+			amount: amount.toString(),
+			slippageBps: slippageBps.toString(),
+			swapMode,
+		}).toString();
+
+		const { data: routes } = await (
+			await fetch(`https://quote-api.jup.ag/v4/quote?${params}`)
+		).json();
+
+		return routes;
+	}
+
+	/**
+	 * Get a swap transaction for a route
+	 * @param route the route to perform swap
+	 * @param userPublicKey the signer's wallet public key
+	 * @param slippageBps the slippage tolerance in basis points
+	 */
+	public async getSwapTransaction({
+		route,
+		userPublicKey,
+		slippageBps = 50,
+	}: {
+		route: Route;
+		userPublicKey: PublicKey;
+		slippageBps?: number;
+	}): Promise<VersionedTransaction> {
+		const resp = await (
+			await fetch(`${this.url}/swap`, {
+				method: 'POST',
+				headers: {
+					'Content-Type': 'application/json',
+				},
+				body: JSON.stringify({
+					route,
+					userPublicKey,
+					slippageBps,
+				}),
+			})
+		).json();
+
+		const { swapTransaction } = resp;
+
+		const swapTransactionBuf = Buffer.from(swapTransaction, 'base64');
+		return VersionedTransaction.deserialize(swapTransactionBuf);
+	}
+
+	/**
+	 * Get the transaction message and lookup tables for a transaction
+	 * @param transaction
+	 */
+	public async getTransactionMessageAndLookupTables({
+		transaction,
+	}: {
+		transaction: VersionedTransaction;
+	}): Promise<{
+		transactionMessage: TransactionMessage;
+		lookupTables: AddressLookupTableAccount[];
+	}> {
+		const message = transaction.message;
+
+		const lookupTables = (
+			await Promise.all(
+				message.addressTableLookups.map(async (lookup) => {
+					return await this.getLookupTable(lookup.accountKey);
+				})
+			)
+		).filter((lookup) => lookup);
+
+		const transactionMessage = TransactionMessage.decompile(message, {
+			addressLookupTableAccounts: lookupTables,
+		});
+		return {
+			transactionMessage,
+			lookupTables,
+		};
+	}
+
+	async getLookupTable(
+		accountKey: PublicKey
+	): Promise<AddressLookupTableAccount> {
+		if (this.lookupTableCahce.has(accountKey.toString())) {
+			return this.lookupTableCahce.get(accountKey.toString());
+		}
+
+		return (await this.connection.getAddressLookupTable(accountKey)).value;
+	}
+
+	/**
+	 * Get the jupiter instructions from transaction by filtering out instructions to compute budget and associated token programs
+	 * @param transactionMessage the transaction message
+	 * @param inputMint the input mint
+	 * @param outputMint the output mint
+	 */
+	public getJupiterInstructions({
+		transactionMessage,
+		inputMint,
+		outputMint,
+	}: {
+		transactionMessage: TransactionMessage;
+		inputMint: PublicKey;
+		outputMint: PublicKey;
+	}): TransactionInstruction[] {
+		return transactionMessage.instructions.filter((instruction) => {
+			if (
+				instruction.programId.toString() ===
+				'ComputeBudget111111111111111111111111111111'
+			) {
+				return false;
+			}
+
+			if (
+				instruction.programId.toString() ===
+				'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
+			) {
+				return false;
+			}
+
+			if (
+				instruction.programId.toString() === '11111111111111111111111111111111'
+			) {
+				return false;
+			}
+
+			if (
+				instruction.programId.toString() ===
+				'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'
+			) {
+				const mint = instruction.keys[3].pubkey;
+				if (mint.equals(inputMint) || mint.equals(outputMint)) {
+					return false;
+				}
+			}
+
+			return true;
+		});
+	}
+}

package/src/math/spotBalance.ts

@@ -23,6 +23,15 @@ import { OraclePriceData } from '../oracles/types';
 import { PERCENTAGE_PRECISION } from '../constants/numericConstants';
 import { divCeil } from './utils';
 
+/**
+ * Calculates the balance of a given token amount including any accumulated interest. This
+ * is the same as `SpotPosition.scaledBalance`.
+ *
+ * @param {BN} tokenAmount - the amount of tokens
+ * @param {SpotMarketAccount} spotMarket - the spot market account
+ * @param {SpotBalanceType} balanceType - the balance type ('deposit' or 'borrow')
+ * @return {BN} the calculated balance, scaled by `SPOT_MARKET_BALANCE_PRECISION`
+ */
 export function getBalance(
 	tokenAmount: BN,
 	spotMarket: SpotMarketAccount,
@@ -43,6 +52,14 @@ export function getBalance(
 	return balance;
 }
 
+/**
+ * Calculates the spot token amount including any accumulated interest.
+ *
+ * @param {BN} balanceAmount - The balance amount, typically from `SpotPosition.scaledBalance`
+ * @param {SpotMarketAccount} spotMarket - The spot market account details
+ * @param {SpotBalanceType} balanceType - The balance type to be used for calculation
+ * @returns {BN} The calculated token amount, scaled by `SpotMarketConfig.precision`
+ */
 export function getTokenAmount(
 	balanceAmount: BN,
 	spotMarket: SpotMarketAccount,
@@ -62,6 +79,13 @@ export function getTokenAmount(
 	}
 }
 
+/**
+ * Returns the signed (positive for deposit,negative for borrow) token amount based on the balance type.
+ *
+ * @param {BN} tokenAmount - The token amount to convert (from `getTokenAmount`)
+ * @param {SpotBalanceType} balanceType - The balance type to determine the sign of the token amount.
+ * @returns {BN} - The signed token amount, scaled by `SpotMarketConfig.precision`
+ */
 export function getSignedTokenAmount(
 	tokenAmount: BN,
 	balanceType: SpotBalanceType
@@ -73,6 +97,15 @@ export function getSignedTokenAmount(
 	}
 }
 
+/**
+ * Calculates the value of a given token amount using the worst of the provided oracle price and its TWAP.
+ *
+ * @param {BN} tokenAmount - The amount of tokens to calculate the value for (from `getTokenAmount`)
+ * @param {number} spotDecimals - The number of decimals in the token.
+ * @param {OraclePriceData} oraclePriceData - The oracle price data (typically a token/USD oracle).
+ * @param {BN} oraclePriceTwap - The Time-Weighted Average Price of the oracle.
+ * @return {BN} The calculated value of the given token amount, scaled by `PRICE_PRECISION`
+ */
 export function getStrictTokenValue(
 	tokenAmount: BN,
 	spotDecimals: number,
@@ -95,6 +128,14 @@ export function getStrictTokenValue(
 	return tokenAmount.mul(price).div(precisionDecrease);
 }
 
+/**
+ * Calculates the value of a given token amount in relation to an oracle price data
+ *
+ * @param {BN} tokenAmount - The amount of tokens to calculate the value for (from `getTokenAmount`)
+ * @param {number} spotDecimals - The number of decimal places of the token.
+ * @param {OraclePriceData} oraclePriceData - The oracle price data (typically a token/USD oracle).
+ * @return {BN} The value of the token based on the oracle, scaled by `PRICE_PRECISION`
+ */
 export function getTokenValue(
 	tokenAmount: BN,
 	spotDecimals: number,

package/src/token/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTokenAccount = void 0;
+const spl_token_1 = require("@solana/spl-token");
+const web3_js_1 = require("@solana/web3.js");
+function parseTokenAccount(data) {
+    const accountInfo = spl_token_1.AccountLayout.decode(data);
+    accountInfo.mint = new web3_js_1.PublicKey(accountInfo.mint);
+    accountInfo.owner = new web3_js_1.PublicKey(accountInfo.owner);
+    accountInfo.amount = spl_token_1.u64.fromBuffer(accountInfo.amount);
+    if (accountInfo.delegateOption === 0) {
+        accountInfo.delegate = null;
+        // eslint-disable-next-line new-cap
+        accountInfo.delegatedAmount = new spl_token_1.u64(0);
+    }
+    else {
+        accountInfo.delegate = new web3_js_1.PublicKey(accountInfo.delegate);
+        accountInfo.delegatedAmount = spl_token_1.u64.fromBuffer(accountInfo.delegatedAmount);
+    }
+    accountInfo.isInitialized = accountInfo.state !== 0;
+    accountInfo.isFrozen = accountInfo.state === 2;
+    if (accountInfo.isNativeOption === 1) {
+        accountInfo.rentExemptReserve = spl_token_1.u64.fromBuffer(accountInfo.isNative);
+        accountInfo.isNative = true;
+    }
+    else {
+        accountInfo.rentExemptReserve = null;
+        accountInfo.isNative = false;
+    }
+    if (accountInfo.closeAuthorityOption === 0) {
+        accountInfo.closeAuthority = null;
+    }
+    else {
+        accountInfo.closeAuthority = new web3_js_1.PublicKey(accountInfo.closeAuthority);
+    }
+    return accountInfo;
+}
+exports.parseTokenAccount = parseTokenAccount;

package/src/token/index.ts

@@ -1,37 +1,13 @@
-import { AccountInfo, AccountLayout, u64 } from '@solana/spl-token';
-import { PublicKey } from '@solana/web3.js';
-
-export function parseTokenAccount(data: Buffer): AccountInfo {
-	const accountInfo = AccountLayout.decode(data);
-	accountInfo.mint = new PublicKey(accountInfo.mint);
-	accountInfo.owner = new PublicKey(accountInfo.owner);
-	accountInfo.amount = u64.fromBuffer(accountInfo.amount);
-
-	if (accountInfo.delegateOption === 0) {
-		accountInfo.delegate = null;
-		// eslint-disable-next-line new-cap
-		accountInfo.delegatedAmount = u64.fromBuffer(Buffer.from('0'));
-	} else {
-		accountInfo.delegate = new PublicKey(accountInfo.delegate);
-		accountInfo.delegatedAmount = u64.fromBuffer(accountInfo.delegatedAmount);
-	}
-
-	accountInfo.isInitialized = accountInfo.state !== 0;
-	accountInfo.isFrozen = accountInfo.state === 2;
-
-	if (accountInfo.isNativeOption === 1) {
-		accountInfo.rentExemptReserve = u64.fromBuffer(accountInfo.isNative);
-		accountInfo.isNative = true;
-	} else {
-		accountInfo.rentExemptReserve = null;
-		accountInfo.isNative = false;
-	}
-
-	if (accountInfo.closeAuthorityOption === 0) {
-		accountInfo.closeAuthority = null;
-	} else {
-		accountInfo.closeAuthority = new PublicKey(accountInfo.closeAuthority);
-	}
-
-	return accountInfo;
+import { Account, TOKEN_PROGRAM_ID, unpackAccount } from '@solana/spl-token';
+import { PublicKey, AccountInfo } from '@solana/web3.js';
+
+export function parseTokenAccount(data: Buffer, pubkey: PublicKey): Account {
+	// mock AccountInfo so unpackAccount can be used
+	const accountInfo: AccountInfo<Buffer> = {
+		data,
+		owner: TOKEN_PROGRAM_ID,
+		executable: false,
+		lamports: 0,
+	};
+	return unpackAccount(pubkey, accountInfo, TOKEN_PROGRAM_ID);
 }