History

meep 277e4ff7c8 Update package.json to use anchor test for yarn test (#78 )		2023-01-11 09:35:27 +08:00
..
src	Add collect protocol fees helper method (#73 )	2023-01-08 13:22:05 +08:00
tests	Fix understated collectRewardsQuote and unit-tests for new collect functions (#72 )	2022-12-26 17:33:44 +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.json to use anchor test for yarn test (#78 )	2023-01-11 09:35:27 +08:00
jest.config.js	fix: getTickArrayPublicKeys edge case (#66 )	2022-12-09 22:06:36 +09:00
package-lock.json	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
package.json	Update package.json to use anchor test for yarn test (#78 )	2023-01-11 09:35:27 +08:00
tsconfig-base.json	Revert back to common-js (#62 )	2022-11-25 13:19:41 +07:00
typedoc.json	Update typedocs & env setup for 0.7.2 (#71 )	2022-12-21 17:28:10 +07:00
yarn-error.log	Release whirlpools-sdk 0.5.2 (#47 )	2022-09-20 11:10:13 -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.

Tests

To run tests for the SDK, setup your anchor environment and run:

anchor test

License

Apache 2.0