cyclos-core 0.1.6

Anchor client and source for Cykura (formerly Cyclos) concentrated liquidity AMM
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use anchor_lang::prelude::*;

/// Position wrapped as an SPL non-fungible token
///
/// PDA of `[POSITION_SEED, mint_address]`
///
#[account(zero_copy)]
#[derive(Default)]
#[repr(packed)]
pub struct TokenizedPositionState {
    /// Bump to identify PDA
    pub bump: u8,

    /// Mint address of the tokenized position
    pub mint: Pubkey,

    /// The ID of the pool with which this token is connected
    pub pool_id: Pubkey,

    /// The lower bound tick of the position
    pub tick_lower: i32,

    /// The upper bound tick of the position
    pub tick_upper: i32,

    /// The amount of liquidity owned by this position
    pub liquidity: u64,

    /// The token_0 fee growth of the aggregate position as of the last action on the individual position
    pub fee_growth_inside_0_last_x32: u64,

    /// The token_0 fee growth of the aggregate position as of the last action on the individual position
    pub fee_growth_inside_1_last_x32: u64,

    /// How many uncollected token_0 are owed to the position, as of the last computation
    pub tokens_owed_0: u64,

    /// How many uncollected token_0 are owed to the position, as of the last computation
    pub tokens_owed_1: u64,
}

/// Emitted when liquidity is increased for a position NFT.
/// Also emitted when a token is minted
#[event]
pub struct IncreaseLiquidityEvent {
    /// The ID of the token for which liquidity was increased
    #[index]
    pub token_id: Pubkey,

    /// The amount by which liquidity for the NFT position was increased
    pub liquidity: u64,

    /// The amount of token_0 that was paid for the increase in liquidity
    pub amount_0: u64,

    /// The amount of token_1 that was paid for the increase in liquidity
    pub amount_1: u64,
}

/// Emitted when liquidity is decreased for a position NFT
#[event]
pub struct DecreaseLiquidityEvent {
    /// The ID of the token for which liquidity was decreased
    #[index]
    pub token_id: Pubkey,

    /// The amount by which liquidity for the NFT position was decreased
    pub liquidity: u64,

    /// The amount of token_0 that was accounted for the decrease in liquidity
    pub amount_0: u64,

    /// The amount of token_1 that was accounted for the decrease in liquidity
    pub amount_1: u64,
}

/// Emitted when tokens are collected for a position NFT
/// The amounts reported may not be exactly equivalent to the amounts transferred, due to rounding behavior
#[event]
pub struct CollectTokenizedEvent {
    /// The ID of the token for which underlying tokens were collected
    #[index]
    pub token_id: Pubkey,

    /// The token account that received the collected token_0 tokens
    pub recipient_wallet_0: Pubkey,

    /// The token account that received the collected token_1 tokens
    pub recipient_wallet_1: Pubkey,

    /// The amount of token_0 owed to the position that was collected
    pub amount_0: u64,

    /// The amount of token_1 owed to the position that was collected
    pub amount_1: u64,
}