Skip to main content

ProgramIdl

Struct ProgramIdl 

Source
pub struct ProgramIdl {
    pub name: &'static str,
    pub version: &'static str,
    pub description: &'static str,
    pub instructions: &'static [IdlInstructionDescriptor],
    pub accounts: &'static [LayoutManifest],
    pub events: &'static [EventDescriptor],
    pub fingerprints: &'static [([u8; 8], &'static str)],
}
Expand description

A public-facing IDL for a Hopper program.

Contains only what external consumers (clients, explorers, SDKs) need. Does NOT contain internal policy logic, migration planner hints, trust internals, or unsafe metadata.

Generated from (and strictly a subset of) ProgramManifest.

Fields§

§name: &'static str

Program name.

§version: &'static str

Program version string.

§description: &'static str

Program description.

§instructions: &'static [IdlInstructionDescriptor]

Instructions with args, accounts, PDA hints.

§accounts: &'static [LayoutManifest]

Account layout summaries (name, disc, version, layout_id, size, fields).

§events: &'static [EventDescriptor]

Event descriptors.

§fingerprints: &'static [([u8; 8], &'static str)]

Optional layout_id fingerprints per account.

Implementations§

Source§

impl ProgramIdl

Source

pub const fn empty() -> Self

Create an empty IDL.

Source

pub const fn instruction_count(&self) -> usize

Number of instructions.

Source

pub const fn account_count(&self) -> usize

Number of account types.

Source

pub fn find_instruction(&self, name: &str) -> Option<&IdlInstructionDescriptor>

Find an instruction by name.

Source

pub fn find_account(&self, name: &str) -> Option<&LayoutManifest>

Find an account layout by name.

Trait Implementations§

Source§

impl Clone for ProgramIdl

Source§

fn clone(&self) -> ProgramIdl

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Display for ProgramIdl

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for ProgramIdl

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.