initial commit

Author: wphan

.env.example

@@ -0,0 +1,2 @@
+PRIVATE_KEY=/path/to/keypair.json
+RPC_URL=mainnet.rpc.com

.gitignore

@@ -0,0 +1,175 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

README.md

@@ -0,0 +1,30 @@
+# drift-examples
+
+Examples here are written using `bun` 1.1.9. If you using `node`, recommended version is v20.18.0. And use [`@drift-labs/sdk`](https://www.npmjs.com/package/@drift-labs/sdk).
+If you are using the drift sdk in browser environment, it's recommended to use [`@drift-labs/sdk-browser`](https://www.npmjs.com/package/@drift-labs/sdk-browser) instead.
+
+## Install dependencies:
+
+```bash
+bun install
+```
+
+All examples require the following environment variables:
+
+- `PRIVATE_KEY`: The private key of the account to use, can be:
+    - numbers array (from `solana-keygen new`)
+	- base58 encoded private key (phantom exported private key)
+	- a file to any of the above
+- `RPC_URL`: The RPC URL of the network to use for the example, you need a proper one
+    - https://helius.xyz/
+	- https://www.triton.one/
+
+
+## Run Examples
+
+Each file under `examples/` is an example, start with:
+
+```bash
+bun run example/1_init_user.ts
+```
+

bun.lockb

@@ -0,0 +1,44 @@
+/**
+ * This example demonstrates how to initialize a new user account. This step is not required
+ * if you have already created a drift account on the drift UI.
+ */
+import {
+	DriftClient,
+	Wallet,
+	loadKeypair,
+} from "@drift-labs/sdk";
+import { Connection } from "@solana/web3.js";
+
+const privateKey = process.env.PRIVATE_KEY;
+if (!privateKey) {
+	throw new Error("PRIVATE_KEY environment variable is not set");
+}
+
+const rpcUrl = process.env.RPC_URL;
+if (!rpcUrl) {
+	throw new Error("RPC_URL environment variable is not set");
+}
+
+const keypair = loadKeypair(privateKey);
+console.log(`Using keypair for user: ${keypair.publicKey.toBase58()}`);
+
+const connection = new Connection(rpcUrl);
+const driftClient = new DriftClient({
+	connection,
+	wallet: new Wallet(keypair),
+	env: "mainnet-beta",
+});
+await driftClient.subscribe();
+
+// subaccount 0 is default
+try {
+	const user = driftClient.getUser(0);
+	console.log(`User 0 already exists: ${user.userAccountPublicKey.toBase58()}`);
+} catch (e) {
+	console.log(`User does not exist, initializing...`);
+	const [tx, userAccountPublicKey] = await driftClient.initializeUserAccount(0);
+	console.log(`User initialized subsaccount 0: ${userAccountPublicKey.toBase58()}`);
+	console.log(`https://solscan.io/tx/${tx}`);
+}
+
+process.exit(0);

examples/1_init_user.ts

@@ -0,0 +1,55 @@
+/**
+ * This example demonstrates how to deposit spot assets into a user account.
+ *
+ * You can get spot market indexes from:
+ *   * `View Details` from the spot market on https://app.drift.trade
+ *   * Streamlit: https://analytics.drift.trade/?tab=Overview-Markets
+ *   * spot markets constants file: https://github.com/drift-labs/protocol-v2/blob/master/sdk/src/constants/spotMarkets.ts
+ */
+import {
+	DriftClient,
+	BN,
+	QUOTE_PRECISION,
+	Wallet,
+	loadKeypair,
+} from "@drift-labs/sdk";
+import { Connection } from "@solana/web3.js";
+
+const privateKey = process.env.PRIVATE_KEY;
+if (!privateKey) {
+	throw new Error("PRIVATE_KEY environment variable is not set");
+}
+
+const rpcUrl = process.env.RPC_URL;
+if (!rpcUrl) {
+	throw new Error("RPC_URL environment variable is not set");
+}
+
+const keypair = loadKeypair(privateKey);
+console.log(`Using keypair for user: ${keypair.publicKey.toBase58()}`);
+
+const connection = new Connection(rpcUrl);
+const driftClient = new DriftClient({
+	connection,
+	wallet: new Wallet(keypair),
+	env: "mainnet-beta",
+});
+await driftClient.subscribe();
+
+const spotMarketIndex = 0; // USDC
+const depositAmount = new BN(100).mul(QUOTE_PRECISION);
+
+const tx = await driftClient.deposit(
+	depositAmount,
+	spotMarketIndex,
+	// helper function to get ATA for spot market mint
+	await driftClient.getAssociatedTokenAccount(0),
+	0, // default will deposit to subaccount 0
+	undefined,
+	{
+		computeUnitsPrice: 10_000,
+	},
+)
+console.log(`Deposit tx: https://solscan.io/tx/${tx}`);
+
+process.exit(0);