# @jup-ag/whirlpools-sdk

> Typescript SDK to interact with Orca's Whirlpool program.

Latest version **0.7.2** (published 2022-12-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @jup-ag/whirlpools-sdk
pnpm add @jup-ag/whirlpools-sdk
yarn add @jup-ag/whirlpools-sdk
bun add @jup-ag/whirlpools-sdk
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.7.2 |
| Published | 2022-12-19 |
| First published | 2022-08-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 566 |
| Author | team@orca.so |
| Maintainers | hjchan, arowana, siong, dicksonp, zhengyutay |
| Keywords | orca_so, orca, solana, typescript, sdk, crypto, dex |

## Links

- npm: https://www.npmjs.com/package/@jup-ag/whirlpools-sdk
- Repository: https://github.com/orca-so/whirlpools
- Homepage: https://www.orca.so
- Issues: https://github.com/orca-so/whirlpools/issues
- npm.io page: https://npm.io/package/@jup-ag/whirlpools-sdk

## Dependencies (6)

- [decimal.js](https://npm.io/package/decimal.js.md) ^10.3.1
- [tiny-invariant](https://npm.io/package/tiny-invariant.md) ^1.2.0
- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) ^1.66.0
- [@solana/spl-token](https://npm.io/package/@solana/spl-token.md) ^0.1.8
- [@orca-so/common-sdk](https://npm.io/package/@orca-so/common-sdk.md) ^0.1.4
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) ~0.25.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.7.2 (latest) — 2022-12-19
- 0.7.1 — 2022-12-19
- 0.7.0 — 2022-12-19
- 0.5.0 — 2022-11-15
- 0.5.1 — 2022-08-14

## README

# Whirlpools

Whirpools is an open-source concentrated liquidity AMM contract on the Solana blockchain.
The Whirlpools Typescript SDK (`@orca-so/whirlpools-sdk`) allows for easy interaction with a deployed Whirlpools program.

The contract has been audited by Kudelski and Neodyme.

# Whirlpool SDK

Use the SDK to interact with a deployed Whirlpools program via Typescript.

## Installation

In your package, run:

```
yarn add `@orca-so/whirlpools-sdk`
yarn add "@project-serum/anchor"
yarn add "decimal.js"
```

## Usage

Read instructions on how to use the SDK on the [Orca Developer Portal](https://orca-so.gitbook.io/orca-developer-portal/orca/welcome).

# License

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

---
_Source: https://npm.io/package/@jup-ag/whirlpools-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._