DLMM SDK This Typescript SDK is meant to help developers easily integrate Meteora's DLMM pools into their protocols. This SDK uses the latest AddLiquidityByStrategy endpoint (instead of AddLiquidityByWeight).
Getting started
List of sections
CPI call example
Access this repo in the SDK, import, CPI:
Rust examples
Access these repos in the SDK, import, and use the necessary functions:
Example codes for key DLMM actions
Below we have provided example codes for the key DLMM actions:
Getting the list of positions
Adding liquidity to an existing position
Removing liquidity from an existing position
Swapping tokens within a specified pool
We have also provided a list of the necessary static functions and DLMM instance functions . To view other SDK files on github, click here .
Main Steps for SDK testing
Copy 1. cd ts-client
2. anchor localnet -- --features localnet
3. pnpm run test
Install
Install dependencies
You will need to first install these SDK dependencies in order for it to function properly
Copy npm i @meteora - ag / dlmm @coral - xyz / anchor @solana / web3 .js
Copy import DLMM from '@meteora-ag/dlmm'
const USDC_USDT_POOL = new PublicKey('ARwi1S4DaiTG5DX7S4M4ZsrXqpMD1MrTmbu9ue2tpmEq') // You can get your desired pool address from the API https://dlmm-api.meteora.ag/pair/all
const dlmmPool = await DLMM .create (connection , USDC_USDT_POOL );
// If you need to create multiple, can consider using `createMultiple`
const dlmmPool = await DLMM .createMultiple (connection , [ USDC_USDT_POOL , ... ]);
To interact with the AmmImpl
Changing Ammlmpl parameters to interact with the lb_pair / or pool
Get Active Bin
To get the active bin where the current pool price resides
Copy const activeBin = await dlmmPool .getActiveBin ();
const activeBinPriceLamport = activeBin .price;
const activeBinPricePerToken = dlmmPool .fromPricePerLamport (
Number ( activeBin .price)
);
Create Position
To create a new liquidity position
Copy const TOTAL_RANGE_INTERVAL = 10 ; // 10 bins on each side of the active bin
const minBinId = activeBin .bin_id - TOTAL_RANGE_INTERVAL ;
const maxBinId = activeBin .bin_id + TOTAL_RANGE_INTERVAL ;
const activeBinPricePerToken = dlmmPool .fromPricePerLamport (
Number ( activeBin .price)
);
const totalXAmount = new BN ( 100 );
const totalYAmount = totalXAmount .mul ( new BN ( Number (activeBinPricePerToken)));
// Create Position (Spot Balance deposit, Please refer ``example.ts` for more example)
const createPositionTx =
await dlmmPool .initializePositionAndAddLiquidityByStrategy ({
positionPubKey : newBalancePosition .publicKey ,
user : user .publicKey ,
totalXAmount ,
totalYAmount ,
strategy : {
maxBinId ,
minBinId ,
strategyType : StrategyType .SpotBalanced ,
} ,
});
try {
const createBalancePositionTxHash = await sendAndConfirmTransaction (
connection ,
createPositionTx ,
[user , newBalancePosition]
);
} catch (error) {}
Get list of positions
To get the list of liquidity positions for a specified pair and pool
Copy const { userPositions } = await dlmmPool .getPositionsByUserAndLbPair (
user .publicKey
);
const binData = userPositions[ 0 ]. positionData .positionBinData;
Add liquidity to existing position
To add liquidity to an existing liquidity position
Copy const TOTAL_RANGE_INTERVAL = 10 ; // 10 bins on each side of the active bin
const minBinId = activeBin .bin_id - TOTAL_RANGE_INTERVAL ;
const maxBinId = activeBin .bin_id + TOTAL_RANGE_INTERVAL ;
const activeBinPricePerToken = dlmmPool .fromPricePerLamport (
Number ( activeBin .price)
);
const totalXAmount = new BN ( 100 );
const totalYAmount = totalXAmount .mul ( new BN ( Number (activeBinPricePerToken)));
// Add Liquidity to existing position
const addLiquidityTx = await dlmmPool .addLiquidityByStrategy ({
positionPubKey : newBalancePosition .publicKey ,
user : user .publicKey ,
totalXAmount ,
totalYAmount ,
strategy : {
maxBinId ,
minBinId ,
strategyType : StrategyType .SpotBalanced ,
} ,
});
try {
const addLiquidityTxHash = await sendAndConfirmTransaction (
connection ,
addLiquidityTx ,
[user]
);
} catch (error) {}
Remove Liquidity
To remove liquidity from an existing liquidity position
Copy const userPosition = userPositions .find (({ publicKey }) =>
publicKey .equals ( newBalancePosition .publicKey)
);
// Remove Liquidity
const binIdsToRemove = userPosition . positionData . positionBinData .map (
(bin) => bin .binId
);
const removeLiquidityTx = await dlmmPool .removeLiquidity ({
position : userPosition .publicKey ,
user : user .publicKey ,
binIds : binIdsToRemove ,
liquiditiesBpsToRemove : new Array ( binIdsToRemove . length ) .fill (
new BN ( 100 * 100 )
) , // 100% (range from 0 to 100)
shouldClaimAndClose : true , // should claim swap fee and close position together
});
try {
for ( let tx of Array .isArray (removeLiquidityTx)
? removeLiquidityTx
: [removeLiquidityTx]) {
const removeBalanceLiquidityTxHash = await sendAndConfirmTransaction (
connection ,
tx ,
[user] ,
{ skipPreflight : false , preflightCommitment : "singleGossip" }
);
}
} catch (error) {}
Swap
To swap tokens within the specified liquidity pool
Copy const swapAmount = new BN ( 100 );
// Swap quote
const swapYtoX = true ;
const binArrays = await dlmmPool .getBinArrayForSwap (swapYtoX);
const swapQuote = await dlmmPool .swapQuote (
swapAmount ,
swapYtoX ,
new BN ( 10 ) ,
binArrays
);
// Swap
const swapTx = await dlmmPool .swap ({
inToken : dlmmPool . tokenX .publicKey ,
binArraysPubkey : swapQuote .binArraysPubkey ,
inAmount : swapAmount ,
lbPair : dlmmPool .pubkey ,
user : user .publicKey ,
minOutAmount : swapQuote .minOutAmount ,
outToken : dlmmPool . tokenY .publicKey ,
});
try {
const swapTxHash = await sendAndConfirmTransaction (connection , swapTx , [
user ,
]);
} catch (error) {}
Static functions
Function Description Return Given the DLMM address, create an instance to access the state and functions
Given a list of DLMM addresses, create instances to access the state and functions
getAllLbPairPositionsByUser
Given a list of DLMM addresses, create instances to access the state and functions
Promise<Map<string, PositionInfo>>
DLMM instance functions
Function Description Return Update onchain state of DLMM instance. It's recommend to call this before interact with the program (Deposit/ Withdraw/ Swap)
Retrieves List of Bin Arrays
Promise<BinArrayAccount[]>
Retrieves List of Bin Arrays for swap purpose
Promise<BinArrayAccount[]>
Retrieves LbPair's fee info including base fee
, protocol fee
& max fee
Retrieves LbPair's dynamic fee
retrieves a specified number of bins to the left and right of the active bin and returns them along with the active bin ID.
Promise<{ activeBin: number; bins: BinLiquidity[] }>
getBinsBetweenMinAndMaxPrice
Retrieves a list of bins within a specified price
Promise<{ activeBin: number; bins: BinLiquidity[] }>
getBinsBetweenLowerAndUpperBound
retrieves a list of bins between a lower and upper bin ID and returns the active bin ID and the list of bins.
Promise<{ activeBin: number; bins: BinLiquidity[] }>
Converts a real price of bin to lamport price
converts a price per lamport value to a real price of bin
Retrieves the active bin ID and its corresponding price
Promise<{ binId: number; price: string }>
Get the price of a bin based on its bin ID
get bin ID based on a given price and a boolean flag indicating whether to round down or up.
getPositionsByUserAndLbPair
Retrieves positions by user and LB pair, including active bin and user positions.
Promise<{ activeBin: { binId: any; price: string; }; userPositions: Array<Position>;}>
initializePositionAndAddLiquidityByStrategy
Initializes a position and adds liquidity
Promise<Transaction|Transaction[]>
Add liquidity to existing position
Promise<Transaction|Transaction[]>
function is used to remove liquidity from a position, with the option to claim rewards and close the position.
Promise<Transaction|Transaction[]>
Promise<Transaction|Transaction[]>
Swap token within the LbPair
Claim rewards for a specific position owned by a specific owner
Claim all liquidity mining rewards for a given owner and their positions.
Claim swap fees for a specific position owned by a specific owner
Claim swap fees for multiple positions owned by a specific owner
Claim swap fees and LM rewards for multiple positions owned by a specific owner
Last updated 3 months ago