Struct ProgramManager 

pub struct ProgramManager<'agent> { /* private fields */ }

Implementations

impl<'agent> ProgramManager<'agent>

pub fn new(agent: &'agent Agent, program_id: ProgramID) -> Self

Creates a new Program Manager with an agent and a particular ProgramID.

pub fn program_id(&self) -> &ProgramID

pub fn agent(&self) -> &Agent

impl<'agent> ProgramManager<'agent>

pub fn execute_program( &self, function: &str, inputs: impl ExactSizeIterator<Item = impl TryInto<Value>>, priority_fee: u64, fee_record: Option<PlaintextRecord>, ) -> Result<String>

Execute a program function on the Aleo Network.

To run this function successfully, the program must already be deployed on the Aleo Network

Arguments

• function - The function to execute
• inputs - The inputs to the function
• priority_fee - The priority fee to pay for the transaction
• fee_record - The plaintext record to pay for the transaction fee. If None, the fee will be paid through the account’s public balance

Returns

The transaction ID of the execution transaction

Example

use aleo_agent::agent::Agent;
use aleo_agent::program::ProgramManager;
let pm = Agent::default().program("xxx.aleo");

// Execute the main function of the xxx.aleo program with inputs 1, 2, 3; priority fee 100; and no fee record
// The fee will be paid through account's public balance
let tx_id = pm.execute_program("main", vec![1, 2, 3].into_iter(), 100, None).expect("Failed to execute program");

pub fn get_program_records( &self, block_heights: Range<u32>, unspent_only: bool, ) -> Result<Vec<(Field, CiphertextRecord)>>

Execute a program function on the Aleo Network with a priority fee and no fee record

Arguments

• block_heights - The range of block heights to search for records
• unspent_only - Whether to return only unspent records : true for unspent records, false for all records

Returns

A vector of records that match the search criteria

Example

use aleo_agent::agent::Agent;
use aleo_agent::program::ProgramManager;
let pm = Agent::default().program("xxx.aleo");

// Get the unspent records of the first 100 blocks for the program
let records = pm.get_program_records(0..100, true).expect("Failed to get program records");

pub fn get_mapping_value( &self, mapping_name: impl TryInto<Identifier>, key: impl TryInto<Plaintext>, ) -> Result<Value>

Get the current value of a mapping given a specific program, mapping name, and mapping key

Arguments

• mapping_name - The name of the mapping to query
• key - The key to query the mapping with

Returns

The value of the mapping at the given key

pub fn get_program_mappings(&self) -> Result<Vec<Identifier>>

Get all mappings associated with a program.

impl<'agent> ProgramManager<'agent>

pub fn get_program_from_chain(program_id: &ProgramID) -> Result<Program>

Get a program from the network by its ID. This method will return an error if it does not exist.

pub fn get_import_programs_from_chain( program: &Program, ) -> Result<IndexMap<ProgramID, Program>>

Resolve imports of a program in a depth-first-search order from program source code

Arguments

• program - The program to resolve imports for

Returns

A map of program IDs to programs

pub fn load_program_from_path<P: Into<PathBuf>>(path: P) -> Result<Program>

Load a program from a file path

Arguments

• path - The path refers to the folder containing the program.json and *.aleo files, which are generated by leo build in the Leo project.

Trait Implementations

impl<'agent> Clone for ProgramManager<'agent>

fn clone(&self) -> ProgramManager<'agent>

Returns a duplicate of the value.

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

Performs copy-assignment from source.