Go to file

meep 61874e5c56 Fix build to unblock yarn link in dev environment (#56 ) - Changing to ES6 build - Add `process` to this build to unblock webpack 5 resolution - Remove forced resolution of web3.js		2022-11-23 11:30:27 +07:00
docs	v0.5.3 (#49 )	2022-09-22 00:20:15 -07:00
migrations	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
programs/whirlpool	Update protocol_fee_rate comment (#44 )	2022-09-04 08:46:50 -07:00
scripts	Upgrade Anchor (Typescript) dependency to 0.25 (#38 )	2022-07-22 09:47:32 -04:00
sdk	Fix build to unblock yarn link in dev environment (#56 )	2022-11-23 11:30:27 +07:00
.gitignore	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
Anchor.toml	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
Cargo.lock	update Cargo.toml to use new anchor sources (#23 )	2022-06-07 08:22:20 -07:00
Cargo.toml	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
LICENSE	Update License to new language (#5 )	2022-05-12 08:35:04 -07:00
README.md	update anchor installation link (#39 )	2022-08-16 10:20:11 -07:00
package-lock.json	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
package.json	Open Source commit for Orca Whirlpools (#1 )	2022-05-02 20:32:00 -07:00
tsconfig.json	Refactor SDK and add formal documentation (#2 )	2022-05-09 10:04:47 -07:00
yarn.lock	Fix build to unblock yarn link in dev environment (#56 )	2022-11-23 11:30:27 +07:00

README.md

Whirlpools

Whirpools is an open-source concentrated liquidity AMM contract on the Solana blockchain. This repository contains the Rust smart contract as well as the Typescript SDK (@orca-so/whirlpools-sdk) to interact with a deployed program.

The contract has been audited by Kudelski and Neodyme.

Requirements

Anchor 0.20.1
Solana 1.9.3
Rust 1.59.0

Setup

Install Anchor using instructions found here.

Set up a valid Solana keypair at the path specified in the wallet in Anchor.toml to do local testing with anchor test flows.

$NODE_PATH must be set to the node_modules directory of your global installs. For example, using Node 16.10.0 installed through nvm, the $NODE_PATH is the following:

$ echo $NODE_PATH
/Users/<home_dir>/.nvm/versions/node/v16.10.0/lib/node_modules

Usage

Instructions on how to interact with the Whirlpools contract is documented in the Orca Developer Portal.

Tests

Run "cargo test --lib" to run Rust unit tests

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.

Run Typescript tests via local validator

In the whirlpools/sdk folder, run:

anchor test

Generate TypeDoc

In the sdk folder, run yarn run docs

Support

Integration Questions

Have problems integrating with the SDK? Pop by over to the Orca Discord #integrations channel and chat with one of our engineers.

Feedback

Got ideas on how to improve the system? Open up an issue on github with the prefix [FEEDBACK] and let's brainstorm more about it together!

License

Apache 2.0