> For the complete documentation index, see [llms.txt](https://docs.veilnyx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.veilnyx.com/veilnyx-sdk/getting-started.md).

# Getting Started

The SDK is a monorepo of multiple packages that are dependencies of the core. These packages are:

* `@veilnyx-sdk/account`: For handling and using the shielded account of a user.
* `@veilnyx-sdk/babyjubjub`: Primitives for all the elliptic curve cryptography operations on the BabyJubJub curve.
* `@veilnyx-sdk/transaction`: For creation and handling of different kinds of transactions in the protocol.
* `@veilnyx-sdk/zk-prover`: For facilitating the generation of zkSNARK proof given transaction details.
* `@veilnyx-sdk/services`: Multiple services utilized in the protocol, like address resolver, Merkle tree builder, events fetcher, etc.
* `@veilnyx-sdk/utils`: Common utilities used across the different packages.
* `@veilnyx-sdk/shared-types`: TypeScript types shared across the packages.
* `@veilnyx-sdk/core`: The core that exposes the APIs for private transactions.
* `@veilnyx-sdk/react`(***Coming Soon)***: React components and hooks for easy usage in React apps. 

However, you don't need to install all of the packages. Just install `@veilnyx-sdk/core` In your project using your package manager,

```bash
# pnpm
pnpm add @veilnyx-sdk/core

# yarn
yarn add @veilnyx-sdk/core

# npm
npm i @veilnyx-sdk/core
```

Now you can simply import and use the SDK in your project,

```typescript
import { CoreOptions, Core } from '@veilnyx-sdk/core';

const opts: CoreOptions = { ... }

const veilnyx = new Core(opts);
```

Before we move further into usage, let's clear a couple of concepts in the next sections so you can use it effectively!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.veilnyx.com/veilnyx-sdk/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.