Removing Margin

Search…

Removing Margin

This guide shows how to remove margin from position by using the withdraw function of liquidityPool object.
Withdraw
Function
withdraw(perpetualIndex, traderAddress, amount)
parameters
type
description
perpetualIndex
number
index of perpetual in the liquidity pool
traderAddress
string
address of trader
amount
number
amount of collateral to withdraw. The amount always use decimals 18.
Notice
After withdrawn, trader shall at least has maintenance margin left in account.
Can only called when the perpetual's state is "NORMAL".
Example
Util function toWei can refer to Quick Start​
import { LiquidityPoolFactory } from '@mcdex/mai3.js'
const liquidityPool = LiquidityPoolFactory.connect(liquidityPoolAddress, provider)
​
// withdraw 1 amount of collateral to account (withdraw amount is 18 decimal)
liquidityPool.withdraw(0, trader.address, toWei("1")) // please check permission of sender 
​
// withdraw 100 amount of collateral to account (withdraw amount is 18 decimal)
liquidityPool.withdraw(0, trader.address, toWei("100")) // please check permission of sender
Sample Code
​Margin​

Adding Margin

Re-Margin

Last modified 10mo ago

Copy link

On this page

Withdraw

Function

Example

Sample Code