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

package/lib/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/lib/index.d.ts

@@ -30,6 +30,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/lib/index.js

@@ -54,6 +54,7 @@ __exportStar(require("./factory/bigNum"), exports);
 __exportStar(require("./events/types"), exports);
 __exportStar(require("./events/eventSubscriber"), exports);
 __exportStar(require("./events/fetchLogs"), exports);
+__exportStar(require("./jupiter/jupiterClient"), exports);
 __exportStar(require("./math/auction"), exports);
 __exportStar(require("./math/spotMarket"), exports);
 __exportStar(require("./math/conversion"), exports);

package/lib/jupiter/jupiterClient.d.ts

@@ -0,0 +1,86 @@
+import { AddressLookupTableAccount, Connection, PublicKey, TransactionInstruction, TransactionMessage, VersionedTransaction } from '@solana/web3.js';
+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 declare class JupiterClient {
+    url: string;
+    connection: Connection;
+    lookupTableCahce: Map<string, AddressLookupTableAccount>;
+    constructor({ connection }: {
+        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)
+     */
+    getRoutes({ inputMint, outputMint, amount, slippageBps, swapMode, }: {
+        inputMint: PublicKey;
+        outputMint: PublicKey;
+        amount: BN;
+        slippageBps?: number;
+        swapMode?: SwapMode;
+    }): Promise<Route[]>;
+    /**
+     * 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
+     */
+    getSwapTransaction({ route, userPublicKey, slippageBps, }: {
+        route: Route;
+        userPublicKey: PublicKey;
+        slippageBps?: number;
+    }): Promise<VersionedTransaction>;
+    /**
+     * Get the transaction message and lookup tables for a transaction
+     * @param transaction
+     */
+    getTransactionMessageAndLookupTables({ transaction, }: {
+        transaction: VersionedTransaction;
+    }): Promise<{
+        transactionMessage: TransactionMessage;
+        lookupTables: AddressLookupTableAccount[];
+    }>;
+    getLookupTable(accountKey: PublicKey): Promise<AddressLookupTableAccount>;
+    /**
+     * 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
+     */
+    getJupiterInstructions({ transactionMessage, inputMint, outputMint, }: {
+        transactionMessage: TransactionMessage;
+        inputMint: PublicKey;
+        outputMint: PublicKey;
+    }): TransactionInstruction[];
+}

package/lib/jupiter/jupiterClient.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JupiterClient = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+class JupiterClient {
+    constructor({ connection }) {
+        this.url = 'https://quote-api.jup.ag/v4';
+        this.lookupTableCahce = new Map();
+        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)
+     */
+    async getRoutes({ inputMint, outputMint, amount, slippageBps = 50, swapMode = 'ExactIn', }) {
+        const params = new URLSearchParams({
+            inputMint: inputMint.toString(),
+            outputMint: outputMint.toString(),
+            amount: amount.toString(),
+            slippageBps: slippageBps.toString(),
+            swapMode,
+        }).toString();
+        const { data: routes } = await (await (0, node_fetch_1.default)(`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
+     */
+    async getSwapTransaction({ route, userPublicKey, slippageBps = 50, }) {
+        const resp = await (await (0, node_fetch_1.default)(`${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 web3_js_1.VersionedTransaction.deserialize(swapTransactionBuf);
+    }
+    /**
+     * Get the transaction message and lookup tables for a transaction
+     * @param transaction
+     */
+    async getTransactionMessageAndLookupTables({ transaction, }) {
+        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 = web3_js_1.TransactionMessage.decompile(message, {
+            addressLookupTableAccounts: lookupTables,
+        });
+        return {
+            transactionMessage,
+            lookupTables,
+        };
+    }
+    async getLookupTable(accountKey) {
+        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
+     */
+    getJupiterInstructions({ transactionMessage, inputMint, outputMint, }) {
+        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;
+        });
+    }
+}
+exports.JupiterClient = JupiterClient;

package/lib/math/spotBalance.d.ts

@@ -1,10 +1,51 @@
 import { SpotMarketAccount, SpotBalanceType, MarginCategory } from '../types';
 import { BN } from '@coral-xyz/anchor';
 import { OraclePriceData } from '../oracles/types';
+/**
+ * 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 declare function getBalance(tokenAmount: BN, spotMarket: SpotMarketAccount, balanceType: SpotBalanceType): BN;
+/**
+ * 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 declare function getTokenAmount(balanceAmount: BN, spotMarket: SpotMarketAccount, balanceType: SpotBalanceType): BN;
+/**
+ * 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 declare function getSignedTokenAmount(tokenAmount: BN, balanceType: SpotBalanceType): BN;
+/**
+ * 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 declare function getStrictTokenValue(tokenAmount: BN, spotDecimals: number, oraclePriceData: OraclePriceData, oraclePriceTwap: BN): BN;
+/**
+ * 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 declare function getTokenValue(tokenAmount: BN, spotDecimals: number, oraclePriceData: OraclePriceData): BN;
 export declare function calculateAssetWeight(balanceAmount: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): BN;
 export declare function calculateLiabilityWeight(size: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): BN;

package/lib/math/spotBalance.js

@@ -7,6 +7,15 @@ const numericConstants_1 = require("../constants/numericConstants");
 const margin_1 = require("./margin");
 const numericConstants_2 = require("../constants/numericConstants");
 const utils_1 = require("./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`
+ */
 function getBalance(tokenAmount, spotMarket, balanceType) {
     const precisionIncrease = numericConstants_1.TEN.pow(new anchor_1.BN(19 - spotMarket.decimals));
     const cumulativeInterest = (0, types_1.isVariant)(balanceType, 'deposit')
@@ -19,6 +28,14 @@ function getBalance(tokenAmount, spotMarket, balanceType) {
     return balance;
 }
 exports.getBalance = getBalance;
+/**
+ * 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`
+ */
 function getTokenAmount(balanceAmount, spotMarket, balanceType) {
     const precisionDecrease = numericConstants_1.TEN.pow(new anchor_1.BN(19 - spotMarket.decimals));
     if ((0, types_1.isVariant)(balanceType, 'deposit')) {
@@ -31,6 +48,13 @@ function getTokenAmount(balanceAmount, spotMarket, balanceType) {
     }
 }
 exports.getTokenAmount = 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`
+ */
 function getSignedTokenAmount(tokenAmount, balanceType) {
     if ((0, types_1.isVariant)(balanceType, 'deposit')) {
         return tokenAmount;
@@ -40,6 +64,15 @@ function getSignedTokenAmount(tokenAmount, balanceType) {
     }
 }
 exports.getSignedTokenAmount = 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`
+ */
 function getStrictTokenValue(tokenAmount, spotDecimals, oraclePriceData, oraclePriceTwap) {
     if (tokenAmount.eq(numericConstants_1.ZERO)) {
         return numericConstants_1.ZERO;
@@ -55,6 +88,14 @@ function getStrictTokenValue(tokenAmount, spotDecimals, oraclePriceData, oracleP
     return tokenAmount.mul(price).div(precisionDecrease);
 }
 exports.getStrictTokenValue = getStrictTokenValue;
+/**
+ * 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`
+ */
 function getTokenValue(tokenAmount, spotDecimals, oraclePriceData) {
     if (tokenAmount.eq(numericConstants_1.ZERO)) {
         return numericConstants_1.ZERO;

package/lib/token/index.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="node" />
-import { AccountInfo } from '@solana/spl-token';
-export declare function parseTokenAccount(data: Buffer): AccountInfo;
+import { Account } from '@solana/spl-token';
+import { PublicKey } from '@solana/web3.js';
+export declare function parseTokenAccount(data: Buffer, pubkey: PublicKey): Account;