light-sdk-types 0.23.0

Core types for Light Protocol SDK
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

use light_compressed_account::instruction_data::compressed_proof::ValidityProof;

/// Base trait for Light CPI instruction types.
///
/// This is the framework-agnostic version that provides CPI builder methods
/// without referencing SDK-specific types like `LightAccount`.
///
/// Each SDK (`light-sdk`, `light-sdk-pinocchio`) defines its own
/// `LightCpiInstruction` trait that includes `with_light_account`.
pub trait LightCpi: Sized {
    /// Creates a new CPI instruction builder with a validity proof.
    ///
    /// # Arguments
    /// * `cpi_signer` - The CPI signer containing program ID and bump seed
    /// * `proof` - Validity proof for compressed account operations
    fn new_cpi(cpi_signer: crate::CpiSigner, proof: ValidityProof) -> Self;

    /// Returns the instruction mode (0 for v1, 1 for v2).
    fn get_mode(&self) -> u8;

    /// Returns the CPI signer bump seed.
    fn get_bump(&self) -> u8;

    /// Writes instruction to CPI context as the first operation in a batch.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    #[must_use = "write_to_cpi_context_first returns a new value"]
    fn write_to_cpi_context_first(self) -> Self;

    /// Writes instruction to CPI context as a subsequent operation in a batch.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    #[must_use = "write_to_cpi_context_set returns a new value"]
    fn write_to_cpi_context_set(self) -> Self;

    /// Executes all operations accumulated in CPI context.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    #[must_use = "execute_with_cpi_context returns a new value"]
    fn execute_with_cpi_context(self) -> Self;

    /// Returns whether this instruction uses CPI context.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    fn get_with_cpi_context(&self) -> bool;

    /// Returns the CPI context configuration.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    fn get_cpi_context(
        &self,
    ) -> &light_compressed_account::instruction_data::cpi_context::CompressedCpiContext;

    /// Returns whether this instruction has any read-only accounts.
    ///
    /// # Availability
    /// Only available with the `cpi-context` feature enabled.
    fn has_read_only_accounts(&self) -> bool;
}