API Reference

Open Position

This method allows the caller to open a position on a pool. The following interfaces can be used to call the method, with the arguments described below:

Interfaces


  public fun open_position<CoinTypeA, CoinTypeB>(
        protocol_config: &GlobalConfig,
        pool: &mut Pool<CoinTypeA, CoinTypeB>, 
        lower_tick_bits: u32, 
        upper_tick_bits: u32, 
        ctx: &mut TxContext): Position {
        abort 0
    }

    /// Parameters:
    /// - protocol_config       : The `config::GlobalConfig` object used for version verification
    /// - pool                  : Mutable reference to the pool on which the position is being opened
    /// - lower_tick_bits       : The unsigned bits of the lower tick. Ticks are represented as 2^31 with the MSB bit being used for sign
    /// - upper_tick_bits       : The unsigned bits of the lower tick. Ticks are represented as 2^31 with the MSB bit being used for sign
    /// - ctx                   : Murable reference to caller's transaction context
    /// 
    /// Events Emitted          : PositionOpened
    /// 
    /// Returns                 : Created Position