jiminy
Deterministic account ABI + safety layer for Solana programs built on pinocchio.
What Jiminy is
- Zero-copy account layouts with deterministic
layout_id - Mechanical safety checks enforced at runtime
- Cross-program ABI verification (
load_foreign) - No framework, no hidden control flow
What Jiminy gives you
- Verified account loading (owner + disc + version + layout_id)
- Tiered trust model for account reads
- Zero-alloc overlays (
Pod,zero_copy_layout!) - Reusable validation and constraint macros
- ABI manifests for off-chain tooling (
jiminy-schema) - Token-2022 extension screening, slippage guards, CPI reentrancy detection
What Jiminy is not
- Not a framework
- Not Anchor
- Not an ORM
- Not a codegen-heavy system
- Not trying to own your program architecture
What Jiminy will never do
- Hide control flow behind a runtime or dispatcher you don't own
- Require
alloc,std, or heap-backed deserialization for core functionality - Silently validate accounts without explicit calls or explicit loaders
- Make cross-program ABI compatibility implicit -- ABI trust is always opt-in and auditable
- Depend on domain-extension crates (finance/lending/staking) from core
- Lock your program into a build-time codegen pipeline or proc-macro framework
- Treat unsafe loaders as normal -- unsafe remains loud and compartmentalized
Mental model
Anchor = full framework
Jiminy = safety + ABI layer
Pinocchio = raw execution layer
Jiminy enforces correctness without taking control. You write process_instruction,
you own the control flow, and you can drop any module and call pinocchio directly.
no_std. no_alloc. Declarative macros only. Everything #[inline(always)].
Start Here
| I want to... | Start with |
|---|---|
| Start a new program | examples/jiminy-vault |
| Add jiminy to a pinocchio program | MIGRATION_COOKBOOK |
| Read another program's accounts | ACCOUNT_ABI_CONTRACT |
| Build off-chain tooling | jiminy-schema |
Account ABI
The account header is what separates jiminy from a bag of utility functions. Every jiminy account starts with the same 16-byte prefix, and that prefix is what makes cross-program reads, version checking, and tooling integration work without deserialization.
| 16-byte header | Discriminator, version, flags, layout_id, reserved. On every account. |
Deterministic layout_id |
8-byte SHA-256 fingerprint of struct name, version, field names, types, and sizes. Changes iff the schema changes. |
zero_copy_layout! |
Declare #[repr(C)] structs that overlay directly onto account bytes. Generates Pod, FixedLayout, tiered loaders, and compile-time size + alignment assertions. |
| Alignment safety | zero_copy_layout! enforces align_of::<T>() <= 8 at compile time. Raw u128 or any over-aligned type is a compile error. Use LeU128 / Le* wrappers for 16-byte scalars. |
| Cross-program reads | load_foreign() validates layout_id without depending on the source program's crate. No deserialization. |
| Tiered loading | load > load_foreign > validate_version_compatible > load_unchecked > load_unverified_overlay. Pick the trust level you need. |
| Version migration | validate_version_compatible() for version transitions. Skips layout_id, so it's explicitly weaker. |
| Tooling | jiminy-schema exports LayoutManifest for TypeScript decoders, indexers, and explorers. |
zero_copy_layout!
// Create: CPI + zero-init + header in one call
init_account!?;
// Read: full ABI validation + zero-copy overlay
let verified = load?;
let vault = verified.get;
// Cross-program: layout_id proof, no crate dependency
let verified = load_foreign?;
let vault = verified.get;
Safety Tiers
Five loading tiers, each with less validation than the last. Most code should use Tier 1 or 2. Anything else is an explicit opt-in.
| Tier | Name | Method | Use when |
|---|---|---|---|
| 1 | Verified | load() / load_mut() |
Your own program's accounts |
| 2 | Foreign Verified | load_foreign() |
Another program's accounts |
| 3 | Compatibility | validate_version_compatible() |
Version migration (weaker, skips layout_id) |
| 4 | Unsafe | load_unchecked() |
Hot path. Caller assumes all risk. |
| 5 | Unverified Overlay | load_unverified_overlay() |
Indexers, explorers, tooling |
Tier 4 is unsafe on purpose. If you reach for it, you know what you're
skipping. See SAFETY_MODEL.md for the full trust
model and all 10 safety invariants.
ABI Contract
These documents define the Jiminy ABI contract:
| Document | Scope |
|---|---|
| LAYOUT_CONVENTION.md | 16-byte header format, zero_copy_layout!, layout_id computation |
| ABI_VERSIONING.md | Append-only versioning, extends, migration rules |
| ACCOUNT_ABI_CONTRACT.md | Cross-program read contract, load_foreign guarantees |
| SEGMENTED_ABI.md | Variable-length accounts, segment descriptors |
Breaking any of these is a breaking change. If a schema change alters
the layout_id, it's a new layout, not a compatible update.
ABI stability rules (semver binding)
- Patch (x.y.Z): bug fixes, docs, performance. Must not change header format,
layout_idhashing, or manifest schema. - Minor (x.Y.z): additive features only. May add new helpers/macros, but must not change
LAYOUT_IDfor an unchanged schema. - Major (X.y.z): only when ABI contracts or hashing rules change.
A change that alters LAYOUT_ID is an ABI change by definition. Treat it as a new layout, not a "compatible upgrade."
Before and After
Raw pinocchio (32 lines):
if accounts.len < 3
let payer = &accounts;
let vault = &accounts;
let system = &accounts;
if !payer.is_signer
if !payer.is_writable
if !vault.is_writable
if *system.address != SYSTEM_PROGRAM_ID
if !vault.is_data_empty
let lamports = rent_exempt_min;
let mut ix_data = ;
ix_data.copy_from_slice;
ix_data.copy_from_slice;
ix_data.copy_from_slice;
ix_data.copy_from_slice;
invoke?;
let mut raw = vault.try_borrow_mut?;
raw.fill;
raw = VAULT_DISC;
raw.copy_from_slice;
raw.copy_from_slice;
Jiminy (14 lines):
let mut accs = new;
let payer = accs.next_writable_signer?;
let vault = accs.next_writable?;
let _sys = accs.next_system_program?;
check_uninitialized?;
CreateAccount
.invoke?;
let mut raw = vault.try_borrow_mut?;
zero_init;
write_discriminator?;
Same CU cost. Same binary size. Half the code. Every check is explicit and there's nothing to forget.
At a Glance
| Feature | Raw Pinocchio | Anchor | Jiminy |
|---|---|---|---|
| Zero-copy | manual | partial | native |
| Safety checks | manual | hidden | explicit |
| ABI standard | none | implicit | explicit |
| Macros | none | heavy (proc) | minimal (declarative) |
| Control | full | limited | full |
New in 0.16
Verified account wrappers
VerifiedAccount<T>/VerifiedAccountMut<T>: type-safe wrappers returned byload()/load_mut()/load_foreign(). Infallibleget()/get_mut()access after construction. No raw bytes exposed.strictfeature: production hardening mode. When enabled,validate_version_compatible()is compile-time disabled, forcing all loads through layout_id-verified tiers.
Safety hardening
- Compile-time alignment assertion in
jiminy_interface!: prevents over-aligned types (rawu128, etc.) from slipping through interface definitions. jiminy_interface!version parameter: interfaces can now specifyversion = Nto match foreign layouts at any version. Default remainsversion = 1for backward compatibility.- Push overlap protection:
segment_pushnow checks the next segment's offset to prevent writes from overflowing into adjacent segments. init_segments_with_capacity(): new initializer for segmented layouts that spaces segment offsets by max capacity with counts starting at zero. Enables safe push/remove workflows.- Exact size enforcement: Tiers 1 and 2 now require
data.len() == expected_size(was<). Prevents hidden trailing data attacks. load_mut()backed byRefMut: eliminates UB from mutable aliasing.
Alignment-safe ABI field types
abimodule: 9 alignment-1 LE wire types (LeU16,LeU32,LeU64,LeU128,LeI16,LeI32,LeI64,LeI128,LeBool).#[repr(transparent)]over[u8; N]. Safe on all targets, zero overhead on SBF.FieldRef/FieldMut: typed, borrow-split views over field-sized byte slices. Read or write individual fields without holding a reference to the whole struct.split_fields/split_fields_mut: generated byzero_copy_layout!. Decompose account data into independent per-field slices. The borrow checker sees non-overlapping references, nounsafeneeded.- Const field offsets:
zero_copy_layout!now emitspub const header: usize = 0,pub const balance: usize = 16, etc. for each field.
Cross-program ABI interfaces
jiminy_interface!macro: declare a read-only view of a foreign program's account. Generates the sameLAYOUT_IDas the foreignzero_copy_layout!, soload_foreignproves ABI compatibility without a crate dependency. Supportsversion = Nto match foreign layouts at any version.cross-program-readexample: two-program demo (Program A creates, Program B reads) showing the full pattern.
Segmented ABI for variable-length accounts
segmented_layout!macro: extendszero_copy_layout!with dynamic segments. Declare a fixed prefix plus any number of variable-length arrays. The macro generatesSEGMENT_COUNT,TABLE_OFFSET,DATA_START_OFFSET,init_segments(),validate_segments(),compute_account_size(), and a dedicatedSEGMENTED_LAYOUT_ID.SegmentDescriptor(8 bytes):offset: u32 LE,count: u16 LE,element_size: u16 LE. Describes one dynamic array.SegmentTable/SegmentTableMut: immutable/mutable views over the descriptor region. Validation (bounds, overlap, element-size match) built in.SegmentSlice<T>/SegmentSliceMut<T>: typed zero-copy views over segment data. Same pattern asZeroCopySlice, driven by descriptors.SegmentIter<T>:ExactSizeIteratorover segment elements by copy.
Schema tooling
export_json(): hand-built JSON manifest for TypeScript decoders and indexers. No serde dependency.verify(): structural validation ofLayoutManifest(header check, zero-size check, duplicate detector).- Anchor IDL generation:
anchor_idl_json()produces Anchor IDL v0.1.0 account fragments. Explorer and wallet integration without the Anchor framework.
Compat
- Le ↔ solana-zero-copy bridge*: bidirectional
Fromconversions between Jiminy'sLe*types andsolana-zero-copyv1.0.0 unaligned types (U16,U32,U64,I16,I64,Bool,U128). Use either ABI surface; switch freely.
Docs
SEGMENTED_ABI.md: Design for variable-length accounts with segment descriptors (implemented in v0.15.0).UNSAFE_INVENTORY.md: everyunsafesite catalogued with file, purpose, and soundness justification.- 265+ Rust tests across the workspace: 109 unit + 13 proptest + 59 segment (jiminy-core), 33 (jiminy-schema), 18 (jiminy-layouts), 25 (jiminy-anchor), plus doc tests.
Account ABI system
- 16-byte account header: discriminator (1 B) + version (1 B) + flags (2 B) +
layout_id(8 B) + reserved (4 B). Every account gets a tamper-evident fingerprint. zero_copy_layout!macro (v2): generates#[repr(C)]structs withPod+FixedLayout, overlay methods, and a deterministicLAYOUT_ID(SHA-256 of field names, types, and sizes). Includesextendskeyword for append-only schema evolution.- Tiered loading:
load_checked(full validation),load_foreign(cross-program reads),load_unchecked(unsafe fast path),load_unverified_overlay(no ABI guarantees). init_account!: CPI CreateAccount → zero-init → write header in one call.check_account!: disc + version + layout_id validation macro.close_account!: safe close with lamport drain and sentinel byte.- Compile-time assertions: size, alignment, and extends-compatibility checked at compile time.
New crates
jiminy-schema:LayoutManifeststruct, TypeScript decoder codegen, indexer/explorer integration kit. Serialize your account schema for off-chain tooling.jiminy-layouts: Pre-built#[repr(C)]overlays for SPL Token Account, Mint, Multisig, Nonce Account, and Stake Account. Read external program accounts withpod_from_bytes.jiminy-anchor: Anchor discriminator computation (account, instruction, event),check_and_overlay/check_and_overlay_mutfor zero-copy Anchor body reads,check_anchor_with_versionfor cross-framework verification, andload_anchor_account/load_anchor_overlayAccountView helpers.
Ecosystem integration
solana-zero-copycompat: optional integration withsolana-zero-copyv1.0.0. BidirectionalFrombridges between JiminyLe*types andBool,U16,U32,U64,I16,I64,U128unaligned types. Enable viafeatures = ["solana-zero-copy"].
error_codes!macro: define numbered program error codes withInto<ProgramError>. Replaces Anchor's#[error_code]proc macro.instruction_dispatch!macro: byte-tag instruction routing. Replaces Anchor's#[program]proc macro.check_accounts_unique!macro: variadic pairwise uniqueness for any N accounts. Replacescheck_accounts_unique_2/3/4.impl_pod!macro: batchunsafe impl Podfor a list of types.extension_types!/check_no_ext!internal macros: generate Token-2022 extension enum and screening functions.- Docs overhaul: every crate's
docs.rspage now has a proper intro explaining what it does and why you need it.
zero_copy_layout!macro: declare#[repr(C)]structs that overlay directly onto account bytes. No proc macros, no borsh, just typed fields at byte offsets.ZeroCopySlice/ZeroCopySliceMut: length-prefixed[u32][T; len]arrays in account data. Zero-copy iteration, random access, mutation.init()for first write.pod_read<T>(): alignment-safe owned copy viaread_unaligned. Works on all targets, great for native tests.- Syscall-based sysvar access:
clock_timestamp(),clock_slot(),clock_epoch(),rent_lamports_per_byte_year(). No account slot needed. Just call and get the value. - Instruction deduplication:
jiminy-solana'scomposeandintrospectmodules now delegate tojiminy-core::instructioninstead of reimplementing the same parsing logic.
Architecture
Twelve crates, four layers. Use jiminy for everything or pull in just the
layer you need.
┌──────────────────────────────────────────────────────────────────┐
│ jiminy (umbrella - re-exports + synced macro copies) │
│ │
│ ┌────────────────────────────────────────────────────────────┐ │
│ │ Tooling jiminy-schema · jiminy-layouts · jiminy-anchor │ │
│ │ │ │
│ │ ┌────────────────────────────────────────────────────┐ │ │
│ │ │ Ring 2 jiminy-solana │ │ │
│ │ │ token/ · cpi/ · crypto/ · oracle ··· │ │ │
│ │ │ │ │ │
│ │ │ ┌──────────────────────────────────────────────┐ │ │ │
│ │ │ │ Ring 1 jiminy-core │ │ │ │
│ │ │ │ account/ · check/ · math · ··· │ │ │ │
│ │ │ └──────────────────────────────────────────────┘ │ │ │
│ │ └────────────────────────────────────────────────────┘ │ │
│ └────────────────────────────────────────────────────────────┘ │
└──────────────────────────────────────────────────────────────────┘
Domain extensions (not core, jiminy does not depend on these):
jiminy-finance · jiminy-lending · jiminy-staking
jiminy-vesting · jiminy-multisig · jiminy-distribute
Ring 1 - Systems layer (jiminy-core)
| Module | |
|---|---|
account |
Header, reader, writer, cursor, lifecycle, pod, overlay, collection, list, bits |
check |
Validation checks, asserts, PDA derivation & verification |
instruction |
Transaction introspection, composition guards, flash-loan detection |
math |
Checked arithmetic, BPS, scaling (u128 intermediates) |
sysvar |
Clock and Rent sysvar readers (syscall-based + account-based) |
state |
State machine transition checks |
time |
Deadline, cooldown, staleness checks |
event |
Zero-alloc event emission via sol_log_data |
programs |
Well-known program IDs (feature: programs) |
Ring 2 - Platform helpers (jiminy-solana)
| Module | |
|---|---|
token |
SPL Token account/mint readers, Token-2022 extension screening |
cpi |
Safe CPI wrappers, reentrancy guards, return data readers |
crypto |
Ed25519 precompile verification, Merkle proof verification |
authority |
Two-step authority rotation (propose + accept) |
balance |
Pre/post CPI balance delta guards |
compute |
Compute budget guards |
compose |
Transaction composition guards (flash-loan detection) |
introspect |
Raw transaction introspection |
oracle |
Pyth V2 price feed readers (zero external deps) |
twap |
TWAP accumulators |
upgrade |
Program upgrade authority verification (feature: programs) |
Tooling & ecosystem crates
| Crate | |
|---|---|
jiminy-schema |
LayoutManifest generation, TypeScript decoder codegen, indexer/explorer integration |
jiminy-layouts |
Pre-built #[repr(C)] overlays for SPL Token Account, Mint, Multisig, Nonce, Stake |
jiminy-anchor |
Anchor disc computation, check_and_overlay, cross-framework layout_id verification |
TypeScript & templates
| Package / Dir | |
|---|---|
ts/jiminy-ts (@jiminy/ts) |
TypeScript npm package: header decode, layout_id checks, segment table parsing, 5 standard layout decoders |
templates/vault |
Minimal vault template (fixed layout, init_account!, close_account!) |
templates/escrow |
Escrow template (flags, time checks, conditional close) |
templates/staking |
Staking pool template (segmented_layout!, dynamic segments, swap-remove) |
Community / Domain Extensions (Not Core)
These crates demonstrate patterns built using Jiminy. They are not part of the core, and Jiminy does not depend on them.
| Crate | |
|---|---|
jiminy-finance |
AMM math, constant-product swaps, slippage & economic bounds |
jiminy-lending |
Lending protocol primitives (collateralization, liquidation, interest) |
jiminy-staking |
Staking reward accumulators (MasterChef-style) |
jiminy-vesting |
Vesting schedule helpers (linear, cliff, stepped, periodic) |
jiminy-multisig |
M-of-N multi-signer threshold checks |
jiminy-distribute |
Dust-safe proportional distribution & fee extraction |
Install
# Full toolkit (recommended)
[]
= "0.16"
# Or pick individual crates for minimal deps
= "0.16" # Account layout, checks, math, PDA
= "0.16" # Token, CPI, crypto, oracle
= "0.16" # AMM math, slippage
# Tooling & ecosystem
= "0.16" # Layout manifests, TS codegen, indexer kit
= "0.16" # SPL Token/Mint/Multisig/Nonce/Stake overlays
= "0.16" # Anchor disc + zero-copy overlay interop
Adding Jiminy to an existing Pinocchio project
Already using pinocchio directly? You have two options:
Option 1: Keep both dependencies
[]
= "0.10"
= "0.16"
This works fine. Cargo deduplicates the pinocchio crate as long as versions are
compatible. You keep your existing use pinocchio::* imports and add jiminy
imports alongside them.
Option 2: Drop the direct pinocchio dependency (recommended)
[]
= "0.16"
Jiminy re-exports the entire pinocchio crate, plus pinocchio-system and
pinocchio-token. Replace your pinocchio imports:
// Before
use ;
use ;
// After
use ;
use ;
// Or just use the prelude for the most common types
use *;
The pub use pinocchio; re-export in lib.rs makes the entire pinocchio
API available under jiminy::pinocchio, so there's no need for a direct
dependency. Same for jiminy::pinocchio_system and jiminy::pinocchio_token.
One crate, one version, no duplication.
The prelude also re-exports the most common CPI structs:
use *;
// System program CPI - no more hand-rolling 52-byte instruction data
CreateAccount
.invoke?;
// Token program CPI
TokenTransfer
.invoke?;
Quick Start
use *;
One import. Everything listed above lands in scope. Account checks, token
readers, CPI wrappers, DeFi math, macros, AccountList, cursors, and the
pinocchio core types. You don't need a direct pinocchio dependency anymore.
All public functions are available both via the prelude and through their
module paths (jiminy::token::*, jiminy::cpi::*, jiminy::math::*, etc.).
A real example
use *;
API reference
Account validation
| Function | Anchor equivalent | What it does |
|---|---|---|
check_signer(account) |
signer |
Must be a transaction signer |
check_writable(account) |
mut |
Must be marked writable |
check_owner(account, program_id) |
owner |
Must be owned by your program |
check_pda(account, expected) |
seeds + bump |
Address must match the derived PDA |
check_system_program(account) |
Program<System> |
Must be the system program |
check_executable(account) |
executable |
Must be an executable program |
check_uninitialized(account) |
init |
Data must be empty (anti-reinit) |
check_has_one(stored, account) |
has_one |
Stored address field must match account key |
check_rent_exempt(account) |
rent_exempt |
Must hold enough lamports for rent exemption |
check_lamports_gte(account, min) |
constraint |
Must hold at least min lamports |
check_closed(account) |
close |
Must have zero lamports and empty data |
check_account(account, id, disc, len) |
composite | Owner + size + discriminator in one call |
check_accounts_unique!(a, b, c, ...) |
-- | Variadic: all accounts have different addresses |
check_accounts_unique_2(a, b) |
-- | Two accounts have different addresses |
check_accounts_unique_3(a, b, c) |
-- | Three accounts all different (src != dest != fee) |
check_accounts_unique_4(a, b, c, d) |
-- | Four accounts all different (two-hop swaps) |
check_instruction_data_len(data, n) |
-- | Exact instruction data length |
check_instruction_data_min(data, n) |
-- | Minimum instruction data length |
check_version(data, min) |
-- | Header version byte >= minimum |
check_program_allowed(account, list) |
-- | Owner must be in a const allowlist |
Assert functions
These derive, compare, and return useful data in addition to validating.
| Function | What it does |
|---|---|
assert_pda(account, seeds, program_id) |
Derive PDA, verify match, return bump |
assert_pda_with_bump(account, seeds, bump, id) |
Verify PDA with known bump (way cheaper) |
assert_pda_external(account, seeds, id) |
Same as assert_pda for external program PDAs |
assert_token_program(account) |
Must be SPL Token or Token-2022 |
assert_address(account, expected) |
Account address must match exactly |
Macros
| Macro | What it does |
|---|---|
check_account!(acct, ...) |
Composable constraint validation (any subset) |
check_account_strict!(acct, owner=, disc=, layout_id=, ...) |
Same, but owner + disc + layout_id are mandatory |
require_pda!(acct, program, seed1, seed2, ...) |
Derive PDA, verify match, return bump |
assert_program(account, expected) |
Address match + must be executable |
assert_not_initialized(account) |
Lamports == 0 (account doesn't exist yet) |
AccountList -- iterator-style account consumption
Stop hand-indexing accounts[0], accounts[1]. AccountList gives you
named, validated accounts in order with inline constraint checks:
let mut accs = new;
let payer = accs.next_writable_signer?;
let vault = accs.next_writable_account?;
let user_token = accs.next_token_account?;
let mint = accs.next_mint?;
let token_program = accs.next_token_program?; // validates SPL Token or Token-2022
let any_token = accs.next_writable_token_account?;
let rent = accs.next_rent?;
let clock = accs.next_clock?;
let sysvar_ix = accs.next_sysvar_instructions?;
Each method consumes one account and runs the appropriate checks. Runs out of
accounts? You get NotEnoughAccountKeys, not a panic.
Token account readers + checks
Zero-copy reads from the 165-byte SPL Token layout. No deserialization.
| Function | What it reads / checks |
|---|---|
token_account_owner(account) |
Owner address (bytes 32..64) |
token_account_amount(account) |
Token balance as u64 (bytes 64..72) |
token_account_mint(account) |
Mint address (bytes 0..32) |
token_account_delegate(account) |
Optional delegate address |
token_account_state(account) |
State byte (0=uninit, 1=init, 2=frozen) |
token_account_close_authority(account) |
Optional close authority |
token_account_delegated_amount(account) |
Delegated amount (u64) |
check_token_account_mint(account, mint) |
Mint matches expected |
check_token_account_owner(account, owner) |
Owner matches expected |
check_token_account_initialized(account) |
State == 1 |
check_no_delegate(account) |
No active delegate (prevents fund pulling) |
check_no_close_authority(account) |
No close authority set |
check_token_balance_gte(account, min) |
Token balance >= minimum |
check_token_program_match(account, prog) |
Account owned by the right token program |
check_not_frozen(account) |
Reject frozen token accounts upfront |
Mint account readers + checks
Same zero-copy approach for the 82-byte SPL Mint layout.
| Function | What it reads / checks |
|---|---|
mint_authority(account) |
Optional mint authority address |
mint_supply(account) |
Total supply (u64) |
mint_decimals(account) |
Decimals (u8) |
mint_is_initialized(account) |
Is initialized (bool) |
mint_freeze_authority(account) |
Optional freeze authority |
check_mint_owner(account, token_prog) |
Mint owned by expected token program |
check_mint_authority(account, expected) |
Mint authority matches |
Token-2022 extension screening
Programs accepting Token-2022 tokens must screen for dangerous extensions. Ignoring transfer fees, hooks, or permanent delegates is a critical vulnerability. Jiminy gives you a full TLV extension reader and one-line safety guards:
let data = mint_account.try_borrow?;
// Nuclear option: reject all dangerous extensions at once
check_safe_token_2022_mint?;
// Or check individually
check_no_transfer_fee?;
check_no_transfer_hook?;
check_no_permanent_delegate?;
check_not_non_transferable?;
check_no_default_account_state?;
// Need to actually handle transfer fees? Read the config.
if let Some = read_transfer_fee_config?
Also: find_extension, has_extension, check_no_extension, check_token_program_for_mint,
and the full ExtensionType enum covering all 24 known extension types.
CPI reentrancy protection
Reentrancy on Solana works differently than on EVM, but it's still real. A malicious program can invoke your instruction via CPI to exploit intermediate state.
let sysvar_ix = accs.next_sysvar_instructions?;
// Reject if we were called via CPI (top-level only)
check_no_cpi_caller?;
// Or verify the CPI caller is a trusted router
check_cpi_caller?;
Reads the Sysvar Instructions account to inspect the instruction stack. Zero runtime overhead beyond the sysvar read.
DeFi math
Standard DeFi math with u128 intermediates. Without the promotion,
amount * price overflows for any token amount above ~4.2B.
| Function | What it does |
|---|---|
checked_add(a, b) |
Overflow-safe u64 addition |
checked_sub(a, b) |
Underflow-safe u64 subtraction |
checked_mul(a, b) |
Overflow-safe u64 multiplication |
checked_div(a, b) |
Division with zero check |
checked_div_ceil(a, b) |
Ceiling division (fees should never round to zero) |
checked_mul_div(a, b, c) |
(a * b) / c with u128 intermediate (floor) |
checked_mul_div_ceil(a, b, c) |
Same, ceiling (protocol-side fee math) |
bps_of(amount, bps) |
Basis point fee: amount * bps / 10_000 |
bps_of_ceil(amount, bps) |
Same, ceiling |
checked_pow(base, exp) |
Exponentiation via repeated squaring |
to_u64(val) |
Safe u128 -> u64 narrowing |
scale_amount(amount, from, to) |
Decimal-aware token amount conversion (u128 intermediate) |
scale_amount_ceil(amount, from, to) |
Same, ceiling (protocol-side math) |
Slippage + economic bounds
| Function | What it does |
|---|---|
check_slippage(actual, min_output) |
Reject sandwich attacks |
check_max_input(actual, max_input) |
Exact-output swap: input doesn't exceed max |
check_min_amount(amount, min) |
Anti-dust: reject economically meaningless ops |
check_max_amount(amount, max) |
Exposure limit per operation |
check_nonzero(amount) |
Zero-amount transfers/swaps are always a bug |
check_within_bps(actual, expected, tol) |
Oracle deviation check (u128 intermediate) |
check_price_bounds(price, min, max) |
Circuit breaker for price feeds |
Time + deadline checks
| Function | What it does |
|---|---|
check_not_expired(now, deadline) |
Current time <= deadline |
check_expired(now, deadline) |
Current time > deadline (for claims/settlements) |
check_within_window(now, start, end) |
Time is within [start, end] (auction windows) |
check_cooldown(last, cooldown, now) |
Rate limiting (oracle updates, admin changes) |
check_deadline(clock, deadline) |
Combined: read Clock sysvar + check not expired |
check_after(clock, deadline) |
Combined: read Clock sysvar + check expired |
check_slot_staleness(last, current, max) |
Slot-based oracle/data feed staleness check |
Sysvar readers
Zero-copy readers for Clock and Rent. No deserialization, just offset reads.
let clock = accs.next_clock?;
let = read_clock?;
let epoch = read_clock_epoch?;
State machine validation
DeFi programs are state machines: orders go Open -> Filled -> Settled, escrows go Pending -> Released -> Disputed.
const TRANSITIONS: & = &;
let data = order.try_borrow?;
check_state?;
check_state_transition?;
let mut data = order.try_borrow_mut?;
write_state?;
Also: check_state_not, check_state_in (multiple valid states).
PDA utilities
| Macro / Function | What it does |
|---|---|
find_pda!(program_id, seed1, seed2, ...) |
Find canonical PDA + bump via syscall |
derive_pda!(program_id, bump, seed1, ...) |
Derive PDA with known bump (~100 CU) |
derive_pda_const!(id_bytes, bump, seed1, ...) |
Compile-time PDA derivation |
derive_ata(wallet, mint) |
Derive ATA address + bump |
derive_ata_with_program(wallet, mint, token_prog) |
ATA with explicit token program |
derive_ata_with_bump(wallet, mint, bump) |
ATA with known bump (cheap) |
derive_ata_const!(wallet_bytes, mint_bytes, bump) |
Compile-time ATA derivation |
check_ata(account, wallet, mint) |
Verify account is the canonical ATA |
check_ata_with_program(account, wallet, mint, prog) |
Same, for Token-2022 ATAs |
Macros
Macros in Jiminy exist to reduce repetitive safety code, not to introduce
abstraction layers. All macros are declarative (macro_rules!). No proc macros.
Account ABI
| Macro | What it does |
|---|---|
zero_copy_layout! |
Define #[repr(C)] account struct with Pod, overlay, tiered loaders, LAYOUT_ID |
segmented_layout! |
Extend zero_copy_layout! with dynamic variable-length segments |
jiminy_interface! |
Declare read-only view of a foreign program's account (cross-program ABI) |
init_account! |
CPI create + zero-init + header write in one call |
close_account! |
Safe close with lamport drain and sentinel byte |
check_account! |
Disc + version + layout_id validation |
impl_pod!(T1, T2, ...) |
Batch unsafe impl Pod for #[repr(C)] types |
Safety guards
| Macro | What it does |
|---|---|
require!(cond, err) |
Return error if condition is false |
require_eq!(a, b, err) |
a == b (scalars) |
require_neq!(a, b, err) |
a != b (scalars) |
require_gt!(a, b, err) |
a > b |
require_gte!(a, b, err) |
a >= b |
require_lt!(a, b, err) |
a < b |
require_lte!(a, b, err) |
a <= b |
require_keys_eq!(a, b, err) |
Two Address values must be equal |
require_keys_neq!(a, b, err) |
Two Address values must differ |
require_accounts_ne!(a, b, err) |
Two accounts must have different addresses |
require_flag!(byte, n, err) |
Bit n must be set in byte |
check_accounts_unique!(a, b, c) |
Variadic uniqueness (any N accounts) |
Program structure
| Macro | What it does |
|---|---|
error_codes! { base = 6000; ... } |
Define numbered ProgramError::Custom codes |
instruction_dispatch! { ... } |
Tag-byte dispatch to handler functions |
PDA
| Macro | What it does |
|---|---|
find_pda!(program_id, seed1, ...) |
Find canonical PDA + bump via syscall |
derive_pda!(program_id, bump, seed1, ...) |
Derive PDA with known bump (~100 CU) |
derive_pda_const!(id_bytes, bump, seed1, ...) |
Compile-time PDA derivation |
derive_ata_const!(wallet_bytes, mint_bytes, bump) |
Compile-time ATA derivation |
Events
| Macro | What it does |
|---|---|
emit!(&disc, &field1, &field2, ...) |
Zero-alloc event emission via sol_log_data |
Cursors
| Type / Function | What it does |
|---|---|
SliceCursor |
Position-tracked, bounds-checked reads from &[u8] |
DataWriter |
Position-tracked, bounds-checked writes to &mut [u8] |
SliceCursor::from_instruction(data, min_len) |
Cursor with upfront length validation |
zero_init(data) |
Zero-fill before writing (prevents stale-data bugs) |
write_discriminator(data, disc) |
Write type tag byte |
Supports: u8, u16, u32, u64, u128, i8, i16, i32, i64, i128,
bool, Address. All little-endian.
Account lifecycle
| Function | What it does |
|---|---|
safe_close(account, destination) |
Move all lamports + close atomically |
safe_realloc(account, new_size, payer) |
Resize account + top up rent from payer |
safe_realloc_shrink(account, new_size, dest) |
Shrink account + return excess rent |
transfer_lamports(from, to, amount) |
Direct lamport transfer between program-owned accounts (no CPI) |
Safe CPI wrappers
Bundle validation + invocation so you can't forget a writable or signer check
before issuing a CPI. All zero-copy, all #[inline(always)].
| Function | What it does |
|---|---|
safe_create_account(payer, account, space, owner) |
System CPI: create account with rent-exempt balance |
safe_create_account_signed(payer, account, space, owner, signers) |
Same, with PDA signer seeds |
safe_transfer_sol(from, to, amount) |
System CPI: transfer SOL with nonzero check |
safe_transfer_tokens(from, to, authority, amount) |
Token CPI: SPL transfer with validation |
safe_transfer_tokens_signed(from, to, authority, amount, signers) |
Same, with PDA signer seeds |
safe_checked_transfer(from, to, auth, mint, from_owner, to_owner, amount) |
Paranoid transfer: mint + owner checks first |
safe_burn(account, mint, authority, amount) |
Token CPI: burn with validation |
safe_mint_to(mint, account, authority, amount) |
Token CPI: mint tokens with validation |
safe_mint_to_signed(mint, account, authority, amount, signers) |
Same, with PDA signer seeds |
safe_close_token_account(account, destination, authority) |
Token CPI: close account |
// One-liner CPI - checks signer, writable, nonzero for you
safe_transfer_tokens?;
// Paranoid transfer - also validates mint + owners match before CPI
safe_checked_transfer?;
// Direct lamport transfer between program-owned PDAs (no CPI needed)
transfer_lamports?;
ATA validation
| Function | What it does |
|---|---|
check_ata(account, wallet, mint) |
Verify account is the canonical ATA |
check_ata_with_program(account, wallet, mint, token_prog) |
Same, for Token-2022 ATAs |
Logging (opt-in)
Zero-alloc diagnostic logging behind the log feature flag. Uses the raw
sol_log syscall, no extra deps.
= { = "0.16", = ["log"] }
| Function | What it logs |
|---|---|
log_msg("text") |
Static message |
log_val("label", u64) |
Label + u64 value |
log_signed("label", i64) |
Label + signed value |
log_addr("label", &address) |
Label + first/last 4 bytes hex |
log_bool("label", bool) |
Label + Y/N |
Well-known program IDs
use programs;
SYSTEM // 11111111111111111111111111111111
TOKEN // TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA
TOKEN_2022 // TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb
ASSOCIATED_TOKEN // ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJe1bTu
METADATA // metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s
SYSVAR_CLOCK // SysvarC1ock11111111111111111111111111111111
SYSVAR_RENT // SysvarRent111111111111111111111111111111111
SYSVAR_INSTRUCTIONS // Sysvar1nstructions1111111111111111111111111
What you're probably hand-rolling
Things Jiminy ships that Anchor and Pinocchio don't.
CPI reentrancy guard
Reads the Sysvar Instructions account to detect whether your instruction was invoked directly by the transaction or via CPI from another program. One function call.
Token-2022 extension screening
Anchor deserializes token accounts but doesn't screen extensions. A mint with a
permanent delegate can drain your vault. A transfer hook can make your CPI fail.
Jiminy's check_safe_token_2022_mint rejects all commonly dangerous extensions
in a single call, or you can check them individually.
Slippage + economic guards
check_slippage, check_within_bps, check_price_bounds. Slippage
protection, oracle deviation checks, and price circuit breakers as one-liners.
U128 intermediate math
checked_mul_div and bps_of use u128 intermediates to prevent overflow.
Without this, amount * price overflows at ~4.2 billion tokens.
State machine transitions
check_state_transition validates (from, to) pairs against a transition table.
No more if state == X && next_state == Y || state == X && next_state == Z.
Define your transitions as a const table, validate in one call.
Source != destination guard
check_accounts_unique!(a, b, c, ...) (variadic macro) plus the original
check_accounts_unique_2, check_accounts_unique_3, and check_accounts_unique_4
functions.
Anchor's released versions (through 0.32.x) don't have a built-in for this.
The upcoming Anchor 1.0 adds duplicate mutable account validation at the
accounts-struct level, which guards against the same account occupying two
mutable positions. Jiminy's functions are explicit per-operation checks you
call inside instruction logic. Same-account-as-source-and-dest is a classic
token program exploit vector.
Oracle staleness (slot-based)
check_slot_staleness compares the slot of the last oracle update against the
current slot. Stale prices lead to liquidation errors and arbitrage exploits.
Decimal-aware amount scaling
scale_amount and scale_amount_ceil convert token amounts between different
decimal precisions using u128 intermediates. USDC (6 decimals) vs SOL (9
decimals) is the common case. Without the scaling, you get off-by-1000 bugs.
Direct lamport transfer (no CPI)
transfer_lamports moves SOL directly between two program-owned accounts
without a system program CPI. Cheapest way to
move lamports between PDAs your program controls. No signer required,
no CPI overhead.
Zero-alloc event emission
emit! and emit_slices write structured event data to the transaction log
via sol_log_data. Indexers (Helius, Triton, etc.) pick these up. Raw bytes
on the stack, single syscall, done.
let disc = ; // your event discriminator
let amt = amount.to_le_bytes;
emit!;
Transaction introspection
read_program_id_at, read_instruction_data_range, read_instruction_account_key,
and check_has_compute_budget. Read any instruction in the current transaction
directly from Sysvar Instructions data. Verify transaction shape before
touching any state.
Ed25519 precompile verification
check_ed25519_signature and check_ed25519_signer. Verify that an Ed25519
precompile instruction in the transaction was signed by an expected key over
an expected message. Used for gasless relayers, signed price feeds, off-chain
authorization flows. The runtime already did the crypto - you just need to
check it was the right signer and message. Zero-copy from the sysvar.
Authority handoff (two-step rotation)
check_pending_authority, write_pending_authority, accept_authority. The
standard DeFi pattern for safe authority transfer: current authority proposes,
new authority accepts. Prevents fat-finger key transfers. Zero-copy reads at
byte offsets you define.
Merkle proof verification
verify_merkle_proof and sha256_leaf. Verify merkle proofs using the native
sol_sha256 syscall. Sorted pair hashing with domain separators (matches the
OpenZeppelin / SPL convention). Whitelists, airdrops, allowlists - all on the
stack, no alloc.
Pyth oracle readers
read_pyth_price, read_pyth_ema, check_pyth_price_fresh, check_pyth_confidence.
Zero-copy Pyth V2 price feed reading at fixed byte offsets. No pyth-sdk-solana
dependency, no borsh, no alloc. Validates magic/version/account-type/status.
One function call replaces 6 crate dependencies.
let data = pyth_account.try_borrow?;
let p = read_pyth_price?;
// p.price * 10^(p.expo) = human-readable price
check_pyth_price_fresh?; // max 30s stale
check_pyth_confidence?; // max 5% band
AMM math
isqrt, constant_product_out, constant_product_in, check_k_invariant,
price_impact_bps, initial_lp_amount, proportional_lp_amount.
Integer square root via Newton's method for LP token minting. Constant-product swap math with u128 intermediates and fee support. K-invariant verification for post-swap safety. Price impact estimation.
let out = constant_product_out?; // 30 bps fee
check_k_invariant?;
let lp = isqrt?;
Balance delta (safe swap composition)
snapshot_token_balance, check_balance_increased, check_balance_decreased,
check_balance_delta, check_lamport_balance_increased.
Read balance before CPI, execute CPI, verify balance changed correctly after. Named functions make the pattern auditor-visible.
let before = snapshot_token_balance?;
safe_transfer_tokens?; // CPI into AMM
check_balance_increased?;
Close revival sentinel
safe_close_with_sentinel, check_not_revived, check_alive.
Defends against Sealevel Attack #9: attacker revives a closed account within
the same transaction by transferring lamports back. The sentinel writes
[0xFF; 8] to the first 8 bytes before zeroing, so revived accounts are
detectable on re-entry.
safe_close_with_sentinel?; // writes dead sentinel
// Later, in any instruction that accepts this account:
check_not_revived?;
Staking rewards math
update_reward_per_token, pending_rewards, update_reward_debt,
emission_rate, rewards_earned.
Reward-per-token accumulator with u128 precision and 1e12 scaling factor. Getting the math wrong leads to reward theft or stuck funds.
let new_rpt = update_reward_per_token?;
let claimable = pending_rewards?;
user.reward_debt = update_reward_debt;
Vesting schedules
vested_amount, check_cliff_reached, unlocked_at_step, claimable,
elapsed_steps.
Linear vesting with cliff, stepped/periodic unlocks, safe claimable computation. Pure arithmetic for team tokens, investor unlocks, grant programs.
let vested = vested_amount;
let claim = claimable;
Multi-signer threshold
check_threshold, count_signers, check_all_signers, check_any_signer.
M-of-N signature checking with built-in duplicate address prevention. Prevents the duplicate-signer attack (same key passed in multiple account slots to inflate the count).
check_threshold?; // 2-of-3 multisig
Compute budget guards
remaining_compute_units, check_compute_remaining, require_compute_remaining.
Wraps sol_remaining_compute_units() so batch-processing loops can bail
with a clean error instead of running into a wall. Also useful for adaptive
code paths that choose between expensive and cheap logic.
for item in items.iter
Transaction composition analysis
check_no_other_invocation, check_no_subsequent_invocation,
detect_flash_loan_bracket, count_program_invocations.
Higher-level introspection: detect flash-loan sandwiches, prevent specific
programs from appearing in the same transaction, count invocations. Builds
on introspect but answers structural questions about the whole tx.
let data = sysvar_ix.try_borrow?;
let me = get_instruction_index?;
if detect_flash_loan_bracket?
CPI return data
read_return_data, read_return_data_from, read_return_u64.
Read values returned by a CPI callee via sol_get_return_data. Verify the
return data came from the expected program (prevents a malicious intermediary
from overwriting results).
let output_amount = read_return_u64?;
check_slippage?;
Program upgrade verification
read_upgrade_authority, check_program_immutable, check_upgrade_authority.
Read BPF Upgradeable Loader state from a program's data account. Verify an external program is frozen (immutable) or that a known governance key controls upgrades before integrating with it.
check_program_immutable?; // must be frozen
check_upgrade_authority?; // known upgrade auth
TWAP accumulators
update_twap_cumulative, compute_twap, check_twap_deviation.
Time-weighted average price math. Maintain a cumulative price sum, compute TWAP between any two observations, and check spot/TWAP deviation as an anti-manipulation guard.
pool.cumulative = update_twap_cumulative?;
let twap = compute_twap?;
check_twap_deviation?; // max 5% spread
Lending math
collateralization_ratio_bps, check_healthy, check_liquidatable,
max_liquidation_amount, liquidation_seize_amount, simple_interest,
utilization_rate_bps.
Lending protocol primitives. All basis-point denominated, u128 intermediates, overflow-checked.
check_healthy?; // 125% min
let max_repay = max_liquidation_amount?; // 50% close factor
let seized = liquidation_seize_amount?; // 5% bonus
Proportional distribution
proportional_split, extract_fee.
Dust-safe N-way splits where sum(parts) == total is guaranteed. Fee
extraction where net + fee == amount holds exactly. Uses the
largest-remainder method for the integer division leftovers.
let shares = ;
let mut amounts = ;
proportional_split?;
// amounts sums to exactly 1_000_003
let = extract_fee?; // 0.3% + 1000 flat
assert_eq!;
Modular crates (v0.16+)
Starting with v0.11, Jiminy is split into focused crates. v0.13 added declarative macros for error codes, instruction dispatch, and account uniqueness checks. v0.15 adds the Account ABI system, schema tooling, SPL layout overlays, and Anchor interop. v0.16 adds verified account wrappers, push overlap protection, and production hardening.
# Full toolkit - zero local code, re-exports everything
= "0.16"
# Or pick what you need
= "0.16" # Account layout, checks, math, PDA, sysvar
= "0.16" # Token, CPI, crypto, oracle, introspection
= "0.16" # AMM math, slippage
= "0.16" # Lending/liquidation primitives
= "0.16" # Reward accumulators
= "0.16" # Vesting schedules
= "0.16" # M-of-N threshold
= "0.16" # Dust-safe splits
= "0.16" # Layout manifests, TS codegen, indexer kit
= "0.16" # SPL Token/Mint/Multisig/Nonce/Stake overlays
= "0.16" # Anchor disc + zero-copy overlay interop
The root jiminy crate re-exports everything. Module paths are unchanged:
// These all still work
use *;
use token_account_amount;
use safe_transfer_tokens;
use checked_mul_div;
// Or use subcrates directly for minimal dependency trees
use check_signer;
use verify_merkle_proof;
Migration from 0.15
The API is the same. If you depend on jiminy = "0.15", upgrade
to "0.16" and everything compiles. 0.16 adds verified account wrappers,
push overlap protection, and production hardening but nothing was removed
or renamed.
Compared to the alternatives
| Raw pinocchio | Anchor | Jiminy | |
|---|---|---|---|
| Allocator required | No | Yes | No |
| Borsh required | No | Yes | No |
| Proc macros | No | Yes | No (declarative macros give you the same benefits) |
| Account validation | Manual | #[account(...)] |
Functions + macros (error_codes!, instruction_dispatch!) |
| System CPI | Manual bytes | system_program::create_account |
CreateAccount { .. }.invoke() |
| Token CPI | Manual bytes | Anchor SPL | TokenTransfer { .. }.invoke() |
| Token account reads | Manual offsets | Borsh deser | Zero-copy readers + check functions |
| Mint account reads | Manual offsets | Borsh deser | Zero-copy readers + check functions |
| Token-2022 screening | Manual | Not built-in | check_safe_token_2022_mint |
| CPI reentrancy guard | Manual | Not built-in | check_no_cpi_caller |
| Slippage protection | Manual | Not built-in | check_slippage |
| DeFi math (u128) | Manual | Not built-in | checked_mul_div / bps_of |
| Decimal scaling | Manual | Not built-in | scale_amount / scale_amount_ceil |
| State machine checks | Manual | Not built-in | check_state_transition |
| Time/deadline checks | Manual | Not built-in | check_not_expired / check_cooldown |
| Oracle staleness | Manual | Not built-in | check_slot_staleness |
| Source != dest guard | Manual | Not built-in* | check_accounts_unique!(a, b, c) |
| Direct lamport xfer | Manual | Not built-in | transfer_lamports |
| Event emission | Manual | Borsh + proc macros | emit! / emit_slices (zero alloc) |
| Tx introspection | Manual | Not built-in | read_program_id_at / check_has_compute_budget |
| Ed25519 sig verify | Manual | Not built-in | check_ed25519_signature |
| Authority handoff | Manual | Not built-in | accept_authority |
| Merkle proofs | Manual | Not built-in | verify_merkle_proof |
| Oracle price feeds | pyth-sdk-solana (6 deps) |
pyth-sdk-solana |
read_pyth_price (zero deps) |
| AMM math / isqrt | Manual | Not built-in | constant_product_out / isqrt |
| Balance delta guard | Manual | Not built-in | check_balance_increased |
| Close revival defense | Manual | Not built-in | safe_close_with_sentinel |
| Staking rewards math | Manual | Not built-in | update_reward_per_token |
| Vesting schedules | Manual | Not built-in | vested_amount / unlocked_at_step |
| M-of-N multisig | Manual | Not built-in | check_threshold |
| Compute budget guard | Manual | Not built-in | check_compute_remaining |
| Flash loan detection | Manual | Not built-in | detect_flash_loan_bracket |
| CPI return data | Manual syscall | Framework-internal | read_return_u64 |
| Program upgrade check | Manual | ProgramData type |
check_program_immutable |
| TWAP math | Manual | Not built-in | compute_twap / check_twap_deviation |
| Lending/liquidation math | Manual | Not built-in | check_healthy / max_liquidation_amount |
| Dust-safe distribution | Manual | Not built-in | proportional_split / extract_fee |
| PDA derivation + bump | Manual syscall | seeds + bump constraint |
assert_pda / find_pda! / derive_pda! |
| Data reads/writes | Manual index math | Borsh | SliceCursor / DataWriter |
* Anchor's upcoming 1.0 adds struct-level duplicate mutable account detection. Jiminy's checks are explicit per-operation runtime guards.
Anchor is great for what it does. But if you went with pinocchio, you already made your choice. You shouldn't have to hand-roll every check that comes after it. That's what Jiminy is for.
Used in SHIPyard
Jiminy powers the on-chain program registry in SHIPyard, a platform for building, deploying, and sharing Solana programs. The code generator targets Jiminy as a framework option.
Docs
| Document | Description |
|---|---|
| LAYOUT_CONVENTION.md | Header format, zero_copy_layout!, tiered loading, layout lint |
| ABI_VERSIONING.md | Append-only versioning, extends, migration |
| SAFETY_MODEL.md | 10 safety invariants, threat model |
| ACCOUNT_ABI_CONTRACT.md | Cross-program read contract |
| ANCHOR_COMPARISON.md | Feature comparison with Anchor |
| HOT_PATH_COOKBOOK.md | Performance recipes for hot-path code |
| WHY_JIMINY.md | Motivation and design philosophy |
| AUDIT_PREP.md | Audit preparation guide and unsafe inventory |
| UNSAFE_INVENTORY.md | Every unsafe site catalogued: file, purpose, soundness |
| SEGMENTED_ABI.md | Design: variable-length accounts with segment descriptors |
| MIGRATION_COOKBOOK.md | Step-by-step migration: pinocchio → Jiminy, Anchor hot-path, version bumps |
| SAFE_COMPOSITION.md | Cross-program composition patterns, program allowlists |
| ROADMAP_V1.md | v1.0 roadmap and phased strategy |
Benchmarks
Comparing a vault program (deposit / withdraw / close) written in raw Pinocchio vs the same logic using Jiminy. Measured via Mollusk SVM on Agave 2.3.
Compute Units
| Instruction | Pinocchio | Jiminy | Delta |
|---|---|---|---|
| Deposit | 147 CU | 154 CU | +7 |
| Withdraw | 254 CU | 266 CU | +12 |
| Close | 215 CU | 228 CU | +13 |
| Guarded Withdraw | 567 CU | 581 CU | +14 |
Guarded Withdraw exercises the new DeFi safety modules: check_nonzero,
check_min_amount, check_accounts_unique_3, check_instruction_data_min,
and checked_mul_div for a 0.3% fee calculation.
Security Demo: Missing Signer Check
The benchmark includes a vuln_withdraw that "forgot" the is_signer() check.
An attacker reads a real user's vault on-chain, passes the stored authority pubkey
(unsigned) and the real vault, and calls withdraw. All other checks pass -- the
vault IS owned by the program. 2 SOL drained.
| Program | CU | Result |
|---|---|---|
| Pinocchio | 211 CU | EXPLOITED -- attacker drains 2 SOL |
| Jiminy | 78 CU | SAFE -- next_signer() rejects unsigned authority |
In Jiminy, the signer check is bundled into accs.next_signer() -- there's no
separate line to forget.
Binary Size (release SBF)
| Program | Size |
|---|---|
| Pinocchio vault | 27.4 KB |
| Jiminy vault | 26.5 KB |
Jiminy adds 7-14 CU of overhead per instruction (a single sol_log costs
~100 CU). The binary is 0.9 KB smaller thanks to pattern deduplication
from AccountList and the check functions.
See BENCHMARKS.md for full details and instructions to run them yourself.
Reference Programs
| Program | What it demonstrates |
|---|---|
examples/jiminy-vault |
Init / deposit / withdraw / close with AccountList, cursors, safe_close, zero_copy_layout! |
examples/jiminy-escrow |
Two-party escrow, flag-based state, check_closed, ordering guarantees, layout_id validation |
examples/cross-program-read |
Cross-program ABI read: Program B reads Program A's account via load_foreign. No deserialization, no crate dependency |
All three use the 16-byte header layout, zero_copy_layout! for ABI fingerprinting,
and jiminy::prelude for all imports.
Workspace layout
jiminy/
├── src/ # Root facade (lib.rs + prelude.rs only)
├── crates/
│ ├── jiminy-core/ # Ring 1: account/, check/, math, sysvar, …
│ ├── jiminy-solana/ # Ring 2: token/, cpi/, crypto/, oracle, …
│ ├── jiminy-finance/ # Ring 3: amm, slippage
│ ├── jiminy-lending/ # lending/liquidation
│ ├── jiminy-staking/ # staking rewards
│ ├── jiminy-vesting/ # vesting schedules
│ ├── jiminy-multisig/ # M-of-N threshold
│ ├── jiminy-distribute/ # proportional splits
│ ├── jiminy-schema/ # Tooling: layout manifests, TS codegen, indexer
│ ├── jiminy-layouts/ # SPL Token/Mint/Multisig/Nonce/Stake overlays
│ └── jiminy-anchor/ # Anchor disc + zero-copy overlay interop
├── examples/
│ ├── jiminy-vault/ # Full vault CRUD example
│ ├── jiminy-escrow/ # Two-party escrow example
│ └── cross-program-read/# Program A defines, Program B reads via load_foreign
├── bench/ # CU benchmarks vs raw pinocchio & Anchor
└── docs/ # Layout convention, ABI versioning, safety model
About
Built by MoonManQuark / Bluefoot Labs.
If jiminy saved you some debugging time, donations welcome at solanadevdao.sol (F42ZovBoRJZU4av5MiESVwJWnEx8ZQVFkc1RM29zMxNT).
License
Apache-2.0. See LICENSE.
pinocchio is also Apache-2.0: anza-xyz/pinocchio.