Merge pull request #20 from MeteoraAg/fix/quote-token

fix: Allow create DLMM launch pool with every quote token without alpha vault
MeteoraAg · Feb 3, 2025 · f1fcd63 · f1fcd63
2 parents 0129812 + 3f38a12
commit f1fcd63
Show file tree

Hide file tree

Showing 17 changed files with 166 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
 
+## [1.4.0] - 2025-01-27 - [PR #8](https://github.com/MeteoraAg/meteora-pool-setup/pull/20)
+### Added 
+- Add field `quoteMint` in configuration. 
+
+### Changed
+- Make field `quoteSymbol` to be optional in configuration.
+- 
+
 ## [1.3.0] - 2025-01-21 - [PR #8](https://github.com/MeteoraAg/meteora-pool-setup/pull/13)
 ### Added 
 - Script to create M3M3 fee farm.

diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Also we need to provide the keypair for the payer wallet in `keypair.json` file.
 - `createBaseToken`: Configuration to create base token.
 - `baseMint`: Base token address if the `createBaseToken` field is not set. 
 - `quoteSymbol`: Quote token symbol, only `SOL` or `USDC` is supported.
+- `quoteMint`: Quote token mint, in case the user wants to create a DLMM launch pool with a token other than SOL or USDC.
 - `dynamicAmm`: Dynamic AMM pool configuration.
 - `dlmm`: DLMM pool configuration.
 - `alphaVault`: Fcfs or Prorata Alpha Vault configuration.
@@ -100,6 +101,11 @@ bun run src/create_pool.ts --config ./config/create_dynamic_amm_pool_with_new_to
 bun run src/create_pool.ts --config ./config/create_dlmm_pool.json
 ```
 
+** Create new DLMM pool without strict quote token**
+```bash
+bun run src/create_pool.ts --config ./config/create_dlmm_pool_without_strict_quote_token.json
+```
+
 ** Create new DLMM pool with alpha vault**
 ```bash
 bun run src/create_pool.ts --config ./config/create_dlmm_pool_with_fcfs_alpha_vault.json

