Struct ProgramCore 

pub struct ProgramCore<N: Network> { /* private fields */ }

Implementations

impl<N: Network> ProgramCore<N>

pub fn to_checksum(&self) -> [U8<N>; 32]

Returns the checksum of the program.

The checksum is a 32-byte hash of the program’s source code in string format. This ensures a strict definition of program equivalence, useful for program upgradability.

impl<N: Network> ProgramCore<N>

pub const KEYWORDS: &'static [&'static str]

A list of reserved keywords for Aleo programs, enforced at the parser level.

pub const RESTRICTED_KEYWORDS: &'static [(ConsensusVersion, &'static [&'static str])]

A list of restricted keywords for Aleo programs, enforced at the VM-level for program hygiene. Each entry is a tuple of the consensus version and a list of keywords. If the current consensus version is greater than or equal to the specified version, the keywords in the list should be restricted.

pub fn new(id: ProgramID<N>) -> Result<Self>

Initializes an empty program.

pub fn credits() -> Result<Self>

Initializes the credits program.

pub const fn id(&self) -> &ProgramID<N>

Returns the ID of the program.

pub const fn imports(&self) -> &IndexMap<ProgramID<N>, Import<N>>

Returns the imports in the program.

pub const fn constructor(&self) -> Option<&ConstructorCore<N>>

Returns the constructor for the program.

pub const fn mappings(&self) -> &IndexMap<Identifier<N>, Mapping<N>>

Returns the mappings in the program.

pub const fn structs(&self) -> &IndexMap<Identifier<N>, StructType<N>>

Returns the structs in the program.

pub const fn records(&self) -> &IndexMap<Identifier<N>, RecordType<N>>

Returns the records in the program.

pub const fn closures(&self) -> &IndexMap<Identifier<N>, ClosureCore<N>>

Returns the closures in the program.

pub const fn functions(&self) -> &IndexMap<Identifier<N>, FunctionCore<N>>

Returns the functions in the program.

pub fn contains_import(&self, id: &ProgramID<N>) -> bool

Returns true if the program contains an import with the given program ID.

pub const fn contains_constructor(&self) -> bool

Returns true if the program contains a constructor.

pub fn contains_mapping(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a mapping with the given name.

pub fn contains_struct(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a struct with the given name.

pub fn contains_record(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a record with the given name.

pub fn contains_closure(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a closure with the given name.

pub fn contains_function(&self, name: &Identifier<N>) -> bool

Returns true if the program contains a function with the given name.

pub fn get_mapping(&self, name: &Identifier<N>) -> Result<Mapping<N>>

Returns the mapping with the given name.

pub fn get_struct(&self, name: &Identifier<N>) -> Result<&StructType<N>>

Returns the struct with the given name.

pub fn get_record(&self, name: &Identifier<N>) -> Result<&RecordType<N>>

Returns the record with the given name.

pub fn get_closure(&self, name: &Identifier<N>) -> Result<ClosureCore<N>>

Returns the closure with the given name.

pub fn get_function(&self, name: &Identifier<N>) -> Result<FunctionCore<N>>

Returns the function with the given name.

pub fn get_function_ref(&self, name: &Identifier<N>) -> Result<&FunctionCore<N>>

Returns a reference to the function with the given name.

pub fn is_reserved_opcode(name: &str) -> bool

Returns true if the given name is a reserved opcode.

pub fn is_reserved_keyword(name: &Identifier<N>) -> bool

Returns true if the given name uses a reserved keyword.

pub fn restricted_keywords_for_consensus_version( consensus_version: ConsensusVersion, ) -> impl Iterator<Item = &'static str>

Returns an iterator over the restricted keywords for the given consensus version.

pub fn check_restricted_keywords_for_consensus_version( &self, consensus_version: ConsensusVersion, ) -> Result<()>

Checks a program for restricted keywords for the given consensus version. Returns an error if any restricted keywords are found. Note: Restrictions are not enforced on the import names in case they were deployed before the restrictions were added.

pub fn check_program_naming_structure(&self) -> Result<()>

Checks that the program structure is well-formed under the following rules:

1. The program ID must not contain the keyword “aleo” in the program name.
2. The record name must not contain the keyword “aleo”.
3. Record names must not be prefixes of other record names.
4. Record entry names must not contain the keyword “aleo”.

pub fn check_external_calls_to_credits_upgrade(&self) -> Result<()>

Checks that the program does not make external calls to credits.aleo/upgrade.

pub fn contains_v9_syntax(&self) -> bool

Returns true if a program contains any V9 syntax. This includes constructor, Operand::Edition, Operand::Checksum, and Operand::ProgramOwner. This is enforced to be false for programs before ConsensusVersion::V9.

pub fn exceeds_max_array_size(&self, max_array_size: u32) -> bool

Returns true if the program contains an array type with a size that exceeds the given maximum.

pub fn contains_v11_syntax(&self) -> bool

Returns true if a program contains any V11 syntax. This includes:

1. .raw hash or signature verification variants
2. ecdsa.verify.* opcodes
3. arrays that exceed the previous maximum length of 32.

Trait Implementations

impl<N: Clone + Network> Clone for ProgramCore<N>

fn clone(&self) -> ProgramCore<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for ProgramCore<N>

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

Prints the program as a string.

impl<'de, N: Network> Deserialize<'de> for ProgramCore<N>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the program from a string or bytes.

impl<N: Network> Display for ProgramCore<N>

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

Prints the program as a string.

impl<N: Network> FromBytes for ProgramCore<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads Self from reader as little-endian bytes.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N: Network> FromStr for ProgramCore<N>

fn from_str(string: &str) -> Result<Self>

Returns a program from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network> Parser for ProgramCore<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a program.

impl<N: Network> PartialEq for ProgramCore<N>

fn eq(&self, other: &Self) -> bool

Compares two programs for equality, verifying that the components are in the same order. The order of the components must match to ensure that deployment tree is well-formed.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Network> Serialize for ProgramCore<N>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the program into string or bytes.

impl<N: Network> ToBytes for ProgramCore<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes self into writer as little-endian bytes.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Network> TypeName for ProgramCore<N>

fn type_name() -> &'static str

Returns the type name as a string.

impl<N: Network> Eq for ProgramCore<N>