\n\n## Installation\n\n```\nnpm i @double-mangoes/drift-sdk\n```\n\n## Getting Started\n\n### Setting up a wallet for your program\n\n```bash\n# Generate a keypair\nsolana-keygen new\n\n# Get the pubkey for the new wallet (You will need to send USDC to this address to Deposit into Drift (only on mainnet - devnet has a faucet for USDC))\nsolana address\n\n# Put the private key into your .env to be used by your bot\ncd {projectLocation}\necho BOT_PRIVATE_KEY=`cat ~/.config/solana/id.json` >> .env\n```\n\n## Concepts\n\n### BN / Precision\n\nThe Drift SDK uses BigNum (BN), using [this package](https://github.com/indutny/bn.js/), to represent numerical values. This is because Solana tokens tend to use levels of precision which are too precise for standard Javascript floating point numbers to handle. All numbers in BN are represented as integers, and we will often denote the `precision` of the number so that it can be converted back down to a regular number.\n\n```bash\nExample:\na BigNum: 10,500,000, with precision 10^6, is equal to 10.5 because 10,500,000 / 10^6 = 10.5.\n```\n\nThe Drift SDK uses some common precisions, which are available as constants to import from the SDK.\n\n| Precision Name | Value |\n| --------------------- | ----- |\n| FUNDING_RATE_BUFFER | 10^3 |\n| QUOTE_PRECISION | 10^6 |\n| PEG_PRECISION | 10^6 |\n| PRICE_PRECISION | 10^6 |\n| AMM_RESERVE_PRECISION | 10^9 |\n| BASE_PRECISION | 10^9 |\n\n**Important Note for BigNum division**\n\nBecause BN only supports integers, you need to be conscious of the numbers you are using when dividing. BN will return the floor when using the regular division function; if you want to get the exact division, you need to add the modulus of the two numbers as well. There is a helper function `convertToNumber` in the SDK which will do this for you.\n\n```typescript\nimport {convertToNumber} from @double-mangoes/drift-sdk\n\n// Gets the floor value\nnew BN(10500).div(new BN(1000)).toNumber(); // = 10\n\n// Gets the exact value\nnew BN(10500).div(new BN(1000)).toNumber() + BN(10500).mod(new BN(1000)).toNumber(); // = 10.5\n\n// Also gets the exact value\nconvertToNumber(new BN(10500), new BN(1000)); // = 10.5\n```\n\n## Examples\n\n### Setting up an account and making a trade\n\n```typescript\nimport { AnchorProvider, BN } from '@coral-xyz/anchor';\nimport { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token';\nimport { Connection, Keypair, PublicKey } from '@solana/web3.js';\nimport {\n\tcalculateReservePrice,\n\tDriftClient,\n\tUser,\n\tinitialize,\n\tPositionDirection,\n\tconvertToNumber,\n\tcalculateTradeSlippage,\n\tPRICE_PRECISION,\n\tQUOTE_PRECISION,\n\tWallet,\n\tPerpMarkets,\n\tBASE_PRECISION,\n\tgetMarketOrderParams,\n\tBulkAccountLoader,\n\tgetMarketsAndOraclesForSubscription\n} from '../sdk';\n\nexport const getTokenAddress = (\n\tmintAddress: string,\n\tuserPubKey: string\n): Promise => {\n\treturn Token.getAssociatedTokenAddress(\n\t\tnew PublicKey(`ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL`),\n\t\tTOKEN_PROGRAM_ID,\n\t\tnew PublicKey(mintAddress),\n\t\tnew PublicKey(userPubKey)\n\t);\n};\n\nconst main = async () => {\n\tconst env = 'devnet';\n\t// Initialize Drift SDK\n\tconst sdkConfig = initialize({ env });\n\n\t// Set up the Wallet and Provider\n\tconst privateKey = process.env.BOT_PRIVATE_KEY; // stored as an array string\n\tconst keypair = Keypair.fromSecretKey(\n\t\tUint8Array.from(JSON.parse(privateKey))\n\t);\n\tconst wallet = new Wallet(keypair);\n\n\t// Set up the Connection\n\tconst rpcAddress = process.env.RPC_ADDRESS; // can use: https://api.devnet.solana.com for devnet; https://api.mainnet-beta.solana.com for mainnet;\n\tconst connection = new Connection(rpcAddress);\n\n\t// Set up the Provider\n\tconst provider = new AnchorProvider(\n\t\tconnection,\n\t\twallet,\n\t\tAnchorProvider.defaultOptions()\n\t);\n\n\t// Check SOL Balance\n\tconst lamportsBalance = await connection.getBalance(wallet.publicKey);\n\tconsole.log('SOL balance:', lamportsBalance / 10 ** 9);\n\n\t// Misc. other things to set up\n\tconst usdcTokenAddress = await getTokenAddress(\n\t\tsdkConfig.USDC_MINT_ADDRESS,\n\t\twallet.publicKey.toString()\n\t);\n\n\t// Set up the Drift Client\n\tconst driftPublicKey = new PublicKey(sdkConfig.DRIFT_PROGRAM_ID);\n\tconst bulkAccountLoader = new BulkAccountLoader(\n\t\tconnection,\n\t\t'confirmed',\n\t\t1000\n\t);\n\tconst driftClient = new DriftClient({\n\t\tconnection,\n\t\twallet: provider.wallet,\n\t\tprogramID: driftPublicKey,\n\t\t...getMarketsAndOraclesForSubscription(env),\n\t\taccountSubscription: {\n\t\t\ttype: 'polling',\n\t\t\taccountLoader: bulkAccountLoader,\n\t\t},\n\t});\n\tawait driftClient.subscribe();\n\n\t// Set up user client\n\tconst user = new User({\n\t\tdriftClient: driftClient,\n\t\tuserAccountPublicKey: await driftClient.getUserAccountPublicKey(),\n\t\taccountSubscription: {\n\t\t\ttype: 'polling',\n\t\t\taccountLoader: bulkAccountLoader,\n\t\t},\n\t});\n\n\t//// Check if user account exists for the current wallet\n\tconst userAccountExists = await user.exists();\n\n\tif (!userAccountExists) {\n\t\t//// Create a Clearing House account by Depositing some USDC ($10,000 in this case)\n\t\tconst depositAmount = new BN(10000).mul(QUOTE_PRECISION);\n\t\tawait driftClient.initializeUserAccountAndDepositCollateral(\n\t\t\tdepositAmount,\n\t\t\tawait getTokenAddress(\n\t\t\t\tusdcTokenAddress.toString(),\n\t\t\t\twallet.publicKey.toString()\n\t\t\t)\n\t\t);\n\t}\n\n\tawait user.subscribe();\n\n\t// Get current price\n\tconst solMarketInfo = PerpMarkets[env].find(\n\t\t(market) => market.baseAssetSymbol === 'SOL'\n\t);\n\n\tconst [bid, ask] = calculateBidAskPrice(\n\t\tdriftClient.getPerpMarketAccount(marketIndex).amm,\n\t\tdriftClient.getOracleDataForPerpMarket(marketIndex)\n\t);\n\n\tconst formattedBidPrice = convertToNumber(bid, PRICE_PRECISION);\n\tconst formattedAskPrice = convertToNumber(ask, PRICE_PRECISION);\n\n\tconsole.log(\n\t\t`Current amm bid and ask price are $${formattedBidPrice} and $${formattedAskPrice}`\n\t);\n\n\t// Estimate the slippage for a $5000 LONG trade\n\tconst solMarketAccount = driftClient.getPerpMarketAccount(\n\t\tsolMarketInfo.marketIndex\n\t);\n\n\tconst slippage = convertToNumber(\n\t\tcalculateTradeSlippage(\n\t\t\tPositionDirection.LONG,\n\t\t\tnew BN(1).mul(BASE_PRECISION),\n\t\t\tsolMarketAccount,\n\t\t\t'base',\n\t\t\tdriftClient.getOracleDataForPerpMarket(solMarketInfo.marketIndex)\n\t\t)[0],\n\t\tPRICE_PRECISION\n\t);\n\n\tconsole.log(`Slippage for a 1 SOL-PERP would be $${slippage}`);\n\n\tawait driftClient.placePerpOrder(\n\t\tgetMarketOrderParams({\n\t\t\tbaseAssetAmount: new BN(1).mul(BASE_PRECISION),\n\t\t\tdirection: PositionDirection.LONG,\n\t\t\tmarketIndex: solMarketAccount.marketIndex,\n\t\t})\n\t);\n\tconsole.log(`Placed a 1 SOL-PERP LONG order`);\n};\n\nmain();\n```\n\n## License\n\nDrift Protocol v2 is licensed under [Apache 2.0](./LICENSE).\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in Drift SDK by you, as defined in the Apache-2.0 license, shall be\nlicensed as above, without any additional terms or conditions.\n\n","readmeFilename":"README.md"}
![](\"https://uploads-ssl.webflow.com/611580035ad59b20437eb024/616f97a42f5637c4517d0193_Logo%20(1)%20(1).png\")
\n\n ![\"SDK](\"https://img.shields.io/npm/v/@double-mangoes/drift-sdk\")
![\"Docs\"](\"https://img.shields.io/badge/docs-tutorials-blueviolet\"){kind=icon}
![\"Discord](\"https://img.shields.io/discord/889577356681945098?color=blueviolet\")
![\"License\"](\"https://img.shields.io/github/license/project-serum/anchor?color=blueviolet\")