1. Create Dynamic Pool With Permissionless Alpha Vault
This example shows how to create a new Dynamic AMM Pool that also adds a permissionless Alpha Vault. Please contact the Meteora team if the existing pool and vault config do not meet your requirements. Currently only Dynamic AMM Pools support the addition of a permissionless Alpha Vault.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction, SYSVAR_CLOCK_PUBKEY,} from"@solana/web3.js";import AlphaVault, { DYNAMIC_AMM_PROGRAM_ID, PoolType, VaultMode } from"..";import DynamicAmm from"@mercurial-finance/dynamic-amm-sdk";import { ActivationType, Clock, ClockLayout, createTokenAndMint, loadKeypairFromFile,} from"./utils";import dotenv from"dotenv";import { BN } from"bn.js";import { derivePoolAddressWithConfig } from"@mercurial-finance/dynamic-amm-sdk/dist/cjs/src/amm/utils";dotenv.config();asyncfunctioncreateDummyMints(connection:Connection, payer:Keypair) {console.log("Creating mint A");constmintAInfo=awaitcreateTokenAndMint( connection, payer,6,100_000_000_000 );console.log("Creating mint B");constmintBInfo=awaitcreateTokenAndMint( connection, payer,6,100_000_000_000 );return { mintAInfo, mintBInfo, };}/** * * @param connection * @param creator * @param activationType Pool activation based on time or slot * @param maximumActivationDuration Maximum duration for pool to be activation after creation * @param minimumLockDuration Minimum duration for bought token be locked * @param maximumLockDuration Maximum duration for bought token to be locked * @param minimumVestingDuration Minimum duration for bought token to be vested * @param maximumVestingDuration Maximum duration for bought token be vested * @param vaultMode Vault mode: fcfs or prorata */asyncfunctiongetPoolConfigByRequirement( connection:Connection, creator:PublicKey, activationType:ActivationType, maximumActivationDuration:number, minimumLockDuration:number, maximumLockDuration:number, minimumVestingDuration:number, maximumVestingDuration:number, vaultMode:VaultMode) {// 1. Pool configs that can be used by anyone to create poolconstpublicPoolConfigs=awaitDynamicAmm.getPoolConfigsWithPoolCreatorAuthority( connection,PublicKey.default );// 2. Pool configs that can only be used by specific pubkey to create poolconstcreatorPoolConfigs=awaitDynamicAmm.getPoolConfigsWithPoolCreatorAuthority( connection, creator );// 3. Look for pool configs that have vault supportconstpoolConfigsWithVaultSupport= [...publicPoolConfigs,...creatorPoolConfigs, ].filter((config) =>config.account.vaultConfigKey !=PublicKey.default);console.log(`Gotten ${poolConfigsWithVaultSupport.length} usable pool configs with vault support` );constconfigFuture= vaultMode ===VaultMode.FCFS?AlphaVault.getFcfsConfigs(connection):AlphaVault.getProrataConfigs(connection);constconfigs=await configFuture;for (constprogramAccountof poolConfigsWithVaultSupport) {const { account } = programAccount;// 3.1 Pool activation type and duration matchesif (account.activationType == activationType &&account.activationDuration.toNumber() >= maximumActivationDuration ) {constvaultConfig=configs.find((c) =>c.publicKey.equals(account.vaultConfigKey) );if (!vaultConfig) {continue; }conststartVestingDuration=vaultConfig.account.startVestingDuration.toNumber();constendVestingDuration=vaultConfig.account.endVestingDuration.toNumber();constvestingDuration= endVestingDuration - startVestingDuration;// 3.2 Vault activation type, lock and vesting duration matchesif ( startVestingDuration >= minimumLockDuration && startVestingDuration <= maximumLockDuration && vestingDuration >= minimumVestingDuration && vestingDuration <= maximumVestingDuration &&vaultConfig.account.activationType == activationType ) {return programAccount; } } }returnnull;}asyncfunctioncreateDynamicPoolWithPermissionlessVault( connection:Connection, payer:Keypair) {const { mintAInfo,mintBInfo } =awaitcreateDummyMints(connection, payer);// Pool and vault requirementconstmaximumActivationDuration=86400; // 1 dayconstminimumLockDuration=60*30; // 30 minutesconstmaximumLockDuration=86400; // 1 dayconstminimumVestingDuration=60*60; // 1 hourconstmaximumVestingDuration=60*60*24*7; // 1 weekconstvaultMode=VaultMode.PRORATA; // 1.Find pool config where it allow user to create pool with customizable start trading time which start from NOW -> NOW + 24H
// With lock duration fall between 30 minutes -> 1 days (non customizable)// And vesting duration fall between 1 hour -> 1 week (non customizable)// And prorata vaultconstpoolConfig=awaitgetPoolConfigByRequirement( connection,payer.publicKey,ActivationType.Timestamp, maximumActivationDuration, minimumLockDuration, maximumLockDuration, minimumVestingDuration, maximumVestingDuration, vaultMode );console.log("Got pool config");console.log(poolConfig);constclockAccount=awaitconnection.getAccountInfo(SYSVAR_CLOCK_PUBKEY);constclock:Clock=ClockLayout.decode(clockAccount.data);// Pool start trade after created for 5 hourconstactivationPoint=clock.unixTimestamp.add(newBN(3600*5));// 2. Create the poolconsttransactions=awaitDynamicAmm.createPermissionlessConstantProductPoolWithConfig2( connection,payer.publicKey,mintAInfo.mint,mintBInfo.mint,newBN(100_000_000),newBN(100_000_000),poolConfig.publicKey, { activationPoint, } );console.log("Creating pool");for (consttxof transactions) {consttxHash=awaitsendAndConfirmTransaction(connection, tx, [payer]);console.log(txHash); }constpoolPubkey=derivePoolAddressWithConfig(mintAInfo.mint,mintBInfo.mint,poolConfig.publicKey,DYNAMIC_AMM_PROGRAM_ID );console.log("Pool created",poolPubkey.toBase58());// 3. Create the alpha vaultconstinitPermissionlessVaultTx=awaitAlphaVault.createPermissionlessVault( connection, { baseMint:mintAInfo.mint, quoteMint:mintBInfo.mint, poolType:PoolType.DYNAMIC, vaultMode:VaultMode.PRORATA, poolAddress: poolPubkey, config:poolConfig.account.vaultConfigKey, },payer.publicKey );console.log("Creating vault");consttxHash=awaitsendAndConfirmTransaction( connection, initPermissionlessVaultTx, [payer] );console.log(txHash);}constconnection=newConnection(clusterApiUrl("devnet"));constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to create dynamic pool with permissionless vault * Please contact meteora team if the existing pool and vault config doesn't meet the requirement * Currently only dynamic pool support permissionless vault */createDynamicPoolWithPermissionlessVault(connection, payer).then(() => {console.log("Done"); }).catch(console.error);
This example shows how to deposit SOL or USDC into an Alpha Vault. Deposit can only happen before the end of the deposit period.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import BN from"bn.js";import dotenv from"dotenv";dotenv.config();asyncfunctiondepositToAlphaVault( vault:PublicKey, depositAmount:BN, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);constdepositTx=awaitalphaVault.deposit(depositAmount,payer.publicKey);console.log(`Depositing ${depositAmount.toString()}`);consttxHash=awaitsendAndConfirmTransaction(connection, depositTx, [ payer, ]);console.log(txHash);constescrow=awaitalphaVault.getEscrow(payer.publicKey);console.log("Escrow info");console.log(escrow);}// Alpha vault to be deposited toconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constdepositAmount=newBN(100_000);constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to deposit to alpha vault. Deposit can only happen before the deposit close. */depositToAlphaVault(vault, depositAmount, payer).then(() => {console.log("Done"); }).catch(console.error);
3. Withdraw SOL or USDC from Alpha Vault during deposit period (only for Pro rata mode)
This example shows how to withdraw SOL or USDC from an Alpha Vault. Withdraw function only available before the end of the deposit period, and the function is applicable only when the Alpha Vault is using Pro rata mode.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import BN from"bn.js";import dotenv from"dotenv";dotenv.config();asyncfunctionwithdrawFromAlphaVault( vault:PublicKey, withdrawAmount:BN, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);constwithdrawTx=awaitalphaVault.withdraw(withdrawAmount,payer.publicKey);console.log(`Withdrawing ${withdrawAmount.toString()}`);consttxHash=awaitsendAndConfirmTransaction(connection, withdrawTx, [ payer, ]);console.log(txHash);constescrow=awaitalphaVault.getEscrow(payer.publicKey);console.log("Escrow info");console.log(escrow);}// Alpha vault to be withdraw fromconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constwithdrawAmount=newBN(100_000);constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to withdraw from an alpha vault. Withdraw can only happen before the deposit close, * and it applicable only when the vault is in Prorata mode. */withdrawFromAlphaVault(vault, withdrawAmount, payer).then(() => {console.log("Done"); }).catch(console.error);
4. Crank Alpha Vault to buy tokens from a Dynamic AMM/Memecoin pool
This example shows how to crank an Alpha Vault to purchase the base token from the liquidity pool during the crank period. Alpha Vault would purchase tokens using the SOL or USDC deposited into the Alpha Vault earlier.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import dotenv from"dotenv";import { PoolType } from"../alpha-vault/type";dotenv.config();asyncfunctionfillVaultWithDynamicAmm(vault:PublicKey, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);console.log("Pool type: ",alphaVault.vault.poolType ==PoolType.DYNAMIC?"Dynamic AMM":"DLMM" );// Dynamic AMM require only single fill transactionconstfillVaultWithDynamicAmmTransaction=awaitalphaVault.fillVault(payer.publicKey );console.log("Fill vault with dynamic AMM");consttxHash=awaitsendAndConfirmTransaction( connection, fillVaultWithDynamicAmmTransaction, [payer] );console.log(txHash);}// Alpha vault to be crankedconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to crank the vault to purchase base token from the pool, with deposited token from the vault. */fillVaultWithDynamicAmm(vault, payer).then(() => {console.log("Done"); }).catch(console.error);
5. Crank Alpha Vault to buy tokens from a DLMM pool
This example shows how to crank an Alpha Vault to purchase the base token from the liquidity pool during the crank period. Alpha Vault would purchase tokens using the SOL or USDC deposited into the Alpha Vault earlier.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import dotenv from"dotenv";import { PoolType, VaultMode } from"../alpha-vault/type";dotenv.config();asyncfunctionfillVaultWithDlmm(vault:PublicKey, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);console.log("Pool type: ",alphaVault.vault.poolType ==PoolType.DYNAMIC?"Dynamic AMM":"DLMM" );// DLMM require require one to many transactionswhile (true) {constfillVaultWithDLMMTransaction=awaitalphaVault.fillVault(payer.publicKey );if (!fillVaultWithDLMMTransaction) {// Vault bought out the whole pool and still have remainingbreak; }console.log("Fill vault with DLMM");consttxHash=awaitsendAndConfirmTransaction( connection, fillVaultWithDLMMTransaction, [payer] );console.log(txHash);awaitalphaVault.refreshState();constinAmountCap=alphaVault.vault.vaultMode ==VaultMode.FCFS?alphaVault.vault.totalDeposit:alphaVault.vault.totalDeposit.lt(alphaVault.vault.maxBuyingCap)?alphaVault.vault.totalDeposit:alphaVault.vault.maxBuyingCap;if (inAmountCap.eq(alphaVault.vault.swappedAmount)) {break; } }}// Alpha vault to be crankedconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to crank the vault to purchase base token from the pool, with deposited token from the vault. */fillVaultWithDlmm(vault, payer).then(() => {console.log("Done"); }).catch(console.error);
6. Withdraw unused SOL or USDC from Alpha Vault (only for Pro rata mode)
This example shows how to withdraw unused SOL or USDC deposit from an Alpha Vault after the Alpha Vault has completed the purchase of tokens from the liquidity pool. This is applicable only for Alpha Vault using Pro rata mode.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import BN from"bn.js";import dotenv from"dotenv";dotenv.config();asyncfunctionwithdrawRemainingFromAlphaVault( vault:PublicKey, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);constwithdrawRemainingTx=awaitalphaVault.withdrawRemainingQuote(payer.publicKey );console.log(`Withdrawing unused fund`);consttxHash=awaitsendAndConfirmTransaction( connection, withdrawRemainingTx, [payer] );console.log(txHash);constescrow=awaitalphaVault.getEscrow(payer.publicKey);console.log("Escrow info");console.log(escrow);}// Alpha vault to be withdraw / refund fromconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to withdraw remaining unused deposit from an alpha vault after the vault done buying. */withdrawRemainingFromAlphaVault(vault, payer).then(() => {console.log("Done"); }).catch(console.error);
7. Claim Tokens from Alpha Vault
This example shows how to claim tokens from an Alpha Vault after it has purchased those tokens from the liquidity pool. Claiming can only happen after the start of the vesting period.
Important Reminder: Claim start time should NOT be earlier than Pool activation time
For a new token launch, the project should ensure that token claiming from the Alpha Vault is NOT possible before the launch pool trading activation or before the token starts trading anywhere, whether on a Dynamic AMM or DLMM Pool. If users are able to claim tokens before the launch pool/token starts trading, they may create a separate market with a price that deviates from the project's preferred launch price.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import dotenv from"dotenv";dotenv.config();asyncfunctionclaimBoughtTokenFromAlphaVault( vault:PublicKey, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);constclaimTx=awaitalphaVault.claimToken(payer.publicKey);console.log("Claiming bought token");consttxHash=awaitsendAndConfirmTransaction(connection, claimTx, [payer]);console.log(txHash);constescrow=awaitalphaVault.getEscrow(payer.publicKey);console.log("Escrow info");console.log(escrow);}// Alpha vault to be deposited toconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to claim bought token from an alpha vault. Claim can only happen when the vesting start. */claimBoughtTokenFromAlphaVault(vault, payer).then(() => {console.log("Done"); }).catch(console.error);
8. Close Escrow Account
When a user deposits to the vault, it will create an escrow account, which stores the user info, such as deposit, claimed token, etc. Once user fully claims all tokens, they can close the escrow account.
Close escrow can only happen after vesting of tokens is complete, and the escrow has claimed all the bought token. This example shows how to close an escrow account and get rental back.
import { clusterApiUrl, Connection, Keypair, PublicKey, sendAndConfirmTransaction,} from"@solana/web3.js";import { loadKeypairFromFile } from"./utils";import { AlphaVault } from"../alpha-vault";import dotenv from"dotenv";dotenv.config();asyncfunctioncloseEscrow(vault:PublicKey, payer:Keypair) {constconnection=newConnection(clusterApiUrl("devnet"),"confirmed");constalphaVault=awaitAlphaVault.create(connection, vault);constclaimTx=awaitalphaVault.closeEscrow(payer.publicKey);console.log("Close escrow");consttxHash=awaitsendAndConfirmTransaction(connection, claimTx, [payer]);console.log(txHash);}// Alpha vault to be deposited toconstvault=newPublicKey("AxRoXRwQgxyaQBMwQsTRrtQ9i9Hd59BKNZBycTcYru5Z");constpayer=loadKeypairFromFile(process.env.KEYPAIR_PATH);/** * This example shows how to close an escrow account and get rental back. Close escrow can only happen after vesting is complete, and escrow have claimed all the bought token.
*/closeEscrow(vault, payer).then(() => {console.log("Done"); }).catch(console.error);
9. Configure Alpha Vault Timings
If you are integrating the Alpha Vault program and need to view and select the predefined timings for the various phases, such as:
Deposit open time (only for FCFS mode currently)
Deposit close time
Vault crank/buy start time
Vault crank/buy end time
Withdraw unused USDC or SOL after crank is successful
Token claim start time
Vesting start time
Vesting end time
You can use this config endpoint that has predefined timings created by Meteora.
If your preferred configs are not available in the predefined config lists above, and you want more customization, please contact the Meteora team.
Config endpoint based on Pool Activation Timing
This config endpoint is tied to the pool activation timing, so all timings for the different Alpha Vault phases is derived from the pool activation timing.
In this example below, the claim process will start 3600 seconds (1 hour) after pool activation, and it will end 7200 seconds (2 hours) after pool activation. In other words, after the pool starts trading, tokens are locked first and released for claiming 3600 seconds (1 hour) later.
{
maxBuyingCap: new BN(10000000),
index,
startVestingDuration: new BN(3600),
endVestingDuration: new BN(7200),
escrowFee: new BN(0),
individualDepositingCap: new BN(50000),
activationType: ActivationType.TIMESTAMP,
depositingPoint: new BN(1028979080),
}
10. Important Reminders
A) Claim start time should NOT be earlier than Pool activation time
For a new token launch, the project should ensure that token claiming from the Alpha Vault is NOT possible before the launch pool trading activation or before the token starts trading anywhere, whether on a Dynamic AMM or DLMM Pool. If users are able to claim tokens before the launch pool/token starts trading, they may create a separate market with a price that deviates from the project's preferred launch price.
B) For Memecoins that want to permanently lock liquidity, lock it before Pool activation time
If the Alpha Vault is used for a Memecoin launch pool, and the project wants to permanently lock liquidity in the Memecoin pool, they should ideally lock the liquidity BEFORE the pool starts trading, so that swap fees from locked liquidity are captured the second trading starts.
In a scenario where:
The pool started trading - t0
Liquidity gets deposited to the pool by the project, but not locked - t1
Subsequently, that liquidity is permanently locked by the project - t2
The project will not be able to claim swap fees earned from t1 to t2, since fees from t1 to t2 are assigned to the LP token before the LP token gets permanently locked. When the LP token gets locked, the earlier fees are locked along with it.
The project will only be able to claim swap fees from locked liquidity starting from t2.