generate new fork

.gitignore

@@ -115,3 +115,5 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+.vscode/*

README.md

@@ -1,9 +1,21 @@
+⚠️ **WARNING: DEPRECATED TYPESCRIPT SDK** ⚠️
+
+This Typescript SDK is for the **legacy pools** which are **deprecated**. We highly recommend you to use the **Whirlpools SDK** for the new and improved pools. You can find it here:
+
+🌊 [Whirlpools SDK on npmjs](https://www.npmjs.com/package/@orca-so/whirlpools-sdk) 🌊
+
+Please update your implementations to avoid any issues or disruptions in the future.
+
 # Orca Typescript SDK
 
-The Orca SDK contains a set of simple to use APIs to allow developers to integrate with the Orca exchange platform.
+The Orca SDK contains a set of simple to use APIs to allow developers to integrate with the Orca platform.
 
 Learn more Orca [here](https://docs.orca.so).
 
+### Orca Token Swap V2
+
+- The [Orca Token Swap V2 program](https://solscan.io/account/9W959DqEETiGZocYWCQPaJ6sBmUzgfxXfqGeTEdp3aQP) uses the following commit hash of the SPL Token Swap program: [3613cea3](https://github.com/solana-labs/solana-program-library/tree/3613cea3cabbb5f7e4445d6203b7292d413732da/token-swap)
+
 ### Trading Orca Liquidity Pools
 
 - Get detailed quotes and make swaps between trading pairs in an Orca Pool
@@ -13,10 +25,28 @@ Learn more Orca [here](https://docs.orca.so).
 
 - The SDK supports all pools currently listed on [Orca](https://www.orca.so/pools)
 
+### Provide Liquidity to Orca Pools
+
+- Deposit liquidity to supported Orca Pools
+  - Deposit a trading pair, and receive LP token
+- Withdraw liquidity from supported Orca Pools
+  - Withdraw a trading pair in exchange for LP token
+
+**Aquafarm Support**
+
+- After depositing liquidtiy to a pool, the LP token can be deposited into
+  the corresponding farm to receive an equivalent amount of farm token
+- Remember to withdraw the LP token in exchange for farm token before
+  withdrawing liquidity from Orca Pool
+
+**DoubleDip Support**
+
+- For farms with double-dip, the aquafarm tokens can be deposited into
+  double-dip farm to receive double-dip rewards
+
 **Features Coming Soon**
-- More trader information (APY, Volume)
-- Deposit/Withdraw from OrcaPools
 
+- More trader information (APY, Volume)
 
 # Installation
 
@@ -33,38 +63,127 @@ npm install @orca-so/sdk @solana/web3.js decimal.js
 # Usage
 
 ```typescript
+import { readFile } from "mz/fs";
 import { Connection, Keypair } from "@solana/web3.js";
-import { getOrca, OrcaPoolConfig, OrcaU64 } from "@orca-so/sdk";
-
-try {
-  const connection = new Connection(url, "singleGossip");
+import { getOrca, OrcaFarmConfig, OrcaPoolConfig } from "@orca-so/sdk";
+import Decimal from "decimal.js";
+
+const main = async () => {
+  /*** Setup ***/
+  // 1. Read secret key file to get owner keypair
+  const secretKeyString = await readFile("/Users/scuba/my-wallet/my-keypair.json", {
+    encoding: "utf8",
+  });
+  const secretKey = Uint8Array.from(JSON.parse(secretKeyString));
+  const owner = Keypair.fromSecretKey(secretKey);
+
+  // 2. Initialzie Orca object with mainnet connection
+  const connection = new Connection("https://api.mainnet-beta.solana.com", "singleGossip");
   const orca = getOrca(connection);
