> For the complete documentation index, see [llms.txt](https://developers.lfj.gg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.lfj.gg/sdk/intro.md).

# Introduction

SDK-V2 is an open source library created to help builders interact with the V2, V2.1 and v2.2 contracts from their JS/TS projects. Please note that SDK-V2 is built on top of SDK-V1 so both libraries must be installed together.

This guide endeavors to show examples of how builders can use the SDKs, together with [Viem](https://viem.sh/docs/getting-started.html), to perform a trade and add/remove liquidity.

## Installation

Run one of the following commands to add the required dependencies to your project:

### NPM

```
npm install @traderjoe-xyz/sdk @traderjoe-xyz/sdk-v2 @traderjoe-xyz/sdk-core viem
```

### Yarn

```
yarn add @traderjoe-xyz/sdk @traderjoe-xyz/sdk-v2 @traderjoe-xyz/sdk-core viem
```

## Classes

SDK-V2 implements 4 main classes: `PairV2`, `RouteV2`, `TradeV2`, and `Bin`. Specific documentation of the fields and functions for each class can be found in the code.

* [PairV2](https://github.com/traderjoe-xyz/joe-sdk-v2/blob/main/src/v2entities/pair.ts)
* [RouteV2](https://github.com/traderjoe-xyz/joe-sdk-v2/blob/main/src/v2entities/route.ts)
* [TradeV2](https://github.com/traderjoe-xyz/joe-sdk-v2/blob/main/src/v2entities/trade.ts)
* [Bin](https://github.com/traderjoe-xyz/joe-sdk-v2/blob/main/src/v2entities/bin.ts)

## Github

SDK-V2 uses Github to track issues and feature requests. Please open an issue if you have found a bug or have new feature requests. We also welcome contributions from the open source community. Open a pull request with a detailed explanation and the team will gladly review your contribution.

| Repo |                  Github URL                 |                        NPM URL                        |
| :--: | :-----------------------------------------: | :---------------------------------------------------: |
|  V2  | <https://github.com/traderjoe-xyz/joe-sdks> | <https://www.npmjs.com/package/@traderjoe-xyz/sdk-v2> |


---

# 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 dynamically by asking a question.

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

```
GET https://developers.lfj.gg/sdk/intro.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.