# TypeScript SDK

### Typescript SDK Features

With the Typescript SDK, you can easily do the following:

* Use the WoofiClient or construct your own transactions with the raw instructions to:
  * Swap tokens on WOOFi sPMM contract
* Quotes - helper functions to help developers perform quote estimations on tasks such as:
  * Get a quote on a swap and swap fee off-chain
  * Get a quote on a swap and swap fee on-chain
* Utility classes
  * Get contract supported tokens.
  * Get pyth oracle for supported tokens (in USD).
  * Other helper functions to help interact with WOO sPMM components

### Installation & Test

In your package, run:

```
yarn
yarn build
```

### Usage

### Run Typescript tests via local validator

In the WOOFi\_Solana/sdk folder, run:

```
yarn test
```

### Generate TypeDoc

In the `sdk` folder, run `yarn run docs`

You can also see the generated TypeDoc under docs folder.

### Sample Codes

You can find sample code covering basic operations under sdk/test folder [here](https://github.com/woonetwork/WOOFi_Solana/tree/main/sdk/tests).


---

# 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://learn.woo.org/dev-docs/guides/integrate-woofi-as-a-liquidity-source-on-solana/typescript-sdk.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.