History

Otto Cheung 09ddd60a34 Revert unexpected PoolUtil commits		2022-06-13 16:20:16 -07:00
..
src	Revert unexpected PoolUtil commits	2022-06-13 16:20:16 -07:00
tests	Revert unexpected PoolUtil commits	2022-06-13 16:20:16 -07:00
.gitignore	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
.prettierignore	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
.prettierrc	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
README.md	Update package license to Apache 2.0 (#9 )	2022-05-13 08:58:23 -07:00
jest.config.js	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
package-lock.json	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
package.json	v0.2.1	2022-06-08 21:15:15 -07:00
tsconfig-base.json	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
yarn-error.log	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
yarn.lock	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00

README.md

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.

License

Apache 2.0