Skip to content

Commit 9030c5f

Browse files
update position rebalance transaction comments
1 parent f9e1bfa commit 9030c5f

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

cadence/transactions/tidal-protocol/pool-management/rebalance_position.cdc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
import "TidalProtocol"
22

3+
/// Rebalances a TidalProtocol position by it's Position ID with the provided `force` value
4+
///
5+
/// @param pid: The position ID to rebalance
6+
/// @param force: Whether the rebalance execution should be forced or not. If `false`, the rebalance executes only if
7+
/// the position is beyond its min/max health. If `true`, the rebalance executes regardless of its relative health.
8+
///
39
transaction(pid: UInt64, force: Bool) {
410
let pool: auth(TidalProtocol.EPosition) &TidalProtocol.Pool
511

0 commit comments

Comments
 (0)