renec-chain / nemo-swap

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

Build and deploy program using Makefile

• Setup wallets
  There are some wallets that need to be used in the scripts package. Read the README.md in the scripts package for more information. For the purpose of building and deploying using Makefile, we can create a deployer_wallet using the following command.

make gen-wallet name=fee_authority_wallet

• Build the program

make build

This scripts will build the program and place the binary in the target/deploy directory. Then it will copy the artifact to the sdk package.

• Deploy the program

CLUSTER=mainnet make deploy keypair_file_path=<path_to_keypair_file>

This script will deploy the program to the desired CLUSTER. The CLUSTER can be localnet, testnet, or mainnet.

If the keypair_file_path is not specified, the program will be deployed under scripts/.wallets/deployer_wallet.json. If you wish to deploy the program under a different wallet, you can specify the keypair_file_path to the path of the keypair file, for exp: make deploy keypair_file_path=~/.config/renec/id.json

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

Run test validator:

solana-test-validator --faucet-sol --reset

Run test validator:

solana-test-validator --faucet-sol --reset

In the nemo-swap folder, run:

solana config set --url http://127.0.0.1:8899

export ANCHOR_PROVIDER_URL=http://127.0.0.1:8899

export ANCHOR_WALLET=/<<userpath>>/.config/solana/id.json // Keypair Path when run solana config get

solana program deploy target/deploy/whirlpool.so

Copy Program Id and paste to Anchor.toml file. Line whirlpool = "<< Program Id >>"

solana config set --url http://127.0.0.1:8899 

export ANCHOR_PROVIDER_URL=http://127.0.0.1:8899

export ANCHOR_WALLET=/<<userpath>>/.config/solana/id.json // Keypair Path when run solana config get

solana program deploy /<<path>>/nemo-swap/target/deploy/whirlpool.so

Copy Program Id and paste to Anchor.toml file. Line whirlpool = "<< Program Id >>"

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