# Quick Start

Get the ksUSD vault running locally or talking to devnet.

***

## Prerequisites

| Tool       | Version                |
| ---------- | ---------------------- |
| Rust       | 1.79+ (rustup-managed) |
| Anchor CLI | 0.31.1+                |
| Solana CLI | 1.18+                  |
| Node.js    | 20+                    |

```bash
git clone https://github.com/kamwithak/keystone-contracts.git
cd keystone-contracts
npm install
```

***

## Program ID

| Network | Program ID                                     |
| ------- | ---------------------------------------------- |
| Devnet  | `HvsAc157bJ7Pd4uGr7xssHMifGs6RMbPu14ZMsiEABWT` |
| Mainnet | *pending audit*                                |

* Single Anchor program: `keystone_finance`
* Implements the ksUSD vault end-to-end
* 29 instructions · 39 errors · 19 events · 2 account types

***

## Build

```bash
# Rust check (fast, no BPF toolchain required)
cargo check -p keystone-finance

# Generate / refresh IDL from source (uses idl-build feature)
PATH="$HOME/.cargo/bin:$PATH" anchor idl build \
  -o target/idl/keystone_finance.json
```

* IDL: `target/idl/keystone_finance.json` — regenerated to match latest source
* TS types: `target/types/keystone_finance.ts` — derived from the IDL

***

## Initialize the devnet vault

```bash
npx tsx scripts/devnet/init.neutral.ts
```

* Creates the vault PDA at seeds `[b"vault"]`
* Generates a fresh `ksUSD` mint keypair
* Calls `initialize` with default risk parameters:
  * 10% liquidity buffer
  * +2% / −12% funding thresholds
  * 20% perf fee · 5% reserve skim
  * $1M deposit cap

***

## Round-trip test

```bash
npx tsx scripts/devnet/test-roundtrip.ts
```

Exercises the user flow end-to-end against the deployed vault:

1. Verifies the vault exists; mints test USDC to the wallet if the wallet holds USDC mint authority.
2. `deposit` — USDC in, ksUSD out at $1.00 share price on first deposit.
3. `withdraw_instant` — partial redemption from the liquidity buffer.
4. `request_withdrawal` + `process_withdrawal` — queued path; verifies the request PDA is closed and rent refunded.

> Strategy paths (`open_position`, `open_reverse`, `settle`) are **not** exercised here — they require Drift devnet account scaffolding. Covered by the keeper bot: [Keeper bot](/for-operators/keeper-bot.md).

***

## TypeScript client

```ts
import * as anchor from "@coral-xyz/anchor";
import { Program } from "@coral-xyz/anchor";
import { Connection, PublicKey } from "@solana/web3.js";
import idl from "../target/idl/keystone_finance.json" with { type: "json" };

const PROGRAM_ID = new PublicKey("HvsAc157bJ7Pd4uGr7xssHMifGs6RMbPu14ZMsiEABWT");
const connection = new Connection("https://api.devnet.solana.com", "confirmed");

const provider = new anchor.AnchorProvider(connection, wallet, { commitment: "confirmed" });
anchor.setProvider(provider);

const program = new Program(idl as any, provider);

const [vaultPda] = PublicKey.findProgramAddressSync(
  [Buffer.from("vault")],
  PROGRAM_ID
);

const vault = await program.account.vault.fetch(vaultPda);
```

***

## Related

* [Instructions reference](/for-developers/instructions.md) — all 29 entry points
* [Account structure](/for-developers/accounts.md) — `Vault` and `WithdrawalRequest` layouts
* [Events](/for-developers/events.md) · [Errors](/for-developers/errors.md)
* [Devnet deployment](/deployment/devnet.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keystonefi.xyz/for-developers/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.