History

tmoc 16bca0ea1f Implement batch getPools method (#42 ) * Adding getPools method in SDK client * Adding fetching of token vault infos to whirlpool retrieval * Adding retrieval of reward infos * Adding comment about empty pubkey constant * Updating comments * Using PoolUtil to check for initialized rewards * Updating getRewardInfos comment		2022-08-10 14:50:02 -04:00
..
src	Implement batch getPools method (#42 )	2022-08-10 14:50:02 -04:00
tests	Change data type for liquidity and sqrtPrice to BN (#40 )	2022-08-01 20:49:52 +09: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.5.0	2022-07-22 10:17:08 -04:00
tsconfig-base.json	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
yarn-error.log	v0.2.3	2022-06-21 11:36:09 -05: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