Syntax

exchange.IO("lp.unstake", ...)

Aerodrome and Velodrome: takes staked positions out of the gauge; Slipstream positions also claim their accrued rewards.


    
    
    
exchange.IO(k, positionIds)

Examples

Take every staked position out of the gauge.


    javascript
    
    
function main() {
    var ids = exchange.IO("lp.positions").filter(function (p) {
        return p.staked
    }).map(function (p) { return p.id })
    if (ids.length == 0) {
        return
    }
    var r = exchange.IO("lp.unstake", ids)
    if (!r) {
        Log("Unstaking failed:", GetLastError())
        return
    }
    r.positions.forEach(function (p) {
        Log(p.id, "taken out, rewards received:", p.rewards)
    })
}

Returns

Type	Description
object / null value	`{positions: [{id, gauge, txHash, rewards}]}`, where `rewards` is the reward tokens received in that transaction; basic pools also have `lpTokens` (the LP tokens returned). Null with an error on failure.

Arguments

Name	Type	Required	Description
k	string	Yes	Set to `lp.unstake` to take positions out of the gauge.
positionIds	string / array	Yes	Position IDs: one ID or an array; Slipstream positions such as `aero:123` or `aero2:456` (`velo:` and `velo2:` on Velodrome), basic pools by the pool address.