diff --git a/bun.lockb b/bun.lockb
diff --git a/config/create_dlmm_pool_without_strict_quote_token.json b/config/create_dlmm_pool_without_strict_quote_token.json
@@ -0,0 +1,17 @@
+{
+  "rpcUrl": "https://api.mainnet-beta.solana.com",
+  "dryRun": true,
+  "keypairFilePath": "keypair.json",
+  "computeUnitPriceMicroLamports": 100000,
+  "baseMint": "5e3ACTUsKDXgwLjnsjELtohL3Wv2tei7Nu6ZS6UeMj7w",
+  "quoteMint": "8QEgDzA1XBcX7WGHvKaBT1eZGST6jmZBqW6B8weEoUw5",
+  "dlmm": {
+    "binStep": 400,
+    "feeBps": 200,
+    "initialPrice": 0.0000017,
+    "activationType": "slot",
+    "activationPoint": null,
+    "priceRounding": "up",
+    "hasAlphaVault": false
+  }
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "meteora_pool_setup",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "main": "index.js",
   "scripts": {
     "format": "bun prettier ./src --write",
@@ -13,7 +13,7 @@
     "@coral-xyz/anchor": "^0.28.0",
     "@mercurial-finance/dynamic-amm-sdk": "^1.1.19",
     "@meteora-ag/alpha-vault": "^1.1.8",
-    "@meteora-ag/dlmm": "^1.3.5",
+    "@meteora-ag/dlmm": "^1.3.10",
     "@meteora-ag/m3m3": "^1.0.5",
     "@solana/spl-token": "^0.4.9",
     "@solana/spl-token-registry": "^0.2.4574",

diff --git a/src/create_alpha_vault.ts b/src/create_alpha_vault.ts
@@ -50,8 +50,8 @@ async function main() {
     throw new Error("Missing baseMint in configuration");
   }
   const baseMint = new PublicKey(config.baseMint);
-  let quoteMint = getQuoteMint(config.quoteSymbol);
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
 
   console.log(`- Using base token mint ${baseMint.toString()}`);
   console.log(`- Using quote token mint ${quoteMint.toString()}`);

diff --git a/src/create_m3m3_farm.ts b/src/create_m3m3_farm.ts
@@ -9,7 +9,6 @@ import { DEFAULT_COMMITMENT_LEVEL, M3M3_PROGRAM_IDS } from "./libs/constants";
 import {
   safeParseKeypairFromFile,
   getQuoteMint,
-  getQuoteDecimals,
   runSimulateTransaction,
 } from "./libs/utils";
 import { createTokenMint } from "./libs/create_token_mint";
@@ -22,7 +21,6 @@ import AmmImpl from "@mercurial-finance/dynamic-amm-sdk";
 import StakeForFee, { deriveFeeVault } from "@meteora-ag/m3m3";
 import {
   create_m3m3_farm,
-  lockLiquidityToFeeVault,
 } from "./libs/create_m3m3_farm_utils";
 
 async function main() {
@@ -43,7 +41,7 @@ async function main() {
     throw new Error("Missing baseMint in configuration");
   }
   let baseMint = new PublicKey(config.baseMint);
-  let quoteMint = getQuoteMint(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
   const ammProgram = createProgram(connection).ammProgram;
   const poolKey = deriveCustomizablePermissionlessConstantProductPoolAddress(
     baseMint,

diff --git a/src/create_pool.ts b/src/create_pool.ts
@@ -28,7 +28,7 @@ async function main() {
   const wallet = new Wallet(keypair);
 
   let baseMint: PublicKey;
-  let quoteMint = getQuoteMint(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
 
   // If we want to create a new token mint
   if (config.createBaseToken) {

diff --git a/src/libs/config.ts b/src/libs/config.ts
@@ -40,6 +40,11 @@ const CONFIG_SCHEMA: JSONSchemaType<MeteoraConfig> = {
     },
     quoteSymbol: {
       type: "string",
+      nullable: true,
+    },
+    quoteMint: {
+      type: "string",
+      nullable: true
     },
     dynamicAmm: {
       type: "object",
@@ -248,8 +253,7 @@ const CONFIG_SCHEMA: JSONSchemaType<MeteoraConfig> = {
     "rpcUrl",
     "dryRun",
     "keypairFilePath",
-    "computeUnitPriceMicroLamports",
-    "quoteSymbol",
+    "computeUnitPriceMicroLamports"
   ],
   additionalProperties: true,
 };
@@ -261,7 +265,8 @@ export interface MeteoraConfig {
   computeUnitPriceMicroLamports: number;
   createBaseToken: CreateBaseMintConfig | null;
   baseMint: string | null;
-  quoteSymbol: string;
+  quoteSymbol?: string;
+  quoteMint?: string;
   dynamicAmm: DynamicAmmConfig | null;
   dlmm: DlmmConfig | null;
   alphaVault: FcfsAlphaVaultConfig | ProrataAlphaVaultConfig | null;

diff --git a/src/libs/create_pool_utils.ts b/src/libs/create_pool_utils.ts
@@ -46,7 +46,7 @@ export async function createPermissionlessDynamicPool(
   }
   console.log("\n> Initializing Permissionless Dynamic AMM pool...");
 
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
   const baseMintAccount = await getMint(connection, baseMint);
   const baseDecimals = baseMintAccount.decimals;
 
@@ -162,7 +162,7 @@ export async function createPermissionlessDlmmPool(
   console.log(`- Using activationPoint = ${activationPoint}`);
   console.log(`- Using hasAlphaVault = ${hasAlphaVault}`);
 
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
   const baseMintAccount = await getMint(connection, baseMint);
   const baseDecimals = baseMintAccount.decimals;
 
@@ -198,6 +198,7 @@ export async function createPermissionlessDlmmPool(
       programId: dlmmProgramId,
     },
   );
+
   modifyComputeUnitPriceIx(initPoolTx, config.computeUnitPriceMicroLamports);
 
   let poolKey: PublicKey;

diff --git a/src/libs/utils.ts b/src/libs/utils.ts
@@ -34,6 +34,7 @@ import {
   PriceRoundingConfig,
   WhitelistModeConfig,
 } from "..";
+import { getMint } from "@solana/spl-token";
 
 export const DEFAULT_ADD_LIQUIDITY_CU = 800_000;
 
@@ -57,6 +58,14 @@ export function extraConfigValidation(config: MeteoraConfig) {
     );
   }
 
+  if (config.dlmm && config.dlmm.hasAlphaVault) {
+    if (config.quoteSymbol == null && config.quoteMint == null) {
+      throw new Error(
+        "Either quoteSymbol or quoteMint must be provided for DLMM",
+      );
+    }
+  }
+
   if (config.alphaVault) {
     if (
       config.alphaVault.alphaVaultType != "fcfs" &&
@@ -114,7 +123,18 @@ export function getDecimalizedAmount(amountLamport: BN, decimals: number): BN {
   return amountLamport / new BN(10 ** decimals);
 }
 
-export function getQuoteMint(quoteSymbol: string): PublicKey {
+export function getQuoteMint(quoteSymbol?: string, quoteMint?: string): PublicKey {
+  if (quoteSymbol == null && quoteMint == null) {
+    throw new Error(`Either quoteSymbol or quoteMint must be provided`);
+  }
+  if (quoteSymbol && quoteMint) {
+    throw new Error(`Cannot provide quoteSymbol and quoteMint at the same time`);
+  }
+
+  if (quoteMint) {
+    return new PublicKey(quoteMint);
+  }
+
   if (quoteSymbol.toLowerCase() == "sol") {
     return new PublicKey(SOL_TOKEN_MINT);
   } else if (quoteSymbol.toLowerCase() == "usdc") {
@@ -124,7 +144,15 @@ export function getQuoteMint(quoteSymbol: string): PublicKey {
   }
 }
 
-export function getQuoteDecimals(quoteSymbol: string): number {
+export async function getQuoteDecimals(connection: Connection, quoteSymbol?: string, quoteMint?: string): Promise<number> {
+  if (quoteSymbol == null && quoteMint == null) {
+    throw new Error(`Either quoteSymbol or quoteMint must be provided`);
+  }
+  if (quoteMint) {
+    const mintAccount = await getMint(connection, new PublicKey(quoteMint));
+    const decimals = mintAccount.decimals;
+    return decimals;
+  }
   if (quoteSymbol.toLowerCase() == "sol") {
     return SOL_TOKEN_DECIMALS;
   } else if (quoteSymbol.toLowerCase() == "usdc") {

diff --git a/src/lock_liquidity.ts b/src/lock_liquidity.ts
@@ -44,8 +44,8 @@ async function main() {
     throw new Error("Missing baseMint in configuration");
   }
   const baseMint = new PublicKey(config.baseMint);
-  let quoteMint = getQuoteMint(config.quoteSymbol);
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
 
   console.log(`- Using base token mint ${baseMint.toString()}`);
   console.log(`- Using quote token mint ${quoteMint.toString()}`);

diff --git a/src/lock_liquidity_for_m3m3.ts b/src/lock_liquidity_for_m3m3.ts
@@ -46,8 +46,8 @@ async function main() {
     throw new Error("Missing baseMint in configuration");
   }
   const baseMint = new PublicKey(config.baseMint);
-  let quoteMint = getQuoteMint(config.quoteSymbol);
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
 
   console.log(`- Using base token mint ${baseMint.toString()}`);
   console.log(`- Using quote token mint ${quoteMint.toString()}`);

diff --git a/src/seed_liquidity_lfg.ts b/src/seed_liquidity_lfg.ts
@@ -73,8 +73,8 @@ async function main() {
   const baseMintAccount = await getMint(connection, baseMint);
   const baseDecimals = baseMintAccount.decimals;
 
-  let quoteMint = getQuoteMint(config.quoteSymbol);
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
+  const quoteDecimals = await getQuoteDecimals(connection, config.quoteSymbol, config.quoteMint);
 
   console.log(`- Using base token mint ${baseMint.toString()}`);
   console.log(`- Using quote token mint ${quoteMint.toString()}`);

diff --git a/src/seed_liquidity_single_bin.ts b/src/seed_liquidity_single_bin.ts
@@ -4,7 +4,6 @@ import {
   MeteoraConfig,
   getAmountInLamports,
   getQuoteMint,
-  getQuoteDecimals,
   safeParseKeypairFromFile,
   parseConfigFromCli,
   seedLiquiditySingleBin,
@@ -42,8 +41,7 @@ async function main() {
   const baseMintAccount = await getMint(connection, baseMint);
   const baseDecimals = baseMintAccount.decimals;
 
-  let quoteMint = getQuoteMint(config.quoteSymbol);
-  const quoteDecimals = getQuoteDecimals(config.quoteSymbol);
+  let quoteMint = getQuoteMint(config.quoteSymbol, config.quoteMint);
 
   console.log(`- Using base token mint ${baseMint.toString()}`);
   console.log(`- Using quote token mint ${quoteMint.toString()}`);

diff --git a/src/tests/artifacts/lb_clmm.so b/src/tests/artifacts/lb_clmm.so