jiminy-core 0.17.0

Core systems layer for Jiminy: account layout, zero-copy IO, validation, PDA, sysvar access, math, time checks. Declarative macros for error codes, instruction dispatch, and account uniqueness. no_std, no_alloc, no proc macros, BPF-safe.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! Convenience re-exports for the common jiminy-core usage pattern.
//!
//! ```rust,ignore
//! use jiminy_core::prelude::*;
//! ```

// ── Check functions ──────────────────────────────────────────────────────────
pub use crate::check::{
    check_account, check_accounts_unique_2, check_accounts_unique_3, check_accounts_unique_4,
    check_closed, check_discriminator, check_executable, check_has_one,
    check_instruction_data_len, check_instruction_data_min, check_keys_eq,
    check_lamports_gte, check_owner, check_pda, check_program_allowed, check_rent_exempt,
    check_signer, check_size, check_system_program, check_uninitialized, check_version,
    check_writable, rent_exempt_min,
};

// ── Assert functions ─────────────────────────────────────────────────────────
pub use crate::check::{
    assert_address, assert_not_initialized, assert_pda, assert_pda_external,
    assert_pda_with_bump, assert_program,
};
#[cfg(feature = "programs")]
pub use crate::check::assert_token_program;

// ── Account header ───────────────────────────────────────────────────────────
pub use crate::account::{
    AccountHeader, body, body_mut, check_header, check_layout_id, header_payload,
    header_payload_mut, read_header_flags, read_layout_id, read_version, write_header,
    HEADER_LEN,
};

// ── Zero-copy IO ─────────────────────────────────────────────────────────────
pub use crate::account::{AccountReader, AccountWriter};
pub use crate::account::{write_discriminator, zero_init, DataWriter, SliceCursor};
pub use crate::account::{pod_from_bytes, pod_from_bytes_mut, pod_read, pod_write, FixedLayout, Pod};
pub use crate::account::{ZeroCopySlice, ZeroCopySliceMut};
pub use crate::account::{VerifiedAccount, VerifiedAccountMut};

// ── Segments ─────────────────────────────────────────────────────────────────
pub use crate::account::{
    SegmentDescriptor, SegmentTable, SegmentTableMut,
    SegmentSlice, SegmentSliceMut, SegmentIter,
    SEGMENT_DESC_SIZE, MAX_SEGMENTS,
};

// ── Tiered loading ───────────────────────────────────────────────────────────
pub use crate::account::view::{validate_account, validate_foreign, load_unverified_overlay};
#[cfg(not(feature = "strict"))]
pub use crate::account::view::validate_version_compatible;

// ── Math ─────────────────────────────────────────────────────────────────────
pub use crate::math::{
    bps_of, bps_of_ceil, checked_add, checked_div, checked_div_ceil, checked_mul,
    checked_mul_div, checked_mul_div_ceil, checked_pow, checked_sub, scale_amount,
    scale_amount_ceil, to_u64,
};

// ── Bit helpers ──────────────────────────────────────────────────────────────
pub use crate::account::{
    check_any_flag, check_flags, clear_bit, read_bit, read_flags_at, set_bit, toggle_bit,
    write_flags_at,
};

// ── Account lifecycle ────────────────────────────────────────────────────────
pub use crate::account::{
    safe_close, safe_close_with_sentinel, safe_realloc, safe_realloc_shrink,
    check_not_revived, check_alive, CLOSE_SENTINEL,
};

// ── PDA utilities ────────────────────────────────────────────────────────────
pub use crate::check::pda::{derive_address, derive_address_const};
#[cfg(feature = "programs")]
pub use crate::check::pda::{
    check_ata, check_ata_with_program, derive_ata, derive_ata_with_bump,
    derive_ata_with_program,
};

// ── Account iteration ────────────────────────────────────────────────────────
pub use crate::account::AccountList;

// ── Field descriptors ────────────────────────────────────────────────────────
pub use crate::field::Field;

// ── State hygiene ────────────────────────────────────────────────────────────
pub use crate::state::{
    zero_bytes, write_version, write_disc, write_layout_id,
    ExtensionRegion,
};
pub use crate::packed::ReservedBytes;

// ── ABI field types ──────────────────────────────────────────────────────────
pub use crate::abi::{
    FieldMut, FieldRef, LeBool, LeI128, LeI16, LeI32, LeI64, LeU128, LeU16, LeU32, LeU64,
};

// ── Sysvar readers ───────────────────────────────────────────────────────────
pub use crate::sysvar::{
    clock_timestamp, clock_slot, clock_slot_and_timestamp, clock_epoch,
    rent_lamports_per_byte_year,
};
#[cfg(feature = "programs")]
pub use crate::sysvar::{
    check_clock_sysvar, check_rent_sysvar, read_clock, read_clock_epoch, read_clock_slot,
    read_clock_timestamp, read_rent_lamports_per_byte_year,
};

// ── Instruction access ───────────────────────────────────────────────────────
pub use crate::instruction::{
    current_index, instruction_count, program_id_at, instruction_data_range,
    instruction_account_key, caller_program, require_top_level, require_cpi_from,
    count_program_invocations, detect_flash_loan_bracket,
    check_no_other_invocation, check_no_subsequent_invocation,
};
#[cfg(feature = "programs")]
pub use crate::instruction::check_has_compute_budget;

// ── Zero-alloc event emission ────────────────────────────────────────────────
pub use crate::event::emit_slices;

// ── Time / deadline checks ───────────────────────────────────────────────────
pub use crate::time::{
    check_cooldown, check_expired, check_not_expired, check_slot_staleness,
    check_within_window,
};
#[cfg(feature = "programs")]
pub use crate::time::{check_after, check_deadline};

// ── State machine checks ─────────────────────────────────────────────────────
pub use crate::state::{
    check_state, check_state_in, check_state_not, check_state_transition, write_state,
};

// ── Macros ───────────────────────────────────────────────────────────────────
pub use crate::{
    assert_legacy_layout, check_accounts_unique, close_account, error_codes, init_account,
    instruction_dispatch, impl_pod, require, require_accounts_ne, require_eq, require_flag,
    require_gt, require_gte, require_keys_eq, require_keys_neq, require_lt, require_lte,
    require_neq, zero_copy_layout,
    segmented_layout,
    // check_account is both a macro (check_account!) and a function (check::check_account).
    // The function is exported above via check::*. The macro is #[macro_export] at crate root.
};

// ── Runtime core types ───────────────────────────────────────────────────────
pub use hopper_runtime::{ProgramError, AccountView, Address, ProgramResult};
pub use hopper_runtime::{
    hopper_entrypoint,
    hopper_lazy_entrypoint,
    lazy_entrypoint,
    no_allocator,
    nostd_panic_handler,
    program_entrypoint,
};