@orca-so/whirlpools-sdk/README.md

Typescript SDK to interact with Orca's Whirlpool program.

# Legacy Whirlpools SDK

Whirpools is an open-source concentrated liquidity AMM contract on the Solana blockchain.

The legacy Whirlpools Typescript SDK (`@orca-so/whirlpools-sdk`) allows for easy interaction with a deployed Whirlpools program and is a solid choice if you are working the Solana Web3.js.

The contract has been audited by Kudelski and Neodyme.

## Installation

In your project, run:

```bash
yarn add "@orca-so/whirlpools-sdk"
yarn add "@orca-so/common-sdk"
yarn add "@coral-xyz/anchor@0.31.1"
yarn add "@solana/web3.js"
yarn add "@solana/spl-token"
yarn add "decimal.js"
```

## Usage

Visit our [documentation site on GitHub](https://dev.orca.so/) to learn more about how to use this SDK.

## Tests

To run tests for the SDK run:

```
yarn workspace @orca-so/whirlpools-sdk-integration test
```

# License

[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)