@drift-labs/sdk 0.2.0-temp.0 → 0.2.0-temp.1

package/lib/{mockUSDCFaucet.js → tokenFaucet.js}

@@ -26,74 +26,75 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockUSDCFaucet = void 0;
+exports.TokenFaucet = void 0;
 const anchor = __importStar(require("@project-serum/anchor"));
 const anchor_1 = require("@project-serum/anchor");
 const spl_token_1 = require("@solana/spl-token");
 const web3_js_1 = require("@solana/web3.js");
-const mock_usdc_faucet_json_1 = __importDefault(require("./idl/mock_usdc_faucet.json"));
-class MockUSDCFaucet {
-    constructor(connection, wallet, programId, opts) {
+const token_faucet_json_1 = __importDefault(require("./idl/token_faucet.json"));
+class TokenFaucet {
+    constructor(connection, wallet, programId, mint, opts) {
         this.connection = connection;
         this.wallet = wallet;
         this.opts = opts || anchor_1.AnchorProvider.defaultOptions();
         const provider = new anchor_1.AnchorProvider(connection, wallet, this.opts);
         this.provider = provider;
-        this.program = new anchor_1.Program(mock_usdc_faucet_json_1.default, programId, provider);
+        this.program = new anchor_1.Program(token_faucet_json_1.default, programId, provider);
+        this.mint = mint;
     }
-    async getMockUSDCFaucetStatePublicKeyAndNonce() {
-        return anchor.web3.PublicKey.findProgramAddress([Buffer.from(anchor.utils.bytes.utf8.encode('mock_usdc_faucet'))], this.program.programId);
+    async getFaucetConfigPublicKeyAndNonce() {
+        return anchor.web3.PublicKey.findProgramAddress([
+            Buffer.from(anchor.utils.bytes.utf8.encode('faucet_config')),
+            this.mint.toBuffer(),
+        ], this.program.programId);
     }
-    async getMockUSDCFaucetStatePublicKey() {
-        if (this.mockUSDCFaucetStatePublicKey) {
-            return this.mockUSDCFaucetStatePublicKey;
-        }
-        this.mockUSDCFaucetStatePublicKey = (await this.getMockUSDCFaucetStatePublicKeyAndNonce())[0];
-        return this.mockUSDCFaucetStatePublicKey;
+    async getMintAuthority() {
+        return (await anchor.web3.PublicKey.findProgramAddress([
+            Buffer.from(anchor.utils.bytes.utf8.encode('mint_authority')),
+            this.mint.toBuffer(),
+        ], this.program.programId))[0];
+    }
+    async getFaucetConfigPublicKey() {
+        return (await this.getFaucetConfigPublicKeyAndNonce())[0];
     }
     async initialize() {
-        const stateAccountRPCResponse = await this.connection.getParsedAccountInfo(await this.getMockUSDCFaucetStatePublicKey());
-        if (stateAccountRPCResponse.value !== null) {
-            throw new Error('Faucet already initialized');
-        }
-        const fakeUSDCMint = anchor.web3.Keypair.generate();
-        const createUSDCMintAccountIx = web3_js_1.SystemProgram.createAccount({
-            fromPubkey: this.wallet.publicKey,
-            newAccountPubkey: fakeUSDCMint.publicKey,
-            lamports: await spl_token_1.Token.getMinBalanceRentForExemptMint(this.connection),
-            space: spl_token_1.MintLayout.span,
-            programId: spl_token_1.TOKEN_PROGRAM_ID,
-        });
-        const [mintAuthority, _mintAuthorityNonce] = await web3_js_1.PublicKey.findProgramAddress([fakeUSDCMint.publicKey.toBuffer()], this.program.programId);
-        const initUSDCMintIx = spl_token_1.Token.createInitMintInstruction(spl_token_1.TOKEN_PROGRAM_ID, fakeUSDCMint.publicKey, 6, mintAuthority, null);
-        const [mockUSDCFaucetStatePublicKey, mockUSDCFaucetStateNonce] = await this.getMockUSDCFaucetStatePublicKeyAndNonce();
-        return await this.program.rpc.initialize(mockUSDCFaucetStateNonce, {
+        const [faucetConfigPublicKey] = await this.getFaucetConfigPublicKeyAndNonce();
+        return await this.program.rpc.initialize({
             accounts: {
-                mockUsdcFaucetState: mockUSDCFaucetStatePublicKey,
+                faucetConfig: faucetConfigPublicKey,
                 admin: this.wallet.publicKey,
-                mintAccount: fakeUSDCMint.publicKey,
+                mintAccount: this.mint,
                 rent: web3_js_1.SYSVAR_RENT_PUBKEY,
                 systemProgram: anchor.web3.SystemProgram.programId,
+                tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
-            instructions: [createUSDCMintAccountIx, initUSDCMintIx],
-            signers: [fakeUSDCMint],
         });
     }
     async fetchState() {
-        return await this.program.account.mockUsdcFaucetState.fetch(await this.getMockUSDCFaucetStatePublicKey());
+        return await this.program.account.faucetConfig.fetch(await this.getFaucetConfigPublicKey());
     }
     async mintToUser(userTokenAccount, amount) {
-        const state = await this.fetchState();
         return await this.program.rpc.mintToUser(amount, {
             accounts: {
-                mockUsdcFaucetState: await this.getMockUSDCFaucetStatePublicKey(),
-                mintAccount: state.mint,
+                faucetConfig: await this.getFaucetConfigPublicKey(),
+                mintAccount: this.mint,
                 userTokenAccount,
-                mintAuthority: state.mintAuthority,
+                mintAuthority: await this.getMintAuthority(),
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
         });
     }
+    async transferMintAuthority() {
+        return await this.program.rpc.transferMintAuthority({
+            accounts: {
+                faucetConfig: await this.getFaucetConfigPublicKey(),
+                mintAccount: this.mint,
+                mintAuthority: await this.getMintAuthority(),
+                tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
+                admin: this.wallet.publicKey,
+            },
+        });
+    }
     async createAssociatedTokenAccountAndMintTo(userPublicKey, amount) {
         const [associatedTokenPublicKey, createAssociatedAccountIx, mintToTx] = await this.createAssociatedTokenAccountAndMintToInstructions(userPublicKey, amount);
         const tx = new web3_js_1.Transaction().add(createAssociatedAccountIx).add(mintToTx);
@@ -106,7 +107,7 @@ class MockUSDCFaucet {
         const createAssociatedAccountIx = spl_token_1.Token.createAssociatedTokenAccountInstruction(spl_token_1.ASSOCIATED_TOKEN_PROGRAM_ID, spl_token_1.TOKEN_PROGRAM_ID, state.mint, associateTokenPublicKey, userPublicKey, this.wallet.publicKey);
         const mintToIx = await this.program.instruction.mintToUser(amount, {
             accounts: {
-                mockUsdcFaucetState: await this.getMockUSDCFaucetStatePublicKey(),
+                faucetConfig: await this.getFaucetConfigPublicKey(),
                 mintAccount: state.mint,
                 userTokenAccount: associateTokenPublicKey,
                 mintAuthority: state.mintAuthority,
@@ -143,4 +144,4 @@ class MockUSDCFaucet {
         }
     }
 }
-exports.MockUSDCFaucet = MockUSDCFaucet;
+exports.TokenFaucet = TokenFaucet;

package/lib/tx/utils.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapInTx = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const COMPUTE_UNITS_DEFAULT = 200000;
-function wrapInTx(instruction, computeUnits = 500000 // TODO, requires less code change
+function wrapInTx(instruction, computeUnits = 600000 // TODO, requires less code change
 ) {
     const tx = new web3_js_1.Transaction();
     if (computeUnits != COMPUTE_UNITS_DEFAULT) {

package/lib/types.d.ts

@@ -25,6 +25,14 @@ export declare class PositionDirection {
         short: {};
     };
 }
+export declare class DepositDirection {
+    static readonly DEPOSIT: {
+        deposit: {};
+    };
+    static readonly WITHDRAW: {
+        withdraw: {};
+    };
+}
 export declare class OracleSource {
     static readonly PYTH: {
         pyth: {};
@@ -92,6 +100,20 @@ export declare class OrderAction {
         trigger: {};
     };
 }
+export declare class OrderActionExplanation {
+    static readonly NONE: {
+        none: {};
+    };
+    static readonly BREACHED_MARGIN_REQUIREMENT: {
+        breachedMarginRequirement: {};
+    };
+    static readonly ORACLE_PRICE_BREACHED_LIMIT_PRICE: {
+        oraclePriceBreachedLimitPrice: {};
+    };
+    static readonly MARKET_ORDER_FILLED_TO_LIMIT_PRICE: {
+        marketOrderFilledToLimitPrice: {};
+    };
+}
 export declare class OrderTriggerCondition {
     static readonly ABOVE: {
         above: {};
@@ -118,6 +140,7 @@ export declare type DepositRecord = {
     };
     bankIndex: BN;
     amount: BN;
+    oraclePrice: BN;
     from?: PublicKey;
     to?: PublicKey;
 };
@@ -164,20 +187,66 @@ export declare type FundingPaymentRecord = {
 };
 export declare type LiquidationRecord = {
     ts: BN;
-    recordId: BN;
-    userAuthority: PublicKey;
     user: PublicKey;
-    partial: boolean;
-    baseAssetValue: BN;
-    baseAssetValueClosed: BN;
-    liquidationFee: BN;
-    feeToLiquidator: BN;
-    feeToInsuranceFund: BN;
     liquidator: PublicKey;
+    liquidationType: LiquidationType;
+    marginRequirement: BN;
     totalCollateral: BN;
-    collateral: BN;
-    unrealizedPnl: BN;
-    marginRatio: BN;
+    liquidatePerp: LiquidatePerpRecord;
+    liquidateBorrow: LiquidateBorrowRecord;
+    liquidateBorrowForPerpPnl: LiquidateBorrowForPerpPnlRecord;
+    liquidatePerpPnlForDeposit: LiquidatePerpPnlForDepositRecord;
+};
+export declare class LiquidationType {
+    static readonly LIQUIDATE_PERP: {
+        liquidatePerp: {};
+    };
+    static readonly LIQUIDATE_BORROW: {
+        liquidateBorrow: {};
+    };
+    static readonly LIQUIDATE_BORROW_FOR_PERP_PNL: {
+        liquidateBorrowForPerpPnl: {};
+    };
+    static readonly LIQUIDATE_PERP_PNL_FOR_DEPOSIT: {
+        liquidatePerpPnlForDeposit: {};
+    };
+}
+export declare type LiquidatePerpRecord = {
+    marketIndex: BN;
+    orderIds: BN[];
+    oraclePrice: BN;
+    baseAssetAmount: BN;
+    quoteAssetAmount: BN;
+    userPnl: BN;
+    liquidatorPnl: BN;
+    canceledOrdersFee: BN;
+    userOrderId: BN;
+    liquidatorOrderId: BN;
+    fillRecordId: BN;
+};
+export declare type LiquidateBorrowRecord = {
+    assetBankIndex: BN;
+    assetPrice: BN;
+    assetTransfer: BN;
+    liabilityBankIndex: BN;
+    liabilityPrice: BN;
+    liabilityTransfer: BN;
+};
+export declare type LiquidateBorrowForPerpPnlRecord = {
+    marketIndex: BN;
+    marketOraclePrice: BN;
+    pnlTransfer: BN;
+    liabilityBankIndex: BN;
+    liabilityPrice: BN;
+    liabilityTransfer: BN;
+};
+export declare type LiquidatePerpPnlForDepositRecord = {
+    marketIndex: BN;
+    marketOraclePrice: BN;
+    pnlTransfer: BN;
+    assetBankIndex: BN;
+    assetPrice: BN;
+    assetTransfer: BN;
 };
 export declare type OrderRecord = {
     ts: BN;
@@ -185,7 +254,10 @@ export declare type OrderRecord = {
     maker: PublicKey;
     takerOrder: Order;
     makerOrder: Order;
+    takerUnsettledPnl: BN;
+    makerUnsettledPnl: BN;
     action: OrderAction;
+    actionExplanation: OrderActionExplanation;
     filler: PublicKey;
     fillRecordId: BN;
     marketIndex: BN;
@@ -238,9 +310,9 @@ export declare type MarketAccount = {
     openInterest: BN;
     marginRatioInitial: number;
     marginRatioMaintenance: number;
-    marginRatioPartial: number;
     nextFillRecordId: BN;
     pnlPool: PoolBalance;
+    liquidationFee: BN;
 };
 export declare type BankAccount = {
     bankIndex: BN;
@@ -263,6 +335,7 @@ export declare type BankAccount = {
     maintenanceAssetWeight: BN;
     initialLiabilityWeight: BN;
     maintenanceLiabilityWeight: BN;
+    liquidationFee: BN;
 };
 export declare type PoolBalance = {
     balance: BN;
@@ -277,6 +350,8 @@ export declare type AMM = {
     lastMarkPriceTwapTs: BN;
     lastOraclePriceTwap: BN;
     lastOraclePriceTwapTs: BN;
+    lastOracleMarkSpreadPct: BN;
+    lastOracleConfPct: BN;
     oracle: PublicKey;
     oracleSource: OracleSource;
     fundingPeriod: BN;
@@ -291,6 +366,8 @@ export declare type AMM = {
     totalFee: BN;
     minimumQuoteAssetTradeSize: BN;
     baseAssetAmountStepSize: BN;
+    maxBaseAssetAmountRatio: number;
+    maxSlippageRatio: number;
     lastOraclePrice: BN;
     baseSpread: number;
     curveUpdateIntensity: number;
@@ -336,6 +413,7 @@ export declare type UserAccount = {
     };
     positions: UserPosition[];
     orders: Order[];
+    beingLiquidated: boolean;
 };
 export declare type UserBankBalance = {
     bankIndex: BN;
@@ -375,7 +453,6 @@ export declare type OrderParams = {
     orderType: OrderType;
     userOrderId: number;
     direction: PositionDirection;
-    quoteAssetAmount: BN;
     baseAssetAmount: BN;
     price: BN;
     marketIndex: BN;
@@ -393,10 +470,50 @@ export declare type OrderParams = {
         referrer: boolean;
     };
 };
+export declare type NecessaryOrderParams = {
+    orderType: OrderType;
+    marketIndex: BN;
+    baseAssetAmount: BN;
+    direction: PositionDirection;
+};
+export declare type OptionalOrderParams = {
+    [Property in keyof OrderParams]?: OrderParams[Property];
+} & NecessaryOrderParams;
+export declare const DefaultOrderParams: {
+    orderType: {
+        market: {};
+    };
+    userOrderId: number;
+    direction: {
+        long: {};
+    };
+    baseAssetAmount: BN;
+    price: BN;
+    marketIndex: BN;
+    reduceOnly: boolean;
+    postOnly: boolean;
+    immediateOrCancel: boolean;
+    triggerPrice: BN;
+    triggerCondition: {
+        above: {};
+    };
+    positionLimit: BN;
+    oraclePriceOffset: BN;
+    padding0: BN;
+    padding1: BN;
+    optionalAccounts: {
+        discountToken: boolean;
+        referrer: boolean;
+    };
+};
 export declare type MakerInfo = {
     maker: PublicKey;
     order: Order;
 };
+export declare type TakerInfo = {
+    taker: PublicKey;
+    order: Order;
+};
 export interface IWallet {
     signTransaction(tx: Transaction): Promise<Transaction>;
     signAllTransactions(txs: Transaction[]): Promise<Transaction[]>;
@@ -436,6 +553,7 @@ export declare type FeeStructure = {
     makerRebateNumerator: BN;
     makerRebateDenominator: BN;
     fillerRewardStructure: OrderFillerRewardStructure;
+    cancelOrderFee: BN;
 };
 export declare type OracleGuardRails = {
     priceDivergence: {
@@ -454,4 +572,4 @@ export declare type OrderFillerRewardStructure = {
     rewardDenominator: BN;
     timeBasedRewardLowerBound: BN;
 };
-export declare type MarginCategory = 'Initial' | 'Partial' | 'Maintenance';
+export declare type MarginCategory = 'Initial' | 'Maintenance';

package/lib/types.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TradeSide = exports.isOneOfVariant = exports.isVariant = exports.OrderTriggerCondition = exports.OrderAction = exports.OrderDiscountTier = exports.OrderStatus = exports.OrderType = exports.OracleSource = exports.PositionDirection = exports.BankBalanceType = exports.SwapDirection = void 0;
+exports.DefaultOrderParams = exports.LiquidationType = exports.TradeSide = exports.isOneOfVariant = exports.isVariant = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderDiscountTier = exports.OrderStatus = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.BankBalanceType = exports.SwapDirection = void 0;
+const _1 = require(".");
 // # Utility Types / Enums / Constants
 class SwapDirection {
 }
@@ -17,6 +18,11 @@ class PositionDirection {
 exports.PositionDirection = PositionDirection;
 PositionDirection.LONG = { long: {} };
 PositionDirection.SHORT = { short: {} };
+class DepositDirection {
+}
+exports.DepositDirection = DepositDirection;
+DepositDirection.DEPOSIT = { deposit: {} };
+DepositDirection.WITHDRAW = { withdraw: {} };
 class OracleSource {
 }
 exports.OracleSource = OracleSource;
@@ -51,6 +57,19 @@ OrderAction.CANCEL = { cancel: {} };
 OrderAction.EXPIRE = { expire: {} };
 OrderAction.FILL = { fill: {} };
 OrderAction.TRIGGER = { trigger: {} };
+class OrderActionExplanation {
+}
+exports.OrderActionExplanation = OrderActionExplanation;
+OrderActionExplanation.NONE = { none: {} };
+OrderActionExplanation.BREACHED_MARGIN_REQUIREMENT = {
+    breachedMarginRequirement: {},
+};
+OrderActionExplanation.ORACLE_PRICE_BREACHED_LIMIT_PRICE = {
+    oraclePriceBreachedLimitPrice: {},
+};
+OrderActionExplanation.MARKET_ORDER_FILLED_TO_LIMIT_PRICE = {
+    marketOrderFilledToLimitPrice: {},
+};
 class OrderTriggerCondition {
 }
 exports.OrderTriggerCondition = OrderTriggerCondition;
@@ -72,3 +91,35 @@ var TradeSide;
     TradeSide[TradeSide["Buy"] = 1] = "Buy";
     TradeSide[TradeSide["Sell"] = 2] = "Sell";
 })(TradeSide = exports.TradeSide || (exports.TradeSide = {}));
+class LiquidationType {
+}
+exports.LiquidationType = LiquidationType;
+LiquidationType.LIQUIDATE_PERP = { liquidatePerp: {} };
+LiquidationType.LIQUIDATE_BORROW = { liquidateBorrow: {} };
+LiquidationType.LIQUIDATE_BORROW_FOR_PERP_PNL = {
+    liquidateBorrowForPerpPnl: {},
+};
+LiquidationType.LIQUIDATE_PERP_PNL_FOR_DEPOSIT = {
+    liquidatePerpPnlForDeposit: {},
+};
+exports.DefaultOrderParams = {
+    orderType: OrderType.MARKET,
+    userOrderId: 0,
+    direction: PositionDirection.LONG,
+    baseAssetAmount: _1.ZERO,
+    price: _1.ZERO,
+    marketIndex: _1.ZERO,
+    reduceOnly: false,
+    postOnly: false,
+    immediateOrCancel: false,
+    triggerPrice: _1.ZERO,
+    triggerCondition: OrderTriggerCondition.ABOVE,
+    positionLimit: _1.ZERO,
+    oraclePriceOffset: _1.ZERO,
+    padding0: _1.ZERO,
+    padding1: _1.ZERO,
+    optionalAccounts: {
+        discountToken: false,
+        referrer: false,
+    },
+};

package/lib/util/computeUnits.js

@@ -4,7 +4,7 @@ exports.findComputeUnitConsumption = void 0;
 async function findComputeUnitConsumption(programId, connection, txSignature, commitment = 'confirmed') {
     const tx = await connection.getTransaction(txSignature, { commitment });
     const computeUnits = [];
-    const regex = new RegExp(`Program ${programId.toString()} consumed ([0-9]{0,6}) of 200000 compute units`);
+    const regex = new RegExp(`Program ${programId.toString()} consumed ([0-9]{0,6}) of ([0-9]{0,7}) compute units`);
     tx.meta.logMessages.forEach((logMessage) => {
         const match = logMessage.match(regex);
         if (match && match[1]) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "0.2.0-temp.0",
+	"version": "0.2.0-temp.1",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",
@@ -30,7 +30,7 @@
 	},
 	"dependencies": {
 		"@project-serum/anchor": "0.24.2",
-		"@pythnetwork/client": "2.5.1",
+		"@pythnetwork/client": "2.5.3",
 		"@solana/spl-token": "^0.1.6",
 		"@solana/web3.js": "1.41.0",
 		"@switchboard-xyz/switchboard-v2": "^0.0.67",
@@ -39,10 +39,10 @@
 	},
 	"devDependencies": {
 		"@types/chai": "^4.3.1",
+		"@types/jest": "^28.1.3",
 		"@types/mocha": "^9.1.1",
 		"@typescript-eslint/eslint-plugin": "^4.28.0",
 		"@typescript-eslint/parser": "^4.28.0",
-		"@types/jest": "^28.1.3",
 		"chai": "^4.3.6",
 		"eslint": "^7.29.0",
 		"eslint-config-prettier": "^8.3.0",