-  const owner: Keypair = getKeyPair();
-
-  // Get an instance of the ETH-USDC orca pool
-  let pool = orca.getPool(OrcaPoolConfig.ETH_USDC);
-
-  // Get the number of ETH-USDC LP tokens in your wallet
-  let ethUsdcLPBalance = await pool.getLPBalance(owner.publicKey);
-
-  // Get the total supply of ETH-USDC LP tokens
-  let ethUsdcLPSupply = await pool.getLPSupply();
-
-  // Get a quote of exchanging 1.1 ETH to USDC with a slippage tolerance of 0.1%
-  // From the quote, you can get the current rate, fees, expected output amount and minimum output amount
-  let usdcToken = pool.getTokenB();
-  let tradeValue = new Decimal(1.1);
-  let quote = await pool.getQuote(usdcToken, tradeValue, new Decimal(0.1));
-
-  // Perform a swap for 1USDC to the quoted minimum amount of ETH
-  // If the user does not have the Associated Token Address(ATA) to receive the output token, the ATA 
-  // instructions will be appended in the transaction.
-  const txId = await pool.swap(owner, usdcToken, tradeValue, quote.getMinOutputAmount()).execute();
-} catch (err) {
-  // Handle errors
-}
+
+  try {
+    /*** Swap ***/
+    // 3. We will be swapping 0.1 SOL for some ORCA
+    const orcaSolPool = orca.getPool(OrcaPoolConfig.ORCA_SOL);
+    const solToken = orcaSolPool.getTokenB();
+    const solAmount = new Decimal(0.1);
+    const quote = await orcaSolPool.getQuote(solToken, solAmount);
+    const orcaAmount = quote.getMinOutputAmount();
+
+    console.log(`Swap ${solAmount.toString()} SOL for at least ${orcaAmount.toNumber()} ORCA`);
+    const swapPayload = await orcaSolPool.swap(owner, solToken, solAmount, orcaAmount);
+    const swapTxId = await swapPayload.execute();
+    console.log("Swapped:", swapTxId, "\n");
+
+    /*** Pool Deposit ***/
+    // 4. Deposit SOL and ORCA for LP token
+    const { maxTokenAIn, maxTokenBIn, minPoolTokenAmountOut } = await orcaSolPool.getDepositQuote(
+      orcaAmount,
+      solAmount
+    );
+
+    console.log(
+      `Deposit at most ${maxTokenBIn.toNumber()} SOL and ${maxTokenAIn.toNumber()} ORCA, for at least ${minPoolTokenAmountOut.toNumber()} LP tokens`
+    );
+    const poolDepositPayload = await orcaSolPool.deposit(
+      owner,
+      maxTokenAIn,
+      maxTokenBIn,
+      minPoolTokenAmountOut
+    );
+    const poolDepositTxId = await poolDepositPayload.execute();
+    console.log("Pool deposited:", poolDepositTxId, "\n");
+
+    /*** Farm Deposit ***/
+    // 5. Deposit some ORCA_SOL LP token for farm token
+    const lpBalance = await orcaSolPool.getLPBalance(owner.publicKey);
+    const orcaSolFarm = orca.getFarm(OrcaFarmConfig.ORCA_SOL_AQ);
+    const farmDepositPayload = await orcaSolFarm.deposit(owner, lpBalance);
+    const farmDepositTxId = await farmDepositPayload.execute();
+    console.log("Farm deposited:", farmDepositTxId, "\n");
+    // Note 1: for double dip, repeat step 5 but with the double dip farm
+    // Note 2: to harvest reward, orcaSolFarm.harvest(owner)
+    // Note 3: to get harvestable reward amount, orcaSolFarm.getHarvestableAmount(owner.publicKey)
+
+    /*** Farm Withdraw ***/
+    // 6. Withdraw ORCA_SOL LP token, in exchange for farm token
+    const farmBalance = await orcaSolFarm.getFarmBalance(owner.publicKey); // withdraw the entire balance
+    const farmWithdrawPayload = await orcaSolFarm.withdraw(owner, farmBalance);
+    const farmWithdrawTxId = await farmWithdrawPayload.execute();
+    console.log("Farm withdrawn:", farmWithdrawTxId, "\n");
+
+    /*** Pool Withdraw ***/
+    // 6. Withdraw SOL and ORCA, in exchange for ORCA_SOL LP token
+    const withdrawTokenAmount = await orcaSolPool.getLPBalance(owner.publicKey);
+    const withdrawTokenMint = orcaSolPool.getPoolTokenMint();
+    const { maxPoolTokenAmountIn, minTokenAOut, minTokenBOut } = await orcaSolPool.getWithdrawQuote(
+      withdrawTokenAmount,
+      withdrawTokenMint
+    );
+
+    console.log(
+      `Withdraw at most ${maxPoolTokenAmountIn.toNumber()} ORCA_SOL LP token for at least ${minTokenAOut.toNumber()} ORCA and ${minTokenBOut.toNumber()} SOL`
+    );
+    const poolWithdrawPayload = await orcaSolPool.withdraw(
+      owner,
+      maxPoolTokenAmountIn,
+      minTokenAOut,
+      minTokenBOut
+    );
+    const poolWithdrawTxId = await poolWithdrawPayload.execute();
+    console.log("Pool withdrawn:", poolWithdrawTxId, "\n");
+  } catch (err) {
+    console.warn(err);
+  }
+};
+
+main()
+  .then(() => {
+    console.log("Done");
+  })
+  .catch((e) => {
+    console.error(e);
+  });
 ```
 
+# Devnet Testing
+
+The example code above can be run on devnet by updating the import statement:
+
+```typescript
+import { getOrca, OrcaFarmConfig, OrcaPoolConfig, Network } from "@orca-so/sdk";
+```
+
+And changing two lines of code like so:
+
+```typescript
+const connection = new Connection("https://api.devnet.solana.com", "singleGossip");
+const orca = getOrca(connection, Network.DEVNET);
+```
+
+One caveat to note is that there are only a few devnet pools available, so if you try to access pools that are only
+available on mainnet, the code will throw an error. The example code uses ORCA_SOL, which exists on the devnet.
+
 # Technical Notes
 
 **Decimals & OrcaU64**

package.json

@@ -1,11 +1,12 @@
 {
   "name": "@orca-so/sdk",
-  "version": "1.1.4",
+  "version": "1.2.25",
   "description": "Typescript SDK for the Orca protocol.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "dependencies": {
+    "@orca-so/aquafarm": "^0.0.12",
     "@orca-so/stablecurve": "^1.0.5",
     "@solana/spl-token": "^0.1.5",
     "@solana/spl-token-swap": "^0.1.2",
@@ -34,6 +35,7 @@
     "watch": "tsc -w -p src",
     "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
     "prepare": "husky install",
+    "prepublishOnly": "tsc -p src",
     "test": "jest"
   },
   "lint-staged": {

src/constants/devnet/farms.ts

@@ -0,0 +1,113 @@
+import { PublicKey } from "@solana/web3.js";
+import { OrcaFarmParams } from "../../model/orca/farm/farm-types";
+
+/**
+ * The following content is auto-generated.
+ */
+
+export const solUsdcAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("CzFnr34cRC1o8yrs5jTHBqDQ1FDckLapkPis6zTfqCF5"),
+  farmTokenMint: new PublicKey("AtJF9fbQ1pbz76NYo2jtKjHuzzyaFToHLCizYk6UoHHL"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("4GpUivZ2jvZqQ3vJRsoq5PwnYv6gdV9fJ9BzHT2JcRr7"),
+  baseTokenDecimals: 6,
+});
+
+export const solUsdtAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("ER1UZsRhzucvXY8xMmXGfbbxb442iTHk2u1rSKRMPakC"),
+  farmTokenMint: new PublicKey("E95ABqtqnJRMG6gqEKZ16dVMfSNDUdCbEYqGUVg3tFRX"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("2E4Mp6y2gFRteXiANnwzAJEhHwD3NX1wru3XvxJpGBq2"),
+  baseTokenDecimals: 6,
+});
+
+export const usdcUsdtAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("D7wWV4nxqEeCAk2UA2nEGWgKw2BgoZYFZFUfwWGBhDF8"),
+  farmTokenMint: new PublicKey("3dDqVehvEpc5HMcbJUAzwMwF54xqa4nNvYN9qis7HAPe"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("EBor1PR5XNGHjRVB6JDJuKVCQbvdr1CVZTaX1hTAdvQv"),
+  baseTokenDecimals: 6,
+});
+
+export const ethSolAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("3q4wtMRT2yKHzQGy6gxwD34i9rsafviKd78rpdDLrBfk"),
+  farmTokenMint: new PublicKey("5NH9rNaoLKbPPP5zwCJTaMPkFACtfJA8wEmqWrXzgCMa"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("8sFnpd7mM1AWxP1LXX2FWbbkaVtAopBPmPNZ9y6172WL"),
+  baseTokenDecimals: 6,
+});
+
+export const ethUsdcAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("3aRTv8TGtZkX4dsM4N9aUHKotcwRr6phWPHXPLN8DEYX"),
+  farmTokenMint: new PublicKey("EeqPcczEZH2cjYBnQyGXBQx1DGs7KG1pobwdPKcwALhD"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("9pRnvg7ihSJDLi6DGf3PLwr6xRRRrBPXsHYEgGL5hzgA"),
+  baseTokenDecimals: 6,
+});
+
+export const orcaSolAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("6YrLcQs5yFvXkRY5VkMGEfVgo5rwozJf7jXedpZxbKmi"),
+  farmTokenMint: new PublicKey("3z8o3b4gMBpnRsrDv7ruZPcVtgoULMFyEoEEGwTsw2TR"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("CmDdQhusZWyi9fue27VSktYgkHefm3JXNdzc9kCpyvYi"),
+  baseTokenDecimals: 6,
+});
+
+export const orcaUsdcAqFarm: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("44GPPv5XedLXCNCc3Mbay1T18vc6x2bWihmmg7UJanvH"),
+  farmTokenMint: new PublicKey("52Tv8d6Z7Lb27dqCufZPUqadZBTv3EAKGzoV6hy185As"),
+  rewardTokenMint: new PublicKey("orcarKHSqC5CDDsGbho8GKvwExejWHxTqGzXgcewB9L"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("2ZEEntzoUN7XuMs88ukLGv5HRR1byL7wFWChryF5ZHri"),
+  baseTokenDecimals: 6,
+});
+
+export const solUsdcDoubleDip: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("L3XdTwLLtZRrXqSk5mqcBKaorqgmM2AMDGmzfBuhLMd"),
+  farmTokenMint: new PublicKey("7AYG2y3je8TqcLsugNkV6aPw14QyqdVFmK5EegeJmRFi"),
+  rewardTokenMint: new PublicKey("Ff5JqsAYUD4vAfQUtfRprT4nXu9e28tTBZTDFMnJNdvd"),
+  rewardTokenDecimals: 9,
+  baseTokenMint: new PublicKey("AtJF9fbQ1pbz76NYo2jtKjHuzzyaFToHLCizYk6UoHHL"),
+  baseTokenDecimals: 6,
+});
+
+export const ethSolDoubleDip: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("5jGfcgoRNpZPwfiRTp5zxNpEKP3PTeM3F9EKS9EsvX67"),
+  farmTokenMint: new PublicKey("5Uv5T1BksJGKGFGVpfxGeGniFFgGLjavNpPWGkfUFNkr"),
+  rewardTokenMint: new PublicKey("6PE3Mwjzx9h8kCoBp5YPed9TFoG7du8L98yucBP5ps3x"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("5NH9rNaoLKbPPP5zwCJTaMPkFACtfJA8wEmqWrXzgCMa"),
+  baseTokenDecimals: 6,
+});
+
+export const ethUsdcDoubleDip: OrcaFarmParams = Object.freeze({
+  address: new PublicKey("B4CTmaFpNRtXL3ZLiLrgbMZknQHFdoGu4V9tbzsjFbRT"),
+  farmTokenMint: new PublicKey("5jdeMPvNrscuw8abZFf99X9kcxDhANcpuBHDNpnx7YPT"),
+  rewardTokenMint: new PublicKey("EmXq3Ni9gfudTiyNKzzYvpnQqnJEMRw2ttnVXoJXjLo1"),
+  rewardTokenDecimals: 6,
+  baseTokenMint: new PublicKey("EeqPcczEZH2cjYBnQyGXBQx1DGs7KG1pobwdPKcwALhD"),
+  baseTokenDecimals: 6,
+});
+
+/**
+ * Mapping for OrcaFarm parameters
+ * Key: baseTokenMint : OrcaFarmParams
+ */
+export const orcaDevnetFarmConfigs: Record<string, OrcaFarmParams> = {
+  "4GpUivZ2jvZqQ3vJRsoq5PwnYv6gdV9fJ9BzHT2JcRr7": solUsdcAqFarm,
+  "2E4Mp6y2gFRteXiANnwzAJEhHwD3NX1wru3XvxJpGBq2": solUsdtAqFarm,
+  EBor1PR5XNGHjRVB6JDJuKVCQbvdr1CVZTaX1hTAdvQv: usdcUsdtAqFarm,
+  "8sFnpd7mM1AWxP1LXX2FWbbkaVtAopBPmPNZ9y6172WL": ethSolAqFarm,
+  "9pRnvg7ihSJDLi6DGf3PLwr6xRRRrBPXsHYEgGL5hzgA": ethUsdcAqFarm,
+  CmDdQhusZWyi9fue27VSktYgkHefm3JXNdzc9kCpyvYi: orcaSolAqFarm,
+  "2ZEEntzoUN7XuMs88ukLGv5HRR1byL7wFWChryF5ZHri": orcaUsdcAqFarm,
+  AtJF9fbQ1pbz76NYo2jtKjHuzzyaFToHLCizYk6UoHHL: solUsdcDoubleDip,
+  "5NH9rNaoLKbPPP5zwCJTaMPkFACtfJA8wEmqWrXzgCMa": ethSolDoubleDip,
+  EeqPcczEZH2cjYBnQyGXBQx1DGs7KG1pobwdPKcwALhD: ethUsdcDoubleDip,
+};

src/constants/devnet/index.ts

@@ -0,0 +1,2 @@
+export { orcaDevnetPoolConfigs } from "./pools";
+export { orcaDevnetFarmConfigs } from "./farms";